PHP Class yii\mongodb\file\Cursor

Since: 2.1

Author: Paul Klimov ([email protected])

Inheritance: extends IteratorIterator, implements Countable

Public Properties

Property	Type	Description
$collection		related GridFS collection instance.

Method	Description
__call ( string $name, array $arguments ) : mixed	PHP magic method, which is invoked on attempt of invocation not existing method.
__construct ( Collection $collection, MongoDB\Driver\Cursor $cursor )	Constructor.
__get ( string $name ) : mixed	PHP magic method, which is invoked on attempt of getting not existing property.
__isset ( string $name ) : boolean	PHP magic method, which is invoked on attempt of checking if a property is set.
__set ( string $name, mixed $value )	PHP magic method, which is invoked on attempt of setting not existing property.
__unset ( string $name )	PHP magic method, which is invoked on attempt of unsetting of property.
count ( ) : integer	Count elements of this cursor.
current ( ) : mixed	Return the current element This method is required by the interface [[\Iterator]].
getId ( ) : MongoDB\Driver\CursorId	Returns the ID for this cursor.
setTypeMap ( array $typemap )	Sets a type map to use for BSON unserialization.
toArray ( ) : array	Returns an array containing all results for this cursor

It redirects method call to inner iterator.

public __call ( string $name, array $arguments ) : mixed
$name	string	method name.
$arguments	array	method arguments
return	mixed	method result.

Constructor.

public __construct ( Collection $collection, MongoDB\Driver\Cursor $cursor )
$collection	Collection
$cursor	MongoDB\Driver\Cursor

It returns value from the inner iterator.

PHP magic method, which is invoked on attempt of checking if a property is set.

public __isset ( string $name ) : boolean
$name	string	field name.
return	boolean	whether field exists or not.

It passes value to the inner iterator.

public __set ( string $name, mixed $value )
$name	string	field name.
$value	mixed	field value.

PHP magic method, which is invoked on attempt of unsetting of property.

public __unset ( string $name )
$name	string	field name.

This method is required by the interface [[\Countable]].

public count ( ) : integer
return	integer	elements count.

Return the current element This method is required by the interface [[\Iterator]].

public current ( ) : mixed
return	mixed	current row

Returns the ID for this cursor.

public getId ( ) : MongoDB\Driver\CursorId
return	MongoDB\Driver\CursorId	cursor ID.

Sets a type map to use for BSON unserialization.

public setTypeMap ( array $typemap )
$typemap	array	type map.

Returns an array containing all results for this cursor

public toArray ( ) : array
return	array	containing all results for this cursor.

related GridFS collection instance.

public $collection