1. class
  2. mako
  3. \
  4. utility
  5. \
  6. Collection

Collection

class Collection implements ArrayAccess, Countable, IteratorAggregate

Collection.

Traits

ExtendableTrait
Extendable trait.

Properties

static protected array $_extensions Class extensions. from ExtendableTrait
protected array $items Collection items.

Methods

static 
extend(string $methodName, Closure $closure)

Extends 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.

array
getItems()

Returns all the items in the collection.

array
getValues()

Returns all the values in the collection.

resetKeys()

Resets the collection keys.

put(int|string $key, mixed $value)

Adds a new item to the collection.

bool
has(int|string $key)

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

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

Returns an item from the collection.

remove(int|string $key)

Removes an item from the collection.

clear()

Clears the collection.

bool
offsetExists(mixed $offset)

Checks whether or not an offset exists.

mixed
offsetGet(mixed $offset)

Returns the value at the specified offset.

offsetSet(mixed $offset, mixed $value)

Assigns a value to the specified offset.

offsetUnset(mixed $offset)

Unsets an offset.

int
count()

Returns the numner of items in the collection.

ArrayIterator
getIterator()

Retruns an array iterator object.

bool
isEmpty()

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

int
unshift(mixed $item)

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

mixed
shift()

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

int
push(mixed $item)

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

mixed
pop()

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

bool
sort(callable $comparator, bool $maintainIndexAssociation = true)

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

Collection
chunk(int $size)

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

bool
shuffle()

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

each(callable $callable)

Applies the callable on all items in the collection.

Collection
map(callable $callable)

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

Collection
filter(callable $callable = null)

Returns a new filtered collection.

Collection
merge(Collection $collection)

Merges two collections.

Details

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

Extends 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

at line 56
__construct(array $items = [])

Constructor.

Parameters

array $items Collection items

at line 66
array getItems()

Returns all the items in the collection.

Return Value

array

at line 76
array getValues()

Returns all the values in the collection.

Return Value

array

at line 84
resetKeys()

Resets the collection keys.

at line 95
put(int|string $key, mixed $value)

Adds a new item to the collection.

Parameters

int|string $key Key
mixed $value Value

at line 106
bool has(int|string $key)

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

Parameters

int|string $key Key

Return Value

bool

at line 118
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

at line 133
remove(int|string $key)

Removes an item from the collection.

Parameters

int|string $key Key

at line 141
clear()

Clears the collection.

at line 152
bool offsetExists(mixed $offset)

Checks whether or not an offset exists.

Parameters

mixed $offset The offset to check for

Return Value

bool

at line 163
mixed offsetGet(mixed $offset)

Returns the value at the specified offset.

Parameters

mixed $offset The offset to retrieve

Return Value

mixed

at line 179
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

at line 196
offsetUnset(mixed $offset)

Unsets an offset.

Parameters

mixed $offset The offset to unset

at line 206
int count()

Returns the numner of items in the collection.

Return Value

int

at line 216
ArrayIterator getIterator()

Retruns an array iterator object.

Return Value

ArrayIterator

at line 226
bool isEmpty()

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

Return Value

bool

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.

Parameters

mixed $item Collection item

Return Value

int

at line 249
mixed shift()

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

Return Value

mixed

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.

Parameters

mixed $item Collection item

Return Value

int

at line 272
mixed pop()

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

Return Value

mixed

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.

Parameters

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

Return Value

bool

at line 296
Collection chunk(int $size)

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

Parameters

int $size Chunk size

Return Value

Collection

at line 314
bool shuffle()

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

Return Value

bool

at line 324
each(callable $callable)

Applies the callable on all items in the collection.

Parameters

callable $callable Callable

at line 339
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

at line 354
Collection filter(callable $callable = null)

Returns a new filtered collection.

Parameters

callable $callable Filter

Return Value

Collection

at line 370
Collection merge(Collection $collection)

Merges two collections.

Parameters

Collection $collection Collection to merge

Return Value

Collection