Cache for object definitions, based on ilGlobalCache. More...

Inheritance diagram for ilCachedObjectDefinition:

Collaboration diagram for ilCachedObjectDefinition:

Public Member Functions
	getContainerKey ()

	isForced ()

	init ()

	getIlObjectDef ()

	getIlObjectGroup ()

	getIlObjectSubType ()

	lookupSubObjForParent ($parent)

	__destruct ()

	lookupGroupedRepObj ($parent)

	getContainerKey ()

	isForced ()

Static Public Member Functions
static	getInstance ()

Protected Member Functions
	__construct ()

	loadFromRawData (array $data)

	getRawData ()

	saveToCache ()

	readFromCache ()

	readFromDB ()

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

Private Attributes
ILIAS Cache Container Container	$cache

Detailed Description

Cache for object definitions, based on ilGlobalCache.

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

Constructor & Destructor Documentation

◆ __construct()

ilCachedObjectDefinition::__construct ( )

protected

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

    {
        global $DIC;
        $this->cache = $DIC->globalCache()->get($this);
        $this->init();
    }

References $DIC, and init().

Here is the call graph for this function:

◆ __destruct()

ilCachedObjectDefinition::__destruct ( )

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

    {
        if ($this->changed) {
            $this->changed = false;
            $this->cache->set('data', $this->getRawData());
        }
    }

References getRawData().

Here is the call graph for this function:

Member Function Documentation

◆ getContainerKey()

ilCachedObjectDefinition::getContainerKey ( )

Implements ILIAS\Cache\Container\Request.

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

                                     : string
    {
        return 'objdef';
    }

◆ getIlObjectDef()

ilCachedObjectDefinition::getIlObjectDef ( )

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

                                    : array
    {
        return $this->il_object_def;
    }

References $il_object_def.

◆ getIlObjectGroup()

ilCachedObjectDefinition::getIlObjectGroup ( )

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

                                      : array
    {
        return $this->il_object_group;
    }

References $il_object_group.

◆ getIlObjectSubType()

ilCachedObjectDefinition::getIlObjectSubType ( )

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

                                        : array
    {
        return $this->il_object_sub_type;
    }

References $il_object_sub_type.

◆ getInstance()

static ilCachedObjectDefinition::getInstance ( )

static

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

                                        : ilCachedObjectDefinition
    {
        if (!isset(self::$instance)) {
            return self::$instance = new self();
        }
 
        return self::$instance;
    }

References $instance.

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

Here is the caller graph for this function:

◆ getRawData()

ilCachedObjectDefinition::getRawData ( )

protected

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

                                   : array
    {
        return [
            'il_object_def' => $this->il_object_def,
            'subobj_for_parent' => $this->subobj_for_parent,
            'grouped_rep_obj_types' => $this->grouped_rep_obj_types,
            'il_object_group' => $this->il_object_group,
            'il_object_sub_type' => $this->il_object_sub_type,
            'cached_results' => $this->cached_results,
        ];
    }

References $cached_results, $grouped_rep_obj_types, $il_object_def, $il_object_group, $il_object_sub_type, and $subobj_for_parent.

Referenced by __destruct(), and saveToCache().

Here is the caller graph for this function:

◆ init()

ilCachedObjectDefinition::init ( )

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

                          : void
    {
        if ($this->cache->has('data')) {
            $this->readFromCache();
        } else {
            $this->readFromDB();
            $this->saveToCache();
        }
    }

References readFromCache(), readFromDB(), and saveToCache().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isForced()

ilCachedObjectDefinition::isForced ( )

Implements ILIAS\Cache\Container\Request.

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

                              : bool
    {
        return false;
    }

◆ loadFromRawData()

ilCachedObjectDefinition::loadFromRawData ( array $data )

protected

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

                                                   : void
    {
        $this->il_object_def = $data['il_object_def'];
        $this->subobj_for_parent = $data['subobj_for_parent'];
        $this->grouped_rep_obj_types = $data['grouped_rep_obj_types'];
        $this->il_object_group = $data['il_object_group'];
        $this->il_object_sub_type = $data['il_object_sub_type'];
        $this->cached_results = $data['cached_results'];
    }

References $data.

Referenced by readFromCache(), and readFromDB().

Here is the caller graph for this function:

◆ lookupGroupedRepObj()

ilCachedObjectDefinition::lookupGroupedRepObj ( $parent )

Parameters

mixed $parent

Returns: mixed

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

    {
        if (is_array($parent)) {
            $index = md5(serialize($parent));
            if (isset($this->cached_results['grpd_repo'][$index])) {
                return $this->cached_results['grpd_repo'][$index];
            }
 
            $return = [];
            $sids = [];
            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 200 of file class.ilCachedObjectDefinition.php.

    {
        if (is_array($parent)) {
            $index = md5(serialize($parent));
            if (isset($this->cached_results['subop_par'][$index])) {
                return $this->cached_results['subop_par'][$index];
            }
 
            $return = [];
            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];
    }

◆ readFromCache()

ilCachedObjectDefinition::readFromCache ( )

protected

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

                                      : void
    {
        // This is a workaround for the fact that transformatuin cannot be created by
        // $DIC->refinery()->xy() since we are in a hell of dependencies. E.g. we cant instantiate the
        // caching service with $DIC->refinery() since the Refinery needs ilLanguage, but ilLanguage
        // needs the caching service and so on...
        $cached_results = $this->cache->get('data', new Transformation(function ($data) {
            return $data;
        }));
        if (is_array($cached_results)) {
            $this->loadFromRawData($cached_results);
        } else {
            $this->readFromDB();
        }
    }

References $cached_results, $data, loadFromRawData(), and readFromDB().

Referenced by init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFromDB()

ilCachedObjectDefinition::readFromDB ( )

protected

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

                                   : void
    {
        global $DIC;
        $db = $DIC->database();
 
        $data = [];
 
        $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)) {
            $data['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'];
            $data['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)) {
            $data['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)) {
            $data['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)) {
            $data['il_object_sub_type'][$rec['obj_type']][] = $rec;
        }
        $data['cached_results'] = [];
        $this->loadFromRawData($data);
    }

References $data, $DIC, and loadFromRawData().

Referenced by init(), and readFromCache().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveToCache()

ilCachedObjectDefinition::saveToCache ( )

protected

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

                                    : void
    {
        $this->cache->set('data', $this->getRawData());
    }

References getRawData().

Referenced by init().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $cache

ILIAS Cache Container Container ilCachedObjectDefinition::$cache

private

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

◆ $cached_results

array ilCachedObjectDefinition::$cached_results = []

protected

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

Referenced by getRawData(), and readFromCache().

◆ $changed

bool ilCachedObjectDefinition::$changed = false

protected

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

◆ $grouped_rep_obj_types

array ilCachedObjectDefinition::$grouped_rep_obj_types = []

protected

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

Referenced by getRawData().

◆ $il_object_def

array ilCachedObjectDefinition::$il_object_def = []

protected

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

Referenced by getIlObjectDef(), and getRawData().

◆ $il_object_group

array ilCachedObjectDefinition::$il_object_group = []

protected

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

Referenced by getIlObjectGroup(), and getRawData().

◆ $il_object_sub_type

array ilCachedObjectDefinition::$il_object_sub_type = []

protected

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

Referenced by getIlObjectSubType(), and getRawData().

◆ $instance

ilCachedObjectDefinition ilCachedObjectDefinition::$instance = null

staticprotected

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

Referenced by getInstance().

◆ $subobj_for_parent

array ilCachedObjectDefinition::$subobj_for_parent = []

protected

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

Referenced by getRawData().

The documentation for this class was generated from the following file:

components/ILIAS/ILIASObject/classes/class.ilCachedObjectDefinition.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ getContainerKey()

◆ getIlObjectDef()

◆ getIlObjectGroup()

◆ getIlObjectSubType()

◆ getInstance()

◆ getRawData()

◆ init()

◆ isForced()

◆ loadFromRawData()

◆ lookupGroupedRepObj()

◆ lookupSubObjForParent()

◆ readFromCache()

◆ readFromDB()

◆ saveToCache()

Field Documentation

◆ $cache

◆ $cached_results

◆ $changed

◆ $grouped_rep_obj_types

◆ $il_object_def

◆ $il_object_group

◆ $il_object_sub_type

◆ $instance

◆ $subobj_for_parent