Documentation

Cursor
in package
implements Iterator

Cursor object.

Interfaces, Classes, Traits and Enums

Iterator

Table of Contents

$collection  : Collection
$criteria  : string|null
$data  : array<string|int, mixed>
$limit  : int|null
$position  : bool|int
$projection  : array<string|int, mixed>|null
$skip  : int|null
$sort  : array<string|int, mixed>|null
__construct()  : mixed
Constructor
count()  : int
Documents count
current()  : array<string|int, mixed>
each()  : object
Loop through result set
key()  : int
limit()  : object
Set limit
next()  : void
rewind()  : void
Iterator implementation
skip()  : object
Set skip
sort()  : object
Set sort
toArray()  : array<string|int, mixed>
Get documents matching criteria
valid()  : bool
getData()  : array<string|int, mixed>
Get documents matching criteria

Properties

$criteria

protected string|null $criteria

$data

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

$limit

protected int|null $limit = null

$position

protected bool|int $position = false

$projection

protected array<string|int, mixed>|null $projection

$skip

protected int|null $skip = null

$sort

protected array<string|int, mixed>|null $sort = null

Methods

__construct()

Constructor

public __construct(object $collection, mixed $criteria[, array<string|int, mixed>|null $projection = null ]) : mixed
Parameters
$collection : object
$criteria : mixed
$projection : array<string|int, mixed>|null = null
Return values
mixed —

count()

Documents count

public count() : int
Return values
int —

current()

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

each()

Loop through result set

public each(mixed $callable) : object
Parameters
$callable : mixed
Return values
object —

key()

public key() : int
Return values
int —

limit()

Set limit

public limit(int $limit) : object
Parameters
$limit : int
Return values
object —

Cursor

next()

public next() : void
Return values
void —

rewind()

Iterator implementation

public rewind() : void
Return values
void —

skip()

Set skip

public skip(int $skip) : object
Parameters
$skip : int
Return values
object —

Cursor

sort()

Set sort

public sort(mixed $sorts) : object
Parameters
$sorts : mixed
Return values
object —

Cursor

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> —

Search results