class Category extends DocumentModel implements SearchableDocumentModelInterface, MovableInterface, DoclinkableDocumentModelInterface, SoftDeleteInterface mixin CategoryDocumentation

Category Model

Traits

Trait SoftDeleteTrait to be used in Models, requires deleted_at column in database table

Trait Auditable to be used in Models

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

ForumController $mod
protected $model_name

var string Name of this model e.g. category or document

from  Model
string $table_name
protected bool $table_use_group_id
protected bool $table_auto_properties
protected string $table_primary_key from  Model
protected array $table_primary_compound_key from  Model
protected array $properties
protected array $properties_meta from  Model
protected array $markers from  Model
protected array $properties_null_values from  Model
bool|string $class_name from  Model
string $render_type from  Model
protected int $model_version

Hint your model version, this parameter might affect certain outcomes and behaviours This version string is added for backwards compatibility

from  Model
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

from  Model
protected array $render_params

Parameters that will be consigned to the XUI helper

from  Model
static string $find_by_separators from  Model
bool $loaded from  Model
bool $saved from  Model
protected array $changed from  Model
array $cache_function_result from  Model
static array $_request_cache from  Model
static protected bool $auditingDisabled

Is auditing disabled?

from  AuditableTrait
protected $auditExcludedProperties from  AuditableTrait
static bool $silent_mode from  DocumentModel
protected array $_update_document_index from  DocumentModel
protected DocumentIndex $documentIndex from  DocumentModel
DocumentIndexReference $rights_context

A document that can be used for accessing this document. Their must either be a reference between the rights_context and the document or the can_read of the document must actually evalute the rights context.

from  DocumentModel
static $rights_cache from  DocumentModel
protected $filled_by_array

Methods

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

No description

from  Model
__clone()

Magic Function Object Cloning Make sure object references are cleaned up as each object requires a clean and separate reference

from  Model
__construct(int|string|bool $category_id = null)

No description

mixed
__get(mixed $var)

No description

from  Model
__isset($name)

No description

from  Model
mixed
__set(mixed $var, mixed $value)

No description

from  Model
string
__toString()

String Representation of this object (calls for render method)

from  Model
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

from  Model
_scopeAll(Query $Query)

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

_scopeDefault(Query $Query)

Load default scopes

mixed
_scopeGroupId(Query $Query)

Applies Group ID Filtering

from  Model
_scopeNotDeleted(Query $query)

No description

_scopeSoftDeleted(Query $query)

No description

_scope_by(mixed $fn, mixed $parameters)

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

_scope_custom(mixed $fn)

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

AuditTrail|null
addAuditTrail(string $event = AuditableInterface::AUDIT_EVENT_MISC, string|null $customMessage = null)

No description

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  Model
add_scope_condition(Condition|Query|string $new_condition)

Adds a condition to scope the following find functions

Model[]
all(mixed $params = ['order_by'=>'COL1)

Return all models

from  Model
bool
allowIndexProcessingByHooks()

Returns whether the related document index should be processed by hooks or not.

bool
canForceDelete()

Makes sure the soft delete minimum keep duration is observed.

bool
can_create()

Can create threads

bool
can_moderate()

Can moderate threads within this category

bool
can_post()

Can create posts, edit own posts

bool
can_read()

Can read this category and its contents

bool
can_read_comments()

Returns whether this model should allow related comments or not. The user can still be denied comments when the comments policy "write" is not given to the user.

bool
can_read_comments_global(bool $return_hidden = false)

Checks whether this model can be commented on.

bool
can_read_global($return_hidden = false)

This function checks wether this document can be read by the logged in user and takes the full hierarchy (parent instances) and all possible rights contexts into account

bool
can_read_global_in_rights_context(DocumentIndexReference|false $rights_context = false)

Evaluates can_read_global inside a specific rights context

bool
can_reference()

Checks whether this document can be linked with read reference.

bool
can_see()

Can see defaults to can_read_global, but can be overridden by supporting modules (e.g. closed group should be visible but not readable)

bool
can_share()

Returns true if this document can be shared with groups or users.

bool
can_write()

Can create new categories or edit this category This is NOT can_post!

bool
can_write_global($return_hidden = false)

This function checks wether this document can be read by the logged in user and takes the full hierarchy (parent instances) and all possible rights contexts into account

bool
can_write_global_in_rights_context(DocumentIndexReference $rights_context)

Evaluates can_write_global inside a specific rights context

clear_cached_functions(string|bool $function = false)

Clears the cache for all functions or a specific one

from  Model
clear_properties()

No description

from  Model
array
convert_array_to_conditions(array $params = array())

Convert Assoc Multidimensional Array to Model Conditional Array

from  Model
int
count_all()

Returns the count of all models

from  Model
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

from  Model
int
count_by_group_id(int $group_id)

No description

string|void
debug(bool $show_markers = false, int $mode = 0)

No description

from  Model
bool
delete(bool $skip_rebuild = false)

No description

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.

from  Model
void
disable_silent_mode()

Disables the silent mode Objects in silent mode do not cause document index job queues, thus saving them is much more performant but does not update the search index, the wall or other similar system modules

void
disable_table_group_id()

Disable the use of the group ID in all queries made

from  Model
void
enable_silent_mode()

Sets the silent mode to true Objects in silent mode do not cause document index job queues, thus saving them is much more performant but does not update the search index, the wall or other similar system modules

void
enable_table_group_id()

Enable the use of the group ID in all queries made

from  Model
mixed
find(string $mode = 'all', mixed $conditions = false, mixed $query_params = false)

Find Function to find models using the passed condition

from  Model
ModelCollection|Model[]
find_all_by_TABLE_COL_and_TABLE_COL2($COL1_VALUE, $COL2_VALUE, $params=['order_by'=>'COL1, 5]] $)

Returns loaded ModelCollection

from  Model
ModelCollection
find_all_by_group_id(mixed $group_id)

No description

ModelCollection
find_all_by_p_id(int $id, array $options)

No description

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

from  Model
self
find_by_p_id_and_group_id(int $int, int $group_context)

No description

bool
forceDelete($force = false)

Will execute standard model delete method.

functionNameToQuery(string $query, array $parameters)

Converts a findby* function name to SQL query.

from  Model
array
getAuditEvents()

Get audit events

array
getAuditExcludeProperties()

Get the (Auditable) properties excluded from audit.

array
getAuditIncludeProperties()

Get the auditable properties to include in audit Defaults to all attributes in the DB Schema

getAuditTrail(int $limit = 50)

Get the last auditTrail records for current Model

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

from  Model
getCollectionByQuery(string $model_name, array|string $dbquery_result, string $population_mode = 'full', string $post_fill_function = 'update')

No description

from  Model
array
getDBSchema()

Get DB Schema if available

from  Model
int
getExpires()

No description

string
getExpiresAt()

No description

string
getExpiryDescription()

No description

getMod()

No description

getModelCollection()

Return a new unscoped model collection for further processing

from  Model
int|bool
getParentId()

Returns the parent id

array
getPropertyMarkers(bool $value_discovery = true)

Return properties and markers

from  Model
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

int
getSoftDeleteKeepDays()

Returns how many days the soft deleted documents are kept.

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

from  Model
get_all_accessible_categories(bool $restrict_to_this_category = false, $groupIds = [])

No description

get_category_dyn_tree()

No description

array
get_category_info()

No description

get_cf()

Return the cf library for this model type

string
get_created_at_formatted()

Return a Formatted DateTime

from  Model
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

from  Model
get_document_index()

Returns the related document index.

get_document_registry_info()

Return the information from the document registry This information contains additional meta data as well as relational information

get_document_tmp_folder()

Returns the path for this documents storage path This folder is automatically cleared when the document is removed

null
get_from_rights_cache(DocumentModel $document, string $right)

No description

bool|mixed
get_i18n_property(string $property, string $force_language = false)

Return the property translated property value if available

from  Model
mixed
get_is_empty()

No description

string
get_model_name()

Returns the SQL table of this model (if available)

from  Model
string|bool
get_model_table_name(string $table_name = null)

Returns the SQL table of this model (if available)

from  Model
mixed
get_parent()

No description

array
get_properties(bool $value_discovery = true)

Returns the complete properties array

from  Model
array
get_properties_meta(bool|string $field = false)

No description

from  Model
mixed
get_property(string $property_id, bool $get_raw_value = false)

No description

from  Model
get_recent_threads(int $limit = 10, bool $include_subcategories = true)

No description

static mixed|null
get_request_cache(string $key)

Return Cache Entry if it exists

from  Model
bool
get_silent_mode()

Returns if the silent mode is currently active Objects in silent mode do not cause document index job queues, thus saving them is much more performant but does not update the search index, the wall or other similar system modules

get_sub_categories()

Get Accessible Sub Categories

string
get_table_name()

Returns the table name of this model.

from  Model
string
get_table_primary_key()

No description

from  Model
get_threads(int $start = 0, int $limit = null, bool $cache = true, bool $include_subcategories = false, string $order_by = null, string $additionalWhere = 'TRUE')

Get Threads in this category

string
get_type_info()

No description

string
get_type_label()

No description

string
get_updated_at_formatted()

Return a Formatted DateTime

from  Model
mixed
get_user_id()

No description

get_xui_document()

Get XUI Document Representation

void
handle_reference_delete(DocumentIndexReference $reference, int $event_user_id = null)

Function is called in routine as part of the index event 'delete' Be aware that the original referenced document will not exist at time of calling This event/callback gives the opportunity to clean up the existing reference (e.g. you are referencing to this document and it you need to act upond this element being deleted)

bool
hasChangedProperties()

No description

from  Model
bool
hasTouchedProperties()

No description

from  Model
static bool
hasTreePolicy(ForumController $mod, int $catId, string $policy, bool|null $defaultAccess = null, bool $isRoot = false)

No description

init(bool $auto_load = true)

Initializes the model

from  Model
initAuditableTrait()

Init Method

initSoftDeleteTrait()

No description

bool
isAuditingEnabled()

Determine whether auditing is enabled.

bool
isBlackBoard()

No description

bool
isSoftDeleted()

No description

load()

No description

from  Model
bool
load_from_db(string $table_name, array|bool $key_fields = false)

No description

from  Model
void
mark_read()

Mark all Threads from this category as read

void
move($targetId)

Moves $this category to the target category with the given $targetId

onForceDelete()

No description

void
onRestore()

Called when the model is restored.

onSearchIndexUpdate(SearchIndexRecord $baseIndexRecord)

No description

onSoftDelete()

Implement to process event

populate_model_by_query(string $model_name, array|string $dbquery_result, string $population_mode = 'full', string $post_fill_function = 'update') deprecated

No description

from  Model
bool
array
process_find_query(mixed $select_field, mixed $query_params)

Execute Query of find() function. Can be modified by child class if necessary

from  Model
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

reload_schema()

Reloads the schema of the model

from  Model
remove_document_index()

removes index-entry of this model (only marking to delete).

bool
remove_from_db(string $table_name, array $key_fields = null)

No description

null
render()

Generic Renderer

resolve_rights_context(null|string $right = null, bool $apply = false)

Loads the rights context by checking all possible rights context and return it without apply on this model.

restore()

Recover soft deleted item

int|bool
save()

No description

int|bool
save_to_db(string $table_name, array $params = array())

No description

from  Model
bool|array
schema_values(mixed $field_name)

Provides a list of all values allowed for enumerations.

from  Model
scopeAll()

No description

scopeNotDeleted()

Default active scope.

scopeSoftDeleted()

Scope to return only soft deleted records.

Model[]
scope_by_TABLE_COL_and_TABLE_COL2(mixed $COL1_VALUE, mixed $COL2_VALUE)

Returns unloaded ModelCollection

from  Model
void
self() $this find_by_id($id)

No description

from  Model
setDocumentIndex(DocumentIndex $documentIndex)

Sets the related document index.

void
setModelCollectionReference(ModelCollection $modelCollectionReference)

No description

void
set_properties_from_array(array $input, array|bool $filter = false)

No description

from  Model
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.

from  Model
set_render_params(mixed $params = array())

Sets parameter that will be passed to the XUI helpers

from  Model
static 
set_request_cache(string $key, mixed $value)

Set Request Cache Entry

from  Model
null
set_to_rights_cache(DocumentModel $document, string $right, $value)

No description

int|bool|null
softDelete()

Mark this model as deleted by setting deleted_at to current time

void
sortMoveTo(int $id, int $sortTo, array|null $conditions = [])

Sort this element to a specific position

sort_down(int $steps = 1, $params = array())

Decrease Sort Priority (Increases SORT value)

sort_up(int $steps = 1, $params = array())

Increase Sort Priority (Decreases SORT value)

stop_temporary_group_id_overwrite()

Stops the temporary overwrite of the table_group_id

from  Model
void
temporarily_disable_table_group_id()

Temporarily disable the use of the group ID in all queries made

from  Model
void
temporarily_enable_table_group_id()

Temporarily enables the use of the group ID in all queries made

from  Model
string
to_json()

Returns the model as JSON array

from  Model
string
to_string()

Returns the model as STRING

from  Model
string
to_xml(array|bool $property_filter = false, bool|DOMDocument $doc = false, DOMElement $parent_element = null)

Returns an XML of all model properties

from  Model
triggerAuditEvent(Model $model, string $eventKey = AuditableInterface::OBSERVE_EVENT_SAVE)

TBD: Move this method to the audit model? and keep things slim in trait?

unscope($scopeName = false)

Removes all scopes (including Default Scopes)

void
update()

No description

bool
update_document_index(string $status = IndexEventInterface::EVENT_UPDATE)

updates the related index-item for itself (not global, only for this model!)

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)

string|true
validate(array $fieldErrors)

No description

from  Model
withDeleted()

No description

Details

in Model at line 994
ModelCollection|Model|Model[]|int __call(string $method, array $args = array())

No description

Parameters

string $method

method-name

array $args

params

Return Value

ModelCollection|Model|Model[]|int
  • Returns resource (find...) or affected rows (count..|deleted..)

in Model 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 107
__construct(int|string|bool $category_id = null)

No description

Parameters

int|string|bool $category_id

in Model at line 963
mixed __get(mixed $var)

No description

Parameters

mixed $var

Return Value

mixed

in Model at line 1601
__isset($name)

No description

Parameters

$name

in Model at line 976
mixed __set(mixed $var, mixed $value)

No description

Parameters

mixed $var
mixed $value

Return Value

mixed

in Model at line 1553
string __toString()

String Representation of this object (calls for render method)

Return Value

string

in Model 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

Parameters

string $function

method-name

array $args

params

Return Value

mixed

in ScopesTrait 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

in ScopesTrait at line 90
Query _scopeDefault(Query $Query)

Load default scopes

Parameters

Query $Query

Return Value

Query

in Model at line 1489
protected mixed _scopeGroupId(Query $Query)

Applies Group ID Filtering

Parameters

Query $Query

Return Value

mixed

in SoftDeleteTrait at line 34
_scopeNotDeleted(Query $query)

No description

Parameters

Query $query

in SoftDeleteTrait at line 40
_scopeSoftDeleted(Query $query)

No description

Parameters

Query $query

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

Parameters

mixed $fn
mixed $parameters

Return Value

ModelCollection

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

Parameters

mixed $fn

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

Return Value

ModelCollection

in AuditableTrait at line 97
AuditTrail|null addAuditTrail(string $event = AuditableInterface::AUDIT_EVENT_MISC, string|null $customMessage = null)

No description

Parameters

string $event
string|null $customMessage

Return Value

AuditTrail|null

Exceptions

AuditException

See also

AuditableInterface::addAuditTrail

in Model 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

Parameters

string $property

Property of models to format

string $format

Format Type (e.g. money, date, ...)

array $options

Additional format options

in ScopesTrait 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

in Model at line 36
Model[] all(mixed $params = ['order_by'=>'COL1)

Return all models

Parameters

mixed $params

Return Value

Model[]

in DocumentModel at line 880
bool allowIndexProcessingByHooks()

Returns whether the related document index should be processed by hooks or not.

Return Value

bool

in SoftDeleteTrait at line 135
bool canForceDelete()

Makes sure the soft delete minimum keep duration is observed.

e.g. document was deleted 30 days ago, but the keep duration was increased to 120 days.

Return Value

bool

at line 689
bool can_create()

Can create threads

Return Value

bool

at line 672
bool can_moderate()

Can moderate threads within this category

Return Value

bool

at line 681
bool can_post()

Can create posts, edit own posts

Return Value

bool

at line 655
bool can_read()

Can read this category and its contents

Return Value

bool

in DocumentModel at line 392
bool can_read_comments()

Returns whether this model should allow related comments or not. The user can still be denied comments when the comments policy "write" is not given to the user.

Return Value

bool

TRUE if this model can be commented, false if not.

in DocumentModel at line 404
final bool can_read_comments_global(bool $return_hidden = false)

Checks whether this model can be commented on.

Parameters

bool $return_hidden

Return Value

bool

See also

can_read_comments

in DocumentModel at line 329
final bool can_read_global($return_hidden = false)

This function checks wether this document can be read by the logged in user and takes the full hierarchy (parent instances) and all possible rights contexts into account

Parameters

$return_hidden

bool Flags if hidden elements may be returned or not

Return Value

bool

in DocumentModel at line 376
bool can_read_global_in_rights_context(DocumentIndexReference|false $rights_context = false)

Evaluates can_read_global inside a specific rights context

Parameters

DocumentIndexReference|false $rights_context

The rights context for which to check the access rights

Return Value

bool

in DocumentModel at line 743
bool can_reference()

Checks whether this document can be linked with read reference.

This method also considers the group context and parent context of the mod owns this document to apply module specific reference policies.

Return Value

bool

in DocumentModel at line 718
bool can_see()

Can see defaults to can_read_global, but can be overridden by supporting modules (e.g. closed group should be visible but not readable)

Return Value

bool

in DocumentModel at line 451
bool can_share()

Returns true if this document can be shared with groups or users.

This method can be overridden by subclass.

Return Value

bool

at line 664
bool can_write()

Can create new categories or edit this category This is NOT can_post!

Return Value

bool

in DocumentModel at line 461
final bool can_write_global($return_hidden = false)

This function checks wether this document can be read by the logged in user and takes the full hierarchy (parent instances) and all possible rights contexts into account

Parameters

$return_hidden

bool Flags if hidden elements may be returned or not

Return Value

bool

in DocumentModel at line 494
bool can_write_global_in_rights_context(DocumentIndexReference $rights_context)

Evaluates can_write_global inside a specific rights context

Parameters

DocumentIndexReference $rights_context

The rights context for which to check the access rights

Return Value

bool

in Model at line 1051
clear_cached_functions(string|bool $function = false)

Clears the cache for all functions or a specific one

Parameters

string|bool $function

in Model at line 567
clear_properties()

No description

in Model at line 1228
array convert_array_to_conditions(array $params = array())

Convert Assoc Multidimensional Array to Model Conditional Array

Parameters

array $params

['id'=>1,'type'=>'active']

Return Value

array

["id = 1","type = 'active'"]

in Model at line 36
int count_all()

Returns the count of all models

Return Value

int

in Model 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

Parameters

mixed $COL1_VALUE
mixed $COL2_VALUE

Return Value

Model[]

at line 34
int count_by_group_id(int $group_id)

No description

Parameters

int $group_id

Return Value

int

in Model at line 808
string|void debug(bool $show_markers = false, int $mode = 0)

No description

Parameters

bool $show_markers

show markers as well?

int $mode

(0 - print, 1 - return, 2 and 3 - Special PopUps)

Return Value

string|void

at line 541
bool delete(bool $skip_rebuild = false)

No description

Parameters

bool $skip_rebuild

Return Value

bool

was delete successful?

Exceptions

Exception

in Model 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.

Parameters

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'

Return Value

int

in DocumentModel at line 68
void disable_silent_mode()

Disables the silent mode Objects in silent mode do not cause document index job queues, thus saving them is much more performant but does not update the search index, the wall or other similar system modules

Return Value

void

in Model at line 1497
void disable_table_group_id()

Disable the use of the group ID in all queries made

Return Value

void

in DocumentModel at line 57
void enable_silent_mode()

Sets the silent mode to true Objects in silent mode do not cause document index job queues, thus saving them is much more performant but does not update the search index, the wall or other similar system modules

Return Value

void

in Model at line 1520
void enable_table_group_id()

Enable the use of the group ID in all queries made

Return Value

void

in Model at line 1094
mixed find(string $mode = 'all', mixed $conditions = false, mixed $query_params = false)

Find Function to find models using the passed condition

Parameters

string $mode

Find mode (all/first/count)

mixed $conditions

Conditions passed as field query string (e.g. 'id=1 and name="TEST"') or as parameter array: First Element contains query, 2..n contain Parameters

mixed $query_params

Further query parameters (e.g. limit, order_by, request_cache)

Return Value

mixed

by_mode [ ALL: ModelCollection; FIRST: Model | boolean false on fail ]

in Model 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

Parameters

$COL1_VALUE
$COL2_VALUE
$params=['order_by'=>'COL1
5]] $

Return Value

ModelCollection|Model[]

at line 34
ModelCollection find_all_by_group_id(mixed $group_id)

No description

Parameters

mixed $group_id

Return Value

ModelCollection

at line 34
ModelCollection find_all_by_p_id(int $id, array $options)

No description

Parameters

int $id
array $options

Return Value

ModelCollection

in Model 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

Parameters

mixed $COL_VALUE
mixed $params

Return Value

Model

at line 34
self find_by_p_id_and_group_id(int $int, int $group_context)

No description

Parameters

int $int
int $group_context

Return Value

self

in SoftDeleteTrait at line 73
bool forceDelete($force = false)

Will execute standard model delete method.

Parameters

$force

Return Value

bool

in Model at line 1286
Query functionNameToQuery(string $query, array $parameters)

Converts a findby* function name to SQL query.

Parameters

string $query
array $parameters

Return Value

Query

Returns a Query Object with the relevant WHERE Scopes

in AuditableTrait at line 166
array getAuditEvents()

Get audit events

Return Value

array

in AuditableTrait at line 220
array getAuditExcludeProperties()

Get the (Auditable) properties excluded from audit.

Defaults to primary_key and timestamps

Return Value

array

in AuditableTrait at line 199
array getAuditIncludeProperties()

Get the auditable properties to include in audit Defaults to all attributes in the DB Schema

Return Value

array

in AuditableTrait at line 183
AuditTrail[]|ModelCollection getAuditTrail(int $limit = 50)

Get the last auditTrail records for current Model

Parameters

int $limit

Return Value

AuditTrail[]|ModelCollection

in Model 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

Parameters

bool $returnOldValues

Return values before change or current value after change?

Return Value

array

['property_key'=>'property_value']

in Model at line 839
ModelCollection getCollectionByQuery(string $model_name, array|string $dbquery_result, string $population_mode = 'full', string $post_fill_function = 'update')

No description

Parameters

string $model_name

Model Name, eg.g. category

array|string $dbquery_result

dbquery Result with one record per model OR SQL query

string $population_mode

Population Mode (full or id) - If set to full all object data will be used to fill the objects, if set to id each model will be initialized with the corresponding record id as parameter

string $post_fill_function

Post-Fill Function is triggered on the each model after an object has been filled with data

Return Value

ModelCollection

Always eturns a model collection

in Model at line 187
array getDBSchema()

Get DB Schema if available

Return Value

array

at line 890
int getExpires()

No description

Return Value

int

at line 897
string getExpiresAt()

No description

Return Value

string

at line 904
string getExpiryDescription()

No description

Return Value

string

in DocumentModel at line 46
Controller getMod()

No description

Return Value

Controller

in Model at line 1066
ModelCollection getModelCollection()

Return a new unscoped model collection for further processing

Return Value

ModelCollection

at line 408
int|bool getParentId()

Returns the parent id

Return Value

int|bool

$parent_id

in Model at line 450
array getPropertyMarkers(bool $value_discovery = true)

Return properties and markers

Parameters

bool $value_discovery

Return Value

array

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

Return Value

Query

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

Return Value

string

in SoftDeleteTrait at line 124
int getSoftDeleteKeepDays()

Returns how many days the soft deleted documents are kept.

Return Value

int

in Model 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

Parameters

bool $returnOldValues

Return values before change or current value after change?

Return Value

array

['property_key'=>'property_value']

at line 586
ModelCollection get_all_accessible_categories(bool $restrict_to_this_category = false, $groupIds = [])

No description

Parameters

bool $restrict_to_this_category
$groupIds

Return Value

ModelCollection

at line 610
get_category_dyn_tree()

No description

at line 417
array get_category_info()

No description

Return Value

array

post_info

Exceptions

Exception

in DocumentModel at line 830
DocumentItem get_cf()

Return the cf library for this model type

Return Value

DocumentItem

The content first library

in Model at line 1472
string get_created_at_formatted()

Return a Formatted DateTime

Return Value

string

in Model 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

Return Value

array

['id'=>'1','example_prop'=>'example_val','created_at'=>'']

in DocumentModel at line 119
DocumentIndex|null get_document_index()

Returns the related document index.

Return Value

DocumentIndex|null

in DocumentModel at line 774
DocumentRegistry get_document_registry_info()

Return the information from the document registry This information contains additional meta data as well as relational information

Return Value

DocumentRegistry

in DocumentModel at line 218
get_document_tmp_folder()

Returns the path for this documents storage path This folder is automatically cleared when the document is removed

in DocumentModel at line 279
null get_from_rights_cache(DocumentModel $document, string $right)

No description

Parameters

DocumentModel $document
string $right

e.g. read

Return Value

null

in Model at line 1642
bool|mixed get_i18n_property(string $property, string $force_language = false)

Return the property translated property value if available

Parameters

string $property

e.g. title_i18n

string $force_language

FALSE will use current user language, otherwise the passed LOCALE will be used

Return Value

bool|mixed

at line 123
mixed get_is_empty()

No description

Return Value

mixed

Exceptions

ContentException

in Model at line 317
string get_model_name()

Returns the SQL table of this model (if available)

Return Value

string

Full qualified table name e.g. xmi_crm01_contact

in Model at line 296
string|bool get_model_table_name(string $table_name = null)

Returns the SQL table of this model (if available)

Parameters

string $table_name

Simple table without instance or system prefix

Return Value

string|bool

Full qualified table name e.g. xmi_crm01_contact

at line 396
mixed get_parent()

No description

Return Value

mixed

object or false

in Model at line 430
array get_properties(bool $value_discovery = true)

Returns the complete properties array

Parameters

bool $value_discovery

Retrieve all values by get_property access method

Return Value

array

in Model at line 466
array get_properties_meta(bool|string $field = false)

No description

Parameters

bool|string $field

if given returns the meta for that field

Return Value

array

in Model at line 397
mixed get_property(string $property_id, bool $get_raw_value = false)

No description

Parameters

string $property_id

Marker ID

bool $get_raw_value

deactivate Marker-Function gets triggered

Return Value

mixed

Marker Content

at line 778
ModelCollection get_recent_threads(int $limit = 10, bool $include_subcategories = true)

No description

Parameters

int $limit
bool $include_subcategories

Return Value

ModelCollection

of post objects

Exceptions

ContentException

in Model at line 1630
static mixed|null get_request_cache(string $key)

Return Cache Entry if it exists

Parameters

string $key

Cache Key

Return Value

mixed|null

in DocumentModel at line 79
bool get_silent_mode()

Returns if the silent mode is currently active Objects in silent mode do not cause document index job queues, thus saving them is much more performant but does not update the search index, the wall or other similar system modules

Return Value

bool

at line 730
ModelCollection get_sub_categories()

Get Accessible Sub Categories

Return Value

ModelCollection

in Model at line 287
string get_table_name()

Returns the table name of this model.

Return Value

string

in Model at line 309
string get_table_primary_key()

No description

Return Value

string

Primary Key Field in DB

at line 762
ModelCollection get_threads(int $start = 0, int $limit = null, bool $cache = true, bool $include_subcategories = false, string $order_by = null, string $additionalWhere = 'TRUE')

Get Threads in this category

Parameters

int $start

Default:0

int $limit

Default:ALL

bool $cache

Should result be cached?

bool $include_subcategories
string $order_by
string $additionalWhere

Return Value

ModelCollection

Exceptions

ContentException

at line 200
string get_type_info()

No description

Return Value

string

Type Info [Idea,Question,Thread,Black Board]

at line 174
string get_type_label()

No description

Return Value

string

Type Label [Idea,Question,Thread,Announcement]

in Model at line 1481
string get_updated_at_formatted()

Return a Formatted DateTime

Return Value

string

at line 722
mixed get_user_id()

No description

Return Value

mixed

in DocumentModel at line 800
Document get_xui_document()

Get XUI Document Representation

Return Value

Document

in DocumentModel at line 852
void handle_reference_delete(DocumentIndexReference $reference, int $event_user_id = null)

Function is called in routine as part of the index event 'delete' Be aware that the original referenced document will not exist at time of calling This event/callback gives the opportunity to clean up the existing reference (e.g. you are referencing to this document and it you need to act upond this element being deleted)

Can be implemented in document models

Parameters

DocumentIndexReference $reference
int $event_user_id

User ID of user who triggered the delete

Return Value

void

in Model at line 1696
bool hasChangedProperties()

No description

Return Value

bool

in Model at line 1673
bool hasTouchedProperties()

No description

Return Value

bool

at line 702
static bool hasTreePolicy(ForumController $mod, int $catId, string $policy, bool|null $defaultAccess = null, bool $isRoot = false)

No description

Parameters

ForumController $mod
int $catId
string $policy
bool|null $defaultAccess
bool $isRoot

Return Value

bool

in Model at line 199
init(bool $auto_load = true)

Initializes the model

Parameters

bool $auto_load

If set to false the init will NOT TRIGGER load in case of a set primary key property

in AuditableTrait at line 43
initAuditableTrait()

Init Method

in SoftDeleteTrait at line 30
initSoftDeleteTrait()

No description

in AuditableTrait at line 233
bool isAuditingEnabled()

Determine whether auditing is enabled.

Defaults to true for Frontend/UI Actions and false for CLI/Console Actions

Return Value

bool

at line 883
bool isBlackBoard()

No description

Return Value

bool

in SoftDeleteTrait at line 107
bool isSoftDeleted()

No description

Return Value

bool

in Model at line 355
load()

No description

in Model at line 698
protected bool load_from_db(string $table_name, array|bool $key_fields = false)

No description

Parameters

string $table_name

Table Name

array|bool $key_fields

Key fields which should be used as WHERE condition

Return Value

bool

at line 290
void mark_read()

Mark all Threads from this category as read

Return Value

void

Exceptions

Exception

at line 259
void move($targetId)

Moves $this category to the target category with the given $targetId

Parameters

$targetId

Return Value

void

Exceptions

Exception

in SoftDeleteTrait at line 154
onForceDelete()

No description

at line 569
void onRestore()

Called when the model is restored.

Return Value

void

at line 276
SearchIndexRecord onSearchIndexUpdate(SearchIndexRecord $baseIndexRecord)

No description

Parameters

SearchIndexRecord $baseIndexRecord

Return Value

SearchIndexRecord

in SoftDeleteTrait at line 147
onSoftDelete()

Implement to process event

in Model 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 Please use getCollectionByQuery() instead

No description

Parameters

string $model_name

Model Name, eg.g. category

array|string $dbquery_result

dbquery Result with one record per model OR SQL query

string $population_mode

Population Mode (full or id) - If set to full all object data will be used to fill the objects, if set to id each model will be initialized with the corresponding record id as parameter

string $post_fill_function

Post-Fill Function is triggered on the each model after an object has been filled with data

Return Value

ModelCollection|Model[]

empty array if none found and compatibility-mode on (xelos model_version < 1)

at line 914
bool preventPresentationAfterIndexing()

No description

Return Value

bool

in Model 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

Parameters

mixed $select_field
mixed $query_params

Return Value

array

dbquery Result

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

Parameters

$scopeName

Return Value

void

in Model at line 160
reload_schema()

Reloads the schema of the model

in DocumentModel at line 205
final remove_document_index()

removes index-entry of this model (only marking to delete).

the real delete operation will be triggered by the document_index_deamon. (will be automatically trigged at: DocumentModel->delete())

Exceptions

AuditException

in DocumentModel at line 234
protected bool remove_from_db(string $table_name, array $key_fields = null)

No description

Parameters

string $table_name

Table Name

array $key_fields

Key fields which should be used as WHERE condition

Return Value

bool

Exceptions

Exception

in DocumentModel at line 789
null render()

Generic Renderer

Return Value

null

in DocumentModel at line 687
mixed|DocumentIndexReference resolve_rights_context(null|string $right = null, bool $apply = false)

Loads the rights context by checking all possible rights context and return it without apply on this model.

Parameters

null|string $right

Keep empty for read and write or set read or write

bool $apply

Return Value

mixed|DocumentIndexReference

in SoftDeleteTrait at line 91
restore()

Recover soft deleted item

at line 228
int|bool save()

No description

Return Value

int|bool

Integer represents ID of saved record, true for successful modifications (update, delete), false otherwise

Exceptions

Exception

in Model at line 584
protected int|bool save_to_db(string $table_name, array $params = array())

No description

Parameters

string $table_name

Table Name

array $params

Return Value

int|bool

Integer represents ID of saved record, true for successful modifications (update, delete), false otherwise

Exceptions

DatabaseException

in Model 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

Parameters

mixed $field_name

The name of the field to examine

Return Value

bool|array

in ScopesTrait at line 14
ModelCollection scopeAll()

No description

Return Value

ModelCollection

in SoftDeleteTrait at line 28
ModelCollection scopeNotDeleted()

Default active scope.

Return Value

ModelCollection

in SoftDeleteTrait at line 28
ModelCollection scopeSoftDeleted()

Scope to return only soft deleted records.

Return Value

ModelCollection

in Model at line 36
Model[] scope_by_TABLE_COL_and_TABLE_COL2(mixed $COL1_VALUE, mixed $COL2_VALUE)

Returns unloaded ModelCollection

Parameters

mixed $COL1_VALUE
mixed $COL2_VALUE

Return Value

Model[]

in Model at line 36
void self() $this find_by_id($id)

No description

Parameters

) $this find_by_id($id

Return Value

void

in DocumentModel at line 132
setDocumentIndex(DocumentIndex $documentIndex)

Sets the related document index.

Parameters

DocumentIndex $documentIndex

in ScopesTrait at line 71
void setModelCollectionReference(ModelCollection $modelCollectionReference)

No description

Parameters

ModelCollection $modelCollectionReference

Return Value

void

in Model at line 550
void set_properties_from_array(array $input, array|bool $filter = false)

No description

Parameters

array $input

Assoc array with field_id=>value

array|bool $filter

Filter array with 1-dim field_id's, only these keys from input will be set

Return Value

void

in Model 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.

Parameters

string|array $property_id

Marker ID (Can also be an Array)

string|bool $property_value

Value

bool $no_change

Value return void

in Model at line 1574
set_render_params(mixed $params = array())

Sets parameter that will be passed to the XUI helpers

Parameters

mixed $params

in Model at line 1614
static set_request_cache(string $key, mixed $value)

Set Request Cache Entry

Parameters

string $key
mixed $value

in DocumentModel at line 306
null set_to_rights_cache(DocumentModel $document, string $right, $value)

No description

Parameters

DocumentModel $document
string $right

e.g. read

$value

Return Value

null

in SoftDeleteTrait at line 54
int|bool|null softDelete()

Mark this model as deleted by setting deleted_at to current time

Return Value

int|bool|null

in SortTrait at line 116
void sortMoveTo(int $id, int $sortTo, array|null $conditions = [])

Sort this element to a specific position

Parameters

int $id

The record ID you intend to move, use 0 if your model has not been saved yet and you intend to save it to the given sort

int $sortTo

Move element to this new position, should be > 0

array|null $conditions

Add conditions

Return Value

void

in SortTrait at line 28
sort_down(int $steps = 1, $params = array())

Decrease Sort Priority (Increases SORT value)

Parameters

int $steps
$params

in SortTrait at line 17
sort_up(int $steps = 1, $params = array())

Increase Sort Priority (Decreases SORT value)

Parameters

int $steps
$params

in Model at line 1536
stop_temporary_group_id_overwrite()

Stops the temporary overwrite of the table_group_id

in Model at line 1511
void temporarily_disable_table_group_id()

Temporarily disable the use of the group ID in all queries made

Return Value

void

in Model at line 1528
void temporarily_enable_table_group_id()

Temporarily enables the use of the group ID in all queries made

Return Value

void

in Model at line 1444
string to_json()

Returns the model as JSON array

Return Value

string

Returns model string

in Model at line 1455
string to_string()

Returns the model as STRING

Return Value

string

Returns model as string

in Model 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

Parameters

array|bool $property_filter

if given, only the properties in this array are added

bool|DOMDocument $doc

used from model_collection to add this model to an existing structure

DOMElement $parent_element

to add this model as Child, necessary if doc is given

Return Value

string

Returns formatted XML string

in AuditableTrait at line 59
triggerAuditEvent(Model $model, string $eventKey = AuditableInterface::OBSERVE_EVENT_SAVE)

TBD: Move this method to the audit model? and keep things slim in trait?

Parameters

Model $model
string $eventKey

Exceptions

AuditException

in ScopesTrait 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

at line 115
void update()

No description

Return Value

void

in DocumentModel at line 143
final bool update_document_index(string $status = IndexEventInterface::EVENT_UPDATE)

updates the related index-item for itself (not global, only for this model!)

Parameters

string $status

Defaults to IndexEventInterface::EVENT_UPDATE

Return Value

bool

was saving of index-item successful?

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)

Parameters

mixed $id

(The record ID you intend to move )

string $direction

(The direction you want the record to move)

int $steps

(The amount of steps you want the record to move)

array $params

key 'filter' optional conditions passed as a key-value array. Key 'order_by' additional ORDER string append to ORDER BY sort

Return Value

int

new Sort Value

in Model at line 951
string|true validate(array $fieldErrors)

No description

Parameters

array $fieldErrors

Field Errors can be returned via reference as array(array('field'=>$field, 'err_msg'=>$error)) or array($field => $error)

Return Value

string|true

TRUE if everything is correct, String for Error-Message

in SoftDeleteTrait at line 46
withDeleted()

No description