Documentation

Cursor
in package
implements Iterator

Interfaces, Classes, Traits and Enums

Iterator

Table of Contents

$collection  : Collection
$data  : array<string|int, mixed>
$pipeline  : array<string|int, mixed>
$position  : bool|int
__construct()  : mixed
current()  : array<string|int, mixed>
key()  : int
next()  : void
rewind()  : void
Iterator implementation
toArray()  : array<string|int, mixed>
Get documents matching criteria
valid()  : bool
getData()  : array<string|int, mixed>
Get documents matching criteria
make_cmp()  : Closure

Properties

$data

protected array<string|int, mixed> $data = []

$pipeline

protected array<string|int, mixed> $pipeline

$position

protected bool|int $position = false

Methods

__construct()

public __construct(Collection $collection, array<string|int, mixed> $pipeline) : mixed
Parameters
$collection : Collection
$pipeline : array<string|int, mixed>
Return values
mixed

current()

public current() : array<string|int, mixed>
Return values
array<string|int, mixed>

key()

public key() : int
Return values
int

next()

public next() : void
Return values
void

rewind()

Iterator implementation

public rewind() : void
Return values
void

toArray()

Get documents matching criteria

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

valid()

public valid() : bool
Return values
bool

getData()

Get documents matching criteria

protected getData() : array<string|int, mixed>
Return values
array<string|int, mixed>

make_cmp()

protected make_cmp(array<string|int, mixed> $sortValues) : Closure
Parameters
$sortValues : array<string|int, mixed>
Return values
Closure

Search results