1. class
  2. mako
  3. \
  4. database
  5. \
  6. midgard
  7. \
  8. ResultSet

ResultSet

class ResultSet extends ResultSet

ORM result set.

Traits

ExtendableTrait
Extendable trait.

Properties

static protected array $_extensions Class extensions. from ExtendableTrait
protected array $items Collection items. from Collection
protected PaginationInterface $pagination Pagination. from ResultSet

Methods

static 
addMethod(string $methodName, Closure $closure)

Adds a method to the class.

from ExtendableTrait
mixed
__call(string $name, array $arguments)

Executes class extensions.

from ExtendableTrait
static mixed
__callStatic(string $name, array $arguments)

Executes class extensions.

from ExtendableTrait
__construct(array $items = [])

Constructor.

from Collection
array
getItems()

Returns all the items in the collection.

from Collection
array
getValues()

Returns all the values in the collection.

from Collection
$this
resetKeys()

Resets the collection keys.

from Collection
$this
put(int|string $key, mixed $value)

Adds a new item to the collection.

from Collection
bool
has(int|string $key)

Returns TRUE if the item key exists and FALSE if not.

from Collection
mixed
get(int|string $key, mixed $default = null)

Returns an item from the collection.

from Collection
$this
remove(int|string $key)

Removes an item from the collection.

from Collection
$this
clear()

Clears the collection.

from Collection
bool
offsetExists(mixed $offset)

Checks whether or not an offset exists.

from Collection
mixed
offsetGet(mixed $offset)

Returns the value at the specified offset.

from Collection
offsetSet(mixed $offset, mixed $value)

Assigns a value to the specified offset.

from Collection
offsetUnset(mixed $offset)

Unsets an offset.

from Collection
int
count()

Returns the numner of items in the collection.

from Collection
ArrayIterator
getIterator()

Retruns an array iterator object.

from Collection
bool
isEmpty()

Returns TRUE if the collection is empty and FALSE if not.

from Collection
int
unshift(mixed $item)

Prepends the passed item to the front of the collection and returns the new number of elements in the collection.

from Collection
mixed
shift()

Shifts the first value of the collection off and returns it, shortening the collection by one element.

from Collection
int
push(mixed $item)

Pushes the passed variable onto the end of the collection and returns the new number of elements in the collection.

from Collection
mixed
pop()

Pops and returns the last value of the collection, shortening the collection by one element.

from Collection
mixed
first()

Returns the first item of the collection or NULL if the collection is empty.

from Collection
mixed
last()

Returns the last item of the collection or NULL if the collection is empty.

from Collection
$this
sort(callable $comparator, bool $maintainIndexAssociation = true)

Sorts the collection using the specified comparator callable and returns TRUE on success and FALSE on failure.

from Collection
Collection
chunk(int $size)

Chunks the collection into a collection containing $size sized collections.

from Collection
$this
shuffle()

Shuffles the items in the collection and returns TRUE on success and FALSE on failure.

from Collection
$this
each(callable $callable)

Applies the callable on all items in the collection.

from Collection
Collection
map(callable $callable)

Returns a new collection where the callable has been applied to all the items.

from Collection
Collection
filter(callable|null $callable = null)

Returns a new filtered collection.

from Collection
Collection
with(array $keys)

Returns a new collection where all items not in the provided list have been removed.

from Collection
Collection
without(array $keys)

Returns a new collection where all items in the provided list have been removed.

from Collection
Collection
merge(Collection $collection)

Merges two collections.

from Collection
setPagination(PaginationInterface $pagination)

Sets the pagination.

from ResultSet
PaginationInterface
getPagination()

Returns the pagination.

from ResultSet
array
pluck(string $column)

Returns an array containing only the values of chosen column.

from ResultSet
array
toArray()

Returns an array representation of the result set.

from ResultSet
array
jsonSerialize()

Returns data which can be serialized by json_encode().

from ResultSet
string
toJson(int $options = 0)

Returns a json representation of the result set.

from ResultSet
string
__toString()

Returns a json representation of the result set.

from ResultSet
__clone()

Clones all items when cloning the collection.

protect(string|array|false $column)

Excludes the chosen columns and relations from array and json representations of the collection.

expose(string|array|true $column)

Exposes the chosen columns and relations in the array and json representations of the collection.

$this
include(string|array $includes)

Eager loads relations on the collection.

Details

in ExtendableTrait at line 35
static addMethod(string $methodName, Closure $closure)

Adds a method to the class.

Parameters

string $methodName Method name
Closure $closure Closure

in ExtendableTrait at line 47
mixed __call(string $name, array $arguments)

Executes class extensions.

Parameters

string $name Method name
array $arguments Method arguments

Return Value

mixed

in ExtendableTrait at line 64
static mixed __callStatic(string $name, array $arguments)

Executes class extensions.

Parameters

string $name Method name
array $arguments Method arguments

Return Value

mixed

in Collection at line 61
__construct(array $items = [])

Constructor.

Parameters

array $items Collection items

in Collection at line 71
array getItems()

Returns all the items in the collection.

Return Value

array

in Collection at line 81
array getValues()

Returns all the values in the collection.

Return Value

array

in Collection at line 91
$this resetKeys()

Resets the collection keys.

Return Value

$this

in Collection at line 105
$this put(int|string $key, mixed $value)

Adds a new item to the collection.

Parameters

int|string $key Key
mixed $value Value

Return Value

$this

in Collection at line 118
bool has(int|string $key)

Returns TRUE if the item key exists and FALSE if not.

Parameters

int|string $key Key

Return Value

bool

in Collection at line 130
mixed get(int|string $key, mixed $default = null)

Returns an item from the collection.

Parameters

int|string $key Key
mixed $default Default value

Return Value

mixed

in Collection at line 146
$this remove(int|string $key)

Removes an item from the collection.

Parameters

int|string $key Key

Return Value

$this

in Collection at line 158
$this clear()

Clears the collection.

Return Value

$this

in Collection at line 171
bool offsetExists(mixed $offset)

Checks whether or not an offset exists.

Parameters

mixed $offset The offset to check for

Return Value

bool

in Collection at line 182
mixed offsetGet(mixed $offset)

Returns the value at the specified offset.

Parameters

mixed $offset The offset to retrieve

Return Value

mixed

in Collection at line 198
offsetSet(mixed $offset, mixed $value)

Assigns a value to the specified offset.

Parameters

mixed $offset The offset to assign the value to
mixed $value The value to set

in Collection at line 215
offsetUnset(mixed $offset)

Unsets an offset.

Parameters

mixed $offset The offset to unset

in Collection at line 225
int count()

Returns the numner of items in the collection.

Return Value

int

in Collection at line 235
ArrayIterator getIterator()

Retruns an array iterator object.

Return Value

ArrayIterator

in Collection at line 245
bool isEmpty()

Returns TRUE if the collection is empty and FALSE if not.

Return Value

bool

in Collection at line 257
int unshift(mixed $item)

Prepends the passed item to the front of the collection and returns the new number of elements in the collection.

Parameters

mixed $item Collection item

Return Value

int

in Collection at line 268
mixed shift()

Shifts the first value of the collection off and returns it, shortening the collection by one element.

Return Value

mixed

in Collection at line 280
int push(mixed $item)

Pushes the passed variable onto the end of the collection and returns the new number of elements in the collection.

Parameters

mixed $item Collection item

Return Value

int

in Collection at line 291
mixed pop()

Pops and returns the last value of the collection, shortening the collection by one element.

Return Value

mixed

in Collection at line 301
mixed first()

Returns the first item of the collection or NULL if the collection is empty.

Return Value

mixed

in Collection at line 318
mixed last()

Returns the last item of the collection or NULL if the collection is empty.

Return Value

mixed

in Collection at line 338
$this sort(callable $comparator, bool $maintainIndexAssociation = true)

Sorts the collection using the specified comparator callable and returns TRUE on success and FALSE on failure.

Parameters

callable $comparator Comparator callable
bool $maintainIndexAssociation Maintain index association?

Return Value

$this

in Collection at line 358
Collection chunk(int $size)

Chunks the collection into a collection containing $size sized collections.

Parameters

int $size Chunk size

Return Value

Collection

in Collection at line 376
$this shuffle()

Shuffles the items in the collection and returns TRUE on success and FALSE on failure.

Return Value

$this

in Collection at line 389
$this each(callable $callable)

Applies the callable on all items in the collection.

Parameters

callable $callable Callable

Return Value

$this

in Collection at line 406
Collection map(callable $callable)

Returns a new collection where the callable has been applied to all the items.

Parameters

callable $callable Callable

Return Value

Collection

in Collection at line 421
Collection filter(callable|null $callable = null)

Returns a new filtered collection.

Parameters

callable|null $callable Filter

Return Value

Collection

in Collection at line 437
Collection with(array $keys)

Returns a new collection where all items not in the provided list have been removed.

Parameters

array $keys Keys

Return Value

Collection

in Collection at line 448
Collection without(array $keys)

Returns a new collection where all items in the provided list have been removed.

Parameters

array $keys Keys

Return Value

Collection

in Collection at line 459
Collection merge(Collection $collection)

Merges two collections.

Parameters

Collection $collection Collection to merge

Return Value

Collection

in ResultSet at line 36
setPagination(PaginationInterface $pagination)

Sets the pagination.

Parameters

PaginationInterface $pagination Pagination

in ResultSet at line 46
PaginationInterface getPagination()

Returns the pagination.

Return Value

PaginationInterface

in ResultSet at line 57
array pluck(string $column)

Returns an array containing only the values of chosen column.

Parameters

string $column Column name

Return Value

array

in ResultSet at line 67
array toArray()

Returns an array representation of the result set.

Return Value

array

in ResultSet at line 84
array jsonSerialize()

Returns data which can be serialized by json_encode().

Return Value

array

in ResultSet at line 100
string toJson(int $options = 0)

Returns a json representation of the result set.

Parameters

int $options JSON encode options

Return Value

string

in ResultSet at line 110
string __toString()

Returns a json representation of the result set.

Return Value

string

at line 22
__clone()

Clones all items when cloning the collection.

at line 35
protect(string|array|false $column)

Excludes the chosen columns and relations from array and json representations of the collection.

Parameters

string|array|false $column Column or relation to hide from the

at line 48
expose(string|array|true $column)

Exposes the chosen columns and relations in the array and json representations of the collection.

Parameters

string|array|true $column Column or relation to hide from the

at line 62
$this include(string|array $includes)

Eager loads relations on the collection.

Parameters

string|array $includes Relation or array of relations to eager load

Return Value

$this