Maslosoft Mangan API

Name: Mangan
Brand: Maslosoft

Trait FinderTrait

Finder trait contains implementation of FinderInterface, and it forwards them to concrete Finder class. Finder used by this trait can be defined via Finder annotation.

This trait could be used as a part of active document class.

Direct Known Users

Maslosoft\Mangan\Document

Indirect Known Users

Maslosoft\Mangan\Example\ExampleUser, Maslosoft\Mangan\Model\Trash, Maslosoft\Mangan\Model\TrashItem

Namespace: Maslosoft\Mangan\Traits
See: Maslosoft\Mangan\Interfaces\FinderInterface
Author: Piotr Maselkowski
Located at Traits/FinderTrait.php

Methods summary

`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|Maslosoft\Mangan\Traits\FinderTrait\|null`	# `find( array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Finds a single Document with the specified condition. Finds a single Document with the specified condition. Parameters `$criteria` query criteria. Returns Maslosoft\Addendum\Interfaces\AnnotatedInterface\|`Maslosoft\Mangan\Traits\FinderTrait`\|null Ignored
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|Maslosoft\Mangan\Traits\FinderTrait\|null`	# `findByPk( mixed $pk, array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Finds document with the specified primary key. Primary key by default is defined by `_id` field. But could be any other. For simple (one column) keys use it's value. Finds document with the specified primary key. Primary key by default is defined by `_id` field. But could be any other. For simple (one column) keys use it's value. For composite use key-value with column names as keys and values for values. Example for simple pk: $pk = '51b616fcc0986e30026d0748' Composite pk: $pk = [ 'mainPk' => 1, 'secondaryPk' => 2 ]; Parameters `$pk` primary key value. Use array for composite key. `$criteria` Returns Maslosoft\Addendum\Interfaces\AnnotatedInterface\|`Maslosoft\Mangan\Traits\FinderTrait`\|null Ignored
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|Maslosoft\Mangan\Traits\FinderTrait\|null`	# `findByAttributes( array $attributes )` Finds document with the specified attributes. Attributes should be specified as key-value pairs. This allows easier syntax for simple queries. Finds document with the specified attributes. Attributes should be specified as key-value pairs. This allows easier syntax for simple queries. Example: $attributes = [ 'name' => 'John', 'title' => 'dr' ]; Parameters `$attributes` of stributes and values in form of ['attributeName' => 'value'] Returns Maslosoft\Addendum\Interfaces\AnnotatedInterface\|`Maslosoft\Mangan\Traits\FinderTrait`\|null Ignored
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|Maslosoft\Mangan\Traits\FinderTrait[]\|Maslosoft\Mangan\Cursor`	# `findAll( array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Finds all documents satisfying the specified condition. Finds all documents satisfying the specified condition. Parameters `$criteria` query criteria. Returns Maslosoft\Addendum\Interfaces\AnnotatedInterface\|`Maslosoft\Mangan\Traits\FinderTrait[]`\|`Maslosoft\Mangan\Cursor` Ignored
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|Maslosoft\Mangan\Traits\FinderTrait[]\|Maslosoft\Mangan\Cursor`	# `findAllByAttributes( array $attributes )` Finds all documents with the specified attributes. Finds all documents with the specified attributes. Parameters `$attributes` of stributes and values in form of ['attributeName' => 'value'] Returns Maslosoft\Addendum\Interfaces\AnnotatedInterface\|`Maslosoft\Mangan\Traits\FinderTrait[]`\|`Maslosoft\Mangan\Cursor` Ignored
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|Maslosoft\Mangan\Traits\FinderTrait[]\|Maslosoft\Mangan\Cursor`	# `findAllByPk( mixed $pk, array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Finds all documents with the specified primary keys. In MongoDB world every document has '_id' unique field, so with this method that field is in use as PK by default. See `Maslosoft\Mangan\Traits\FinderTrait::find()` for detailed explanation about $condition. Finds all documents with the specified primary keys. In MongoDB world every document has '_id' unique field, so with this method that field is in use as PK by default. See `Maslosoft\Mangan\Traits\FinderTrait::find()` for detailed explanation about $condition. Parameters `$pk` primary key value(s). Use array for multiple primary keys. For composite key, each key value must be an array (column name=>column value). `$criteria` query criteria. Returns Maslosoft\Addendum\Interfaces\AnnotatedInterface\|`Maslosoft\Mangan\Traits\FinderTrait[]`\|`Maslosoft\Mangan\Cursor` Ignored
`public integer`	# `count( array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Counts all documents satisfying the specified condition. Counts all documents satisfying the specified condition. Parameters `$criteria` query criteria. Returns integer Ignored
`public integer`	# `countByAttributes( array $attributes )` Counts all documents found by attribute values. Counts all documents found by attribute values. Example: $attributes = [ 'name' => 'John', 'title' => 'dr' ]; Parameters `$attributes` of attributes and values in form of ['attributeName' => 'value'] Returns integer Ignored
`public boolean`	# `exists( Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Checks whether there is document satisfying the specified condition. Checks whether there is document satisfying the specified condition. Parameters `$criteria` Returns boolean Ignored
`public Maslosoft\Mangan\Interfaces\FinderInterface`	# `withCursor( boolean $useCursor = true )` Whenever to use cursor Whenever to use cursor Parameters `$useCursor` Returns `Maslosoft\Mangan\Interfaces\FinderInterface` Ignored

API documentation generated by ApiGen

`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|Maslosoft\Mangan\Traits\FinderTrait\|null`	# `find( array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Finds a single Document with the specified condition. Finds a single Document with the specified condition. Parameters `$criteria` query criteria. Returns Maslosoft\Addendum\Interfaces\AnnotatedInterface\|`Maslosoft\Mangan\Traits\FinderTrait`\|null Ignored
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|Maslosoft\Mangan\Traits\FinderTrait\|null`	# `findByPk( mixed $pk, array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Finds document with the specified primary key. Primary key by default is defined by `_id` field. But could be any other. For simple (one column) keys use it's value. Finds document with the specified primary key. Primary key by default is defined by `_id` field. But could be any other. For simple (one column) keys use it's value. For composite use key-value with column names as keys and values for values. Example for simple pk: $pk = '51b616fcc0986e30026d0748' Composite pk: $pk = [ 'mainPk' => 1, 'secondaryPk' => 2 ]; Parameters `$pk` primary key value. Use array for composite key. `$criteria` Returns Maslosoft\Addendum\Interfaces\AnnotatedInterface\|`Maslosoft\Mangan\Traits\FinderTrait`\|null Ignored
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|Maslosoft\Mangan\Traits\FinderTrait\|null`	# `findByAttributes( array $attributes )` Finds document with the specified attributes. Attributes should be specified as key-value pairs. This allows easier syntax for simple queries. Finds document with the specified attributes. Attributes should be specified as key-value pairs. This allows easier syntax for simple queries. Example: $attributes = [ 'name' => 'John', 'title' => 'dr' ]; Parameters `$attributes` of stributes and values in form of ['attributeName' => 'value'] Returns Maslosoft\Addendum\Interfaces\AnnotatedInterface\|`Maslosoft\Mangan\Traits\FinderTrait`\|null Ignored
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|Maslosoft\Mangan\Traits\FinderTrait[]\|Maslosoft\Mangan\Cursor`	# `findAll( array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Finds all documents satisfying the specified condition. Finds all documents satisfying the specified condition. Parameters `$criteria` query criteria. Returns Maslosoft\Addendum\Interfaces\AnnotatedInterface\|`Maslosoft\Mangan\Traits\FinderTrait[]`\|`Maslosoft\Mangan\Cursor` Ignored
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|Maslosoft\Mangan\Traits\FinderTrait[]\|Maslosoft\Mangan\Cursor`	# `findAllByAttributes( array $attributes )` Finds all documents with the specified attributes. Finds all documents with the specified attributes. Parameters `$attributes` of stributes and values in form of ['attributeName' => 'value'] Returns Maslosoft\Addendum\Interfaces\AnnotatedInterface\|`Maslosoft\Mangan\Traits\FinderTrait[]`\|`Maslosoft\Mangan\Cursor` Ignored
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|Maslosoft\Mangan\Traits\FinderTrait[]\|Maslosoft\Mangan\Cursor`	# `findAllByPk( mixed $pk, array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Finds all documents with the specified primary keys. In MongoDB world every document has '_id' unique field, so with this method that field is in use as PK by default. See `Maslosoft\Mangan\Traits\FinderTrait::find()` for detailed explanation about $condition. Finds all documents with the specified primary keys. In MongoDB world every document has '_id' unique field, so with this method that field is in use as PK by default. See `Maslosoft\Mangan\Traits\FinderTrait::find()` for detailed explanation about $condition. Parameters `$pk` primary key value(s). Use array for multiple primary keys. For composite key, each key value must be an array (column name=>column value). `$criteria` query criteria. Returns Maslosoft\Addendum\Interfaces\AnnotatedInterface\|`Maslosoft\Mangan\Traits\FinderTrait[]`\|`Maslosoft\Mangan\Cursor` Ignored
`public integer`	# `count( array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Counts all documents satisfying the specified condition. Counts all documents satisfying the specified condition. Parameters `$criteria` query criteria. Returns integer Ignored
`public integer`	# `countByAttributes( array $attributes )` Counts all documents found by attribute values. Counts all documents found by attribute values. Example: $attributes = [ 'name' => 'John', 'title' => 'dr' ]; Parameters `$attributes` of attributes and values in form of ['attributeName' => 'value'] Returns integer Ignored
`public boolean`	# `exists( Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Checks whether there is document satisfying the specified condition. Checks whether there is document satisfying the specified condition. Parameters `$criteria` Returns boolean Ignored
`public Maslosoft\Mangan\Interfaces\FinderInterface`	# `withCursor( boolean $useCursor = true )` Whenever to use cursor Whenever to use cursor Parameters `$useCursor` Returns `Maslosoft\Mangan\Interfaces\FinderInterface` Ignored

Maslosoft Mangan API

Namespaces

Traits

Trait FinderTrait

Direct Known Users

Indirect Known Users

Methods summary

Parameters

Returns

Ignored

Parameters

Returns

Ignored

Parameters

Returns

Ignored

Parameters

Returns

Ignored

Parameters

Returns

Ignored

Parameters

Returns

Ignored

Parameters

Returns

Ignored

Parameters

Returns

Ignored

Parameters

Returns

Ignored

Parameters

Returns

Ignored

Contact us