Model
class Model
Database Model
Traits
Constants
EVENT_MODEL_AFTER_SAVE |
|
EVENT_MODEL_BEFORE_SAVE |
|
EVENT_MODEL_BEFORE_DELETE |
|
EVENT_MODEL_AFTER_DELETE |
|
FIELD_IS_NULL |
$this->find_by_field(Model::IS_NULL) |
Properties
Core | $mod | ||
protected | $model_name | var string Name of this model e.g. category or document |
|
protected | $table_name | var string Table name for this model |
|
protected bool | $table_use_group_id | ||
protected bool | $table_auto_properties | ||
protected string | $table_primary_key | ||
protected array | $table_primary_compound_key | ||
protected array | $properties | ||
protected array | $properties_meta | ||
protected array | $markers | ||
protected array | $properties_null_values | ||
bool|string | $class_name | ||
string | $render_type | ||
protected int | $model_version | Hint your model version, this parameter might affect certain outcomes and behaviours This version string is added for backwards compatibility |
|
protected string | $model_default_render_xui | Defines a XUI helper which can be used to display this model in the render() function e.g. use 'thread' to use this xui helper "XELOS\Modules\Forum\UI\Thread" of the models parent module |
|
protected array | $render_params | Parameters that will be consigned to the XUI helper |
|
static string | $find_by_separators | ||
bool | $loaded | ||
bool | $saved | ||
protected array | $changed | ||
array | $cache_function_result | ||
static array | $_request_cache |
Methods
No description
Magic Function Object Cloning Make sure object references are cleaned up as each object requires a clean and separate reference
No description
No description
No description
No description
String Representation of this object (calls for render method)
Calls the passed function only if it is not cached yet, otherwise the previous cached result will be returned
Global named scope scopeAll to use on models to return an unscoped unloaded collection
Called for scopeby Magic Function Creates a new ModelCollection and applies the passed scope
Called for scope_ Magic Function Creates a new ModelCollection and applies the passed custom scope function
Apply lib->format multi_format on passed property. The result will be written to ->[property]_formatted
Adds a condition to scope the following find functions
Return all models
Clears the cache for all functions or a specific one
No description
Convert Assoc Multidimensional Array to Model Conditional Array
Returns the count of all models
Returns the count of all models with the specific column value
No description
No description
on the desired collection.
Disable the use of the group ID in all queries made
Enable the use of the group ID in all queries made
Find Function to find models using the passed condition
Returns loaded ModelCollection
Returns all models with a specific column value. Query params can be e.g. order_by
Converts a findby* function name to SQL query.
Return properties which have been changed after model was initialized/loaded We know these values have been changed locally, but these changes are NOT necessarily reflecting the DB diff
No description
Get DB Schema if available
Return a new unscoped model collection for further processing
Return properties and markers
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
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 properties which have been touched/set after model was initialized/loaded We know these values have been set, but they might not have changed
Return a Formatted DateTime
Returns all properties which are available as DB field (= can be used as find_by() properties) with its currently known raw value Please note that smartTimeFields (updated_at, created_at) are not converted to mysql-date format
Return the property translated property value if available
Returns the SQL table of this model (if available)
Returns the SQL table of this model (if available)
Returns the complete properties array
No description
No description
Return Cache Entry if it exists
Returns the table name of this model.
No description
Return a Formatted DateTime
No description
No description
Initializes the model
No description
No description
No description
Execute Query of find() function. Can be modified by child class if necessary
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
Reloads the schema of the model
No description
Generic Renderer
No description
No description
Provides a list of all values allowed for enumerations.
Returns unloaded ModelCollection
No description
No description
Set a Property. If $property_id is an array and $property_value is false, set_property is called for each element in the array with the array key and value as params.
Sets parameter that will be passed to the XUI helpers
Set Request Cache Entry
Sort this element to a specific position
Decrease Sort Priority (Increases SORT value)
Increase Sort Priority (Decreases SORT value)
Stops the temporary overwrite of the table_group_id
Temporarily disable the use of the group ID in all queries made
Temporarily enables the use of the group ID in all queries made
Returns the model as JSON array
Returns the model as STRING
Returns an XML of all model properties
Removes all scopes (including Default Scopes)
Update the sort property for a given table (Move a record up/down)
No description
Details
at line 994
ModelCollection|Model|Model[]|int
__call(string $method, array $args = array())
No description
at line 1544
__clone()
Magic Function Object Cloning Make sure object references are cleaned up as each object requires a clean and separate reference
at line 145
__construct(int|bool $id = false)
No description
at line 963
mixed
__get(mixed $var)
No description
at line 1601
__isset($name)
No description
at line 976
mixed
__set(mixed $var, mixed $value)
No description
at line 1553
string
__toString()
String Representation of this object (calls for render method)
at line 1032
mixed
_call_cached_function(string $function, array $args)
Calls the passed function only if it is not cached yet, otherwise the previous cached result will be returned
in
ScopesTrait at line 81
Query
_scopeAll(Query $Query)
Global named scope scopeAll to use on models to return an unscoped unloaded collection
in
ScopesTrait at line 90
Query
_scopeDefault(Query $Query)
Load default scopes
at line 1489
protected mixed
_scopeGroupId(Query $Query)
Applies Group ID Filtering
in
ScopesTrait 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
in
ScopesTrait 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
at line 823
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
in
ScopesTrait at line 32
ModelCollection
add_scope_condition(Condition|Query|string $new_condition)
Adds a condition to scope the following find functions
at line 36
Model[]
all(mixed $params = ['order_by'=>'COL1)
Return all models
at line 1051
clear_cached_functions(string|bool $function = false)
Clears the cache for all functions or a specific one
at line 567
clear_properties()
No description
at line 1228
array
convert_array_to_conditions(array $params = array())
Convert Assoc Multidimensional Array to Model Conditional Array
at line 36
int
count_all()
Returns the count of all models
at line 36
Model[]
count_by_TABLE_COL_and_TABLE_COL2(mixed $COL1_VALUE, mixed $COL2_VALUE)
Returns the count of all models with the specific column value
at line 808
string|void
debug(bool $show_markers = false, int $mode = 0)
No description
at line 375
bool
delete()
No description
at line 36
int
delete_by_TABLE_COL(mixed $COL_VALUE) Delete rows specified by condition and returns the affected rows. NOTE: This does not trigger a delete() function of the model. If required use pluck('delete')
on the desired collection.
at line 1497
void
disable_table_group_id()
Disable the use of the group ID in all queries made
at line 1520
void
enable_table_group_id()
Enable the use of the group ID in all queries made
at line 1094
mixed
find(string $mode = 'all', mixed $conditions = false, mixed $query_params = false)
Find Function to find models using the passed condition
at line 36
ModelCollection|Model[]
find_all_by_TABLE_COL_and_TABLE_COL2($COL1_VALUE, $COL2_VALUE, $params=['order_by'=>'COL1, 5]] $)
Returns loaded ModelCollection
at line 36
Model
find_by_TABLE_COL(mixed $COL_VALUE, mixed $params = ['order_by'=>'COL1)
Returns all models with a specific column value. Query params can be e.g. order_by
at line 1286
Query
functionNameToQuery(string $query, array $parameters)
Converts a findby* function name to SQL query.
at line 1685
array
getChangedProperties(bool $returnOldValues = false)
Return properties which have been changed after model was initialized/loaded We know these values have been changed locally, but these changes are NOT necessarily reflecting the DB diff
at line 839
ModelCollection
getCollectionByQuery(string $model_name, array|string $dbquery_result, string $population_mode = 'full', string $post_fill_function = 'update')
No description
at line 187
array
getDBSchema()
Get DB Schema if available
at line 1066
ModelCollection
getModelCollection()
Return a new unscoped model collection for further processing
at line 450
array
getPropertyMarkers(bool $value_discovery = true)
Return properties and markers
in
ScopesTrait 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
in
ScopesTrait 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
at line 1666
array
getTouchedProperties(bool $returnOldValues = false)
Return properties which have been touched/set after model was initialized/loaded We know these values have been set, but they might not have changed
at line 1472
string
get_created_at_formatted()
Return a Formatted DateTime
at line 479
array
get_db_properties()
Returns all properties which are available as DB field (= can be used as find_by() properties) with its currently known raw value Please note that smartTimeFields (updated_at, created_at) are not converted to mysql-date format
at line 1642
bool|mixed
get_i18n_property(string $property, string $force_language = false)
Return the property translated property value if available
at line 317
string
get_model_name()
Returns the SQL table of this model (if available)
at line 296
string|bool
get_model_table_name(string $table_name = null)
Returns the SQL table of this model (if available)
at line 430
array
get_properties(bool $value_discovery = true)
Returns the complete properties array
at line 466
array
get_properties_meta(bool|string $field = false)
No description
at line 397
mixed
get_property(string $property_id, bool $get_raw_value = false)
No description
at line 1630
static mixed|null
get_request_cache(string $key)
Return Cache Entry if it exists
at line 287
string
get_table_name()
Returns the table name of this model.
at line 309
string
get_table_primary_key()
No description
at line 1481
string
get_updated_at_formatted()
Return a Formatted DateTime
at line 1696
bool
hasChangedProperties()
No description
at line 1673
bool
hasTouchedProperties()
No description
at line 199
init(bool $auto_load = true)
Initializes the model
at line 355
load()
No description
at line 698
protected bool
load_from_db(string $table_name, array|bool $key_fields = false)
No description
at line 932
ModelCollection|Model[]
populate_model_by_query(string $model_name, array|string $dbquery_result, string $population_mode = 'full', string $post_fill_function = 'update')
deprecated
deprecated
No description
at line 1246
protected array
process_find_query(mixed $select_field, mixed $query_params)
Execute Query of find() function. Can be modified by child class if necessary
in
ScopesTrait 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
at line 160
reload_schema()
Reloads the schema of the model
at line 773
protected bool
remove_from_db(string $table_name, array $key_fields = null)
No description
at line 1584
null
render()
Generic Renderer
at line 327
int|bool
save()
No description
at line 584
protected int|bool
save_to_db(string $table_name, array $params = array())
No description
at line 1266
bool|array
schema_values(mixed $field_name)
Provides a list of all values allowed for enumerations.
Returns FALSE if the field in question does not exist Returns TRUE for non enum fields Returns an array for enum fields with all available values
in
ScopesTrait at line 14
ModelCollection
scopeAll()
No description
at line 36
Model[]
scope_by_TABLE_COL_and_TABLE_COL2(mixed $COL1_VALUE, mixed $COL2_VALUE)
Returns unloaded ModelCollection
at line 36
void
self() $this find_by_id($id)
No description
in
ScopesTrait at line 71
void
setModelCollectionReference(ModelCollection $modelCollectionReference)
No description
at line 550
void
set_properties_from_array(array $input, array|bool $filter = false)
No description
at line 499
set_property(string|array $property_id, string|bool $property_value = false, bool $no_change = false)
Set a Property. If $property_id is an array and $property_value is false, set_property is called for each element in the array with the array key and value as params.
at line 1574
set_render_params(mixed $params = array())
Sets parameter that will be passed to the XUI helpers
at line 1614
static
set_request_cache(string $key, mixed $value)
Set Request Cache Entry
in
SortTrait at line 116
void
sortMoveTo(int $id, int $sortTo, array|null $conditions = [])
Sort this element to a specific position
in
SortTrait at line 28
sort_down(int $steps = 1, $params = array())
Decrease Sort Priority (Increases SORT value)
in
SortTrait at line 17
sort_up(int $steps = 1, $params = array())
Increase Sort Priority (Decreases SORT value)
at line 1536
stop_temporary_group_id_overwrite()
Stops the temporary overwrite of the table_group_id
at line 1511
void
temporarily_disable_table_group_id()
Temporarily disable the use of the group ID in all queries made
at line 1528
void
temporarily_enable_table_group_id()
Temporarily enables the use of the group ID in all queries made
at line 1444
string
to_json()
Returns the model as JSON array
at line 1455
string
to_string()
Returns the model as STRING
at line 1397
string
to_xml(array|bool $property_filter = false, bool|DOMDocument $doc = false, DOMElement $parent_element = null)
Returns an XML of all model properties
in
ScopesTrait at line 49
ModelCollection
unscope($scopeName = false)
Removes all scopes (including Default Scopes)
in
SortTrait at line 43
protected int
update_sort(mixed $id = false, string $direction = 'up', int $steps = 1, array $params = array())
Update the sort property for a given table (Move a record up/down)
at line 951
string|true
validate(array $fieldErrors)
No description