Collaboration diagram for ilObjectDataCache:

Public Member Functions
	__construct ()

	deleteCachedEntry (int $obj_id)

	lookupObjId (int $ref_id)

	lookupTitle (int $obj_id)

	lookupType (int $obj_id)

	lookupOwner (int $obj_id)

	lookupDescription (int $obj_id)

	lookupLastUpdate (int $obj_id)

	lookupOfflineStatus (int $obj_id)
	Check if supports centralized offline handling and is offline. More...

	isTranslatedDescription (int $obj_id)

	preloadObjectCache (array $obj_ids, string $lang='')
	Stores object data in cache. More...

	preloadTranslations (array $obj_ids, string $lang)
	Preload translation information. More...

	preloadReferenceCache (array $ref_ids, bool $incl_obj=true)

Protected Attributes
ilDBInterface	$db

array	$trans_loaded = []

array	$reference_cache = []

array	$object_data_cache = []

array	$description_trans = []

Private Member Functions
	__isReferenceCached (int $ref_id)
	checks whether a reference id is already in cache or not More...

	__isObjectCached (int $obj_id)
	checks whether an object is already in cache or not More...

	__storeReference (int $ref_id)
	Stores Reference in cache. More...

	__storeObjectData (int $obj_id)
	Stores object data in cache. More...

Detailed Description

class ilObjectDataCache

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

This class caches some properties of the object_data table. Like title description owner obj_id

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

Constructor & Destructor Documentation

◆ __construct()

ilObjectDataCache::__construct ( )

Definition at line 39 of file class.ilObjectDataCache.php.

    {
        global $DIC;
        $this->db = $DIC->database();
    }

References $DIC.

Member Function Documentation

◆ __isObjectCached()

ilObjectDataCache::__isObjectCached ( int $obj_id )

private

checks whether an object is already in cache or not

Definition at line 135 of file class.ilObjectDataCache.php.

                                                  : bool
    {
        if (isset($this->object_data_cache[$obj_id])) {
            return true;
        }
 
        return false;
    }

Referenced by lookupDescription(), lookupLastUpdate(), lookupOfflineStatus(), lookupOwner(), lookupTitle(), and lookupType().

Here is the caller graph for this function:

◆ __isReferenceCached()

ilObjectDataCache::__isReferenceCached ( int $ref_id )

private

checks whether a reference id is already in cache or not

Definition at line 123 of file class.ilObjectDataCache.php.

                                                     : bool
    {
        if (isset($this->reference_cache[$ref_id])) {
            return true;
        }
 
        return false;
    }

References $ref_id.

Referenced by lookupObjId().

Here is the caller graph for this function:

◆ __storeObjectData()

ilObjectDataCache::__storeObjectData ( int $obj_id )

private

Stores object data in cache.

Definition at line 167 of file class.ilObjectDataCache.php.

                                                   : void
    {
        global $DIC;
 
        $obj_definition = $DIC["objDefinition"];
        $user = $DIC["ilUser"];
 
        $sql =
            "SELECT object_data.obj_id, object_data.type, object_data.title, object_data.description, " . PHP_EOL
            . "object_data.owner, object_data.create_date, object_data.last_update, object_data.import_id, " . PHP_EOL
            . "object_data.offline, object_description.description as long_description " . PHP_EOL
            . "FROM object_data LEFT JOIN object_description ON object_data.obj_id = object_description.obj_id " . PHP_EOL
            . "WHERE object_data.obj_id = " . $this->db->quote($obj_id, 'integer') . PHP_EOL
        ;
        $res = $this->db->query($sql);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->object_data_cache[$obj_id]['title'] = $row->title;
            $this->object_data_cache[$obj_id]['description'] = $row->description;
            if ($row->long_description !== null) {
                $this->object_data_cache[$row->obj_id]['description'] = $row->long_description;
            }
            $this->object_data_cache[$obj_id]['type'] = $row->type;
            $this->object_data_cache[$obj_id]['owner'] = $row->owner;
            $this->object_data_cache[$obj_id]['last_update'] = $row->last_update;
            $this->object_data_cache[$obj_id]['offline'] = $row->offline;
 
            $translation_type = $obj_definition->getTranslationType($row->type);
 
            if ($translation_type === "db" && !isset($this->trans_loaded[$obj_id])) {
                $sql =
                    "SELECT title, description" . PHP_EOL
                    . "FROM object_translation" . PHP_EOL
                    . "WHERE obj_id = " . $this->db->quote($obj_id, 'integer') . PHP_EOL
                    . "AND lang_code = " . $this->db->quote($user->getLanguage(), 'text') . PHP_EOL
                ;
                $trans_res = $this->db->query($sql);
 
                $trans_row = $trans_res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
                if ($trans_row) {
                    $this->object_data_cache[$obj_id]['title'] = $trans_row->title;
                    $this->object_data_cache[$obj_id]['description'] = $trans_row->description;
                    $this->description_trans[] = $obj_id;
                }
                $this->trans_loaded[$obj_id] = true;
            }
        }
    }

References $DIC, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by lookupDescription(), lookupLastUpdate(), lookupObjId(), lookupOfflineStatus(), lookupOwner(), lookupTitle(), and lookupType().

Here is the caller graph for this function:

◆ __storeReference()

ilObjectDataCache::__storeReference ( int $ref_id )

private

Stores Reference in cache.

Maybe it could be useful to find all references of that object and store them also in the cache. But this would be an extra query.

Definition at line 149 of file class.ilObjectDataCache.php.

                                                  : int
    {
        $sql =
            "SELECT obj_id" . PHP_EOL
            . "FROM object_reference" . PHP_EOL
            . "WHERE ref_id = " . $this->db->quote($ref_id, 'integer') . PHP_EOL
        ;
        $result = $this->db->query($sql);
        while ($row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $this->reference_cache[$ref_id] = (int) $row['obj_id'];
        }
 
        return (int) ($this->reference_cache[$ref_id] ?? 0);
    }

References $ref_id, ilDBConstants\FETCHMODE_ASSOC, and ILIAS\Repository\int().

Referenced by lookupObjId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteCachedEntry()

ilObjectDataCache::deleteCachedEntry ( int $obj_id )

Definition at line 45 of file class.ilObjectDataCache.php.

                                                  : void
    {
        if (isset($this->object_data_cache[$obj_id])) {
            unset($this->object_data_cache[$obj_id]);
        }
    }

◆ isTranslatedDescription()

ilObjectDataCache::isTranslatedDescription ( int $obj_id )

Definition at line 215 of file class.ilObjectDataCache.php.

                                                        : bool
    {
        return in_array($obj_id, $this->description_trans);
    }

◆ lookupDescription()

ilObjectDataCache::lookupDescription ( int $obj_id )

Definition at line 89 of file class.ilObjectDataCache.php.

                                                  : string
    {
        if (!$this->__isObjectCached($obj_id)) {
            $this->__storeObjectData($obj_id);
        }
 
        return (string) ($this->object_data_cache[$obj_id]['description'] ?? '');
    }

References __isObjectCached(), and __storeObjectData().

Here is the call graph for this function:

◆ lookupLastUpdate()

ilObjectDataCache::lookupLastUpdate ( int $obj_id )

Definition at line 98 of file class.ilObjectDataCache.php.

                                                 : string
    {
        if (!$this->__isObjectCached($obj_id)) {
            $this->__storeObjectData($obj_id);
        }
        return (string) ($this->object_data_cache[$obj_id]['last_update']);
    }

References __isObjectCached(), and __storeObjectData().

Here is the call graph for this function:

◆ lookupObjId()

ilObjectDataCache::lookupObjId ( int $ref_id )

Definition at line 52 of file class.ilObjectDataCache.php.

                                            : int
    {
        if (!$this->__isReferenceCached($ref_id)) {
            $obj_id = $this->__storeReference($ref_id);
            $this->__storeObjectData($obj_id);
        }
 
        return (int) ($this->reference_cache[$ref_id] ?? 0);
    }

References $ref_id, __isReferenceCached(), __storeObjectData(), and __storeReference().

Referenced by ilLearningProgressBaseGUI\__construct(), ilLPListOfObjectsGUI\__initDetails(), ilLPListOfProgressGUI\__initDetails(), ilLearningProgressBaseGUI\__setSubTabs(), ilLPStatusCollection\_getCompleted(), ilLPStatusCollection\_getFailed(), and ilLPStatusCollection\_getTypicalLearningTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupOfflineStatus()

ilObjectDataCache::lookupOfflineStatus ( int $obj_id )

Check if supports centralized offline handling and is offline.

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

                                                    : bool
    {
        if (!$this->__isObjectCached($obj_id)) {
            $this->__storeObjectData($obj_id);
        }
 
        return (bool) ($this->object_data_cache[$obj_id]['offline'] ?? false);
    }

References __isObjectCached(), and __storeObjectData().

Here is the call graph for this function:

◆ lookupOwner()

ilObjectDataCache::lookupOwner ( int $obj_id )

Definition at line 80 of file class.ilObjectDataCache.php.

                                            : int
    {
        if (!$this->__isObjectCached($obj_id)) {
            $this->__storeObjectData($obj_id);
        }
 
        return (int) ($this->object_data_cache[$obj_id]['owner'] ?? 0);
    }

References __isObjectCached(), and __storeObjectData().

Here is the call graph for this function:

◆ lookupTitle()

ilObjectDataCache::lookupTitle ( int $obj_id )

Definition at line 62 of file class.ilObjectDataCache.php.

                                            : string
    {
        if (!$this->__isObjectCached($obj_id)) {
            $this->__storeObjectData($obj_id);
        }
 
        return (string) ($this->object_data_cache[$obj_id]['title'] ?? '');
    }

References __isObjectCached(), and __storeObjectData().

Here is the call graph for this function:

◆ lookupType()

ilObjectDataCache::lookupType ( int $obj_id )

Definition at line 71 of file class.ilObjectDataCache.php.

                                           : string
    {
        if (!$this->__isObjectCached($obj_id)) {
            $this->__storeObjectData($obj_id);
        }
 
        return (string) ($this->object_data_cache[$obj_id]['type'] ?? '');
    }

References __isObjectCached(), and __storeObjectData().

Referenced by ilLearningProgressBaseGUI\__construct(), ilLPMarks\__construct(), ilLPListOfObjectsGUI\__initDetails(), ilLPListOfProgressGUI\__initDetails(), ilLearningProgressBaseGUI\__setSubTabs(), and ilLPStatusCollection\_getTypicalLearningTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ preloadObjectCache()

ilObjectDataCache::preloadObjectCache	(	array	$obj_ids,
		string	$lang = `''`
	)

Stores object data in cache.

Parameters

int[]	$obj_ids
string	$lang

Definition at line 225 of file class.ilObjectDataCache.php.

                                                                         : void
    {
        global $DIC;
 
        $obj_definition = $DIC["objDefinition"];
        $user = $DIC["ilUser"];
 
        if ($lang == "") {
            $lang = $user->getLanguage();
        }
 
        if ($obj_ids === []) {
            return;
        }
 
        $sql =
            "SELECT object_data.obj_id, object_data.type, object_data.title, object_data.description, " . PHP_EOL
            . "object_data.owner, object_data.create_date, object_data.last_update, object_data.import_id, " . PHP_EOL
            . "object_data.offline, object_description.description as long_description " . PHP_EOL
            . "FROM object_data LEFT JOIN object_description ON object_data.obj_id = object_description.obj_id " . PHP_EOL
            . "WHERE " . $this->db->in('object_data.obj_id', $obj_ids, false, 'integer') . PHP_EOL
        ;
        $res = $this->db->query($sql);
        $db_trans = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $obj_id = (int) $row->obj_id;
 
            if (!isset($this->trans_loaded[$obj_id])) {
                $this->object_data_cache[$obj_id]['title'] = $row->title;
                $this->object_data_cache[$obj_id]['description'] = $row->description;
                if ($row->long_description !== null) {
                    $this->object_data_cache[$row->obj_id]['description'] = $row->long_description;
                }
            }
            $this->object_data_cache[$obj_id]['type'] = $row->type;
            $this->object_data_cache[$obj_id]['owner'] = $row->owner;
            $this->object_data_cache[$obj_id]['last_update'] = $row->last_update;
            $this->object_data_cache[$obj_id]['offline'] = $row->offline;
 
            $translation_type = $obj_definition->getTranslationType($row->type);
 
            if ($translation_type === "db") {
                $db_trans[$obj_id] = $obj_id;
            }
        }
 
        if (count($db_trans) > 0) {
            $this->preloadTranslations($db_trans, $lang);
        }
    }

References $DIC, $lang, $res, ilDBConstants\FETCHMODE_OBJECT, if, ILIAS\Repository\int(), and preloadTranslations().

Referenced by preloadReferenceCache().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ preloadReferenceCache()

ilObjectDataCache::preloadReferenceCache	(	array	$ref_ids,
		bool	$incl_obj = `true`
	)

Parameters

int[]	$ref_ids
bool	$incl_obj

Definition at line 314 of file class.ilObjectDataCache.php.

                                                                                : void
    {
        if ($ref_ids === []) {
            return;
        }
 
        $sql =
            "SELECT ref_id, obj_id" . PHP_EOL
            . "FROM object_reference" . PHP_EOL
            . "WHERE " . $this->db->in('ref_id', $ref_ids, false, 'integer') . PHP_EOL
        ;
        $res = $this->db->query($sql);
 
        $obj_ids = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $this->reference_cache[(int) $row['ref_id']] = (int) $row['obj_id'];
            $obj_ids[] = (int) $row['obj_id'];
        }
 
        if ($incl_obj) {
            $this->preloadObjectCache($obj_ids);
        }
    }

References $res, ilDBConstants\FETCHMODE_ASSOC, ILIAS\Repository\int(), and preloadObjectCache().

Here is the call graph for this function:

◆ preloadTranslations()

ilObjectDataCache::preloadTranslations	(	array	$obj_ids,
		string	$lang
	)

Preload translation information.

Parameters

int[]	$obj_ids
string	$lang

Definition at line 281 of file class.ilObjectDataCache.php.

                                                                     : void
    {
        $ids = [];
        foreach ($obj_ids as $id) {
            // do not load an id more than one time
            if (!isset($this->trans_loaded[$id])) {
                $ids[] = $id;
                $this->trans_loaded[$id] = true;
            }
        }
 
        if ($ids !== []) {
            $sql =
                "SELECT obj_id, title, description" . PHP_EOL
                . "FROM object_translation" . PHP_EOL
                . "WHERE " . $this->db->in('obj_id', $ids, false, 'integer') . PHP_EOL
                . "AND lang_code = " . $this->db->quote($lang, 'text') . PHP_EOL
            ;
            $result = $this->db->query($sql);
            while ($row = $result->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                $obj_id = (int) $row->obj_id;
 
                $this->object_data_cache[$obj_id]['title'] = $row->title;
                $this->object_data_cache[$obj_id]['description'] = $row->description;
                $this->description_trans[] = $obj_id;
            }
        }
    }