DMSController
class DMSController extends SystemDMSController
Class DMSController
Traits
Trait CoreLinkMethods
Static Cache Trait Adds a static (per request) cache to the object which can hold data for the time of the request (in the frontend) or a certain duration during long running processes. It works together with the global caching system and enforces a static cache clearing in case of global cache clearings as well.
Trait ObjectManager XELOS Framework
Constants
| EVENT_MODEL_CREATED |
Global modules events. |
| EVENT_MODEL_UPDATED |
|
| EVENT_MODEL_DELETED |
|
| XFS_ROOT_NAME |
|
| PERSONAL_WORKSPACE_NAME |
|
| CATEGORY_ICON_PATH |
|
| HAS_READ_POLICY |
|
| HAS_WRITE_POLICY |
|
| HAS_DELETE_POLICY |
|
| DOCUMENT_ISLINK_HTML |
|
Properties
| protected array | $object_cache | Each object created by a success call of |
from ObjectManager |
| protected array | $registry | The instantiation of a requested object can be processed only if the class of the object is registered with the class name as key and its information as array in this property. The element should have at least the class name or the relative path to "class" folder. |
from ObjectManager |
| protected string | $lib_class_dir | This property contains the path to the folder served as root for all requested classes. This folder can contains other folder or classes. All requested and registered classes will be searched in this folder by concating this path with the relative path defined in the registration of the requested class. If the class is not included it will be done on the fly. |
from ObjectManager |
| protected string | $lib_class_prefix | An optional possibility to pretend a prefix for all registered classes. |
from ObjectManager |
| protected string | $ns_class_prefix | An optional possibility to pretend a namespace prefix for classes have no namespace yet. |
from ObjectManager |
| protected bool | $factory_mode | This property effects the object cache. By default it is set to false to enable the object cache for all requested objects. If this property is set true, the object cache will be disabled. |
from ObjectManager |
| protected array | $injection_objects | This is an assoc array and contains objects that will be injected into each requested object. Each containing object will be injected by the name of the key. E.g. ['mod' => $object] this would inject the property named mod with the value of $object. |
from ObjectManager |
| protected bool | $auto_init | This property controls if the init method of requested objects is called by this trait or not. |
from ObjectManager |
| bool | $full_module_namespace_support | from Controller | |
| Config | $config | from Core | |
| bool | $instance_copy_id | from Core | |
| mixed | $template | from Core | |
| string | $context | from Core | |
| Core | $parent_context | from Core | |
| array | $meta_info | from Core | |
| int deprecated | $group_context | from Core | |
| string | $group_name | from Core | |
| string | $storage_path | from Core | |
| protected Link | $xf_link | from Core | |
| array | $GPvars | from Core | |
| Action read-only | $action | from SystemDMSController | |
| MagicMethodHelper | $model | from Controller | |
| MagicMethodHelper | $page | from Controller | |
| MagicMethodHelper | $ui | from Controller | |
| MagicMethodHelper | $collection | from Controller | |
| ContentFirst read-only | $cf | from SystemDMSController | |
| Controller | $mod | from Controller | |
| bool | $table_show_export | from SystemDMSController | |
| bool | $initialized | from SystemDMSController | |
| bool | $table_show_version | from SystemDMSController | |
| bool | $table_show_summary | from SystemDMSController | |
| bool | $table_show_size | from SystemDMSController | |
| bool | $table_show_owner | from SystemDMSController | |
| bool | $table_show_date | from SystemDMSController | |
| bool | $table_show_select_column | from SystemDMSController | |
| protected Quota|null | $quota | from SystemDMSController | |
| bool | $enable_search_index | from SystemDMSController | |
| string|null | $force_view_mode | from SystemDMSController | |
| string | $default_view_mode | Default category mode of document panel |
from SystemDMSController |
| string | $default_document_page | This determines where files links are pointing to |
from SystemDMSController |
| int | $force_category_restriction | Param will force document panel to treat a given category id as top category |
from SystemDMSController |
Methods
Gettext Wrapper using current module context for module specific translations
XELOS\Modules\DMS\xm_dms constructor.
No description
No description
Add CSS file from the wwwres/css folder to the page
Add JS file from the wwwres/js folder to the page
No description
Returns the passed JSON and returns the module template directly to the view class for rendering
show the add document link above the files table
Attach a Link to each model in the collection
Copies an existing document by its document index id.
Calls dbquery() after given SQL has been converted by $XF->lib->i18n->convert_i18n_sql()
No description
No description
Deletes all category which relates to the given group.
Generates and returns the completed sentences for the dyn tree params field.
Creates a default category within current context if no root category exists.
No description
Needs to be done this way, since methods from traits won't be inherited and therefor not be called right here.
Get dependency with unknown group context
Placeholder method, that simply returns an empty array, in case the user chose a module, which isn't able to provide dynamic tree parameters.
Get the group_security_id for this instance (optional: based on a local group_context)
Defines an array containing pages, which will then be returned to the group navigation form in order to display them as entries in the select field 'ref_page'.
This method will return an object without killing the whole process by triggering a fatal error You can use this method if its possible that the object is not available, e.g. due to user configurations
Get the XELOS File Root for attachments and System Files
Get the configured languages for this instance
No description
returns the global document index fron document_index
returns the global document id fron document_index
No description
No description
No description
No description
No description
Returns true if the i18n translation has been set to required for this instance
Returns the personal workspace folder for the current user
Call specific object - allows to use constructor-params (overload function) This function is primarily called from the magic GET and CALL Methods
Returns the default dms to store application files.
Get usage size based on folder sizes, can be filtered by group_id optionally, will automatically group if DMS is in group_context
No description
No description
Guess the group ID by evaluating GP and CMD Vars
Returns true if the default access is allowed, otherwise false.
Checks if the user has access to the hook
Returns the passed data object as JSON body response
No description
No description
Notification
DeepLink Page (will be called for unresolvable deeplinks, e.g. from hooks search or others
No description
No description
Print File Link (Alias Function)
Wrapper for XF->lib->link substituting modules with instance names etc.
Render Module Output, this will get the template of the default page and render the template
Resolve URL like https://local.xelos-project.net/_doc/goto/FCF68648-A8CE-4362-9901-1CEA704515D6
Resolve a Link for a local dependency (a - by returning a valid template or b - by sending a http-redirect)
Needed for Index Search
Returns the xfs_document in the storage DMS to a ID.
Allows access to different versions DMS documents.
Enforce Link Context based on Current Parent Instance for the local Page and CMD
Nested Path is used for resolving referenced documents and is special to SystemDMS
No description
No description
sets the numerical Context-ID (PrimaryKey in Instance_Registry)
show download link in file table instead of the detail link
Set Dep Link Context - generated URLs will be considered relative to the given parent instance
Add given objects to injection object list that will be inject into object by magic call. The array should consists of property name as key and object as value.
Sets the quota as the given unit.
show any file options such as edit, delete, lock, download as zip etc.
Clears the specified cache pool from the static cache
Retrieves a value from the static cache
Returns an array of all cache keys which have been set
Returns an key/value array with all cached values from the passed pool
Checks if the passed is key has a value set
Removes the passed key
Store a value in the static cache
Stores the file in the system DMS
Stores a file of an instance
No description
Calculates used resources of this instance.
Check if user has PAGE access to the instance
Return the group_security ids the user has access to
No description
Return the group_security ids the user has the policy in
User has policy values
trait constructor This method have to be called from constructor of each class that uses this trait.
Details
in
Core at line 165
string
_(string $token, string[] $placeholder = [])
Gettext Wrapper using current module context for module specific translations
in
ObjectManager at line 250
mixed
__call($class, $args)
Magic method.
Returns the requested object. If the object is not cached, it will be instantiated with given arguments.
This method calls xf_trait::get_object.
at line 32
__construct(string $instance)
XELOS\Modules\DMS\xm_dms constructor.
in
ObjectManager at line 232
mixed
__get($class)
Magic method.
First it checks if the requested property is defined and returns it if null. If not defined of null, it calls
xf_trait::get_object and returns its return value.
in
ObjectManager at line 200
bool
__isset($property)
Magic method.
This method checks whether the property is defined or injected by __set. If not
injected or defined, it will check the registry for an entry of requested property.
in
ObjectManager at line 220
__set($name, $value)
Magic method.
Sets the given value by $name
in
Core at line 2451
__toString()
No description
in
Core at line 2401
addActionLog(DocumentIndex $documentIndex, int $action_key, int $user_id = null, string $subject = null, int $target_user_id = null, array $link_params = [])
No description
in
Core at line 2369
add_actionlog(int $action_id, int|bool $user_id = false, string|bool $what = false, int|bool $target_user_id = false, array|bool $link_params = false, int|bool $post_id = false, int|bool $post_type = 0, int|bool $group_id = false)
deprecated
deprecated
No description
in
Core at line 659
final
add_class_to_registry($registry)
No description
in
Core at line 862
add_config_array(mixed $configArray, mixed $context = false)
No description
in
Controller at line 159
add_css_file(string $filename_in_css_dir, string $position = 'bottom', bool $media = false, bool $if_condition = false)
Add CSS file from the wwwres/css folder to the page
in
Controller at line 170
add_js_file(string $filename_in_js_dir, string $position = 'bottom')
Add JS file from the wwwres/js folder to the page
in
SystemDMSController at line 866
bool|Category|Document
add_link(int|DocumentIndex $document_index, int|string $category_id, string $level = 'read', int $groupId = 0)
No description
in
Core at line 466
bool|string|xelos_global_template
ajax_response(array|bool $json_response = false, bool|int $error_code = false, bool|xelos_global_template $template = false, bool|string $render_mode = false)
Returns the passed JSON and returns the module template directly to the view class for rendering
in
SystemDMSController at line 168
allow_add_document(bool $value)
show the add document link above the files table
in
SystemDMSController at line 159
allow_table_export(bool $value)
show the export link above the files table
in
Controller at line 337
ModelCollection
attach_link(ModelCollection|Model $model_collection, string $property_name, array $link_params, bool $current_link = true)
Attach a Link to each model in the collection
in
Core at line 1877
check_download_file(mixed $path_to_file, mixed $download_params)
No description
in
Core at line 1505
clear_template()
No description
in
SystemDMSController at line 929
Document
copy_document_by_di(int $document_index_id, Core $mod, null $category_id = null)
Copies an existing document by its document index id.
If the copy target is a dms instance, it will copy into category by category_id, otherwise the target category is one of the context category in the system dms. If this mod context category does not exists yet, this method will create this category an set this as category for the copied dms document.
in
Core at line 725
dblquery($sql, $mode = 'fetch_assoc', $file = __FILE__, $line = __LINE__, $cache_ttl = false, $cache_group = false, $query_type = false)
Calls dbquery() after given SQL has been converted by $XF->lib->i18n->convert_i18n_sql()
in
Core at line 676
mixed
dbquery(string $sql, string $mode = 'fetch_assoc', string $file = __FILE__, int $line = __LINE__, int|bool $cache_ttl = false, int|bool $cache_group = false, string|bool $query_type = false)
No description
in
Core at line 701
array|int|false
dbquery_with_params(string $sql, array $params, string $mode = 'fetch_assoc', string $file = __FILE__, int $line = __LINE__, int|bool $cache_ttl = false, int|bool $cache_group = false, string|bool $query_type = false)
No description
in
SystemDMSController at line 793
deleteGroupContext(int $group_id)
Deletes all category which relates to the given group.
in
Core at line 2634
bool
delete_file(int $id)
Deletes the file stored in the storage DMS.
If the file does not exist in the DMS, it checks the mod_storage_path if the file exists there and deletes it there.
in
Controller at line 131
MagicDocumentHelper|null
document(DocumentIndex|int $document_index)
No description
in
ModulePageCollector at line 29
array
dynTreeAutocompletion(array $acceptedDyntreeParams)
Generates and returns the completed sentences for the dyn tree params field.
in
SystemDMSController at line 294
mixed
ensureInitialization()
Creates a default category within current context if no root category exists.
in
Core at line 543
xelos_global_template|string
error_response(string $err_msg = 'access_denied', string $err_type = 'denied', string $render_mode = 'full')
No description
at line 80
array
getCommandsForPage(string $searchString, string $refPage = '')
Needs to be done this way, since methods from traits won't be inherited and therefor not be called right here.
in
Core at line 1404
Core|null
getDependencyInGuessGroupContext(string $dependency, string $page_id, array $cmd)
Get dependency with unknown group context
in
ModulePageCollector at line 18
array
getDynTreeParams()
Placeholder method, that simply returns an empty array, in case the user chose a module, which isn't able to provide dynamic tree parameters.
in
Core at line 429
int
getGroupContext()
No description
in
Core at line 1332
int
getGroupSecurityId(int $group_context = 0)
Get the group_security_id for this instance (optional: based on a local group_context)
in
Core at line 1275
array
getHooksAsObject($hookName)
No description
in
Core at line 195
string
getI18nTokenDomain()
Return i18n Token Domain
in
ModulePageCollector at line 52
array
getModulePages()
Defines an array containing pages, which will then be returned to the group navigation form in order to display them as entries in the select field 'ref_page'.
The user then is able to select one of these pages (of the selected instance).
in
ObjectManager at line 267
object|null
getObjectIfAvailable(string $class)
This method will return an object without killing the whole process by triggering a fatal error You can use this method if its possible that the object is not available, e.g. due to user configurations
in
SystemDMSController at line 979
Category
getRootCategory()
No description
in
SystemDMSController at line 214
bool
getShowNavBar()
No description
in
Core at line 2568
static SystemDMSController|null
getSystemDMS()
Get System DMS, using static cache
in
SystemDMSController at line 150
string
getTrashPath()
Returns the path to the trash storage.
in
SystemDMSController at line 991
Category
getXFSRootCategory()
Get the XELOS File Root for attachments and System Files
in
Controller at line 147
mixed
get_action(string $helper)
No description
in
Core at line 2416
protected SystemActionlogController
get_actionlog()
Return the actionlog instance
in
SystemDMSController at line 175
bool
get_allow_add_document()
No description
in
Core at line 2494
array
get_available_languages($includeTitle = false)
Get the configured languages for this instance
in
Core at line 613
mixed
get_config(string $var, mixed $context = false)
No description
in
Core at line 2460
int
get_context_id()
gets the numerical Context-ID (PrimaryKey in Instance_Registry)
in
CoreLinkMethods at line 174
array|false
get_current_link(array $params = array())
No description
in
CoreLinkMethods at line 190
get_current_url()
No description
in
SystemDMSController at line 244
string
get_current_view_mode()
Get current View Mode
in
Core at line 2477
string
get_default_i18n()
Get the default language set for this instance
in
Core at line 351
Template
get_dep_page(bool|string $default = false, bool|string $cmd = false, bool $preserve_render_mode = false)
No description
in
Core at line 1428
array
get_deps($group_context = false)
No description
in
Core at line 2539
DocumentIndex
get_document_index(int $local_document_id, int $document_type = 0)
returns the global document index fron document_index
requires the model is registered in document_registry for being index by document_index!
in
Core at line 2521
int|false
get_document_index_id(int $local_document_id, int $document_type = 0)
returns the global document id fron document_index
requires the model is registered in document_registry for being index by document_index!
in
Core at line 2434
bool|mixed
get_dyn_config($var, bool $order_set_name = false, bool $context = false)
deprecated
deprecated
No description
in
SystemDMSController at line 617
array
get_dyn_tree(array $params = [])
No description
in
SystemDMSController at line 586
string|bool
get_file_link(string $path_to_file, array $params = [])
No description
in
SystemDMSController at line 555
mixed
get_file_url(string $path_to_file, bool $inline_disposition = true, string|bool $name = false, bool $zipOnTheFly = false, int|bool $width = false, int|bool $height = false, string|bool $resize_mode = false, bool $public_file_link = false, null $cache_hash = null)
No description
in
Core at line 1852
array
get_file_url_args(string $path_to_file, mixed $inline_disposition = true, mixed $name = false, mixed $zipOnTheFly = false)
No description
in
Core at line 408
int
get_group()
deprecated
deprecated
No description
in
Core at line 976
mixed
get_hook(string $original_hook_name, string $provider_instance = 'self', bool $force_new = false, bool $skip_access_check = false)
No description
in
Core at line 1114
array
get_hooks(string $local_hook_name, array|bool $limit_to_instances = false, bool $instantiate = true, mixed $parentContext = false, string $hook_class = null)
No description
in
Core at line 2508
bool
get_i18n_translation_required()
Returns true if the i18n translation has been set to required for this instance
in
ObjectManager at line 168
string
get_lib_class_dir()
Returns the path to class directory.
in
ObjectManager at line 178
string
get_lib_class_prefix()
Returns the defined prefix for all classes.
in
CoreLinkMethods at line 101
array|bool
get_link()
No description
in
Controller at line 119
mixed
get_model(string $model, bool $new_instance = false)
No description
at line 71
null|Category
get_my_documents_folder()
Returns the personal workspace folder for the current user
in
Core at line 634
final mixed
get_object(string $class, null|array $args = null, bool $call_init = true)
Call specific object - allows to use constructor-params (overload function) This function is primarily called from the magic GET and CALL Methods
in
ObjectManager at line 188
array
get_object_cache()
Returns an array containing all objects were requested.
in
Core at line 911
xelos_global_template
get_page(string $page_id, array $args = array())
No description
in
Core at line 1445
Core|null
get_parent_context()
Get Parent Context
in
Controller at line 385
string
get_parsed_message(string $template_name, string $section)
No description
in
Core at line 204
mixed
get_plugin(string $name)
No description
in
Core at line 223
array
get_plugins_by_prefix(string $prefix)
No description
in
Core at line 1750
get_preview_url($path_to_file, $name = false)
No description
in
SystemDMSController at line 200
Quota|null
get_quota()
Returns a quota object.
in
Core at line 1737
static
get_resize_hash(int $w, int $h)
Calculate Resize Hash !Is also called static
in
Core at line 438
bool
get_security_level()
deprecated
deprecated
No description
in
SystemDMSController at line 191
bool
get_show_file_options()
No description
in
Core at line 2559
SystemDMSController|null
get_system_dms()
Returns the default dms to store application files.
It uses the DMS configured in Expert Configuration -> GUI -> Filebrowser DMS: system config key filebrowser_dms
in
Core at line 1741
get_thumb_url($path_to_file, $name = false)
No description
in
CoreLinkMethods at line 117
string
get_url()
No description
in
SystemDMSController at line 282
int
get_usage_size(null $group_id = null)
Get usage size based on folder sizes, can be filtered by group_id optionally, will automatically group if DMS is in group_context
at line 63
VarsTemplate|bool
get_vars(string $file, string $block = null)
No description
in
Controller at line 300
VarsTemplate
get_vars_from_text(string $text)
Create a Vars model from text
at line 53
Template
get_view(string $view, string $section = false, bool $template_auto_setup = true, bool $force_new = false)
No description
in
SystemDMSController at line 535
int
guessGroupId(string $page_id, string[]|int $args)
Guess the group ID by evaluating GP and CMD Vars
in
SystemDMSController at line 232
bool
hasDefaultAccess()
Returns true if the default access is allowed, otherwise false.
in
Core at line 1355
bool
hasDependency(string $dep_id)
Does module have an existing dependency
in
Core at line 1295
bool
has_hook_access(string $hook_instance_id, string $hook_name)
Checks if the user has access to the hook
in
SystemDMSController at line 119
init()
Initializes object
in
Core at line 2655
bool
isXlabsFeaturePreview()
No description
in
Core at line 448
void
jsonResponse($data, $httpResponseCode = 200)
Returns the passed data object as JSON body response
in
Core at line 802
mixed
lpquery(string $query, array $params = array(), string $file = __FILE__, int $line = __LINE__, int $cache_ttl = 0, null $cache_group = null)
No description
in
Core at line 186
string
ngettext(string $singularToken, string $pluralToken, int $count, array $placeholder = [])
No description
in
Core at line 2698
Notification
notification_info($user_id, $token_id)
deprecated
deprecated
No description
in
Core at line 2705
notification_mark_read($userId, $token)
deprecated
deprecated
No description
in
Core at line 2680
notify(int|array $user_id, string $token, string $subject, string $plaintext = null, mixed $html = false, mixed $url = null, string $icon = null, string $type = XF\Lib\Notification\NotificationType::ACTIVITY)
deprecated
deprecated
Notification
in
Core at line 2232
string|void|xelos_global_template
page__deeplink(array $dependency_id)
DeepLink Page (will be called for unresolvable deeplinks, e.g. from hooks search or others
in
Core at line 1885
page__feed(UniversalFeedCreator $feed)
No description
in
Core at line 1896
page__file()
No description
in
Core at line 776
mixed
pquery(string $query, array $params = array(), string $file = __FILE__, int $line = __LINE__, int $cache_ttl = 0, null $cache_group = null)
No description
in
Core at line 716
string|string[]|null
prepareQueryWithParams(string $sql, array $params)
No description
in
Core at line 753
string
prepare_lquery($sql)
No description
in
Core at line 743
string
prepare_query(string $sql)
No description
in
Core at line 1636
string
print_context_menu($params, array $context_links, bool $current_link = false, bool $no_js_fallback = true, $onMouseOver = false)
No description
in
Core at line 1664
string
print_context_menu_with_submenu(array $entries, array $params = array())
deprecated
deprecated
No description
in
CoreLinkMethods at line 207
print_current_link()
No description
in
Core at line 1784
string
print_file_link(string $path_to_file, array $params = array())
Print File Link (Alias Function)
in
CoreLinkMethods at line 156
string
print_link(array $params = array())
Wrapper for XF->lib->link substituting modules with instance names etc.
Example:
$this->mod->print_link(array('label'=>$label, 'page'=>$page, 'ajax_modal'=>array('form' => 'noajax')));
$this->mod->print_link(array('label'=>$label, 'page'=>$page, 'JS-FSLoader'=>array('message' => 'loading..','autohide'=>'5000')));
in
Core at line 1760
print_preview_link($path_to_file, $params = array())
No description
in
Core at line 384
string
render()
Render Module Output, this will get the template of the default page and render the template
in
Core at line 2345
string|null
resolveDocumentIndexPermaURL(DocumentIndex $documentIndex)
in
SystemDMSController at line 492
protected int
resolveGroupId(string $page, array $cmd)
Resolve group ID
in
SystemDMSController at line 461
string|false
resolve_dep_link(string $dependency, string $page_id, array $cmd)
Resolve a Link for a local dependency (a - by returning a valid template or b - by sending a http-redirect)
in
SystemDMSController at line 416
array
resolve_doc_link(int $post_id, int $post_type = null)
Needed for Index Search
in
Core at line 2588
XfsDocument|null
retrieve_document(int $document_index_id, DocumentIndex|DocumentModel|int $main_document_index_id = null)
Returns the xfs_document in the storage DMS to a ID.
in
SystemDMSController at line 631
bool
send_file(array $args, bool $binary = false, bool $is_full_path = false)
Allows access to different versions DMS documents.
in
Core at line 315
setDepLinkContext(string $localPage, string $localCmd)
Enforce Link Context based on Current Parent Instance for the local Page and CMD
in
SystemDMSController at line 404
setNestedPath($nestedPath)
Nested Path is used for resolving referenced documents and is special to SystemDMS
in
Core at line 579
void
set_config(string $var, mixed $value, string|bool $context = false, string|bool $subcontext = false)
No description
in
Core at line 597
void
set_config_for_session(string $var, string $value, string $context = false, string $subcontext = false)
No description
in
Core at line 2469
set_context_id(int $context_id)
sets the numerical Context-ID (PrimaryKey in Instance_Registry)
in
SystemDMSController at line 223
set_default_document_page(string $value)
show download link in file table instead of the detail link
in
Core at line 331
set_dep_link_context(Core $parent, string $view, string $page, string $cmd)
Set Dep Link Context - generated URLs will be considered relative to the given parent instance
in
Core at line 398
void
set_group(int $group_id, string|bool $short_name = false)
No description
in
ObjectManager at line 126
set_injection_objects(array $objects)
Add given objects to injection object list that will be inject into object by magic call. The array should consists of property name as key and object as value.
in
ObjectManager at line 142
set_lib_class_dir($lib_class_dir)
Sets the directory where classes are stored.
This folder can contains other folder or classes. All requested and registered classes will be searched in this folder by concating this path with the relative path defined in the registration of the requested class. If the class is not included it will be done on the fly.
in
ObjectManager at line 157
set_lib_class_prefix($lib_class_prefix)
Sets the class name prefix.
An optional possibility to pretend a prefix for all registered classes. This prefix is only required in the class name of the requested object. The registered class name should not contains this prefix. E.g. a class called xf_foobar should be registered as foobar.
in
Controller at line 370
bool
set_message_vars($values, bool $reset = false)
No description
in
SystemDMSController at line 267
set_quota_size(int $quota_size, null $group_id = null)
Sets the quota as the given unit.
This method creates an quota objects that contains the quota information.
in
Core at line 1515
void
set_xf_link($xf_link)
No description
in
Core at line 950
xelos_global_template|bool
setup_check($args = array())
Check/Get Setup Page
in
SystemDMSController at line 207
showNavBar(bool $value = true)
No description
in
SystemDMSController at line 184
show_file_options(bool $value = true)
show any file options such as edit, delete, lock, download as zip etc.
in
StaticCacheTrait at line 121
static void
staticCacheClearAllCachePools()
No description
in
StaticCacheTrait at line 114
static void
staticCacheClearCachePool($cache_pool = 'default')
Clears the specified cache pool from the static cache
in
StaticCacheTrait at line 61
static array|string|int|bool|null
staticCacheGet($key, string $cache_pool = 'default')
Retrieves a value from the static cache
in
StaticCacheTrait at line 98
static array
staticCacheGetKeys(string $cache_pool = 'default')
Returns an array of all cache keys which have been set
in
StaticCacheTrait at line 107
static array
staticCacheGetPool($cache_pool)
Returns an key/value array with all cached values from the passed pool
in
StaticCacheTrait at line 34
static bool
staticCacheIsEnabled()
No description
in
StaticCacheTrait at line 85
static bool
staticCacheIsSet($key, string $cache_pool = 'default')
Checks if the passed is key has a value set
in
StaticCacheTrait at line 73
static
staticCacheRemove($key, string $cache_pool = 'default')
Removes the passed key
in
StaticCacheTrait at line 46
static void
staticCacheSet(string|int $key, mixed $value, string $cache_pool = 'default')
Store a value in the static cache
in
Core at line 2606
Document|null
store_file(string $path, string|null $xfsPath, string|null $file_name = null, DocumentModel|null $ownerDocumentModel = null)
Stores the file in the system DMS
in
SystemDMSController at line 813
Document|null
store_file_raw(string $instanceIdString, string $file_path, string $xfs_path, string|null $saveAsFilename = null, DocumentModel|null $ownerDocumentModel = null)
Stores a file of an instance
in
Controller at line 316
bool|string|Template|xelos_global_template
templateResponse(mixed $content, string $title)
No description
in
SystemDMSController at line 698
array
usedResources(int|bool $group_id = false)
Calculates used resources of this instance.
in
SystemDMSController at line 1080
bool
userHasApiAccess()
Does the user have API access to this instance?
in
Core at line 1587
bool
user_has_access(?string $page = null, string|bool $instance_id = false, int $group_security_id = 0)
Check if user has PAGE access to the instance
in
Core at line 1618
array
user_has_access_in_groups(string $page)
Return the group_security ids the user has access to
in
Core at line 1541
bool
user_has_policy(string $policy, mixed $policy_value = '*', int|bool $target_user = false, int|bool $group_id = false, string $default_policy = 'deny')
No description
in
Core at line 1554
array
user_has_policy_in_groups(string $policy, string $policy_value = false)
Return the group_security ids the user has the policy in
in
Core at line 1567
array
user_has_policy_values(string $policy, string $treeTable = null)
User has policy values
in
ObjectManager at line 104
xelos_object_manager_init(bool $lib_class_dir, string $lib_class_prefix = '', string $ns_prefix = '')
trait constructor This method have to be called from constructor of each class that uses this trait.
It sets the defaults and all necessary properties.