Document
class Document extends Document
Class Document
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 Document | |
protected bool | $table_auto_properties | from Document | |
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 Document | |
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 bool | $save_as_new_version | from Document | |
protected string | $attach_new_file | from Document | |
protected bool | $action_logged | from Document | |
DocumentIndex | $reference_document_index | from Document | |
DocumentModel|Document | $reference_document | from Document | |
DocumentIndexReference | $reference_object | from Document | |
bool|int | $current_category_id | from Document | |
bool | $_load | from Document | |
array | $action_links | Set with XELOS\Modules\SystemDMS\Model\xm_system_dms_document::attach_document_actions |
from Document |
string | $file_extension | Accessible via XELOS\Modules\SystemDMS\Model\xm_system_dms_document::get_file_extension |
from Document |
string | $file_path | Accessible via XELOS\Modules\SystemDMS\Model\xm_system_dms_document::get_file_path |
from Document |
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
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.
Attach action Links for a document Links that would be set on field 'action_links' as array
- lock
- delete (only if policy matches)
- edit (only if policy matches)
- detail
- download
No description
Returns if current User can delete this Document
Checks if current User can read this Document
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.
Checks if current User can write this Document
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
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
Find Function to find models using the passed condition
Returns loaded ModelCollection
No description
Returns all models with a specific column value. Query params can be e.g. order_by
No description
Converts a findby* function name to SQL query.
No description
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
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
Returns all document objects of the passed category
Returns all document objects with the passed tag
Return a download link to the corresponding file
Get File Download URL
Returns the time the file was last modified. The time is returned as a Unix timestamp, which is suitable for the date() function.
Check for the current FileName without Extension
If a template is used for this document, the values are formatted.
Returns a list with all versioned document objects
Return the property translated property value if available
Returns the SQL table of this model (if available)
Generates the preview pages and returns them
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
Returns an url to the thumb of this document if available
Checks if the mime type of this document matches the given mime type.
Checks if the current document has a NAME-duplicate in its Category (Important for webDav-Listing) A Duplicate must have the same File-Extension, too.
Loads the reference document and saves internally as property.
Returns the meta data for this document Wrapped in a public method to allow forwarding that request to link targets in the future
Checks if the mime type of this document matches one of the given mime types.
No description
Returns whether this document should be present to user (e.g. activity stream/log) after an indexing process or not.
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
removes index-entry of this model (only marking to delete).
Rename Filename Do not currently update the file_path
Resolve Combined IDs to a single document
Loads the rights context by checking all possible rights context and return it without apply on this model.
Save document to database
Writes the meta data to the database Wrapped in a public method to allow forwarding this request to link targets in the future
Provides a list of all values allowed for enumerations.
Returns unloaded ModelCollection
Will set the filename url-friendly and without any path-information IMPORTANT: do not use the current model-set-methods it will not rename the files proper
No description
Sets parameter that will be passed to the XUI helpers
Handler for uploading files (should be attached as upload_callback to the corresponding form)
Sort this element to a specific position
Decrease Sort Priority (Increases SORT value)
Increase Sort Priority (Decreases SORT value)
Starts a new version (will be saved when save() is called)
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)
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
Document at line 102
__construct(int|bool $id = false, int|bool $version_id = false)
Constructor
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
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
Document at line 1609
attach_document_actions(bool $icon_only = false, bool $mod = false, string $display = 'link')
Attach action Links for a document Links that would be set on field 'action_links' as array
- lock
- delete (only if policy matches)
- edit (only if policy matches)
- detail
- download
in
Document at line 784
bool
attach_file(string $fs_path, bool $move = false, string $target_filename = null)
No description
in
Document at line 1383
bool
can_delete(int $category_id = null)
Returns if current User can delete this Document
in
Document at line 1315
bool
can_read(int $category_id = null, bool $return_system_folders = false)
Checks if current User can read this Document
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
Document at line 1340
bool
can_write(int $category_id = null)
Checks if current User can write this Document
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
Model at line 808
string|void
debug(bool $show_markers = false, int $mode = 0)
No description
in
Document at line 437
bool
delete(bool $trash = true)
Delete Document
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
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
Document at line 43
Document[]
find_all_by_category_id(array $available_category_ids, array $array)
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
Document at line 43
Document
find_by_id_and_category_id(mixed $document_id, int $id)
No description
in
Document at line 43
Document|bool
find_by_id_and_group_id(mixed $id, mixed $group_id, 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
Document at line 1406
string
generate_file_path(mixed $version = 'current', bool|string $overwrite_filename = false, bool $old_revision_fallback = false)
No description
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
Document at line 2344
string
getBasePath()
No description
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
Document at line 2069
Preview|null
getPreview($type)
No description
in
Document at line 2053
array
getPreviewFiles()
Get Preview Files if available for this document
in
Document at line 2351
string
getPreviewStoragePath()
No description
in
Model at line 450
array
getPropertyMarkers(bool $value_discovery = true)
Return properties and markers
in
Document at line 2221
DocumentModel|null
getReferenceDocument()
No description
in
Document at line 2229
DocumentIndex|null
getReferenceDocumentIndex()
No description
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
Document at line 864
string
get_author()
Returns the author name of the current document
in
DocumentModel at line 830
DocumentItem
get_cf()
Return the cf library for this model type
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
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
Document at line 1004
Document[]|ModelCollection
get_documents_by_category(int $category, bool $return_objects = true, bool|string $filter = false, bool $hasSecurityCheck = true)
Returns all document objects of the passed category
in
Document at line 1077
array
get_documents_by_search(int $query, bool $return_objects = true, array $search_params = [], int $limit = 200)
Returns all document objects with the passed tag
in
Document at line 955
string
get_download_link(int $limit = 25, bool $icon = true)
No description
in
Document at line 942
string
get_download_link_full(bool $icon = true)
Return a download link to the corresponding file
in
Document at line 969
bool|string
get_download_url()
No description
in
Document at line 1474
string
get_file_base_path(bool $force_this = false)
No description
in
Document at line 830
string
get_file_extension()
Check for the current File-Extension
in
Document at line 1494
string
get_file_path()
Returns the file path of this or the reference document.
in
Document at line 1449
string
get_file_path_relative(string $version = 'current')
No description
in
Document at line 1850
bool|string
get_file_url(mixed $version = null, bool $inline_disposition = true)
Get File Download URL
in
Document at line 895
int
get_filemtime()
Returns the time the file was last modified. The time is returned as a Unix timestamp, which is suitable for the date() function.
in
Document at line 847
string
get_filename_url()
gets the url-friendly filename
in
Document at line 813
string
get_filename_without_extension()
Check for the current FileName without Extension
in
Document at line 876
int
get_filesize()
gets the filesize in Bytes for the current file
in
Document at line 916
array
get_formatted_data(bool $xoi_dialog = false)
If a template is used for this document, the values are formatted.
in
DocumentModel at line 279
null
get_from_rights_cache(DocumentModel $document, string $right)
No description
in
Document at line 1152
Document[]|int[]
get_history(bool $return_objects = true, int $limit = null)
Returns a list with all versioned document objects
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
Document at line 2237
string
get_icon_class()
No description
in
Document at line 168
int
get_latest_version_id()
No description
in
Document at line 1895
xm_webdav_lock|bool
get_lock()
Get the lock of the referenced document
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
Document at line 2086
array|false
get_preview_pages(mixed $page_count, bool $force_new = false, bool $cache_only = true)
Generates the preview pages and returns them
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
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
Document at line 2036
string
get_thumb_url(int $width = 100, int $height = 100)
Returns an url to the thumb of this document if available
in
Document at line 2044
string
get_thumb_url_if_set()
No description
in
Document at line 2143
string|int
get_thumbnail_document(bool $force_new = false)
No description
in
Model at line 1481
string
get_updated_at_formatted()
Return a Formatted DateTime
in
Document at line 2262
string
get_version_download_url(int $version_id)
No description
in
Document at line 2272
mixed|string
get_version_string()
No description
in
Document at line 1559
string
get_webdav_url()
No description
in
DocumentModel at line 800
Document
get_xui_document()
Get XUI Document Representation
in
Document at line 240
void
handle_reference_delete(DocumentIndexReference $reference, $user_id = null)
No description
in
Model at line 1696
bool
hasChangedProperties()
No description
in
Model at line 1673
bool
hasTouchedProperties()
No description
in
Document at line 120
init(bool $auto_load = true)
Initialization
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
Document at line 1881
bool
is_locked()
Check if referenced document is locked
in
Document at line 1546
bool
is_mime_type($type)
Checks if the mime type of this document matches the given mime type.
in
Document at line 1277
bool
is_name_in_category()
Checks if the current document has a NAME-duplicate in its Category (Important for webDav-Listing) A Duplicate must have the same File-Extension, too.
in
Document at line 176
load()
Loads the document.
in
Document at line 2204
protected void
loadReferenceDocument()
Loads the reference document and saves internally as property.
in
Model at line 698
protected bool
load_from_db(string $table_name, array|bool $key_fields = false)
No description
in
Document at line 614
mixed
load_meta_data()
Returns the meta data for this document Wrapped in a public method to allow forwarding that request to link targets in the future
in
Document at line 1930
bool
lock()
Lock the referenced document
in
Document at line 1530
bool
match_mime_types($types)
Checks if the mime type of this document matches one of the given mime types.
in
Document at line 2279
SearchIndexRecord
onSearchIndexUpdate(SearchIndexRecord $baseIndexRecord)
No description
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
DocumentModel at line 890
bool
preventPresentationAfterIndexing()
Returns whether this document should be present to user (e.g. activity stream/log) after an indexing process or not.
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
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
Document at line 719
bool
rename(string $new_filename, bool $rename_name = true)
Rename Filename Do not currently update the file_path
in
Document at line 154
null
render()
No description
in
Document at line 2178
Document
resolve_document_id(string $document_id)
Resolve Combined IDs to a single document
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
Document at line 256
int|bool
save(bool $save_raw = false, bool $skip_category_notification = false, bool $skip_search_index_update = false)
Save document to database
in
Document at line 654
int|bool
save_meta_data(mixed $meta)
Writes the meta data to the database Wrapped in a public method to allow forwarding this request to link targets in the future
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
Document at line 557
bool
secureFile()
auto-renames filename and document-name triggered from save()
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
Document at line 980
set_filename(string $filename)
Will set the filename url-friendly and without any path-information IMPORTANT: do not use the current model-set-methods it will not rename the files proper
in
Document at line 147
set_model_default_render_xui(string $model_default_render_xui)
No description
in
Model at line 550
void
set_properties_from_array(array $input, array|bool $filter = false)
No description
in
Document at line 639
set_property(string|array $property_id, string|bool $property_value = false, bool $no_change = false)
No description
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
Document at line 768
string
set_uploaded_file(array $FILE)
Handler for uploading files (should be attached as upload_callback to the corresponding form)
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
Document at line 604
start_new_version($auto_minor_change = false)
Starts a new version (will be saved when save() is called)
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
Document at line 1965
bool
unlock()
Remove all locks from the referenced document
in
ScopesTrait at line 49
ModelCollection
unscope($scopeName = false)
Removes all scopes (including Default Scopes)
in
Document at line 688
protected
update()
Updates properties.
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
Document at line 530
string|true
validate(array $fieldErrors)
Validate Function for Forms with Document-Models as Target