PHP Класс MongoCursor

Наследование: implements Iterator
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$slaveOkay boolean
$timeout integer

Защищенные свойства (Protected)

Свойство Тип Описание
$allowPartialResults
$awaitData
$flags
$hint
$limit
$maxTimeMS
$noCursorTimeout
$optionNames array
$options
$projection array
$query array
$skip
$snapshot
$sort
$tailable

Открытые методы

Метод Описание
__construct ( MongoClient $connection, string $ns, array $query = [], array $fields = [] ) Create a new cursor
__sleep ( ) : array
addOption ( string $key, mixed $value ) : MongoCursor Adds a top-level key/value pair to a query
awaitData ( boolean $wait = true ) : MongoCursor (PECL mongo >= 1.2.11)
Sets whether this cursor will wait for a while for a tailable cursor to return more data
count ( boolean $foundOnly = false ) : integer Counts the number of results for this query
explain ( ) : array Return an explanation of the query, often useful for optimization and debugging
fields ( array $f ) : MongoCursor Sets the fields for a query
getNext ( ) : array Advances the cursor to the next result, and returns that result
hasNext ( ) : boolean Checks if there are any more elements in this cursor
hint ( array | string $keyPattern ) : MongoCursor Gives the database a hint about the query
immortal ( boolean $liveForever = true ) : MongoCursor Sets whether this cursor will timeout
limit ( integer $num ) : MongoCursor Limits the number of results returned
maxTimeMS ( integer $ms )
partial ( boolean $okay = true ) : MongoCursor
reset ( ) : void Clears the cursor
setFlag ( integer $flag, boolean $set = true ) : MongoCursor
skip ( integer $num ) : MongoCursor Skips a number of results
slaveOkay ( boolean $okay = true ) : MongoCursor Sets whether this query can be done on a slave This method will override the static class variable slaveOkay.
snapshot ( ) : MongoCursor Use snapshot mode for the query
sort ( array $fields ) : MongoCursor Sorts the results by given fields
tailable ( boolean $tail = true ) : MongoCursor Sets whether this cursor will be left open after fetching the last results

Защищенные методы

Метод Описание
convertCursorType ( ) : integer | null
convertModifiers ( ) : array
convertProjection ( ) : array
doQuery ( ) : void Execute the query
ensureCursor ( ) : MongoDB\Driver\Cursor
getCursorInfo ( ) : array
wrapTraversable ( Traversable $traversable ) : Generator

Описание методов

__construct() публичный Метод

Create a new cursor
См. ссылку: http://www.php.net/manual/en/mongocursor.construct.php
public __construct ( MongoClient $connection, string $ns, array $query = [], array $fields = [] )
$connection MongoClient Database connection.
$ns string Full name of database and collection.
$query array Database query.
$fields array Fields to return.

__sleep() публичный Метод

public __sleep ( ) : array
Результат array

addOption() публичный Метод

Adds a top-level key/value pair to a query
См. ссылку: http://www.php.net/manual/en/mongocursor.addoption.php
public addOption ( string $key, mixed $value ) : MongoCursor
$key string Fieldname to add.
$value mixed Value to add.
Результат MongoCursor Returns this cursor

awaitData() публичный Метод

(PECL mongo >= 1.2.11)
Sets whether this cursor will wait for a while for a tailable cursor to return more data
public awaitData ( boolean $wait = true ) : MongoCursor
$wait boolean [optional]

If the cursor should wait for more data to become available.
Результат MongoCursor Returns this cursor.

convertCursorType() защищенный Метод

protected convertCursorType ( ) : integer | null
Результат integer | null

convertModifiers() защищенный Метод

protected convertModifiers ( ) : array
Результат array

convertProjection() защищенный Метод

protected convertProjection ( ) : array
Результат array

count() публичный Метод

Counts the number of results for this query
См. ссылку: http://www.php.net/manual/en/mongocursor.count.php
public count ( boolean $foundOnly = false ) : integer
$foundOnly boolean Send cursor limit and skip information to the count function, if applicable.
Результат integer The number of documents returned by this cursor's query.

doQuery() защищенный Метод

Execute the query
См. ссылку: http://www.php.net/manual/en/mongocursor.doquery.php
protected doQuery ( ) : void
Результат void

ensureCursor() защищенный Метод

protected ensureCursor ( ) : MongoDB\Driver\Cursor
Результат MongoDB\Driver\Cursor

explain() публичный Метод

Return an explanation of the query, often useful for optimization and debugging
См. ссылку: http://www.php.net/manual/en/mongocursor.explain.php
public explain ( ) : array
Результат array Returns an explanation of the query.

fields() публичный Метод

Sets the fields for a query
См. ссылку: http://www.php.net/manual/en/mongocursor.fields.php
public fields ( array $f ) : MongoCursor
$f array Fields to return (or not return).
Результат MongoCursor

getCursorInfo() защищенный Метод

protected getCursorInfo ( ) : array
Результат array

getNext() публичный Метод

Advances the cursor to the next result, and returns that result
См. ссылку: http://www.php.net/manual/en/mongocursor.getnext.php
public getNext ( ) : array
Результат array Returns the next object

hasNext() публичный Метод

Checks if there are any more elements in this cursor
См. ссылку: http://www.php.net/manual/en/mongocursor.hasnext.php
public hasNext ( ) : boolean
Результат boolean Returns true if there is another element

hint() публичный Метод

Gives the database a hint about the query
См. ссылку: http://www.php.net/manual/en/mongocursor.hint.php
public hint ( array | string $keyPattern ) : MongoCursor
$keyPattern array | string Indexes to use for the query.
Результат MongoCursor Returns this cursor

immortal() публичный Метод

Sets whether this cursor will timeout
См. ссылку: http://www.php.net/manual/en/mongocursor.immortal.php
public immortal ( boolean $liveForever = true ) : MongoCursor
$liveForever boolean If the cursor should be immortal.
Результат MongoCursor Returns this cursor

limit() публичный Метод

Limits the number of results returned
См. ссылку: http://www.php.net/manual/en/mongocursor.limit.php
public limit ( integer $num ) : MongoCursor
$num integer The number of results to return.
Результат MongoCursor Returns this cursor

maxTimeMS() публичный Метод

public maxTimeMS ( integer $ms )
$ms integer

partial() публичный Метод

См. ссылку: http://www.php.net/manual/en/mongocursor.partial.php
public partial ( boolean $okay = true ) : MongoCursor
$okay boolean [optional]

If receiving partial results is okay.
Результат MongoCursor Returns this cursor.

reset() публичный Метод

Clears the cursor
См. ссылку: http://www.php.net/manual/en/mongocursor.reset.php
public reset ( ) : void
Результат void

setFlag() публичный Метод

См. ссылку: http://www.php.net/manual/en/mongocursor.setflag.php
public setFlag ( integer $flag, boolean $set = true ) : MongoCursor
$flag integer
$set boolean
Результат MongoCursor

skip() публичный Метод

Skips a number of results
См. ссылку: http://www.php.net/manual/en/mongocursor.skip.php
public skip ( integer $num ) : MongoCursor
$num integer The number of results to skip.
Результат MongoCursor Returns this cursor

slaveOkay() публичный Метод

Sets whether this query can be done on a slave This method will override the static class variable slaveOkay.
См. ссылку: http://www.php.net/manual/en/mongocursor.slaveOkay.php
public slaveOkay ( boolean $okay = true ) : MongoCursor
$okay boolean If it is okay to query the slave.
Результат MongoCursor Returns this cursor

snapshot() публичный Метод

Use snapshot mode for the query
См. ссылку: http://www.php.net/manual/en/mongocursor.snapshot.php
public snapshot ( ) : MongoCursor
Результат MongoCursor Returns this cursor

sort() публичный Метод

Sorts the results by given fields
См. ссылку: http://www.php.net/manual/en/mongocursor.sort.php
public sort ( array $fields ) : MongoCursor
$fields array An array of fields by which to sort. Each element in the array has as key the field name, and as value either 1 for ascending sort, or -1 for descending sort
Результат MongoCursor Returns the same cursor that this method was called on

tailable() публичный Метод

Sets whether this cursor will be left open after fetching the last results
См. ссылку: http://www.php.net/manual/en/mongocursor.tailable.php
public tailable ( boolean $tail = true ) : MongoCursor
$tail boolean If the cursor should be tailable.
Результат MongoCursor Returns this cursor

wrapTraversable() защищенный Метод

protected wrapTraversable ( Traversable $traversable ) : Generator
$traversable Traversable
Результат Generator

Описание свойств

$allowPartialResults защищенное свойство

protected $allowPartialResults

$awaitData защищенное свойство

protected $awaitData

$flags защищенное свойство

protected $flags

$hint защищенное свойство

protected $hint

$limit защищенное свойство

protected $limit

$maxTimeMS защищенное свойство

protected $maxTimeMS

$noCursorTimeout защищенное свойство

protected $noCursorTimeout

$optionNames защищенное свойство

protected array $optionNames
Результат array

$options защищенное свойство

protected $options

$projection защищенное свойство

protected array $projection
Результат array

$query защищенное свойство

protected array $query
Результат array

$skip защищенное свойство

protected $skip

$slaveOkay публичное статическое свойство

public static bool $slaveOkay
Результат boolean

$snapshot защищенное свойство

protected $snapshot

$sort защищенное свойство

protected $sort

$tailable защищенное свойство

protected $tailable

$timeout публичное статическое свойство

public static int $timeout
Результат integer