1. class
  2. Doctrine
  3. \
  4. MongoDB
  5. \
  6. EagerCursor

EagerCursor

class EagerCursor implements CursorInterface (View source)

EagerCursor wraps a Cursor instance and fetches all of its results upon initialization.

Properties

protected CursorInterface $cursor The Cursor instance being wrapped.
protected array $data The Cursor results.
protected boolean $initialized Whether the internal data has been initialized.

Methods

__construct(CursorInterface $cursor)

Constructor.

count()

No description

current()

No description

CursorInterface
getCursor()

Return the wrapped Cursor.

array|object|null
getSingleResult()

No description

initialize()

Initialize the internal data by converting the Cursor to an array.

boolean
isInitialized()

Return whether the internal data has been initialized.

key()

No description

next()

No description

rewind()

No description

array
toArray()

No description

valid()

No description

$this
addOption(string $key, mixed $value)

Wrapper method for MongoCursor::addOption().

$this
batchSize(integer $num)

Wrapper method for MongoCursor::batchSize().

boolean
dead()

Wrapper method for MongoCursor::dead().

array
explain()

Wrapper method for MongoCursor::explain().

$this
fields(array $f)

Wrapper method for MongoCursor::fields().

Collection
getCollection()

Return the collection for this cursor.

array
getFields()

Return the selected fields (projection).

array|null
getNext()

Wrapper method for MongoCursor::getNext().

array
getQuery()

Return the query criteria.

array
getReadPreference()

Wrapper method for MongoCursor::getReadPreference().

$this
setReadPreference(string $readPreference, array $tags = null)

Set the read preference.

boolean
getUseIdentifierKeys()

Return whether the document's "_id" value is used as its iteration key.

$this
setUseIdentifierKeys(boolean $useIdentifierKeys)

Set whether to use the document's "_id" value as its iteration key.

boolean
hasNext()

Wrapper method for MongoCursor::hasNext().

$this
hint(array|string $keyPattern)

Wrapper method for MongoCursor::hint().

$this
immortal(boolean $liveForever = true)

Wrapper method for MongoCursor::immortal().

array
info()

Wrapper method for MongoCursor::info().

$this
limit(integer $num)

Wrapper method for MongoCursor::limit().

maxTimeMS($ms)

{@inheritdoc}

recreate()

Recreates the internal MongoCursor.

reset()

Wrapper method for MongoCursor::reset().

$this
skip(integer $num)

Wrapper method for MongoCursor::skip().

$this
slaveOkay(boolean $ok = true)

Wrapper method for MongoCursor::slaveOkay().

$this
snapshot()

Wrapper method for MongoCursor::snapshot().

$this
sort(array $fields)

Wrapper method for MongoCursor::sort().

$this
tailable(boolean $tail = true)

Wrapper method for MongoCursor::tailable().

$this
timeout(integer $ms)

Wrapper method for MongoCursor::timeout().

Details

at line 49
__construct(CursorInterface $cursor)

Constructor.

Parameters

CursorInterface $cursor

at line 57
count()

See also

http://php.net/manual/en/countable.count.php

at line 67
current()

See also

http://php.net/manual/en/iterator.current.php

at line 79
CursorInterface getCursor()

Return the wrapped Cursor.

Return Value

CursorInterface

at line 87
array|object|null getSingleResult()

Return Value

array|object|null

See also

Iterator::getSingleResult

at line 101
initialize()

Initialize the internal data by converting the Cursor to an array.

at line 114
boolean isInitialized()

Return whether the internal data has been initialized.

Return Value

boolean

at line 122
key()

See also

http://php.net/manual/en/iterator.key.php

at line 133
next()

See also

http://php.net/manual/en/iterator.next.php

at line 143
rewind()

See also

http://php.net/manual/en/iterator.rewind.php

at line 153
array toArray()

Return Value

array

See also

Iterator::toArray

at line 163
valid()

See also

http://php.net/manual/en/iterator.valid.php

at line 174
$this addOption(string $key, mixed $value)

Wrapper method for MongoCursor::addOption().

Parameters

string $key
mixed $value

Return Value

$this

at line 184
$this batchSize(integer $num)

Wrapper method for MongoCursor::batchSize().

Parameters

integer $num

Return Value

$this

at line 194
boolean dead()

Wrapper method for MongoCursor::dead().

Return Value

boolean

at line 202
array explain()

Wrapper method for MongoCursor::explain().

Return Value

array

at line 210
$this fields(array $f)

Wrapper method for MongoCursor::fields().

Parameters

array $f Fields to return (or not return).

Return Value

$this

at line 220
Collection getCollection()

Return the collection for this cursor.

Return Value

Collection

at line 228
array getFields()

Return the selected fields (projection).

Return Value

array

at line 236
array|null getNext()

Wrapper method for MongoCursor::getNext().

Return Value

array|null

at line 249
array getQuery()

Return the query criteria.

Return Value

array

at line 257
array getReadPreference()

Wrapper method for MongoCursor::getReadPreference().

Return Value

array

at line 265
$this setReadPreference(string $readPreference, array $tags = null)

Set the read preference.

Parameters

string $readPreference
array $tags

Return Value

$this

at line 275
boolean getUseIdentifierKeys()

Return whether the document's "_id" value is used as its iteration key.

Return Value

boolean

at line 283
$this setUseIdentifierKeys(boolean $useIdentifierKeys)

Set whether to use the document's "_id" value as its iteration key.

Parameters

boolean $useIdentifierKeys

Return Value

$this

at line 293
boolean hasNext()

Wrapper method for MongoCursor::hasNext().

Return Value

boolean

at line 313
$this hint(array|string $keyPattern)

Wrapper method for MongoCursor::hint().

Parameters

array|string $keyPattern

Return Value

$this

at line 323
$this immortal(boolean $liveForever = true)

Wrapper method for MongoCursor::immortal().

Parameters

boolean $liveForever

Return Value

$this

at line 333
array info()

Wrapper method for MongoCursor::info().

Return Value

array

at line 341
$this limit(integer $num)

Wrapper method for MongoCursor::limit().

Parameters

integer $num

Return Value

$this

at line 351
maxTimeMS($ms)

{@inheritdoc}

Parameters

$ms

at line 365
recreate()

Recreates the internal MongoCursor.

at line 376
reset()

Wrapper method for MongoCursor::reset().

at line 384
$this skip(integer $num)

Wrapper method for MongoCursor::skip().

Parameters

integer $num

Return Value

$this

at line 394
$this slaveOkay(boolean $ok = true)

Wrapper method for MongoCursor::slaveOkay().

Parameters

boolean $ok

Return Value

$this

at line 404
$this snapshot()

Wrapper method for MongoCursor::snapshot().

Return Value

$this

at line 414
$this sort(array $fields)

Wrapper method for MongoCursor::sort().

Parameters

array $fields

Return Value

$this

at line 424
$this tailable(boolean $tail = true)

Wrapper method for MongoCursor::tailable().

Parameters

boolean $tail

Return Value

$this

at line 434
$this timeout(integer $ms)

Wrapper method for MongoCursor::timeout().

Parameters

integer $ms

Return Value

$this