This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilCachedObjectDefinition:

Public Member Functions
	getIlObjectDef ()

	getIlObjectGroup ()

	getIlObjectSubType ()

	lookupSubObjForParent ($parent)

	__destruct ()

	lookupGroupedRepObj ($parent)

Static Public Member Functions
static	getInstance ()

static	flush ()

Protected Member Functions
	__construct ()

	readFromDB ()

Protected Attributes
ilGlobalCache	$global_cache

array	$cached_results = []

bool	$changed = false

array	$il_object_def = []

array	$subobj_for_parent = []

array	$grouped_rep_obj_types = []

array	$il_object_group = []

array	$il_object_sub_type = []

Static Protected Attributes
static ilCachedObjectDefinition	$instance = null

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Cache for object definitions, based on ilGlobalCache.

Definition at line 24 of file class.ilCachedObjectDefinition.php.

Constructor & Destructor Documentation

◆ __construct()

ilCachedObjectDefinition::__construct ( )

protected

Definition at line 37 of file class.ilCachedObjectDefinition.php.

References ilGlobalCache\COMP_OBJ_DEF, ilGlobalCache\getInstance(), and readFromDB().

     {
         $this->global_cache = ilGlobalCache::getInstance(ilGlobalCache::COMP_OBJ_DEF);
         $this->readFromDB();
     }

Here is the call graph for this function:

◆ __destruct()

ilCachedObjectDefinition::__destruct ( )

Definition at line 173 of file class.ilCachedObjectDefinition.php.

References ilGlobalCache\COMP_OBJ_DEF, and ilGlobalCache\getInstance().

     {
         $ilGlobalCache = ilGlobalCache::getInstance(ilGlobalCache::COMP_OBJ_DEF);
         if ($this->changed && $ilGlobalCache->isActive()) {
             $this->changed = false;
             $ilGlobalCache->set('ilCachedObjectDefinition', $this);
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ flush()

static ilCachedObjectDefinition::flush ( )

static

Definition at line 136 of file class.ilCachedObjectDefinition.php.

References ilGlobalCache\COMP_OBJ_DEF, and ilGlobalCache\getInstance().

                                   : void
     {
         ilGlobalCache::getInstance(ilGlobalCache::COMP_OBJ_DEF)->flush();
         self::$instance = null;
     }

Here is the call graph for this function:

◆ getIlObjectDef()

ilCachedObjectDefinition::getIlObjectDef ( )

Definition at line 104 of file class.ilCachedObjectDefinition.php.

References $il_object_def.

                                     : array
     {
         return $this->il_object_def;
     }

◆ getIlObjectGroup()

ilCachedObjectDefinition::getIlObjectGroup ( )

Definition at line 109 of file class.ilCachedObjectDefinition.php.

References $il_object_group.

                                       : array
     {
         return $this->il_object_group;
     }

◆ getIlObjectSubType()

ilCachedObjectDefinition::getIlObjectSubType ( )

Definition at line 114 of file class.ilCachedObjectDefinition.php.

References $il_object_sub_type.

                                         : array
     {
         return $this->il_object_sub_type;
     }

◆ getInstance()

static ilCachedObjectDefinition::getInstance ( )

static

Definition at line 119 of file class.ilCachedObjectDefinition.php.

References ilGlobalCache\COMP_OBJ_DEF, ilGlobalCache\get(), ilGlobalCache\getInstance(), and ilGlobalCache\set().

Referenced by ilObjectDefinition\getGroupedRepositoryObjectTypes(), and ilObjectDefinition\readDefinitionDataFromCache().

                                         : ilCachedObjectDefinition
     {
         if (!isset(self::$instance)) {
             $global_cache = ilGlobalCache::getInstance(ilGlobalCache::COMP_OBJ_DEF);
             $cached_obj = $global_cache->get('ilCachedObjectDefinition');
             if ($cached_obj instanceof ilCachedObjectDefinition) {
                 self::$instance = $cached_obj;
             } else {
                 self::$instance = new self();
                 $global_cache->set('ilCachedObjectDefinition', self::$instance);
             }
         }
 
         return self::$instance;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupGroupedRepObj()

ilCachedObjectDefinition::lookupGroupedRepObj ( $parent )

Parameters

mixed $parent

Returns: mixed

Definition at line 187 of file class.ilCachedObjectDefinition.php.

References $index.

     {
         if (is_array($parent)) {
             $index = md5(serialize($parent));
             if (isset($this->cached_results['grpd_repo'][$index])) {
                 return $this->cached_results['grpd_repo'][$index];
             }
 
             $return = array();
             $sids = array();
             foreach ($parent as $p) {
                 $s = $this->grouped_rep_obj_types[$p];
                 foreach ($s as $child) {
                     if (!in_array($child['sid'], $sids)) {
                         $sids[] = $child['sid'];
                         $return[] = $child;
                     }
                 }
             }
             $this->changed = true;
             $this->cached_results['grpd_repo'][$index] = $return;
 
             return $return;
         } else {
             return $this->grouped_rep_obj_types[$parent] ?? null;
         }
     }

◆ lookupSubObjForParent()

ilCachedObjectDefinition::lookupSubObjForParent ( $parent )

Parameters

mixed $parent

Returns: mixed

Definition at line 147 of file class.ilCachedObjectDefinition.php.

References $index.

     {
         if (is_array($parent)) {
             $index = md5(serialize($parent));
             if (isset($this->cached_results['subop_par'][$index])) {
                 return $this->cached_results['subop_par'][$index];
             }
 
             $return = array();
             foreach ($parent as $p) {
                 if (isset($this->subobj_for_parent[$p]) && is_array($this->subobj_for_parent[$p])) {
                     foreach ($this->subobj_for_parent[$p] as $rec) {
                         $return[] = $rec;
                     }
                 }
             }
 
             $this->cached_results['subop_par'][$index] = $return;
             $this->changed = true;
 
             return $return;
         }
 
         return $this->subobj_for_parent[$parent];
     }

◆ readFromDB()

ilCachedObjectDefinition::readFromDB ( )

protected

Definition at line 44 of file class.ilCachedObjectDefinition.php.

References $DIC.

Referenced by __construct().

                                    : void
     {
         global $DIC;
         $db = $DIC->database();
 
         $sql =
             "SELECT id, class_name, component, location, checkbox, inherit, translate, devmode, allow_link," . PHP_EOL
             . "allow_copy, rbac, `system`, sideblock, default_pos, grp, default_pres_pos, `export`, repository," . PHP_EOL
             . "workspace, administration, amet, orgunit_permissions, lti_provider, offline_handling" . PHP_EOL
             . "FROM il_object_def" . PHP_EOL
         ;
         $set = $db->query($sql);
         while ($rec = $db->fetchAssoc($set)) {
             $this->il_object_def[$rec['id']] = $rec;
         }
 
         $sql =
             "SELECT parent, subobj, mmax" . PHP_EOL
             . "FROM il_object_subobj" . PHP_EOL
         ;
         $set = $db->query($sql);
         while ($rec = $db->fetchAssoc($set)) {
             $parent = $rec['parent'];
             $this->subobj_for_parent[$parent][] = $rec;
         }
 
         $sql =
             "SELECT DISTINCT(id) AS sid, parent, id, class_name, component, location, checkbox, inherit," . PHP_EOL
             . "translate, devmode, allow_link, allow_copy, rbac, `system`, sideblock, default_pos, grp," . PHP_EOL
             . "default_pres_pos, `export`, repository, workspace, administration, amet, orgunit_permissions," . PHP_EOL
             . "lti_provider, offline_handling" . PHP_EOL
             . "FROM il_object_def, il_object_subobj" . PHP_EOL
             . "WHERE NOT (" . $db->quoteIdentifier('system') . " = 1)" . PHP_EOL
             . "AND NOT (sideblock = 1)" . PHP_EOL
             . "AND subobj = id" . PHP_EOL
         ;
         $set = $db->query($sql);
         while ($rec = $db->fetchAssoc($set)) {
             $this->grouped_rep_obj_types[$rec['parent']][] = $rec;
         }
 
         $sql =
             "SELECT id, name, default_pres_pos" . PHP_EOL
             . "FROM il_object_group" . PHP_EOL
         ;
         $set = $db->query($sql);
         while ($rec = $db->fetchAssoc($set)) {
             $this->il_object_group[$rec['id']] = $rec;
         }
 
         $sql =
             "SELECT obj_type, sub_type, amet" . PHP_EOL
             . "FROM il_object_sub_type" . PHP_EOL
         ;
         $set = $db->query($sql);
         while ($rec = $db->fetchAssoc($set)) {
             $this->il_object_sub_type[$rec['obj_type']][] = $rec;
         }
     }