Maslosoft Mangan API

Name: Mangan
Brand: Maslosoft

Interface FinderInterface

Direct known implementers

Maslosoft\Mangan\Abstracts\AbstractFinder, Maslosoft\Mangan\Interfaces\ActiveRecordInterface

Indirect known implementers

Maslosoft\Mangan\Document, Maslosoft\Mangan\Example\ExampleUser, Maslosoft\Mangan\Finder, Maslosoft\Mangan\Helpers\RawFinder, Maslosoft\Mangan\Model\Trash, Maslosoft\Mangan\Model\TrashItem

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

Methods summary

`public Maslosoft\Addendum\Interfaces\AnnotatedInterface`	# `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 Ignored
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|null`	# `findByPk( mixed $pk, array\|Maslosoft\Mangan\Interfaces\CriteriaInterface\|Maslosoft\Mangan\Criteria $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\|null Ignored
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|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\|null
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|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\Cursor` Ignored
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|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\Cursor` Array or cursor of Documents Since v1.0
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|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\Interfaces\FinderInterface::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\Interfaces\FinderInterface::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\Cursor` Array or cursor of Documents Since v1.0
`public integer`	# `count( array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Counts all documents satisfying the specified condition. See `Maslosoft\Mangan\Interfaces\FinderInterface::find()` for detailed explanation about $condition and $params. Counts all documents satisfying the specified condition. See `Maslosoft\Mangan\Interfaces\FinderInterface::find()` for detailed explanation about $condition and $params. Parameters `$criteria` query criteria. Returns integer Count of all documents satisfying the specified condition. Since v1.0
`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 Since v1.2.2 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
`public Maslosoft\Mangan\Interfaces\FinderInterface`	# `withCursor( type $useCursor = true )` Whenever to use cursor Whenever to use cursor Parameters `$useCursor` Returns `Maslosoft\Mangan\Interfaces\FinderInterface`

Constants summary

`string`	`EventBeforeFind` This event is triggered before an AR finder executes a find call. The find calls include `Maslosoft\Mangan\Interfaces\FinderInterface::find()`, `Maslosoft\Mangan\Interfaces\FinderInterface::findAll()`, `Maslosoft\Mangan\Interfaces\FinderInterface::findByPk()`, `Maslosoft\Mangan\Interfaces\FinderInterface::findAllByPk()`, `Maslosoft\Mangan\Interfaces\FinderInterface::findByAttributes()` and `Maslosoft\Mangan\Interfaces\FinderInterface::findAllByAttributes()`. This event is triggered before an AR finder executes a find call. The find calls include `Maslosoft\Mangan\Interfaces\FinderInterface::find()`, `Maslosoft\Mangan\Interfaces\FinderInterface::findAll()`, `Maslosoft\Mangan\Interfaces\FinderInterface::findByPk()`, `Maslosoft\Mangan\Interfaces\FinderInterface::findAllByPk()`, `Maslosoft\Mangan\Interfaces\FinderInterface::findByAttributes()` and `Maslosoft\Mangan\Interfaces\FinderInterface::findAllByAttributes()`.	# `'beforeFind'`
`string`	`EventBeforeCount` This event is triggered before count methods This event is triggered before count methods	# `'beforeCount'`
`string`	`EventBeforeExists` This event is triggered before exists methods This event is triggered before exists methods	# `'beforeExists'`
`string`	`EventAfterFind` This event is trigerred after each record is instantiated by a find method. The find calls include `Maslosoft\Mangan\Interfaces\FinderInterface::find()`, `Maslosoft\Mangan\Interfaces\FinderInterface::findAll()`, `Maslosoft\Mangan\Interfaces\FinderInterface::findByPk()`, `Maslosoft\Mangan\Interfaces\FinderInterface::findAllByPk()`, `Maslosoft\Mangan\Interfaces\FinderInterface::findByAttributes()` and `Maslosoft\Mangan\Interfaces\FinderInterface::findAllByAttributes()`. This event is trigerred after each record is instantiated by a find method. The find calls include `Maslosoft\Mangan\Interfaces\FinderInterface::find()`, `Maslosoft\Mangan\Interfaces\FinderInterface::findAll()`, `Maslosoft\Mangan\Interfaces\FinderInterface::findByPk()`, `Maslosoft\Mangan\Interfaces\FinderInterface::findAllByPk()`, `Maslosoft\Mangan\Interfaces\FinderInterface::findByAttributes()` and `Maslosoft\Mangan\Interfaces\FinderInterface::findAllByAttributes()`.	# `'afterFind'`
`string`	`EventAfterCount` This event is triggered after count methods This event is triggered after count methods	# `'afterCount'`
`string`	`EventAfterExists` This event is triggered after exists methods This event is triggered after exists methods	# `'afterExists'`

API documentation generated by ApiGen

`public Maslosoft\Addendum\Interfaces\AnnotatedInterface`	# `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 Ignored
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|null`	# `findByPk( mixed $pk, array\|Maslosoft\Mangan\Interfaces\CriteriaInterface\|Maslosoft\Mangan\Criteria $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\|null Ignored
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|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\|null
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|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\Cursor` Ignored
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|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\Cursor` Array or cursor of Documents Since v1.0
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|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\Interfaces\FinderInterface::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\Interfaces\FinderInterface::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\Cursor` Array or cursor of Documents Since v1.0
`public integer`	# `count( array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Counts all documents satisfying the specified condition. See `Maslosoft\Mangan\Interfaces\FinderInterface::find()` for detailed explanation about $condition and $params. Counts all documents satisfying the specified condition. See `Maslosoft\Mangan\Interfaces\FinderInterface::find()` for detailed explanation about $condition and $params. Parameters `$criteria` query criteria. Returns integer Count of all documents satisfying the specified condition. Since v1.0
`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 Since v1.2.2 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
`public Maslosoft\Mangan\Interfaces\FinderInterface`	# `withCursor( type $useCursor = true )` Whenever to use cursor Whenever to use cursor Parameters `$useCursor` Returns `Maslosoft\Mangan\Interfaces\FinderInterface`

Maslosoft Mangan API

Namespaces

Interfaces

Interface FinderInterface

Direct known implementers

Indirect known implementers

Methods summary

Parameters

Returns

Ignored

Parameters

Returns

Ignored

Parameters

Returns

Parameters

Returns

Ignored

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Ignored

Parameters

Returns

Parameters

Returns

Constants summary

Contact us