interface result_interface implements Countable, IteratorAggregate

internal  
 

Interface for immutable result container returned by the Query Engine.

Methods

array
items()

No description

int
total()

Returns total number of items matching the query, ignoring pagination.

bool
is_std_class()

Indicates whether the items are stdClass objects instead of Domain objects.

bool
is_paginated()

Indicates whether the result is paginated.

int|null
page()

Returns current page number.

int|null
perpage()

Returns number of items per page.

int
pages()

Returns total number of pages.

mixed
first()

Returns the first item or null.

mixed
last()

Returns the last item or null.

bool
is_empty()

Returns true when no items were returned.

bool
is_not_empty()

Returns true when at least one item exists.

array
to_array()

Convert to array for JSON or external APIs.

Details

at line 37
array items()

No description

Return Value

array

at line 44
int total()

Returns total number of items matching the query, ignoring pagination.

Return Value

int

at line 51
bool is_std_class()

Indicates whether the items are stdClass objects instead of Domain objects.

Return Value

bool

at line 58
bool is_paginated()

Indicates whether the result is paginated.

Return Value

bool

at line 65
int|null page()

Returns current page number.

Return Value

int|null

at line 72
int|null perpage()

Returns number of items per page.

Return Value

int|null

at line 80
int pages()

Returns total number of pages.

When pagination is disabled, always returns 1.

Return Value

int

at line 87
mixed first()

Returns the first item or null.

Return Value

mixed

at line 94
mixed last()

Returns the last item or null.

Return Value

mixed

at line 101
bool is_empty()

Returns true when no items were returned.

Return Value

bool

at line 108
bool is_not_empty()

Returns true when at least one item exists.

Return Value

bool

at line 116
array to_array()

Convert to array for JSON or external APIs.

Directly returns internal resolved dataset.

Return Value

array