Category
class Category extends Category
Class Category
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
| Controller read-only | $mod | from AuditableTrait | |
| protected | $model_name | var string Name of this model e.g. category or document |
from Model |
| string read-only | $table_name | from AuditableTrait | |
| protected bool | $table_use_group_id | from Category | |
| protected bool | $table_auto_properties | from Category | |
| protected string | $table_primary_key | from Model | |
| protected array | $table_primary_compound_key | from Model | |
| array read-only | $properties | from AuditableTrait | |
| 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 | from Category | |
| 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 | |
| static protected Category[][] | $rights_context_categories | from Category | |
| static protected array | $tree | from Category | |
| bool deprecated | $duplicate | This is coming from group template init |
from Category |
Methods
Magic Function Object Cloning Make sure object references are cleaned up as each object requires a clean and separate reference
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
No description
Attaches a file, creating a document within this category
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
Returns whether the related document index should be processed by hooks or not.
Returns if current user can read this category
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.
Checks whether this model can be commented on.
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
Evaluates can_read_global inside a specific rights context
Checks whether this document can be linked with read reference.
Can see defaults to can_read_global, but can be overridden by supporting modules (e.g. closed group should be visible but not readable)
Returns true if this document can be shared with groups or users.
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
Evaluates can_write_global inside a specific rights context
Clears the cache for all functions or a specific one
Convert Assoc Multidimensional Array to Model Conditional Array
Returns the count of all models with the specific column value
Creates a category for the instance in the xfs root category
Decreases the size of this and all affected folders.
on the desired collection.
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
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
Evaluates the first possible template ID from the category (and parent categories) and returns it.
Find Function to find models using the passed condition
Returns loaded ModelCollection
No description
No description
No description
No description
Returns all models with a specific column value. Query params can be e.g. order_by
Converts a findby* function name to SQL query.
Get the (Auditable) properties excluded from audit.
Get the auditable properties to include in audit Defaults to all attributes in the DB Schema
Get the last auditTrail records for current Model
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
Return a new unscoped model collection for further processing
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
Lookup Category ID
No description
Function designed to work well with cat_selector form elements
Function designed to work well with cat_selector form elements
recursive function, returns all child ids of category
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 information from the document registry This information contains additional meta data as well as relational information
Returns the path for this documents storage path This folder is automatically cleared when the document is removed
Return the property translated property value if available
Returns the SQL table of this model (if available)
Returns an array of ancestor categories tree arrays for this category.
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
Gets all Child-Categories of this Category, with the same Group-Context (important for Root-Categories)
No description
will determine a new folder name, which isn't set in the same parent-Category
Returns an instance specific category as system folder from system dms.
Increases the size of this and all affected folders.
Checks if the current category has a name-duplicate in its parent-category.
Returns whether this category is one of a personal workspace folder.
Recursively creates categories.
No description
Execute Query of find() function. Can be modified by child class if necessary
Checks the policies of the current folder and saves the information as bit in has_policy property
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
removes index-entry of this model (only marking to delete).
Resolves the category id, taking into consideration potential rights context prefixes.
Resolve the link of a category Return the category itself if it isn't a link
Loads the rights context by checking all possible rights context and return it without apply on this model.
Provides a list of all values allowed for enumerations.
Returns unloaded ModelCollection
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
Sort this element to a specific position
Decrease Sort Priority (Increases SORT value)
Increase Sort Priority (Decreases SORT value)
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 an XML of all model properties
TBD: Move this method to the audit model? and keep things slim in trait?
Removes all scopes (including Default Scopes)
updates the related index-item for itself (not global, only for this model!)
Update the sort property for a given table (Move a record up/down)
checks for a policy in this category-context
Details
in
Model at line 994
ModelCollection|Model|Model[]|int
__call(string $method, array $args = array())
No description
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
in
Model at line 145
__construct(int|bool $id = false)
No description
in
Model at line 963
mixed
__get(mixed $var)
No description
in
Model at line 1601
__isset($name)
No description
in
Model at line 976
mixed
__set(mixed $var, mixed $value)
No description
in
Model at line 1553
string
__toString()
String Representation of this object (calls for render method)
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
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
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
in
AuditableTrait at line 97
AuditTrail|null
addAuditTrail(string $event = AuditableInterface::AUDIT_EVENT_MISC, string|null $customMessage = null)
No description
in
Category at line 1076
add_category($name)
Creates a sub directory from a given name
in
Category at line 1107
add_file(DocumentIndex $xfs_document_index)
Attaches a file, creating a document within this category
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
in
ScopesTrait at line 32
ModelCollection
add_scope_condition(Condition|Query|string $new_condition)
Adds a condition to scope the following find functions
in
Model at line 36
Model[]
all(mixed $params = ['order_by'=>'COL1)
Return all models
in
DocumentModel at line 880
bool
allowIndexProcessingByHooks()
Returns whether the related document index should be processed by hooks or not.
in
Category at line 512
bool
can_delete(int $id = null)
No description
in
Category at line 326
bool
can_read(int $id = null, bool $skip_system_folder_check = false)
Returns if current user can read this category
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.
in
DocumentModel at line 404
final bool
can_read_comments_global(bool $return_hidden = false)
Checks whether this model can be commented on.
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
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
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.
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)
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.
in
Category at line 386
bool
can_write(int|bool $id = false)
Returns if current user can write this category
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
in
DocumentModel at line 494
bool
can_write_global_in_rights_context(DocumentIndexReference $rights_context)
Evaluates can_write_global inside a specific rights context
in
Model at line 1051
clear_cached_functions(string|bool $function = false)
Clears the cache for all functions or a specific one
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
in
Model at line 36
int
count_all()
Returns the count of all models
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
in
Category at line 1324
Category
create_xfs_category(string $instance_id)
Creates a category for the instance in the xfs root category
in
Model at line 808
string|void
debug(bool $show_markers = false, int $mode = 0)
No description
in
Category at line 1313
decrease_folder_size(int $size, int|null $updated_at = null, null|Category $target_category = null)
Decreases the size of this and all affected folders.
If the file was moved from one in another folder, the target category (structure) will be used to determine the folders that are not affected of the size calculation.
in
Category at line 218
bool
delete(int|string $limit = 'auto')
Delete Category
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.
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
in
Model at line 1497
void
disable_table_group_id()
Disable the use of the group ID in all queries made
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
in
Model at line 1520
void
enable_table_group_id()
Enable the use of the group ID in all queries made
in
Category at line 1407
int
evaluateTemplateId()
Evaluates the first possible template ID from the category (and parent categories) and returns it.
This method takes into account, that the inheritance chain might be broken and, therefore, returns 0. Returns null if something went wrong with fetching the category (and potential parent categories).
in
Category at line 1115
fill_structure(Category[]|array $category_lookup = null, bool $auto_save = true)
No description
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
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
in
Category at line 37
Category[]
find_all_by_group_id(int|int[] $group_id, mixed $query_params)
No description
in
Category at line 37
Category[]
find_all_by_group_id_and_pid(int|int[] $group_id, int|int[] $pid, mixed $query_params)
No description
in
Category at line 37
Category[]
find_all_by_pid(int $id)
No description
in
Category at line 37
Category[]
find_all_by_pid_and_group_id(string $pid, int $group_id, array $options = [])
No description
in
Category at line 37
Category[]
find_all_by_reference_id(int $reference_index_id)
No description
in
Category at line 37
Category[]
find_all_by_structure(string|string[] $group_id, mixed $query_params)
No description
in
Category at line 37
Category[]
find_all_by_system_folder(int $int)
No description
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
in
Category at line 37
Category
find_by_foldername_and_pid(mixed $sub_folder, int $id)
No description
in
Category at line 37
Category
find_by_xfs_source(mixed $xfs_source, mixed $query_params)
No description
in
Model at line 1286
Query
functionNameToQuery(string $query, array $parameters)
Converts a findby* function name to SQL query.
in
AuditableTrait at line 166
array
getAuditEvents()
Get audit events
in
AuditableTrait at line 220
array
getAuditExcludeProperties()
Get the (Auditable) properties excluded from audit.
Defaults to primary_key and timestamps
in
AuditableTrait at line 199
array
getAuditIncludeProperties()
Get the auditable properties to include in audit Defaults to all attributes in the DB Schema
in
AuditableTrait at line 183
AuditTrail[]|ModelCollection
getAuditTrail(int $limit = 50)
Get the last auditTrail records for current Model
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
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
in
Model at line 187
array
getDBSchema()
Get DB Schema if available
in
DocumentModel at line 46
Controller
getMod()
No description
in
Model at line 1066
ModelCollection
getModelCollection()
Return a new unscoped model collection for further processing
in
Model 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
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
in
Category at line 679
array|bool
get_categories_by_pid($pid = 0, bool $sort_by_name = false)
Lookup Category ID
in
Category at line 709
array
get_category_dyn_tree(array $params = [])
Get categories for navigation
in
Category at line 813
array
get_category_tree(Category $parent = null, int $levels = null, bool $with_objects = true, bool $hide_system_folders = true, string $sec_level = 'read')
No description
in
Category at line 748
array
get_catselect_tree()
Function designed to work well with cat_selector form elements
in
Category at line 757
array
get_catselect_tree_write()
Function designed to work well with cat_selector form elements
in
DocumentModel at line 830
DocumentItem
get_cf()
Return the cf library for this model type
in
Category at line 1046
array
get_child_ids(int|bool $start_id = false)
recursive function, returns all child ids of category
in
Model at line 1472
string
get_created_at_formatted()
Return a Formatted DateTime
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
in
Category at line 1208
Category
get_default_category()
Returns the default category for the current folder
in
DocumentModel at line 119
DocumentIndex|null
get_document_index()
Returns the related document index.
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
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
Category at line 638
ModelCollection|Document[]
get_documents()
get related documents of this category
in
DocumentModel at line 279
null
get_from_rights_cache(DocumentModel $document, string $right)
No description
in
Model at line 1642
bool|mixed
get_i18n_property(string $property, string $force_language = false)
Return the property translated property value if available
in
Model at line 317
string
get_model_name()
Returns the SQL table of this model (if available)
in
Model at line 296
string|bool
get_model_table_name(string $table_name = null)
Returns the SQL table of this model (if available)
in
Category at line 901
array
get_parent_categories(int $limit = 10, bool $category_id_path = false)
Returns an array of ancestor categories tree arrays for this category.
These tree arrays contain all information relative for building a dyn tree.
in
Category at line 1090
string
get_path(bool $category_id = false)
No description
in
Model at line 430
array
get_properties(bool $value_discovery = true)
Returns the complete properties array
in
Model at line 466
array
get_properties_meta(bool|string $field = false)
No description
in
Model at line 397
mixed
get_property(string $property_id, bool $get_raw_value = false)
No description
in
Model at line 1630
static mixed|null
get_request_cache(string $key)
Return Cache Entry if it exists
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
in
Category at line 314
Category[]|ModelCollection|null
get_sub_categories()
Gets all Child-Categories of this Category, with the same Group-Context (important for Root-Categories)
in
Model at line 287
string
get_table_name()
Returns the table name of this model.
in
Model at line 309
string
get_table_primary_key()
No description
in
Category at line 78
string|int
get_thumbnail_document(bool $force_new = false)
No description
in
Category at line 768
mixed
get_tree_data(Category|null $parent = null, int $levels = 0, bool $hideSystemFolders = true)
No description
in
Category at line 620
string
get_uniqe_foldername(string $old_name = 'unnamed')
will determine a new folder name, which isn't set in the same parent-Category
in
Model at line 1481
string
get_updated_at_formatted()
Return a Formatted DateTime
in
Category at line 1357
Category
get_xfs_instance_category($instance_id)
Returns an instance specific category as system folder from system dms.
If the category is not exists, it will be create.
in
DocumentModel at line 800
Document
get_xui_document()
Get XUI Document Representation
in
Category at line 291
void
handle_reference_delete(DocumentIndexReference $ref, $user_id = null)
No description
in
Model at line 1696
bool
hasChangedProperties()
No description
in
Model at line 1673
bool
hasTouchedProperties()
No description
in
Category at line 1300
increase_folder_size(int $size, int|null $updated_at = null, null|Category $source_category = null)
Increases the size of this and all affected folders.
If the file was moved from one in another folder, the source category (structure) will be used to determine the folders that are not affected of the size calculation.
in
Model at line 199
init(bool $auto_load = true)
Initializes the model
in
AuditableTrait at line 43
initAuditableTrait()
Init Method
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
in
Category at line 1268
bool
is_from_share()
No description
in
Category at line 95
bool
is_name_in_category(string $name = '')
Checks if the current category has a name-duplicate in its parent-category.
Will check other categories (AND other documents if this has no file-extension)
in
Category at line 1035
bool
is_parent_of($category_id)
No description
in
Category at line 1237
bool
is_personal(bool $user_id = false)
Returns whether this category is one of a personal workspace folder.
in
Category at line 1250
bool
is_personal_root(bool $user_id = false)
No description
in
Category at line 1261
bool
is_share_root()
No description
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
in
Category at line 981
int
mkcat($category_path, $target_category_id = 0, $path_split = '/', $path_name_friendly = false)
Recursively creates categories.
in
Category at line 1436
SearchIndexRecord
onSearchIndexUpdate(SearchIndexRecord $searchIndexRecord)
Adds the Category to the search index
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
No description
in
Category at line 1496
bool
preventPresentationAfterIndexing()
No description
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
in
Category at line 1013
refresh_policy_info()
Checks the policies of the current folder and saves the information as bit in has_policy property
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
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())
in
DocumentModel at line 234
protected bool
remove_from_db(string $table_name, array $key_fields = null)
No description
in
DocumentModel at line 789
null
render()
Generic Renderer
in
Category at line 1163
Category
resolve_category_id(mixed $category_id, bool $resolve_link_itself = false, bool $return_default = true)
Resolves the category id, taking into consideration potential rights context prefixes.
The prefix usually identifies an actual object in the current module. The suffix either is empty for direct access or provides the local id of an object below the linked category
in
Category at line 1139
Category|DocumentModel|false
resolve_link()
Resolve the link of a category Return the category itself if it isn't a link
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.
in
Category at line 135
int|bool
save(bool $notify_parent_of_change = true)
Save Changes
in
Model at line 584
protected int|bool
save_to_db(string $table_name, array $params = array())
No description
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
in
ScopesTrait at line 14
ModelCollection
scopeAll()
No description
in
Model at line 36
Model[]
scope_by_TABLE_COL_and_TABLE_COL2(mixed $COL1_VALUE, mixed $COL2_VALUE)
Returns unloaded ModelCollection
in
Category at line 652
int
search_category_id_by_name($name, int $pid = 0)
Lookup Category ID
in
Model at line 36
void
self() $this find_by_id($id)
No description
in
DocumentModel at line 132
setDocumentIndex(DocumentIndex $documentIndex)
Sets the related document index.
in
ScopesTrait at line 71
void
setModelCollectionReference(ModelCollection $modelCollectionReference)
No description
in
Category at line 1469
void
set_name_i18n($name)
No description
in
Model at line 550
void
set_properties_from_array(array $input, array|bool $filter = false)
No description
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.
in
Model at line 1574
set_render_params(mixed $params = array())
Sets parameter that will be passed to the XUI helpers
in
Model at line 1614
static
set_request_cache(string $key, mixed $value)
Set Request Cache Entry
in
DocumentModel at line 306
null
set_to_rights_cache(DocumentModel $document, string $right, $value)
No description
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)
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
in
Model at line 1528
void
temporarily_enable_table_group_id()
Temporarily enables the use of the group ID in all queries made
in
Model at line 1444
string
to_json()
Returns the model as JSON array
in
Model at line 1455
string
to_string()
Returns the 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
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?
in
ScopesTrait at line 49
ModelCollection
unscope($scopeName = false)
Removes all scopes (including Default Scopes)
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!)
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)
in
Category at line 445
string
user_has_tree_policy(string $policy, bool $id = false, DocumentIndexReference $rights_context = null)
checks for a policy in this category-context
in
Category at line 540
string|true
validate(array $fieldErrors)
No description