1. class
  2. XELOS
  3. \
  4. Modules
  5. \
  6. DMS
  7. \
  8. Model
  9. \
  10. Document

Document

class Document extends Document

Class Document

Traits

DuplicatableModelTrait

Trait DuplicatableModelTrait

AuditableTrait

Trait Auditable to be used in Models

SortTrait
ScopesTrait

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 string|null $model_name 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
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|null $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
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
$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

ModelCollection|Model|Model[]|int
__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|bool $id = false, int|bool $version_id = false)

Constructor

from  Document
mixed
__get(mixed $var)

No description

from  Model
__isset($name)

No description

from  Model
Model
__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
Query
_scopeAll(Query $Query)

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

from  ScopesTrait
Query
_scopeDefault(Query $Query)

Load default scopes

from  ScopesTrait
Query
_scopeGroupId(Query $Query)

Applies Group ID Filtering

from  Model
ModelCollection
_scope_by(string $fn, array $parameters)

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

from  ScopesTrait
ModelCollection
_scope_custom(string $scopeName, Query|null $Query = null)

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

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

No description

from  AuditableTrait
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
ModelCollection
add_scope_condition(Condition|ConditionGroup|Query|string $new_condition)

Adds a condition to scope the following find functions

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

Return all models

from  Model
?array
attach_document_actions(Core|null $mod = null, string $display = 'link', bool $returnLinks = false)

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

from  Document
bool
attach_file(string $fs_path, bool $move = false, string $target_filename = null)

No description

from  Document
bool
can_delete(int $category_id = null)

Returns if current User can delete this Document

from  Document
bool
can_read(int $category_id = null, bool $return_system_folders = false)

Checks if current User can read this Document

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

from  DocumentModel
bool
can_read_comments_global(bool $return_hidden = false)

Checks whether this model can be commented on.

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

from  DocumentModel
bool
can_read_global_in_rights_context(DocumentIndexReference|false $rights_context = false)

Evaluates can_read_global inside a specific rights context

from  DocumentModel
bool
can_reference()

Checks whether this document can be linked with read reference.

from  DocumentModel
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)

from  DocumentModel
bool
can_share() deprecated

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

from  DocumentModel
bool
can_write(int $category_id = null)

Checks if current User can write this Document

from  Document
bool
can_write_comments()

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

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

from  DocumentModel
bool
can_write_global_in_rights_context(DocumentIndexReference $rights_context)

Evaluates can_write_global inside a specific rights context

from  DocumentModel
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
int
count_all() $eturns the count of all models, see $this->find('count')

No description

from  Model
int
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
string|void
debug(bool $show_markers = false, int $mode = 0)

No description

from  Model
bool
delete(bool $trash = true)

Delete Document

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

from  DocumentModel
void
disable_table_group_id()

Disable the use of the group ID in all queries made

from  Model
Model
duplicate(array $overwriteProperties = [], DuplicatableInterface|null $targetModel = null)

Duplicate Model and associated content This function will replicate the current model and its associated content:

  • Referenced Documents will be referenced by passive or read reference
  • Tags will be copied

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

from  DocumentModel
void
enable_table_group_id()

Enable the use of the group ID in all queries made

from  Model
static DocumentModel|null
fetchByUuid(string $uuid, bool $ignoreCanReadRights = false) deprecated

Get Document by using the uuid

from  DocumentModel
ModelCollection|Model|int|null
find(string $mode = 'all', Condition|ConditionGroup|Query|string|array $conditions = false, array|null $query_params = null)

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
Document[]
find_all_by_category_id(array $available_category_ids, array $array)

No description

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

from  Model
Document
find_by_id_and_category_id(mixed $document_id, int $id)

No description

from  Document
Document|bool
find_by_id_and_group_id(mixed $id, mixed $group_id, mixed $query_params)

No description

from  Document
Document
find_by_xfs_path(string $CATEGORY_ICON_PATH)

No description

from  Document
Query
functionNameToQuery(string $query, array $parameters)

Converts a findby* function name to SQL query.

from  Model
string
generate_file_path(mixed $version = 'current', bool|string $overwrite_filename = false, bool $old_revision_fallback = false)

No description

from  Document
array
getAuditEvents()

Get audit events

from  AuditableTrait
array
getAuditExcludeProperties()

Get the (Auditable) properties excluded from audit.

from  AuditableTrait
array
getAuditIncludeProperties()

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

from  AuditableTrait
AuditTrail[]|ModelCollection
getAuditTrail(int $limit = 50)

Get the last auditTrail records for current Model

from  AuditableTrait
string
getBasePath()

No description

from  Document
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
ModelCollection
getCollectionByQuery(string $model_name, array|string $dbquery_result, string $population_mode = 'full', string $post_fill_function = 'update')

No description

from  Model
array
getDBSchema(string $field = null)

Get DB Schema if available

from  Model
string[]
getI18nPropertyVariants($propertyName, $localeAsKey = false)

Returns a list of all property name variants for all languages, e.g. "title_i18n" -> "title_i18n, title_DE_DE, title_EN_EN"

from  Model
I18nTokenHelper
getI18nTokenForProperty(string $i18nProperty, int|null $limitString = null)

Gets an I18nToken for a model property (e.g. title_i18n)

from  Model
Controller
getMod()

No description

from  DocumentModel
DocumentCollection
getModelCollection()

No description

from  Document
array
getNonDuplicatableFields(array $ignoredFieldsByDefault = [])

No description

from  DuplicatableModelTrait
Preview|null
getPreview(string $type)

No description

from  Document
array
getPreviewFiles()

Get Preview Files if available for this document

from  Document
array|void
getPreviewInfo($fullInfo = false)

Centralized function to collect all necessary information to allow the frontend to display the content

from  Document
string
getPreviewStoragePath()

No description

from  Document
ModelCollection
getPreviews()

No description

from  Document
int|null
getPrimaryKeyValue()

Get the primary id (post_id) for this model

from  Model
array
getPropertyMarkers(bool $value_discovery = true)

Return properties and markers

from  Model
DocumentModel|null
getReferenceDocument()

No description

from  Document
DocumentIndex|null
getReferenceDocumentIndex()

No description

from  Document
Query
getScopeQuery(bool $applyDefaultScopes = true)

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

from  ScopesTrait
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
mixed|string
getUniquePropertyValue($propertyId, $propertyValue)

Helper Function to iterate over existing field values to ensure a valid name. a "_ID" with an increasing ID will be appended if the value already exists

from  DuplicatableModelTrait
string
get_author()

Returns the author name of the current document

from  Document
DocumentItem
get_cf()

Return the cf library for this model type

from  DocumentModel
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
DocumentIndex|null
get_document_index()

Returns the related document index.

from  DocumentModel
DocumentRegistry|null
get_document_registry_info()

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

from  DocumentModel
get_document_tmp_folder()

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

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

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

from  Document
string
get_download_link(int $limit = 25, bool $icon = true)

No description

from  Document
string
get_download_link_full(bool $icon = true)

Return a download link to the corresponding file

from  Document
bool|string
get_download_url()

No description

from  Document
string
get_file_base_path(bool $force_this = false)

No description

from  Document
string
get_file_extension()

Check for the current File-Extension

from  Document
string
get_file_path()

Returns the file path of this or the reference document.

from  Document
string
get_file_path_relative(string $version = 'current')

No description

from  Document
bool|string
get_file_url(mixed $version = null, bool $inline_disposition = true, $width = null, $height = null)

Get File Download URL

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

from  Document
string
get_filename_url()

gets the url-friendly filename

from  Document
string
get_filename_without_extension()

Check for the current FileName without Extension

from  Document
int
get_filesize()

gets the filesize in Bytes for the current file

from  Document
array
get_formatted_data(bool $xoi_dialog = false)

If a template is used for this document, the values are formatted.

from  Document
Document[]|int[]
get_history(bool $return_objects = true, int $limit = null)

Returns a list with all versioned document objects

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

Return the property translated property value if available

from  Model
string
get_icon_class()

No description

from  Document
int
get_latest_version_id()

No description

from  Document
xm_webdav_lock|bool
get_lock()

Get the lock of the referenced document

from  Document
string|null
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
array|false
get_preview_pages(mixed $page_count, bool $force_new = false, bool $cache_only = true)

Generates the preview pages and returns them

from  Document
string
get_preview_url($width = 1024, $height = 800)

Returns an url with a resized preview (not cropped) If you need a cropped image use get_thumb_url() instead

from  Document
array
get_properties(bool $value_discovery = true)

Returns the complete properties array

from  Model
array
get_properties_meta(?string $field = null)

No description

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

No description

from  Model
Category|bool
get_related_category()

No description

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

from  DocumentModel
string|null
get_table_name()

Returns the table name of this model.

from  Model
string|null
get_table_primary_key()

No description

from  Model
string
get_thumb_url(int $width = 100, int $height = 100)

Returns an url to the thumb of this document if available The thumb is cropped to the passed dimensions. If you need an uncropped version please use get_preview_url

from  Document
string
get_thumb_url_if_set()

No description

from  Document
string|int
get_thumbnail_document(bool $force_new = false)

No description

from  Document
string
get_updated_at_formatted()

Return a Formatted DateTime

from  Model
string
get_version_download_url(int $version_id)

No description

from  Document
mixed|string
get_version_string()

No description

from  Document
string|null
get_webdav_url()

No description

from  Document
Document|null
get_xui_document()

Get XUI Document Representation

from  DocumentModel
void
handle_reference_delete(DocumentIndexReference $reference, $user_id = null)

No description

from  Document
bool
hasChangedProperties()

No description

from  Model
bool
hasExistingDatabaseRecord()

Does this model represent an existing database record? (can be updated)

from  Model
bool
hasTouchedProperties()

Returns true if at least one property is marked as changed

from  Model
init(bool $auto_load = true)

Initialization

from  Document
initAuditableTrait()

Init Method

from  AuditableTrait
bool
isAuditingEnabled()

Determine whether auditing is enabled.

from  AuditableTrait
isImage()

No description

from  Document
bool
isPreviewReady($progress)

Checks if the previews are already available

from  Document
bool
isReferenceDuplicationAllowed()

Should reference items be duplicated (deep copy of dms objects) If false (default), references will be replicated as shallow read references to their original items

from  DuplicatableModelTrait
isVideo()

No description

from  Document
bool
is_locked()

Check if referenced document is locked

from  Document
bool
is_mime_type($type)

Checks if the mime type of this document matches the given mime type.

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

from  Document
load()

Loads the document.

from  Document
void
loadReferenceDocument()

Loads the reference document and saves internally as property.

from  Document
bool
load_from_db(string $table_name = null, array $key_fields = [])

No description

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

from  Document
bool
lock()

Lock the referenced document

from  Document
bool
match_mime_types($types)

Checks if the mime type of this document matches one of the given mime types.

from  Document
void
onDuplicateProperties(Model $duplicate)

No description

from  DuplicatableModelTrait
void
onDuplicateSaved(Model $duplicate)

No description

from  DuplicatableModelTrait
void
onReferencesDuplicated(array $referenceMap = [])

No description

from  DuplicatableModelTrait
void
onRestore()

Automatically recover document index if document model is restored

from  DocumentModel
SearchIndexRecord
onSearchIndexUpdate(SearchIndexRecord $baseIndexRecord)

No description

from  Document
static array
parseIdRefProperty(mixed $documentIndexValues = null)

Function to parse a property which is supposed to contain id references

from  DocumentModel
ModelCollection|Model[]
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
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

from  ScopesTrait
reload_schema()

Reloads the schema of the model

from  Model
remove_document_index()

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

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

No description

from  DocumentModel
bool
rename(string $new_filename, bool $rename_name = true)

Rename Filename Do not currently update the file_path

from  Document
string|null
render()

No description

from  Document
static void
resetRightsCache(int $document_index_id)

No description

from  DocumentModel
void
resetScopeQuery()

Reset Scope to null

from  ScopesTrait
Document
resolve_document_id(string $document_id)

Resolve Combined IDs to a single document

from  Document
DocumentIndexReference|null
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.

from  DocumentModel
int|bool
save(bool $save_raw = false, bool $skip_category_notification = false, bool $skip_search_index_update = false, bool $createPreviewJob = true)

Save document to database

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

from  Document
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
ModelCollection
scope(string $scopeName, Query|null $scopeQuery = null)

No description

from  ScopesTrait
ModelCollection
scopeAll()

No description

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

Returns unloaded ModelCollection

from  Model
ModelCollection
scope_by_id(int|array $id)

No description

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

No description

from  Model
bool
setCustomThumbnail(string|null $filePath = null)

Sets a custom thumbnail for this document. Set to FALSE to unset.

from  Document
setDocumentIndex(DocumentIndex|null $documentIndex)

Sets the related document index.

from  DocumentModel
void
setModelCollectionReference(ModelCollection $modelCollectionReference)

No description

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

from  Document
set_model_default_render_xui(string $model_default_render_xui)

No description

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

No description

from  Model
set_property(string|array $property_id, mixed $property_value = false, bool $no_change = false)

No description

from  Document
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
string
set_uploaded_file(array $FILE)

Handler for uploading files (should be attached as upload_callback to the corresponding form)

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

Sort this element to a specific position

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

Decrease Sort Priority (Increases SORT value)

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

Increase Sort Priority (Decreases SORT value)

from  SortTrait
start_new_version($auto_minor_change = false)

Starts a new version (will be saved when save() is called)

from  Document
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
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
void
touchProperty($propertyName)

No description

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?

from  AuditableTrait
bool
unlock()

Remove all locks from the referenced document

from  Document
ModelCollection
unscope(string $scopeName = null, Query|null $scopeQuery = null)

Returns an unscoped Collection

from  ScopesTrait
update()

Updates properties.

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

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

from  DocumentModel
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)

from  SortTrait
string|true
validate(array $fieldErrors)

Validate Function for Forms with Document-Models as Target

from  Document

Details

in Model at line 1117
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 1684
__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 110
__construct(int|bool $id = false, int|bool $version_id = false)

Constructor

Parameters

int|bool $id

Primary ID of the model which should be loaded
int|bool $version_id Version-ID

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

No description

Parameters

mixed $var

Return Value

mixed

in Model at line 1743
__isset($name)

No description

Parameters

$name

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

No description

Parameters

mixed $var
mixed $value

Return Value

Model

in Model at line 1695
string __toString()

String Representation of this object (calls for render method)

Return Value

string

in Model at line 1155
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 100
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 111
Query _scopeDefault(Query $Query)

Load default scopes

Parameters

Query $Query

Return Value

Query

in Model at line 1631
protected Query _scopeGroupId(Query $Query)

Applies Group ID Filtering

Parameters

Query $Query

Return Value

Query

in ScopesTrait at line 143
protected ModelCollection _scope_by(string $fn, array $parameters)

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

Parameters

string $fn
array $parameters

Return Value

ModelCollection

in ScopesTrait at line 159
protected ModelCollection _scope_custom(string $scopeName, Query|null $Query = null)

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

Parameters

string $scopeName

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

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 954
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 34
ModelCollection add_scope_condition(Condition|ConditionGroup|Query|string $new_condition)

Adds a condition to scope the following find functions

Parameters

Condition|ConditionGroup|Query|string $new_condition

Return Value

ModelCollection

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

Return all models

Parameters

mixed $params

Return Value

Model[]

in Document at line 1663
?array attach_document_actions(Core|null $mod = null, string $display = 'link', bool $returnLinks = false)

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

Parameters

Core|null $mod
string $display
bool $returnLinks

If links are returned, they are NOT attached!

Return Value

?array

in Document at line 809
bool attach_file(string $fs_path, bool $move = false, string $target_filename = null)

No description

Parameters

string $fs_path
bool $move
string $target_filename

Return Value

bool

in Document at line 1436
bool can_delete(int $category_id = null)

Returns if current User can delete this Document

Parameters

int $category_id

Category-ID. if unset then use current Category-ID of Document

Return Value

bool

in Document at line 1368
bool can_read(int $category_id = null, bool $return_system_folders = false)

Checks if current User can read this Document

Parameters

int $category_id

Category-ID. if unset then use current Category-ID of Document
bool $return_system_folders

Return Value

bool

in DocumentModel at line 429
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 451
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 361
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 413
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 795
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 770
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 498
bool can_share() deprecated

deprecated unused

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

This method can be overridden by subclass.

Return Value

bool

in Document at line 1393
bool can_write(int $category_id = null)

Checks if current User can write this Document

Parameters

int $category_id

Category-ID. if unset then use current Category-ID of Document

Return Value

bool

in DocumentModel at line 439
bool can_write_comments()

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

Return Value

bool

TRUE if new comments can be created.

in DocumentModel at line 508
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 546
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 1174
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 616
clear_properties()

No description

in Model at line 40
int count_all() $eturns the count of all models, see $this->find('count')

No description

Parameters

) $eturns the count of all models
see $this->find('count'

Return Value

int

in Model at line 40
int 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

int

in Model at line 939
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

in Document at line 454
bool delete(bool $trash = true)

Delete Document

Parameters

bool $trash

Trash mode enabled

Return Value

bool

was delete successful?

in Model at line 40
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 71
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 1642
void disable_table_group_id()

Disable the use of the group ID in all queries made

Return Value

void

in DuplicatableModelTrait at line 33
Model duplicate(array $overwriteProperties = [], DuplicatableInterface|null $targetModel = null)

Duplicate Model and associated content This function will replicate the current model and its associated content:

  • Referenced Documents will be referenced by passive or read reference
  • Tags will be copied

Parameters

array $overwriteProperties ['group_id'=>'new_group_id']
DuplicatableInterface|null $targetModel

The passed model to duplicate all properties onto. Only superclasses from $this are allowed - a System DMS document could never be copied into another DMS instance, only the other way around (DMS to System DMS).

Return Value

Model

See also

DuplicatableInterface

in DocumentModel at line 60
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 1667
void enable_table_group_id()

Enable the use of the group ID in all queries made

Return Value

void

in DocumentModel at line 125
static DocumentModel|null fetchByUuid(string $uuid, bool $ignoreCanReadRights = false) deprecated

deprecated This function may cause a fatal error if the class is not available, better use DocumentIndex::fetchRelatedDocumentByUuid()

Get Document by using the uuid

Parameters

string $uuid

hex presentation of uuid
bool $ignoreCanReadRights

Access check is performed by default for this function

Return Value

DocumentModel|null

in Model at line 1218
ModelCollection|Model|int|null find(string $mode = 'all', Condition|ConditionGroup|Query|string|array $conditions = false, array|null $query_params = null)

Find Function to find models using the passed condition

Parameters

string $mode

Find mode (all/first/count)
Condition|ConditionGroup|Query|string|array $conditions

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

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

Return Value

ModelCollection|Model|int|null

depending from $mode: ALL: ModelCollection; FIRST: Model | boolean false on fail COUNT: int

in Model at line 40
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[]

in Document at line 48
Document[] find_all_by_category_id(array $available_category_ids, array $array)

No description

Parameters

array $available_category_ids
array $array

Return Value

Document[]

in Model at line 40
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

in Document at line 48
Document find_by_id_and_category_id(mixed $document_id, int $id)

No description

Parameters

mixed $document_id
int $id

Return Value

Document

in Document at line 48
Document|bool find_by_id_and_group_id(mixed $id, mixed $group_id, mixed $query_params)

No description

Parameters

mixed $id
mixed $group_id
mixed $query_params

Return Value

Document|bool

in Document at line 48
Document find_by_xfs_path(string $CATEGORY_ICON_PATH)

No description

Parameters

string $CATEGORY_ICON_PATH

Return Value

Document

in Model at line 1402
protected 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 Document at line 1459
string generate_file_path(mixed $version = 'current', bool|string $overwrite_filename = false, bool $old_revision_fallback = false)

No description

Parameters

mixed $version

FILEVERSION: default string 'current' or explicit int version_id (not used yet)
bool|string $overwrite_filename
bool $old_revision_fallback

Return Value

string

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 Document at line 2412
string getBasePath()

No description

Return Value

string

in Model at line 1857
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 970
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 returns a model collection

in Model at line 191
array getDBSchema(string $field = null)

Get DB Schema if available

Parameters

string $field

Return Value

array

in Model at line 1806
string[] getI18nPropertyVariants($propertyName, $localeAsKey = false)

Returns a list of all property name variants for all languages, e.g. "title_i18n" -> "title_i18n, title_DE_DE, title_EN_EN"

Parameters

$propertyName
$localeAsKey

Return Value

string[]

in Model at line 1914
I18nTokenHelper getI18nTokenForProperty(string $i18nProperty, int|null $limitString = null)

Gets an I18nToken for a model property (e.g. title_i18n)

Parameters

string $i18nProperty

The property name (e.g. title_i18n)
int|null $limitString

The translated string will be only $limitString amount of characters long (Adds '...' at the end of the string)

Return Value

I18nTokenHelper

in DocumentModel at line 49
Controller getMod()

No description

Return Value

Controller

in Document at line 48
DocumentCollection getModelCollection()

No description

Return Value

DocumentCollection

in DuplicatableModelTrait at line 190
array getNonDuplicatableFields(array $ignoredFieldsByDefault = [])

No description

Parameters

array $ignoredFieldsByDefault

Contains the default fields which will be ignored for your model, based on the database schema

Return Value

array

Fields that you do not want copied,

in Document at line 2118
Preview|null getPreview(string $type)

No description

Parameters

string $type

image, pdf, video, video-hd

Return Value

Preview|null

in Document at line 2097
array getPreviewFiles()

Get Preview Files if available for this document

Return Value

array

['images'=>[(string) $path1, (string) $path2],'pdf'=> (string) $path3]

in Document at line 2508
array|void getPreviewInfo($fullInfo = false)

Centralized function to collect all necessary information to allow the frontend to display the content

Parameters

$fullInfo

Include full edit infos for video - should not be used on collections but rather on single documents

Return Value

array|void

in Document at line 2419
string getPreviewStoragePath()

No description

Return Value

string

in Document at line 2130
ModelCollection getPreviews()

No description

Return Value

ModelCollection

in Model at line 334
int|null getPrimaryKeyValue()

Get the primary id (post_id) for this model

Return Value

int|null

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

Return properties and markers

Parameters

bool $value_discovery

Return Value

array

in Document at line 2289
DocumentModel|null getReferenceDocument()

No description

Return Value

DocumentModel|null

in Document at line 2297
DocumentIndex|null getReferenceDocumentIndex()

No description

Return Value

DocumentIndex|null

in ScopesTrait at line 217
Query getScopeQuery(bool $applyDefaultScopes = true)

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

Parameters

bool $applyDefaultScopes

Return Value

Query

in Model at line 1827
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']

in DuplicatableModelTrait at line 112
mixed|string getUniquePropertyValue($propertyId, $propertyValue)

Helper Function to iterate over existing field values to ensure a valid name. a "_ID" with an increasing ID will be appended if the value already exists

Parameters

$propertyId
$propertyValue

Return Value

mixed|string

in Document at line 889
string get_author()

Returns the author name of the current document

Return Value

string

display name or boolean false on fail

in DocumentModel at line 882
DocumentItem get_cf()

Return the cf library for this model type

Return Value

DocumentItem

The content first library

in Model at line 1611
string get_created_at_formatted()

Return a Formatted DateTime

Return Value

string

in Model at line 520
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 135
DocumentIndex|null get_document_index()

Returns the related document index.

Return Value

DocumentIndex|null

in DocumentModel at line 826
DocumentRegistry|null 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|null

in DocumentModel at line 243
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 1055
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

Parameters

int $category

Category ID
bool $return_objects
bool|string $filter

Additional string used to filter by document name or filename
bool $hasSecurityCheck

Used when documents are needed for name/filename duplicate check before the parent Document/Model is saved

Return Value

Document[]|ModelCollection

Array with all document objects

Returns all document objects with the passed tag

Parameters

int $query Category-ID
bool $return_objects
array $search_params
int $limit

Return Value

array

Array with all document objects

No description

Parameters

int $limit

limit of string-size
bool $icon

Return Value

string

Link-Return Array or string with error-message on fail

Return a download link to the corresponding file

Parameters

bool $icon

Return Value

string

Link-Return Array or string with error-message on fail

in Document at line 1020
bool|string get_download_url()

No description

Return Value

bool|string

in Document at line 1527
string get_file_base_path(bool $force_this = false)

No description

Parameters

bool $force_this

Return Value

string

in Document at line 855
string get_file_extension()

Check for the current File-Extension

Return Value

string File-Extension

in Document at line 1547
string get_file_path()

Returns the file path of this or the reference document.

Return Value

string

in Document at line 1502
string get_file_path_relative(string $version = 'current')

No description

Parameters

string $version

Return Value

string

in Document at line 1874
bool|string get_file_url(mixed $version = null, bool $inline_disposition = true, $width = null, $height = null)

Get File Download URL

Parameters

mixed $version
bool $inline_disposition
$width
$height

Return Value

bool|string

in Document at line 920
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.

Return Value

int

Unix timestamp or FALSE on failure

in Document at line 872
string get_filename_url()

gets the url-friendly filename

Return Value

string

URL-encoded string according to RFC 1738

in Document at line 838
string get_filename_without_extension()

Check for the current FileName without Extension

Return Value

string

Basic File-Name

in Document at line 901
int get_filesize()

gets the filesize in Bytes for the current file

Return Value

int

filesize in Bytes

in Document at line 941
array get_formatted_data(bool $xoi_dialog = false)

If a template is used for this document, the values are formatted.

Parameters

bool $xoi_dialog

Is this method called in the XOI sidebar? External links have to be formatted differently

Return Value

array

array of array('label' => Label in Template, 'value' => formatted value)

in Document at line 1203
Document[]|int[] get_history(bool $return_objects = true, int $limit = null)

Returns a list with all versioned document objects

Parameters

bool $return_objects

Return Objects or IDs
int $limit

limit of returning Items (boolean false for no limit)

Return Value

Document[]|int[]

array(XELOS\Modules\SystemDMS\Model\xm_system_dms_document) or array(int)

in Model at line 1784
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

in Document at line 2305
string get_icon_class()

No description

Return Value

string

in Document at line 177
int get_latest_version_id()

No description

Return Value

int

in Document at line 1920
xm_webdav_lock|bool get_lock()

Get the lock of the referenced document

Return Value

xm_webdav_lock|bool

in Model at line 351
string|null get_model_name()

Returns the SQL table of this model (if available)

Return Value

string|null

Full qualified table name e.g. xmi_crm01_contact

in Model at line 312
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

in Document at line 2147
array|false get_preview_pages(mixed $page_count, bool $force_new = false, bool $cache_only = true)

Generates the preview pages and returns them

Parameters

mixed $page_count
bool $force_new

Regenerate Preview even if it already exists (Automatically se
bool $cache_only

Return Value

array|false

in Document at line 2089
string get_preview_url($width = 1024, $height = 800)

Returns an url with a resized preview (not cropped) If you need a cropped image use get_thumb_url() instead

Parameters

$width
$height

Return Value

string

in Model at line 474
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 508
array get_properties_meta(?string $field = null)

No description

Parameters

?string $field

if given returns the meta for that field

Return Value

array

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

No description

Parameters

string|null $property_id

Marker ID
bool $get_raw_value

deactivate Marker-Function gets triggered

Return Value

mixed

Marker Content

No description

Return Value

Category|bool

XELOS\Modules\SystemDMS\Model\xm_system_dms_category: on success; boolean: false on fail

in Model at line 1772
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 82
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

in Model at line 303
string|null get_table_name()

Returns the table name of this model.

Return Value

string|null

in Model at line 325
string|null get_table_primary_key()

No description

Return Value

string|null

Primary Key Field in DB

in Document at line 2069
string get_thumb_url(int $width = 100, int $height = 100)

Returns an url to the thumb of this document if available The thumb is cropped to the passed dimensions. If you need an uncropped version please use get_preview_url

Parameters

int $width
int $height

Return Value

string

in Document at line 2077
string get_thumb_url_if_set()

No description

Return Value

string

in Document at line 2207
string|int get_thumbnail_document(bool $force_new = false)

No description

Parameters

bool $force_new

Should generation of thumbnail be enforced (thumbnail should be generated new)

Return Value

string|int

Absolute path to resizable image (JPG, PNG) or System Document Index ID

in Model at line 1620
string get_updated_at_formatted()

Return a Formatted DateTime

Return Value

string

in Document at line 2330
string get_version_download_url(int $version_id)

No description

Parameters

int $version_id document_history

Return Value

string $url

in Document at line 2340
mixed|string get_version_string()

No description

Return Value

mixed|string

in Document at line 1611
string|null get_webdav_url()

No description

Return Value

string|null

link for direct webdav access

in DocumentModel at line 852
Document|null get_xui_document()

Get XUI Document Representation

Return Value

Document|null

in Document at line 249
void handle_reference_delete(DocumentIndexReference $reference, $user_id = null)

No description

Parameters

DocumentIndexReference $reference
$user_id

Return Value

void

in Model at line 1868
bool hasChangedProperties()

No description

Return Value

bool

in Model at line 807
bool hasExistingDatabaseRecord()

Does this model represent an existing database record? (can be updated)

Return Value

bool

in Model at line 1835
bool hasTouchedProperties()

Returns true if at least one property is marked as changed

Return Value

bool

in Document at line 129
init(bool $auto_load = true)

Initialization

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

in Document at line 2427
isImage()

No description

in Document at line 2435
bool isPreviewReady($progress)

Checks if the previews are already available

Parameters

$progress

Return Value

bool

in DuplicatableModelTrait at line 199
protected bool isReferenceDuplicationAllowed()

Should reference items be duplicated (deep copy of dms objects) If false (default), references will be replicated as shallow read references to their original items

Return Value

bool

in Document at line 2423
isVideo()

No description

in Document at line 1906
bool is_locked()

Check if referenced document is locked

Return Value

bool

in Document at line 1599
bool is_mime_type($type)

Checks if the mime type of this document matches the given mime type.

Parameters

$type

Return Value

bool

in Document at line 1330
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.

Return Value

bool

in Document at line 185
load()

Loads the document.

in Document at line 2272
protected void loadReferenceDocument()

Loads the reference document and saves internally as property.

Return Value

void

in Model at line 837
protected bool load_from_db(string $table_name = null, array $key_fields = [])

No description

Parameters

string $table_name

Table Name
array $key_fields

Key fields which should be used as WHERE condition

Return Value

bool

in Document at line 632
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

Return Value

mixed

An assoc array of all meta data

in Document at line 1955
bool lock()

Lock the referenced document

Return Value

bool

in Document at line 1583
bool match_mime_types($types)

Checks if the mime type of this document matches one of the given mime types.

Parameters

$types

Return Value

bool

in DuplicatableModelTrait at line 206
protected void onDuplicateProperties(Model $duplicate)

No description

Parameters

Model $duplicate

Return Value

void

in DuplicatableModelTrait at line 213
protected void onDuplicateSaved(Model $duplicate)

No description

Parameters

Model $duplicate

Return Value

void

in DuplicatableModelTrait at line 217
protected void onReferencesDuplicated(array $referenceMap = [])

No description

Parameters

array $referenceMap

Return Value

void

in DocumentModel at line 932
void onRestore()

Automatically recover document index if document model is restored

Return Value

void

in Document at line 2347
SearchIndexRecord onSearchIndexUpdate(SearchIndexRecord $baseIndexRecord)

No description

Parameters

SearchIndexRecord $baseIndexRecord

Return Value

SearchIndexRecord

in DocumentModel at line 943
static array parseIdRefProperty(mixed $documentIndexValues = null)

Function to parse a property which is supposed to contain id references

Parameters

mixed $documentIndexValues

Return Value

array ids

in Model at line 1062
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)

in ScopesTrait at line 127
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 161
reload_schema()

Reloads the schema of the model

in DocumentModel at line 230
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 259
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 Document at line 744
bool rename(string $new_filename, bool $rename_name = true)

Rename Filename Do not currently update the file_path

Parameters

string $new_filename Filename
bool $rename_name

Rename doc name too

Return Value

bool

in Document at line 163
string|null render()

No description

Return Value

string|null

in DocumentModel at line 350
static void resetRightsCache(int $document_index_id)

No description

Parameters

int $document_index_id

Return Value

void

in ScopesTrait at line 231
void resetScopeQuery()

Reset Scope to null

Return Value

void

in Document at line 2245
Document resolve_document_id(string $document_id)

Resolve Combined IDs to a single document

Parameters

string $document_id

$categoryid.''.$document_id (where category_id can also be combined)

Return Value

Document

DMS Document or FALSE on failure

in DocumentModel at line 739
DocumentIndexReference|null 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

DocumentIndexReference|null

in Document at line 266
int|bool save(bool $save_raw = false, bool $skip_category_notification = false, bool $skip_search_index_update = false, bool $createPreviewJob = true)

Save document to database

Parameters

bool $save_raw

dont handle secure filenames
bool $skip_category_notification

Skip Category Notification (Category will not be updated and saved)
bool $skip_search_index_update

Skip Search Index Update (Search Index will not be updated)
bool $createPreviewJob

Creates a PreviewJob at the end of the process.

Return Value

int|bool

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

in Document at line 677
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

Parameters

mixed $meta

An assoc array of all meta data

Return Value

int|bool

Number of inserted meta data rows to the document_meta_data table

in Model at line 633
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 1381
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 81
ModelCollection scope(string $scopeName, Query|null $scopeQuery = null)

No description

Parameters

string $scopeName
Query|null $scopeQuery

Return Value

ModelCollection

in ScopesTrait at line 16
ModelCollection scopeAll()

No description

Return Value

ModelCollection

in Model at line 40
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 ScopesTrait at line 16
ModelCollection scope_by_id(int|array $id)

No description

Parameters

int|array $id

Return Value

ModelCollection

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

No description

Parameters

) $this find_by_id($id

Return Value

void

in Document at line 2491
bool setCustomThumbnail(string|null $filePath = null)

Sets a custom thumbnail for this document. Set to FALSE to unset.

Parameters

string|null $filePath

Return Value

bool

in DocumentModel at line 148
setDocumentIndex(DocumentIndex|null $documentIndex)

Sets the related document index.

Parameters

DocumentIndex|null $documentIndex

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

No description

Parameters

ModelCollection $modelCollectionReference

Return Value

void

in Document at line 1031
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

Parameters

string $filename

in Document at line 156
set_model_default_render_xui(string $model_default_render_xui)

No description

Parameters

string $model_default_render_xui

in Model at line 599
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 Document at line 660
set_property(string|array $property_id, mixed $property_value = false, bool $no_change = false)

No description

Parameters

string|array $property_id

Marker ID (Can also be an Array)
mixed $property_value Value
bool $no_change

Value

return static

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

Sets parameter that will be passed to the XUI helpers

Parameters

mixed $params

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

Set Request Cache Entry

Parameters

string $key
mixed $value

in Document at line 793
string set_uploaded_file(array $FILE)

Handler for uploading files (should be attached as upload_callback to the corresponding form)

Parameters

array $FILE File

Return Value

string filename?

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 Document at line 622
start_new_version($auto_minor_change = false)

Starts a new version (will be saved when save() is called)

Parameters

$auto_minor_change

in Model at line 1675
stop_temporary_group_id_overwrite()

Stops the temporary overwrite of the table_group_id

in Model at line 1657
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 1583
string to_json()

Returns the model as JSON array

Return Value

string

Returns model string

in Model at line 1594
string to_string()

Returns the model as STRING

Return Value

string

Returns model as string

in Model at line 1536
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 Model at line 1843
void touchProperty($propertyName)

No description

Parameters

$propertyName

Return Value

void

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 Document at line 1990
bool unlock()

Remove all locks from the referenced document

Return Value

bool

in ScopesTrait at line 56
ModelCollection unscope(string $scopeName = null, Query|null $scopeQuery = null)

Returns an unscoped Collection

Parameters

string $scopeName
Query|null $scopeQuery

Provide a specific Query Object you want to unscope

Return Value

ModelCollection

in Document at line 713
protected update()

Updates properties.

in DocumentModel at line 159
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 Document at line 548
string|true validate(array $fieldErrors)

Validate Function for Forms with Document-Models as Target

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