IM
class IM
Class IM
Traits
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.
Methods
Add Instances which should be ignored when applying global group context
No description
Returns all changed files from modules and system.
returns the default instance of the given module or false if no default is available To set a default insert order in insance:registry in fields sort_for_default -> as long there is null, no default is returned
returns global group context if set
returns global group parent context reference [Core] (if set). false if not set
No description
No description
Returns an array of all available instances
No description
Retrieve an Object Reference from the "lib-array"
No description
No description
No description
No description
Search and return Module Name Returns false if current user has no access rights for passed instance, otherwise the name of the module is returned
Returns all related instances(grand parent, parent, children and siblings)
No description
No description
Resets the local cache and forces IM to reload instance data for the next call
Renames the alphanumerical instance ID of an instance. Helper can only be renamed to the module name.
Resolve numeric instance_id to string representation or vice versa
Set the global parent context which will be used for each new instance (e.g. get_instance())
Set Instances which should be ignored when applying global group context
Set Instance Reference
Checks if a certain shellplugin is available on this system
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
Details
at line 258
add_global_group_context_exclude(array $global_group_excludes = array())
Add Instances which should be ignored when applying global group context
at line 511
add_include_path($include_paths)
No description
at line 1082
array
get_changed_files(string $module_name = '*')
Returns all changed files from modules and system.
To determine changes, the file_check_list.yml is used that located in each setup folder of modules and system. This file contains all necessary files with related checksum. A comparison of the local file checksum with the checksum of the file list determines if the file is changed of not.
at line 754
Core|bool
get_default_instance(string $module)
returns the default instance of the given module or false if no default is available To set a default insert order in insance:registry in fields sort_for_default -> as long there is null, no default is returned
at line 201
int
get_global_group_context(string $instance_id = false)
returns global group context if set
at line 184
Core
get_global_group_parent_context(string|bool $instance_id = false)
returns global group parent context reference [Core] (if set). false if not set
at line 48
get_hook_instances($hook_name, $create_obj = true)
No description
at line 223
Core|false
get_instance(string $instance_id, string|bool $instance_copy_id = false, bool $force_new = false, Core|bool $parent_context = false, int|bool $group_context = false, int $groupSecurityId = 0)
No description
at line 109
bool|mixed
get_instance_list(string|bool $mod = false)
Returns an array of all available instances
at line 658
array
get_instance_meta(string $instance_id)
No description
at line 473
Core
get_instance_reference($calling_instance, $object_id, $instance_copy_id = false, $module_name = false)
Retrieve an Object Reference from the "lib-array"
at line 278
Core|false
get_mod_instance(string $module_name, string $instance_id = null, string|bool $instance_copy_id = false, bool $no_existing_check_for_install = false, bool $force_new = false, Core|bool $parent_context = false, string|bool $group_context = false)
No description
at line 87
get_mod_instance_list($module_name)
No description
at line 529
string
get_module_icon(string $module_name, int $size = 16, string $vendor = null)
No description
at line 594
array
get_module_meta($module_name)
No description
at line 698
string|false
get_module_name_for_instance(string $instance_id, string $type = 'module', bool $skip_checks = false, int $group_context = false, int $groupSecurityId = 0)
Search and return Module Name Returns false if current user has no access rights for passed instance, otherwise the name of the module is returned
at line 907
array
get_related_instances(string $instance_id)
Returns all related instances(grand parent, parent, children and siblings)
at line 146
bool
instance_exists(string|int $instance_id, string $module_name = null)
No description
at line 164
bool
module_exists($module, $vendor = false)
No description
at line 1119
reload()
Resets the local cache and forces IM to reload instance data for the next call
at line 921
rename_instance(string $current_instance_id, string $new_instance_id = '')
Renames the alphanumerical instance ID of an instance. Helper can only be renamed to the module name.
Performs checks and updates the system tables and tables of other instances(e.g. search, workflows).
at line 635
string|int
resolve_instance_id(mixed $instance_id, string $output = 'auto')
Resolve numeric instance_id to string representation or vice versa
at line 239
void
set_global_group_context(int $context, Core|bool $parent_context = false)
Set the global parent context which will be used for each new instance (e.g. get_instance())
at line 250
set_global_group_context_exclude(array $global_group_excludes = array())
Set Instances which should be ignored when applying global group context
at line 498
set_instance_reference(mixed $calling_instance, mixed $object_id, mixed $object, mixed $instance_copy_id = false)
Set Instance Reference
at line 842
mixed
shellplugin_is_installed(string $plugin_id)
Checks if a certain shellplugin is available on this system
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