Maslosoft Mangan API

Name: Mangan
Brand: Maslosoft

Class AbstractFinder

AbstractFinder

Maslosoft\Mangan\Abstracts\AbstractFinder implements Maslosoft\Mangan\Interfaces\FinderInterface, Maslosoft\Mangan\Interfaces\ModelAwareInterface uses Maslosoft\Mangan\Traits\ModelAwareTrait

Direct known subclasses

Maslosoft\Mangan\Finder

Indirect known subclasses

Maslosoft\Mangan\Helpers\RawFinder

Abstract
Namespace: Maslosoft\Mangan\Abstracts
Author: Piotr Maselkowski
Located at Abstracts/AbstractFinder.php

Methods summary

`abstract public Maslosoft\Mangan\Interfaces\Adapters\FinderAdapterInterface\|Maslosoft\Mangan\Adapters\Finder\MongoAdapter`	# `getAdapter( )` Returns `Maslosoft\Mangan\Interfaces\Adapters\FinderAdapterInterface`\|Maslosoft\Mangan\Adapters\Finder\MongoAdapter See `Maslosoft\Mangan\Traits\Finder\FinderHelpers`
`abstract public Maslosoft\Mangan\Interfaces\ScopeManagerInterface`	# `getScopeManager( )` Returns `Maslosoft\Mangan\Interfaces\ScopeManagerInterface` See `Maslosoft\Mangan\Traits\Finder\FinderHelpers`
`abstract public Maslosoft\Mangan\Interfaces\FinderEventsInterface`	# `getFinderEvents( )` Returns `Maslosoft\Mangan\Interfaces\FinderEventsInterface` See `Maslosoft\Mangan\Traits\Finder\FinderHelpers`
`abstract public Maslosoft\Mangan\Interfaces\ProfilerInterface`	# `getProfiler( )` Returns `Maslosoft\Mangan\Interfaces\ProfilerInterface` See `Maslosoft\Mangan\Traits\Finder\FinderHelpers`
`abstract public Maslosoft\Mangan\Abstracts\AbstractFinder`	# `setAdapter( Maslosoft\Mangan\Interfaces\Adapters\FinderAdapterInterface $adapter )` Returns `Maslosoft\Mangan\Abstracts\AbstractFinder` See `Maslosoft\Mangan\Traits\Finder\FinderHelpers`
`abstract public Maslosoft\Mangan\Abstracts\AbstractFinder`	# `setScopeManager( Maslosoft\Mangan\Interfaces\ScopeManagerInterface $scopeManager )` Returns `Maslosoft\Mangan\Abstracts\AbstractFinder` See `Maslosoft\Mangan\Traits\Finder\FinderHelpers`
`abstract public Maslosoft\Mangan\Abstracts\AbstractFinder`	# `setFinderEvents( Maslosoft\Mangan\Interfaces\FinderEventsInterface $finderEvents )` Returns `Maslosoft\Mangan\Abstracts\AbstractFinder` See `Maslosoft\Mangan\Traits\Finder\FinderHelpers`
`abstract public Maslosoft\Mangan\Abstracts\AbstractFinder`	# `setProfiler( Maslosoft\Mangan\Interfaces\ProfilerInterface $profiler )` Returns `Maslosoft\Mangan\Abstracts\AbstractFinder` See `Maslosoft\Mangan\Traits\Finder\FinderHelpers`
`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 Implementation of `Maslosoft\Mangan\Interfaces\FinderInterface::find()`
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|null`	# `findByPk( mixed $pkValue, 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 `$pkValue` primary key value. Use array for composite key. `$criteria` Returns Maslosoft\Addendum\Interfaces\AnnotatedInterface\|null Ignored Implementation of `Maslosoft\Mangan\Interfaces\FinderInterface::findByPk()`
`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 Implementation of `Maslosoft\Mangan\Interfaces\FinderInterface::findByAttributes()`
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|Maslosoft\Mangan\Cursor`	# `findAll( array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Finds all documents satisfying the specified condition. See `Maslosoft\Mangan\Abstracts\AbstractFinder::find()` for detailed explanation about $condition and $params. Finds all documents satisfying the specified condition. See `Maslosoft\Mangan\Abstracts\AbstractFinder::find()` for detailed explanation about $condition and $params. Parameters `$criteria` query criteria. Returns Maslosoft\Addendum\Interfaces\AnnotatedInterface\|`Maslosoft\Mangan\Cursor` Implementation of `Maslosoft\Mangan\Interfaces\FinderInterface::findAll()`
`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 Implementation of `Maslosoft\Mangan\Interfaces\FinderInterface::findAllByAttributes()`
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|Maslosoft\Mangan\Cursor`	# `findAllByPk( mixed $pkValues, 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\Abstracts\AbstractFinder::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\Abstracts\AbstractFinder::find()` for detailed explanation about $condition. Parameters `$pkValues` 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 Implementation of `Maslosoft\Mangan\Interfaces\FinderInterface::findAllByPk()`
`public integer`	# `count( array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria = null )` Counts all documents satisfying the specified condition. See `Maslosoft\Mangan\Abstracts\AbstractFinder::find()` for detailed explanation about $condition and $params. Counts all documents satisfying the specified condition. See `Maslosoft\Mangan\Abstracts\AbstractFinder::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 Implementation of `Maslosoft\Mangan\Interfaces\FinderInterface::count()`
`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 Implementation of `Maslosoft\Mangan\Interfaces\FinderInterface::countByAttributes()`
`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 Implementation of `Maslosoft\Mangan\Interfaces\FinderInterface::exists()`
`public Maslosoft\Mangan\Finder`	# `resetScope( )` Resets all scopes and criteria applied including default scope. Resets all scopes and criteria applied including default scope. Returns `Maslosoft\Mangan\Finder` Since v1.0
`public Maslosoft\Mangan\Interfaces\FinderInterface`	# `withCursor( boolean $useCursor = true )` Whenever to use cursor Whenever to use cursor Parameters `$useCursor` Returns `Maslosoft\Mangan\Interfaces\FinderInterface` Implementation of `Maslosoft\Mangan\Interfaces\FinderInterface::withCursor()`
`public`	# `isWithCursor( )`

Methods inherited from Maslosoft\Mangan\Interfaces\ModelAwareInterface

getModel(), setModel()

Methods used from Maslosoft\Mangan\Traits\ModelAwareTrait

getModel(), setModel()

Constants summary

Constants inherited from Maslosoft\Mangan\Interfaces\FinderInterface

EventAfterCount, EventAfterExists, EventAfterFind, EventBeforeCount, EventBeforeExists, EventBeforeFind

Properties summary

Properties used from Maslosoft\Mangan\Traits\ModelAwareTrait

$model

API documentation generated by ApiGen

Maslosoft Mangan API

Namespaces

Classes

Class AbstractFinder

Direct known subclasses

Indirect known subclasses

Methods summary

Returns

See

Returns

See

Returns

See

Returns

See

Returns

See

Returns

See

Returns

See

Returns

See

Parameters

Returns

Ignored

Implementation of

Parameters

Returns

Ignored

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Since

Implementation of

Parameters

Returns

Since

Implementation of

Parameters

Returns

Since

Implementation of

Parameters

Returns

Since

Ignored

Implementation of

Parameters

Returns

Implementation of

Returns

Since

Parameters

Returns

Implementation of

Methods inherited from Maslosoft\Mangan\Interfaces\ModelAwareInterface

Methods used from Maslosoft\Mangan\Traits\ModelAwareTrait

Constants summary

Constants inherited from Maslosoft\Mangan\Interfaces\FinderInterface

Properties summary

Properties used from Maslosoft\Mangan\Traits\ModelAwareTrait

Contact us