Maslosoft Mangan API

Name: Mangan
Brand: Maslosoft

Class Cursor

Cursor

Cursor object, that behaves much like the MongoCursor, but this one returns instantiated objects

Maslosoft\Mangan\Cursor implements Iterator, Countable

Namespace: Maslosoft\Mangan
Author: Ianaré Sévi
Author: Dariusz Górecki darek.krk@gmail.com
Author: Invenzzia Group, open-source division of CleverIT company http://www.invenzzia.org
Copyright: 2011 CleverIT http://www.cleverit.com.pl
Since: v1.3.4
Located at Cursor.php

Methods summary

`public`	# `__construct( Iterator $cursor, Maslosoft\Addendum\Interfaces\AnnotatedInterface $model )` Construct a new Cursor Construct a new Cursor Parameters `$cursor` the cursor returned by the query `$model` the model for instantiating objects Since v1.3.4
`public Maslosoft\Mangan\Interfaces\Adapters\FinderCursorInterface\|MongoCursor`	# `getCursor( )` Return MongoCursor for additional tuning Return MongoCursor for additional tuning Returns `Maslosoft\Mangan\Interfaces\Adapters\FinderCursorInterface`\|MongoCursor the cursor used for this query Since v1.3.4
`public Maslosoft\Addendum\Interfaces\AnnotatedInterface\|Maslosoft\Mangan\Document\|null`	# `current( )` Return the current element Return the current element Returns Maslosoft\Addendum\Interfaces\AnnotatedInterface\|`Maslosoft\Mangan\Document`\|null Since v1.3.4 Implementation of `Iterator::current()`
`public scalar`	# `key( )` Return the key of the current element Return the key of the current element Returns scalar Since v1.3.4 Implementation of `Iterator::key()`
`public`	# `next( )` Move forward to next element Move forward to next element Since v1.3.4 Implementation of `Iterator::next()`
`public`	# `rewind( )` Rewind the Iterator to the first element Rewind the Iterator to the first element Since v1.3.4 Implementation of `Iterator::rewind()`
`public boolean`	# `valid( )` Checks if current position is valid Checks if current position is valid Returns boolean Since v1.3.4 Implementation of `Iterator::valid()`
`public integer`	# `count( boolean $foundOnly = false )` Returns the number of documents found http://www.php.net/manual/en/mongocursor.count.php Returns the number of documents found http://www.php.net/manual/en/mongocursor.count.php Parameters `$foundOnly` default FALSE Returns integer count of documents found Since v1.3.4 Implementation of `Countable::count()`
`public`	# `limit( integer $limit )` Apply a limit to this cursor http://www.php.net/manual/en/mongocursor.limit.php Apply a limit to this cursor http://www.php.net/manual/en/mongocursor.limit.php Parameters `$limit` new limit Since v1.3.4
`public`	# `offset( integer $offset )` Skip a $offset records http://www.php.net/manual/en/mongocursor.skip.php Skip a $offset records http://www.php.net/manual/en/mongocursor.skip.php Parameters `$offset` new skip Since v1.3.4
`public`	# `sort( array $fields )` Apply sorting directives http://www.php.net/manual/en/mongocursor.sort.php Apply sorting directives http://www.php.net/manual/en/mongocursor.sort.php Parameters `$fields` sorting directives Since v1.3.4

API documentation generated by ApiGen

Maslosoft Mangan API

Namespaces

Classes

Class Cursor

Methods summary

Parameters

Since

Returns

Since

Returns

Since

Implementation of

Returns

Since

Implementation of

Since

Implementation of

Since

Implementation of

Returns

Since

Implementation of

Parameters

Returns

Since

Implementation of

Parameters

Since

Parameters

Since

Parameters

Since

Contact us