1. class
  2. XELOS
  3. \
  4. Modules
  5. \
  6. ReadConfirmation
  7. \
  8. Collection
  9. \
  10. DocumentCollection

DocumentCollection

class DocumentCollection extends Collection

Traits

XQLCollectionTrait

Constants

SORT_ALPHABETICAL

SORT_NUMERICAL

SORT_ASC

SORT_DESC

EVENT_AFTER_LOAD

Properties

protected Model $model

reference to model-type

 from  ModelCollection
protected bool|Model[] $models

Array of models in this collection

 from  ModelCollection
protected bool $loaded

Boolean which indicates whether collection is loaded or not (not equal empty!)

 from  ModelCollection
bool $canBeScoped

ModelCollection cannot be scoped anymore if manual changes have been made

 from  ModelCollection
ReadConfirmationController $mod
static bool $isDocumentModel from  Collection

Methods

mixed
__call(mixed $method, mixed $args = array())

Handle find functions

from  ModelCollection
__clone()

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

from  ModelCollection
__construct(Model $model, array|ModelCollection $model_array = null, bool $useModelClone = true)

Create new Model Array

from  ModelCollection
__toString()

No description

from  ModelCollection
Model|ModelCollection|null
_search_by(string $query, array|bool $parameters = false, bool $return_single = true)

returns model found by property => value

from  ModelCollection
int|int[]
addAfterLoadListener(callable $function)

No description

from  Collection
add_formatted_property(string $property, string $format, array $options = array())

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

from  ModelCollection
ConfirmationCollection
all()

No description

void
append(Model $model)

Adds an Object to the models-array.

from  ModelCollection
static 
applyScopeFromReferencingCollection(Collection $primaryCollection, Collection $referencingCollection, string $referenceKeyField = null)

Apply related collection scopes, assumes 1:n relation

from  Collection
static 
applyScopeFromRelatedCollection(Collection $primaryCollection, Collection $relatedCollection, string $foreignKeyFieldToRelatedCollection = null)

Apply related collection scopes, assumes n:1/n:m relation

from  Collection
XQLCollectionTrait
applyXQLFilter(XQL $XQL, ParameterObject|null $parameterObject = null)

No description

from  XQLCollectionTrait
XQLCollectionTrait
applyXQLPagination(XQL $XQL)

Apply XQL Pagination to current Collection

from  XQLCollectionTrait
void
array() $int, T> $etIterator()

No description

from  Collection
attach(string $property, array $values, string $key_field = null)

Set property values to models from array

from  ModelCollection
batchProcess(int $batchSize, callable $callback)

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!

from  ModelCollection
int
count()

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

from  ModelCollection
int
countAll()

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

from  ModelCollection
int
count_all() deprecated

No description

from  ModelCollection
static DocumentCollection
create(Document $model)

No description

array
debug()

Use for debugging

from  ModelCollection
mixed
delete()

Creates a delete statement for the scoped collection and executes it.

from  Collection
void
filter(mixed $callback = false)

No description

from  Collection
Collection
filterByDateRange(DateTime|null $start = null, DateTime|null $end = null, string $dateProperty = 'updated_at')

Scope the Collection with $start date and/or $end date on the given $dateProperty.

from  Collection
Collection
filterByDocumentIndexCollection(DocumentIndexCollection $documentIndexCollection)

Filter a DocumentCollection by using a DocumentIndexCollection

from  Collection
Collection
filterByReferencingCollection(Collection $referencingCollection, string $referenceKeyField = null)

Apply filter scopes based on a relation, e.g. filter a UserCollection by using user_id from your DocumentCollection This function is similar to ->scope_by_id($referencingCollection->pluck('related_id')) but will avoid db calls and minimize queries whenever possible.

from  Collection
Collection
filterByRelatedCollection(Collection $relatedCollection)

Apply filter scopes based on a relation, e.g. filter a ArticleCollection by using id from a UserCollection This function is similar to ->scope_by_user_id($userCollection->pluck('id')) but will avoid db calls and minimize queries whenever possible.

from  Collection
Collection
filterBySearchQuery(string $searchQuery)

No description

from  Collection
Collection
filterByTags(array $tags, int|null $postType = null)

Returns articles if they are in one of the given tags.

from  Collection
Model|null
first()

Get first model of collection, without shifting

from  ModelCollection
array
getAPIResult(ParameterObject|null $parameterObject = null, PartitionQuery|null $partitionQuery = null)

Fullfill API Request and return result

from  XQLCollectionTrait
DocumentIndexCollection
getDocumentIndexes()

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

from  ModelCollection
Document[]
getIterator()

No description

DocumentIndexCollection
getRelatedDocumentIndexCollection()

Returns a DocumentIndexCollection which is NOT loaded

from  ModelCollection
ConditionGroup
getSearchQueryConditionGroup(string $searchQuery)

Callback for the faceted search filter.

static ParameterObject
getWebserviceParameterObject()

Get generic description of collection for webservice API

from  XQLCollectionTrait
static Closure
getXQLReferenceClosure(Collection $referenceCollection, string $expandToProperty = null, string $referenceKeyField = null)

Returns a closure that adds an AfterLoadListener to filter elements of a reference collection and attach them as expand property to this collection, e.g. articles referencing to user by user_id

from  XQLCollectionTrait
array
getXQLResult(XQL|null $XQL, string|null $partitionColumn = null, bool $hasManyRelation = true)

Apply XELOS Query Language Object

  • [Optional] Apply $filter
  • [Optional] Apply $pagination
  • [Optional] Populate $expand
  • [Optional] Remove fields which are not required by $select

from  XQLCollectionTrait
array|bool
get_db_properties()

No description

from  ModelCollection
Model
get_model()

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

from  ModelCollection
string
get_model_class()

put your comment there.

from  ModelCollection
array|Model[]
get_models()

Returns array with objects

from  ModelCollection
void
init()

Use init for default sort order of your collection

array
invoke(string $method)

Calls the passed method for each object

from  ModelCollection
bool
isScopeable()

Returns true if the collection has no manual modifications yet

from  ModelCollection
bool
is_loaded()

Returns true if this collection has been filled

from  ModelCollection
Collection
joinDocumentIndex()

Joins the system_document_index table

from  Collection
Model|null
last()

Return the last element of the collection, not popping

from  ModelCollection
ModelCollection
limit(int $limit, int $offset = 0)

Limit the visible articles.

from  ModelCollection
void
merge()

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

from  ModelCollection
bool
offsetExists(mixed $offset)

isset($collection[0])

from  ModelCollection
Document
offsetGet(mixed $offset)

No description

offsetSet(mixed $offset, mixed $value)

$collections[0] = $entry

from  ModelCollection
offsetUnset(mixed $offset)

unset($collection[0])

from  ModelCollection
ModelCollection
orderBy(string $field, string $sortDirection = ModelCollection::SORT_ASC)

No description

from  ModelCollection
Collection
orderByViews()

Order Collection by views desc (popularity)

from  Collection
pluck(string|string[] $property, string $key_field = null)

Returns the passed property of all objects in an array

from  ModelCollection
array
pluckWithScopeQuery(string $property, string|null $key_field = null)

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

from  ModelCollection
array
pluck_unique(mixed $property, mixed $key_field = false)

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

from  ModelCollection
Model|null
pop()

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

from  ModelCollection
XQLCollectionTrait
populateApiProperties(ParameterObject|null $parameterObject = null)

Map internal collection information to fulfill the promised ParameterObject

from  XQLCollectionTrait
Collection
populateDocumentIndexes()

Preload Document Indexes for the Models in this collection Make sure to add this listener before using documentindexes in other populate functions

from  Collection
Collection
populateDocumentReactions(string $setToProperty = 'reactions')

No description

from  Collection
Collection
populateDocumentStatistics(string $setToProperty = 'documentStats')

Populate common document statistics: comments, likes, views

from  Collection
Collection
populateDocumentTags(string $setToProperty = 'tags')

Read tags associated with the current documents and attach the corresponding tags to the models

from  Collection
Collection
populateGroupSecurity(string $setToProperty = 'groupSecurity')

No description

from  Collection
Collection
populateMagicDocumentHelperList(string $attachmentProperty, string $setToProperty = 'attachmentList', bool $extendedAttachmentInfo = false)

Preload Document Indexes for the Models in this collection Make sure to add this listener before using documentindexes in other populate functions

from  Collection
Collection
populateUsers(string $setToProperty = 'user', string $readFromProperty = 'user_id')

Read associated users from property and attach the corresponding model

from  Collection
int
push(Model ...$models)

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

from  ModelCollection
bool
require_loading()

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

from  ModelCollection
reset()

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

from  ModelCollection
reverse(bool $preserve_keys = false)

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

from  ModelCollection
ModelCollection
save(bool $silent = false)

No description

from  ModelCollection
ModelCollection
scope_by_COL(mixed $value)

No description

from  ModelCollection
Model[]
search_all_by_id(mixed $id, mixed $query_params)

No description

from  ModelCollection
Model|null
search_by_id(mixed $id, mixed $query_params)

No description

from  ModelCollection
ModelCollection
setCanBeScoped(bool $canBeScoped = true)

No description

from  ModelCollection
ModelCollection
setEmpty()

Set this ModelCollection as loaded and empty collection

from  ModelCollection
ModelCollection
setModels(Model[]|ModelCollection $models)

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

from  ModelCollection
ModelCollection
setProperty(string $key, mixed $value)

No description

from  ModelCollection
Model|null
shift()

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

from  ModelCollection
slice(int $offset, int|bool $length = false, bool $preserve_keys = false) deprecated

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

from  ModelCollection
ModelCollection
sortByQuery(Query $query = null)

Mimics the SQL sorting on the ModelCollection

from  ModelCollection
ModelCollection
sort_by(string $property, string $order_by = 'asc') deprecated

Sorts the current Collection by given Property-Name

from  ModelCollection
mixed
sum(string $property, string|bool $group_field = false)

Returns the sum of the passed property across all models

from  ModelCollection
array|Model[]
to_array(bool $raw = false)

Returns collection as array of models

from  ModelCollection
string
to_json()

Returns collection as json of models

from  ModelCollection
string
to_string()

Returns collection as string

from  ModelCollection
string
to_xml(array|bool $property_filter = false)

Returns an XML of all model properties

from  ModelCollection
int
unshift()

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

from  ModelCollection
ModelCollection
updateDocumentIndexes()

No description

from  ModelCollection
mixed
updateField(string $field, string|int|float $value)

Creates an update statement for the scoped collection and executes it.

from  Collection
bool
usort(callable $cmp_function)

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

from  ModelCollection

Details

in ModelCollection at line 254
mixed __call(mixed $method, mixed $args = array())

Handle find functions

Parameters

mixed $method
mixed $args

Return Value

mixed

in ModelCollection at line 1507
__clone()

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

in ModelCollection at line 101
__construct(Model $model, array|ModelCollection $model_array = null, bool $useModelClone = true)

Create new Model Array

Parameters

Model $model

Reference to Model
array|ModelCollection $model_array

Optional array of Models to initialize collection with
bool $useModelClone

in ModelCollection at line 967
__toString()

No description

in ModelCollection at line 666
protected Model|ModelCollection|null _search_by(string $query, array|bool $parameters = false, bool $return_single = true)

returns model found by property => value

Parameters

string $query

function_name_query (e.g.: title_and_user_id)
array|bool $parameters
bool $return_single

determines the result-type [FALSE] : Model or boolean false on fail [TRUE] : ModelCollection

Return Value

Model|ModelCollection|null

see also param-doc of "$return_single"

in Collection at line 72
int|int[] addAfterLoadListener(callable $function)

No description

Parameters

callable $function

Return Value

int|int[]

Event ID

in ModelCollection at line 954
add_formatted_property(string $property, string $format, array $options = array())

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

Parameters

string $property

Property of models to format
string $format

Format Type (e.g. money, date, ...)
array $options

Additional format options

at line 20
ConfirmationCollection all()

No description

Return Value

ConfirmationCollection

in ModelCollection at line 1049
void append(Model $model)

Adds an Object to the models-array.

It will be appended after the last position of array

Parameters

Model $model

Return Value

void

in Collection at line 526
final static applyScopeFromReferencingCollection(Collection $primaryCollection, Collection $referencingCollection, string $referenceKeyField = null)

Apply related collection scopes, assumes 1:n relation

Parameters

Collection $primaryCollection

Scopes are applied to this collection, scopes are applied to the primary key (e.g. id)
Collection $referencingCollection

ScopeQuery is taken from this collection which is referencing to primary collection, (e.g. select user_id from articles )
string $referenceKeyField

This function will help applying the current scope to your collection

in Collection at line 576
final static applyScopeFromRelatedCollection(Collection $primaryCollection, Collection $relatedCollection, string $foreignKeyFieldToRelatedCollection = null)

Apply related collection scopes, assumes n:1/n:m relation

Parameters

Collection $primaryCollection

Scopes are applied to this collection, scopes are applied to the foreign key (e.g. user_id)
Collection $relatedCollection

ScopeQuery is taken from this collection which is holding the relation to primary collection, (e.g. select id from users )
string $foreignKeyFieldToRelatedCollection

Which field in your primaryCollection is holding the foreignKey to the related Collection? (e.g. user_id)

in XQLCollectionTrait at line 36
protected XQLCollectionTrait applyXQLFilter(XQL $XQL, ParameterObject|null $parameterObject = null)

No description

Parameters

XQL $XQL
ParameterObject|null $parameterObject

Return Value

XQLCollectionTrait

in XQLCollectionTrait at line 82
protected XQLCollectionTrait applyXQLPagination(XQL $XQL)

Apply XQL Pagination to current Collection

Return information / stats about applied pagination

Parameters

XQL $XQL

Return Value

XQLCollectionTrait

in Collection at line 28
void array() $int, T> $etIterator()

No description

Parameters

) $int
T> $etIterator(

Return Value

void

in ModelCollection at line 631
attach(string $property, array $values, string $key_field = null)

Set property values to models from array

Parameters

string $property

e.g. calculated_property
array $values

['id1'=>'CALCULATED for id1']
string $key_field

Will default to table_primary_key

in ModelCollection at line 483
batchProcess(int $batchSize, callable $callback)

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!

Parameters

int $batchSize

Number of models which should be processed per chunk
callable $callback

Callback which will be called for each chunk. The function receives a ModelCollection as the first argument which contains a subset of models for this chunk run.

in ModelCollection at line 1028
int count()

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 Value

int

count of models

in ModelCollection at line 1543
int countAll()

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

Return Value

int

in ModelCollection at line 1555
int count_all() deprecated

deprecated Use countAll()

No description

Return Value

int

at line 20
static DocumentCollection create(Document $model)

No description

Parameters

Document $model

Return Value

DocumentCollection

in ModelCollection at line 1416
array debug()

Use for debugging

Return Value

array

in Collection at line 118
mixed delete()

Creates a delete statement for the scoped collection and executes it.

When there's no scope defined, throws a LogicException to prevent an accidental delete of the whole table.

Return Value

mixed

in Collection at line 596
void filter(mixed $callback = false)

No description

Parameters

mixed $callback

If the callback function is not supplied, array_filter() will remove all the entries of input that are equal to FALSE, null or ''

Return Value

void

in Collection at line 483
Collection filterByDateRange(DateTime|null $start = null, DateTime|null $end = null, string $dateProperty = 'updated_at')

Scope the Collection with $start date and/or $end date on the given $dateProperty.

Parameters

DateTime|null $start
DateTime|null $end
string $dateProperty

Return Value

Collection

in Collection at line 167
Collection filterByDocumentIndexCollection(DocumentIndexCollection $documentIndexCollection)

Filter a DocumentCollection by using a DocumentIndexCollection

Parameters

DocumentIndexCollection $documentIndexCollection

Return Value

Collection

in Collection at line 511
Collection filterByReferencingCollection(Collection $referencingCollection, string $referenceKeyField = null)

Apply filter scopes based on a relation, e.g. filter a UserCollection by using user_id from your DocumentCollection This function is similar to ->scope_by_id($referencingCollection->pluck('related_id')) but will avoid db calls and minimize queries whenever possible.

Parameters

Collection $referencingCollection

e.g. articles referencing to user by user_id
string $referenceKeyField

overwrite field name if referencing collection does not use standard fields, e.g. created_by instead of user_id in forum posts

Return Value

Collection

in Collection at line 564
Collection filterByRelatedCollection(Collection $relatedCollection)

Apply filter scopes based on a relation, e.g. filter a ArticleCollection by using id from a UserCollection This function is similar to ->scope_by_user_id($userCollection->pluck('id')) but will avoid db calls and minimize queries whenever possible.

Parameters

Collection $relatedCollection

e.g. users related to by user_id

Return Value

Collection

in Collection at line 455
Collection filterBySearchQuery(string $searchQuery)

No description

Parameters

string $searchQuery

Return Value

Collection

in Collection at line 146
Collection filterByTags(array $tags, int|null $postType = null)

Returns articles if they are in one of the given tags.

Parameters

array $tags
int|null $postType

Return Value

Collection

in ModelCollection at line 1260
Model|null first()

Get first model of collection, without shifting

Return Value

Model|null

in XQLCollectionTrait at line 215
array getAPIResult(ParameterObject|null $parameterObject = null, PartitionQuery|null $partitionQuery = null)

Fullfill API Request and return result

Parameters

ParameterObject|null $parameterObject
PartitionQuery|null $partitionQuery

Return Value

array

in ModelCollection at line 195
DocumentIndexCollection getDocumentIndexes()

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

Return Value

DocumentIndexCollection

at line 20
Document[] getIterator()

No description

Return Value

Document[]

in ModelCollection at line 219
DocumentIndexCollection getRelatedDocumentIndexCollection()

Returns a DocumentIndexCollection which is NOT loaded

Return Value

DocumentIndexCollection

at line 31
protected ConditionGroup getSearchQueryConditionGroup(string $searchQuery)

Callback for the faceted search filter.

Parameters

string $searchQuery

Return Value

ConditionGroup

in XQLCollectionTrait at line 26
static ParameterObject getWebserviceParameterObject()

Get generic description of collection for webservice API

Return Value

ParameterObject

in XQLCollectionTrait at line 304
static protected Closure getXQLReferenceClosure(Collection $referenceCollection, string $expandToProperty = null, string $referenceKeyField = null)

Returns a closure that adds an AfterLoadListener to filter elements of a reference collection and attach them as expand property to this collection, e.g. articles referencing to user by user_id

Parameters

Collection $referenceCollection

the collection referenced by this collection, e.g. users referenced as authors of articles
string $expandToProperty

overwrite the name of the expand property, default is the model name, e.g. user_Expand for a user collection
string $referenceKeyField

overwrite field name if referencing collection does not use standard fields, e.g. created_by instead of user_id in forum posts

Return Value

Closure

in XQLCollectionTrait at line 124
final array getXQLResult(XQL|null $XQL, string|null $partitionColumn = null, bool $hasManyRelation = true)

Apply XELOS Query Language Object

  • [Optional] Apply $filter
  • [Optional] Apply $pagination
  • [Optional] Populate $expand
  • [Optional] Remove fields which are not required by $select

Parameters

XQL|null $XQL
string|null $partitionColumn
bool $hasManyRelation

If true, we expect there to be {0,n} results per column (1:n relationship) and return a collection result. If false, we expect a 1:1 relationship and return a single result or null

Return Value

array

in ModelCollection at line 1404
array|bool get_db_properties()

No description

Return Value

array|bool

in ModelCollection at line 1397
Model get_model()

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

Return Value

Model

in ModelCollection at line 120
string get_model_class()

put your comment there.

..

Return Value

string ???

in ModelCollection at line 128
array|Model[] get_models()

Returns array with objects

Return Value

array|Model[]

at line 23
void init()

Use init for default sort order of your collection

Return Value

void

in ModelCollection at line 460
array invoke(string $method)

internal  param mixed $args Additional Parameters
 

Calls the passed method for each object

Parameters

string $method

Method Name

Return Value

array

[like pluck]

in ModelCollection at line 1535
bool isScopeable()

Returns true if the collection has no manual modifications yet

Return Value

bool

in ModelCollection at line 136
bool is_loaded()

Returns true if this collection has been filled

Return Value

bool

True if loaded

in Collection at line 640
Collection joinDocumentIndex()

Joins the system_document_index table

Return Value

Collection

in ModelCollection at line 1251
Model|null last()

Return the last element of the collection, not popping

Return Value

Model|null

in ModelCollection at line 1273
final ModelCollection limit(int $limit, int $offset = 0)

Limit the visible articles.

Parameters

int $limit
int $offset

Return Value

ModelCollection

in ModelCollection at line 1096
void merge()

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.

Return Value

void

in ModelCollection at line 1456
bool offsetExists(mixed $offset)

isset($collection[0])

Parameters

mixed $offset

Return Value

bool

at line 20
Document offsetGet(mixed $offset)

No description

Parameters

mixed $offset

Return Value

Document

in ModelCollection at line 1439
offsetSet(mixed $offset, mixed $value)

$collections[0] = $entry

Parameters

mixed $offset
mixed $value

in ModelCollection at line 1467
offsetUnset(mixed $offset)

unset($collection[0])

Parameters

mixed $offset

in ModelCollection at line 1289
final ModelCollection orderBy(string $field, string $sortDirection = ModelCollection::SORT_ASC)

No description

Parameters

string $field
string $sortDirection

Return Value

ModelCollection

in Collection at line 674
Collection orderByViews()

Order Collection by views desc (popularity)

Return Value

Collection

Exceptions

ModuleException

in ModelCollection at line 543
pluck(string|string[] $property, string $key_field = null)

Returns the passed property of all objects in an array

Parameters

string|string[] $property

[array ior], pass * to retrieve all properties, pass 'this' to retrieve models
string $key_field

in ModelCollection at line 612
array pluckWithScopeQuery(string $property, string|null $key_field = null)

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

Parameters

string $property
string|null $key_field

Return Value

array

in ModelCollection at line 594
array pluck_unique(mixed $property, mixed $key_field = false)

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

Parameters

mixed $property
mixed $key_field

Return Value

array

in ModelCollection at line 1062
Model|null pop()

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.

Return Value

Model|null

Model or NULL if models-array is empty or not an array

in XQLCollectionTrait at line 293
protected XQLCollectionTrait populateApiProperties(ParameterObject|null $parameterObject = null)

Map internal collection information to fulfill the promised ParameterObject

Parameters

ParameterObject|null $parameterObject

Return Value

XQLCollectionTrait

in Collection at line 187
Collection populateDocumentIndexes()

Preload Document Indexes for the Models in this collection Make sure to add this listener before using documentindexes in other populate functions

Return Value

Collection

in Collection at line 350
Collection populateDocumentReactions(string $setToProperty = 'reactions')

No description

Parameters

string $setToProperty

Return Value

Collection

in Collection at line 260
Collection populateDocumentStatistics(string $setToProperty = 'documentStats')

Populate common document statistics: comments, likes, views

Parameters

string $setToProperty

Return Value

Collection

in Collection at line 387
Collection populateDocumentTags(string $setToProperty = 'tags')

Read tags associated with the current documents and attach the corresponding tags to the models

Parameters

string $setToProperty

Return Value

Collection

in Collection at line 434
Collection populateGroupSecurity(string $setToProperty = 'groupSecurity')

No description

Parameters

string $setToProperty

Return Value

Collection

in Collection at line 205
Collection populateMagicDocumentHelperList(string $attachmentProperty, string $setToProperty = 'attachmentList', bool $extendedAttachmentInfo = false)

Preload Document Indexes for the Models in this collection Make sure to add this listener before using documentindexes in other populate functions

Parameters

string $attachmentProperty
string $setToProperty
bool $extendedAttachmentInfo

Return Value

Collection

in Collection at line 425
Collection populateUsers(string $setToProperty = 'user', string $readFromProperty = 'user_id')

Read associated users from property and attach the corresponding model

Parameters

string $setToProperty
string $readFromProperty

Return Value

Collection

in ModelCollection at line 1075
int push(Model ...$models)

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.

Parameters

Model ...$models

Return Value

int

Count of Models after pushing-operation

in ModelCollection at line 182
bool require_loading()

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

Return Value

bool

requires loading

in ModelCollection at line 1214
reset()

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

Will not reset scope.

in ModelCollection at line 1157
reverse(bool $preserve_keys = false)

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.

Parameters

bool $preserve_keys

in ModelCollection at line 426
ModelCollection save(bool $silent = false)

No description

Parameters

bool $silent

Return Value

ModelCollection

in ModelCollection at line 27
ModelCollection scope_by_COL(mixed $value)

No description

Parameters

mixed $value

Return Value

ModelCollection

in ModelCollection at line 27
Model[] search_all_by_id(mixed $id, mixed $query_params)

No description

Parameters

mixed $id
mixed $query_params

Return Value

Model[]

in ModelCollection at line 27
Model|null search_by_id(mixed $id, mixed $query_params)

No description

Parameters

mixed $id
mixed $query_params

Return Value

Model|null

in ModelCollection at line 1526
ModelCollection setCanBeScoped(bool $canBeScoped = true)

No description

Parameters

bool $canBeScoped

Return Value

ModelCollection

in ModelCollection at line 171
ModelCollection setEmpty()

Set this ModelCollection as loaded and empty collection

Return Value

ModelCollection

in ModelCollection at line 148
ModelCollection setModels(Model[]|ModelCollection $models)

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

Parameters

Model[]|ModelCollection $models

Return Value

ModelCollection

in ModelCollection at line 408
ModelCollection setProperty(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

ModelCollection

in ModelCollection at line 1123
Model|null shift()

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.

Return Value

Model|null

Returns the shifted value, or NULL if models-array is empty or is not an array.

in ModelCollection at line 1241
slice(int $offset, int|bool $length = false, bool $preserve_keys = false) deprecated

deprecated This function should be protected - use limit() instead

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

Parameters

int $offset

If offset is non-negative, the sequence will start at that offset in the array . If offset is negative, the sequence will start that far from the end of the array .
int|bool $length

If length is given and is positive, then the sequence will have that many elements in it. If length is given and is negative then the sequence will stop that many elements from the end of the array. If it is omitted, then the sequence will have everything from offset up until the end of the array .
bool $preserve_keys

Note that array_slice() will reorder and reset the array indices by default. You can change this behaviour by setting preserve_keys to TRUE.

in ModelCollection at line 1340
ModelCollection sortByQuery(Query $query = null)

Mimics the SQL sorting on the ModelCollection

Parameters

Query $query

Return Value

ModelCollection

in ModelCollection at line 1322
ModelCollection sort_by(string $property, string $order_by = 'asc') deprecated

deprecated This function should be private and orderBy or sortByQuery should be used as public method (same as slice/limit)

Sorts the current Collection by given Property-Name

Parameters

string $property

Field-Name of the Model-Property (e.g.: 'id', 'created_at', ...)
string $order_by

sort-direction ['asc' | 'desc']

Return Value

ModelCollection

in ModelCollection at line 520
mixed sum(string $property, string|bool $group_field = false)

Returns the sum of the passed property across all models

Parameters

string $property

Property Field to sum up (e.g. price)
string|bool $group_field

Optional Group Field to group sums

Return Value

mixed

Returns array or value

in ModelCollection at line 978
array|Model[] to_array(bool $raw = false)

Returns collection as array of models

Parameters

bool $raw

If true calls get_properties on each model

Return Value

array|Model[]

in ModelCollection at line 995
string to_json()

Returns collection as json of models

Return Value

string

in ModelCollection at line 963
string to_string()

Returns collection as string

Return Value

string

in ModelCollection at line 1005
string to_xml(array|bool $property_filter = false)

Returns an XML of all model properties

Parameters

array|bool $property_filter

property_filter array if given, only the properties in this array are added

Return Value

string

in ModelCollection at line 1136
int unshift()

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.

Return Value

int

Returns the new number of elements in the array.

in ModelCollection at line 443
ModelCollection updateDocumentIndexes()

No description

Return Value

ModelCollection

in Collection at line 90
mixed updateField(string $field, string|int|float $value)

Creates an update statement for the scoped collection and executes it.

When there's no scope defined, throws a LogicException to prevent an accidental update of the whole table.

Parameters

string $field
string|int|float $value

Return Value

mixed

in ModelCollection at line 1179
bool usort(callable $cmp_function)

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.

Parameters

callable $cmp_function

The comparison function must return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second.

Return Value

bool

was sorting successful?

Examples

$collection->usort("compare_objects");
 
$collection->usort(array(&$article, "compare_articles"));