1. trait
  2. XELOS
  3. \
  4. Framework
  5. \
  6. Module
  7. \
  8. Model
  9. \
  10. Traits
  11. \
  12. Base
  13. \
  14. ScopesTrait

ScopesTrait

trait ScopesTrait

Methods

Query
_scopeAll(Query $Query)

Global named scope scopeAll to use on models to return an unscoped unloaded collection

Query
_scopeDefault(Query $Query)

Load default scopes

ModelCollection
_scope_by(mixed $fn, mixed $parameters)

Called for scopeby Magic Function Creates a new ModelCollection and applies the passed scope

ModelCollection
_scope_custom(mixed $fn)

Called for scope_ Magic Function Creates a new ModelCollection and applies the passed custom scope function

ModelCollection
add_scope_condition(Condition|Query|string $new_condition)

Adds a condition to scope the following find functions

Query
getScopeQuery()

Returns the Query object which is being used for building the query The function creates a new Query object if required to enable lazy loading

string
getScopeQueryConditionSQL()

Returns the WHERE SQL Conditions based on the current Condition Separate function to be able to update scopes at this point in time if needed

void
registerDefaultScope($scopeName)

Registers the passed scope as default scope A default scope is present when the model is being loaded and can be removed using the unscope() function if required The passed scope must be defined in a scope[SCOPE_NAME] function e.g. scopeGroupId

ModelCollection
scopeAll()

No description

void
setModelCollectionReference(ModelCollection $modelCollectionReference)

No description

ModelCollection
unscope($scopeName = false)

Removes all scopes (including Default Scopes)

Details

at line 81
Query _scopeAll(Query $Query)

Global named scope scopeAll to use on models to return an unscoped unloaded collection

Parameters

Query $Query

Query

Return Value

Query

at line 90
Query _scopeDefault(Query $Query)

Load default scopes

Parameters

Query $Query

Return Value

Query

at line 119
protected ModelCollection _scope_by(mixed $fn, mixed $parameters)

Called for scopeby Magic Function Creates a new ModelCollection and applies the passed scope

Parameters

mixed $fn
mixed $parameters

Return Value

ModelCollection

at line 132
protected ModelCollection _scope_custom(mixed $fn)

Called for scope_ Magic Function Creates a new ModelCollection and applies the passed custom scope function

Parameters

mixed $fn

Name of the custom scope - e.g. Active - calls _scopeActive() on the model

Return Value

ModelCollection

at line 32
ModelCollection add_scope_condition(Condition|Query|string $new_condition)

Adds a condition to scope the following find functions

Parameters

Condition|Query|string $new_condition

Return Value

ModelCollection

at line 212
Query getScopeQuery()

Returns the Query object which is being used for building the query The function creates a new Query object if required to enable lazy loading

Return Value

Query

at line 202
protected string getScopeQueryConditionSQL()

Returns the WHERE SQL Conditions based on the current Condition Separate function to be able to update scopes at this point in time if needed

Return Value

string

at line 105
protected void registerDefaultScope($scopeName)

Registers the passed scope as default scope A default scope is present when the model is being loaded and can be removed using the unscope() function if required The passed scope must be defined in a scope[SCOPE_NAME] function e.g. scopeGroupId

Parameters

$scopeName

Return Value

void

at line 14
ModelCollection scopeAll()

No description

Return Value

ModelCollection

at line 71
void setModelCollectionReference(ModelCollection $modelCollectionReference)

No description

Parameters

ModelCollection $modelCollectionReference

Return Value

void

at line 49
ModelCollection unscope($scopeName = false)

Removes all scopes (including Default Scopes)

Parameters

$scopeName

string|bool Name of named scope to be removed or FALSE to clear all scopes incl. unnamed scopes (e.g. scope_by)

Return Value

ModelCollection