result_interface
interface result_interface implements Countable, IteratorAggregate
Interface for immutable result container returned by the Query Engine.
Methods
No description
Returns total number of items matching the query, ignoring pagination.
Indicates whether the items are stdClass objects instead of Domain objects.
Indicates whether the result is paginated.
Returns current page number.
Returns number of items per page.
Returns total number of pages.
Returns the first item or null.
Returns the last item or null.
Returns true when no items were returned.
Returns true when at least one item exists.
Convert to array for JSON or external APIs.
Details
at line 35
array
items()
No description
at line 42
int
total()
Returns total number of items matching the query, ignoring pagination.
at line 49
bool
is_std_class()
Indicates whether the items are stdClass objects instead of Domain objects.
at line 56
bool
is_paginated()
Indicates whether the result is paginated.
at line 63
int|null
page()
Returns current page number.
at line 70
int|null
perpage()
Returns number of items per page.
at line 78
int
pages()
Returns total number of pages.
When pagination is disabled, always returns 1.
at line 85
mixed
first()
Returns the first item or null.
at line 92
mixed
last()
Returns the last item or null.
at line 99
bool
is_empty()
Returns true when no items were returned.
at line 106
bool
is_not_empty()
Returns true when at least one item exists.
at line 114
array
to_array()
Convert to array for JSON or external APIs.
Directly returns internal resolved dataset.