\Pop\Db\RecordCollection

__construct()

__construct(mixed  $data = array()) 

Constructor

Instantiate the collection object

Parameters

count()

count() : integer

Method to get the count of data in the collection

Returns

first()

first() : mixed

Get the first item of the collection

Returns

next()

next() : mixed

Get the next item of the collection

Returns

current()

current() : mixed

Get the current item of the collection

Returns

last()

last() : mixed

Get the last item of the collection

Returns

key()

key() : mixed

Get the key of the current item of the collection

Returns

contains()

contains(mixed  $key, boolean  $strict = false) : boolean

Determine if an item exists in the collection

Parameters

Returns

each()

each(callable  $callback) : \Pop\Utils\Collection

Execute a callback over each item

Parameters

Returns

every()

every(integer  $step, integer  $offset) : \Pop\Utils\Collection

Create a new collection from every n-th element

Parameters

Returns

filter()

filter(callable  $callback = null, integer  $flag) : \Pop\Utils\Collection

Apply filter to the collection

Parameters

Returns

map()

map(callable  $callback, integer  $flag) : \Pop\Utils\Collection

Apply map to the collection

Parameters

Returns

flip()

flip() : \Pop\Utils\Collection

Flip the data in the collection

Returns

has()

has(mixed  $key) : boolean

Determine if the key exists

Parameters

Returns

isEmpty()

isEmpty() : boolean

Determine if the collection is empty or not

Returns

keys()

keys() : \Pop\Utils\Collection

Get the keys of the collection data

Returns

values()

values() : \Pop\Utils\Collection

Get the values of the collection data

Returns

merge()

merge(mixed  $data, boolean  $recursive = false) : \Pop\Utils\Collection

Merge the collection with the passed data

Parameters

Returns

forPage()

forPage(integer  $page, integer  $perPage) : \Pop\Utils\Collection

Slice the collection for a page

Parameters

Returns

pop()

pop() : mixed

Get and remove the last item from the collection

Returns

push()

push(mixed  $value) : \Pop\Utils\Collection

Push an item onto the end of the collection.

Parameters

Returns

shift()

shift() : mixed

Get and remove the first item from the collection

Returns

slice()

slice(integer  $offset, integer  $length = null) : \Pop\Utils\Collection

Slice the collection

Parameters

Returns

splice()

splice(integer  $offset, integer|null  $length = null, mixed  $replacement = array()) : \Pop\Utils\Collection

Splice a portion of the collection

Parameters

Returns

sort()

sort(callable|null  $callback = null, integer  $flags = SORT_REGULAR) : \Pop\Utils\Collection

Sort data

Parameters

Returns

sortByAsc()

sortByAsc(integer  $flags = SORT_REGULAR) : \Pop\Utils\Collection

Sort the collection ascending

Parameters

Returns

sortByDesc()

sortByDesc(integer  $flags = SORT_REGULAR) : \Pop\Utils\Collection

Sort the collection descending

Parameters

Returns

toArray()

toArray(array  $options = array()) : array

Method to get collection object as an array

Parameters

Returns

getIterator()

getIterator() : \ArrayIterator

Method to iterate over the collection

Returns

__set()

__set(string  $name, mixed  $value) : void

Magic method to set the property to the value of $this->data[$name]

Parameters

__get()

__get(string  $name) : mixed

Magic method to return the value of $this->data[$name]

Parameters

Returns

__isset()

__isset(string  $name) : boolean

Magic method to return the isset value of $this->data[$name]

Parameters

Returns

__unset()

__unset(string  $name) : void

Magic method to unset $this->data[$name]

Parameters

offsetExists()

offsetExists(mixed  $offset) : boolean

ArrayAccess offsetExists

Parameters

Returns

offsetGet()

offsetGet(mixed  $offset) : mixed

ArrayAccess offsetGet

Parameters

Returns

offsetSet()

offsetSet(mixed  $offset, mixed  $value) : void

ArrayAccess offsetSet

Parameters

offsetUnset()

offsetUnset(mixed  $offset) : void

ArrayAccess offsetUnset

Parameters

getItems()

getItems() : array

Method to get collection object items

Returns

getDataAsArray()

getDataAsArray(mixed  $data) : array

Method to get data as an array

Parameters

Returns