ResultSet
class ResultSet extends ResultSet
ORM result set.
Traits
Properties
| static protected array | $_extensions | Class extensions. | from ExtendableTrait |
| protected array | $items | Collection items. | from Collection |
| protected PaginationInterface | $pagination | Pagination. | from ResultSet |
Methods
Executes class extensions.
Returns an item from the collection.
Prepends the passed item to the front of the collection and returns the new number of elements in the collection.
Shifts the first value of the collection off and returns it, shortening the collection by one element.
Pushes the passed variable onto the end of the collection and returns the new number of elements in the collection.
Pops and returns the last value of the collection, shortening the collection by one element.
Sorts the collection using the specified comparator callable and returns TRUE on success and FALSE on failure.
Chunks the collection into a collection containing $size sized collections.
Shuffles the items in the collection and returns TRUE on success and FALSE on failure.
Returns a new collection where the callable has been applied to all the items.
Returns an array containing only the values of chosen column.
Clones all items when cloning the collection.
Excludes the chosen columns and relations from array and json representations of the collection.
Exposes the chosen columns and relations in the array and json representations of the collection.
Details
in ExtendableTrait at line 35
static
extend(string $methodName, Closure $closure)
Extends the class.
in ExtendableTrait at line 47
mixed
__call(string $name, array $arguments)
Executes class extensions.
in ExtendableTrait at line 64
static mixed
__callStatic(string $name, array $arguments)
Executes class extensions.
in Collection at line 56
__construct(array $items = [])
Constructor.
in Collection at line 66
array
getItems()
Returns all the items in the collection.
in Collection at line 76
array
getValues()
Returns all the values in the collection.
in Collection at line 84
resetKeys()
Resets the collection keys.
in Collection at line 95
put(int|string $key, mixed $value)
Adds a new item to the collection.
in Collection at line 106
bool
has(int|string $key)
Returns TRUE if the item key exists and FALSE if not.
in Collection at line 118
mixed
get(int|string $key, mixed $default = null)
Returns an item from the collection.
in Collection at line 133
remove(int|string $key)
Removes an item from the collection.
in Collection at line 141
clear()
Clears the collection.
in Collection at line 152
bool
offsetExists(mixed $offset)
Checks whether or not an offset exists.
in Collection at line 163
mixed
offsetGet(mixed $offset)
Returns the value at the specified offset.
in Collection at line 179
offsetSet(mixed $offset, mixed $value)
Assigns a value to the specified offset.
in Collection at line 196
offsetUnset(mixed $offset)
Unsets an offset.
in Collection at line 206
int
count()
Returns the numner of items in the collection.
in Collection at line 216
ArrayIterator
getIterator()
Retruns an array iterator object.
in Collection at line 226
bool
isEmpty()
Returns TRUE if the collection is empty and FALSE if not.
in Collection at line 238
int
unshift(mixed $item)
Prepends the passed item to the front of the collection and returns the new number of elements in the collection.
in Collection at line 249
mixed
shift()
Shifts the first value of the collection off and returns it, shortening the collection by one element.
in Collection at line 261
int
push(mixed $item)
Pushes the passed variable onto the end of the collection and returns the new number of elements in the collection.
in Collection at line 272
mixed
pop()
Pops and returns the last value of the collection, shortening the collection by one element.
in Collection at line 285
bool
sort(callable $comparator, bool $maintainIndexAssociation = true)
Sorts the collection using the specified comparator callable and returns TRUE on success and FALSE on failure.
in Collection at line 296
Collection
chunk(int $size)
Chunks the collection into a collection containing $size sized collections.
in Collection at line 314
bool
shuffle()
Shuffles the items in the collection and returns TRUE on success and FALSE on failure.
in Collection at line 324
each(callable $callable)
Applies the callable on all items in the collection.
in Collection at line 339
Collection
map(callable $callable)
Returns a new collection where the callable has been applied to all the items.
in Collection at line 354
Collection
filter(callable $callable = null)
Returns a new filtered collection.
in Collection at line 370
Collection
merge(Collection $collection)
Merges two collections.
in ResultSet at line 36
setPagination(PaginationInterface $pagination)
Sets the pagination.
in ResultSet at line 46
PaginationInterface
getPagination()
Returns the pagination.
in ResultSet at line 57
array
pluck(string $column)
Returns an array containing only the values of chosen column.
in ResultSet at line 67
array
toArray()
Returns an array representation of the result set.
in ResultSet at line 84
array
jsonSerialize()
Returns data which can be serialized by json_encode().
in ResultSet at line 100
string
toJson(int $options = 0)
Returns a json representation of the result set.
in ResultSet at line 110
string
__toString()
Returns a json representation of the result set.
at line 22
__clone()
Clones all items when cloning the collection.
at line 35
protect(string|array|bool $column)
Excludes the chosen columns and relations from array and json representations of the collection.
at line 48
expose(string|array|bool $column)
Exposes the chosen columns and relations in the array and json representations of the collection.
at line 62
ResultSet
include(string|array $includes)
Eager loads relations on the collection.