ModelCollection

Handle find functions

Called after cloning a collection and makes sure that model reference is cloned as well

Create new Model Array

No description

returns model found by property => value

Apply lib->format multi_format on passed property. The result will be written to ->[property]_formatted

Find Function to find models using the passed condition

Adds an Object to the models-array.

It will be appended after the last position of array

Set property values to models from array

Runs the passed function batched for the passed amount of models to reduce memory issues while creating too many model objects at once This function should be called on an unloaded Collection to be most effective This method is ignoring any limits which might have been set on the scopeQuery!

Returns the number of containing models Attention: This will load all models of the collection Use $model_collection->count_all() for this case to determine count without loading all models Note: this function is called if the php function count(this_collection) is used

Return the maximum number of items in this collection, will return the count of all items in the database if the collection is a scoped collection and ignore limits set. Will return local count for manual collections

No description

Use for debugging

DESTRUCTIVE This will manipulate the models-list and doesn't return anything!

Iterates over each value in the models-array passing them to the callback function. If the callback function returns true, the current value from input is returned into the result array. Array keys are preserved.

Get first model of collection, without shifting

Prefetch and returns document index objects for all items of this collection.

foreach($collection) .

..

Returns a DocumentIndexCollection which is NOT loaded

No description

Returns the Default-Model (-Type) for this Collection

put your comment there.

..

Returns array with objects

Calls the passed method for each object

Returns true if the collection has no manual modifications yet

Returns true if this collection has been filled

Return the last element of the collection, not popping

Limit the visible articles.

DESTRUCTIVE This will manipulate the models-list and doesn't return anything!

Merges the elements of one or more arrays together so that the values of one are appended to the end of the previous one. It returns the resulting array. If the input arrays have the same string keys, then the later value for that key will overwrite the previous one. If, however, the arrays contain numeric keys, the later value will not overwrite the original value, but will be appended. If only one array is given and the array is numerically indexed, the keys get reindexed in a continuous way.

isset($collection[0])

$collection[0]

$collections[0] = $entry

unset($collection[0])

No description

Returns the passed property of all objects in an array

Returns the passed property. In contrast to pluck() this function does not use the loaded models but uses a SQL query to retrieve the values Attention: This returns the RAW database values

Returns the passed property of all objects in an array (unique and filtered)

this function returns the last value of the models-array, shortening the models-array by one element.

Will additionally produce a Warning when called on a non-array.

this function treats models-array as a stack, and pushes the passed variables onto the end of array.

The length of array increases by the number of variables pushed.

If the collection is not loaded yet the collection will use all() to be filled

Resets the loaded collection by clearing all loaded models and marking the collection as not being loaded.

Will not reset scope.

DESTRUCTIVE This will manipulate the models-list and doesn't return anything!

The models-array will be modified with the order of the elements reversed.

No description

No description

No description

No description

No description

Set this ModelCollection as loaded and empty collection

Setting model manually in a collection will set the collection prefilled/not scopable

No description

This function shifts the first value of the models-array off and returns it, shortening the array by one element and moving everything down.

All numerical array keys will be modified to start counting from zero while literal keys won't be touched.

DESTRUCTIVE This will manipulate the models-list and doesn't return anything!

Mimics the SQL sorting on the ModelCollection

Sorts the current Collection by given Property-Name

Returns the sum of the passed property across all models

Returns collection as array of models

Returns collection as json of models

Returns collection as string

Returns an XML of all model properties

This function prepends passed elements to the front of the array.

Note that the list of elements is prepended as a whole, so that the prepended elements stay in the same order. All numerical array keys will be modified to start counting from zero while literal keys won't be touched.

No description

DESTRUCTIVE This will manipulate the models-list and doesn't return anything!

This function will sort the models-array by its values using a user-supplied comparison function. If the array you wish to sort needs to be sorted by some non-trivial criteria, you should use this function.