PHP Class Doctrine\ODM\MongoDB\CommandCursor

Since: 1.1
Author: alcaeus ([email protected])
Inheritance: implements Doctrine\MongoDB\Iterator
Afficher le fichier Open project: doctrine/mongodb-odm

Méthodes publiques

Méthode Description
__construct ( Doctrine\MongoDB\CommandCursor $commandCursor, UnitOfWork $unitOfWork, ClassMetadata $class = null )
batchSize ( integer $num ) : self Wrapper method for MongoCommandCursor::batchSize().
count ( ) : integer Recreates the command cursor and counts its results.
current ( ) : object | array | null Wrapper method for MongoCommandCursor::current().
dead ( ) : boolean Wrapper method for MongoCommandCursor::dead().
getBaseCursor ( ) : Doctrine\MongoDB\CommandCursor Returns the MongoCommandCursor instance being wrapped.
getSingleResult ( ) : object | array | null Rewinds the cursor and returns its first result.
info ( ) : array Wrapper method for MongoCommandCursor::info().
key ( ) : integer Wrapper method for MongoCommandCursor::key().
next ( ) Wrapper method for MongoCommandCursor::next().
rewind ( ) : array Wrapper method for MongoCommandCursor::rewind().
timeout ( integer $ms ) : self Wrapper method for MongoCommandCursor::timeout().
toArray ( ) : array Return the cursor's results as an array.
valid ( ) : boolean Wrapper method for MongoCommandCursor::valid().

Private Methods

Méthode Description
hydrateDocument ( array $document ) : array | object | null

Method Details

__construct() public méthode

public __construct ( Doctrine\MongoDB\CommandCursor $commandCursor, UnitOfWork $unitOfWork, ClassMetadata $class = null )
$commandCursor Doctrine\MongoDB\CommandCursor The ComamndCursor instance being wrapped
$unitOfWork UnitOfWork
$class Doctrine\ODM\MongoDB\Mapping\ClassMetadata The class to use for hydration or null if results should not be hydrated

batchSize() public méthode

Wrapper method for MongoCommandCursor::batchSize().
See also: http://php.net/manual/en/mongocommandcursor.batchsize.php
public batchSize ( integer $num ) : self
$num integer
Résultat self

count() public méthode

Recreates the command cursor and counts its results.
See also: http://php.net/manual/en/countable.count.php
public count ( ) : integer
Résultat integer

current() public méthode

Wrapper method for MongoCommandCursor::current().
See also: http://php.net/manual/en/iterator.current.php
See also: http://php.net/manual/en/mongocommandcursor.current.php
public current ( ) : object | array | null
Résultat object | array | null

dead() public méthode

Wrapper method for MongoCommandCursor::dead().
See also: http://php.net/manual/en/mongocommandcursor.dead.php
public dead ( ) : boolean
Résultat boolean

getBaseCursor() public méthode

Returns the MongoCommandCursor instance being wrapped.
public getBaseCursor ( ) : Doctrine\MongoDB\CommandCursor
Résultat Doctrine\MongoDB\CommandCursor

getSingleResult() public méthode

Rewinds the cursor and returns its first result.
See also: Iterator::getSingleResult()
public getSingleResult ( ) : object | array | null
Résultat object | array | null

info() public méthode

Wrapper method for MongoCommandCursor::info().
See also: http://php.net/manual/en/mongocommandcursor.info.php
public info ( ) : array
Résultat array

key() public méthode

Wrapper method for MongoCommandCursor::key().
See also: http://php.net/manual/en/iterator.key.php
See also: http://php.net/manual/en/mongocommandcursor.key.php
public key ( ) : integer
Résultat integer

next() public méthode

Wrapper method for MongoCommandCursor::next().
See also: http://php.net/manual/en/iterator.next.php
See also: http://php.net/manual/en/mongocommandcursor.next.php
public next ( )

rewind() public méthode

Wrapper method for MongoCommandCursor::rewind().
See also: http://php.net/manual/en/iterator.rewind.php
See also: http://php.net/manual/en/mongocommandcursor.rewind.php
public rewind ( ) : array
Résultat array

timeout() public méthode

Wrapper method for MongoCommandCursor::timeout().
See also: http://php.net/manual/en/mongocommandcursor.timeout.php
public timeout ( integer $ms ) : self
$ms integer
Résultat self

toArray() public méthode

Return the cursor's results as an array.
See also: Iterator::toArray()
public toArray ( ) : array
Résultat array

valid() public méthode

Wrapper method for MongoCommandCursor::valid().
See also: http://php.net/manual/en/iterator.valid.php
See also: http://php.net/manual/en/mongocommandcursor.valid.php
public valid ( ) : boolean
Résultat boolean