Collaboration diagram for ilObjectDataCache:

Public Member Functions
	__construct ()

	deleteCachedEntry ($a_obj_id)

	lookupObjId ($a_ref_id)

	lookupTitle ($a_obj_id)

	lookupType ($a_obj_id)

	lookupOwner ($a_obj_id)

	lookupDescription ($a_obj_id)

	lookupLastUpdate ($a_obj_id)

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

	__isReferenceCached ($a_ref_id)
	checks whether an reference id is already in cache or not More...

	__isObjectCached ($a_obj_id)
	checks whether an object is aleady in cache or not More...

	__storeReference ($a_ref_id)
	Stores Reference in cache. More...

	__storeObjectData ($a_obj_id, $a_lang="")
	Stores object data in cache. More...

	isTranslatedDescription ($a_obj_id)

	preloadObjectCache ($a_obj_ids, $a_lang="")
	Stores object data in cache. More...

	preloadTranslations ($a_obj_ids, $a_lang)
	Preload translation informations. More...

	preloadReferenceCache ($a_ref_ids, $a_incl_obj=true)

Data Fields
	$db = null

	$reference_cache = array()

	$object_data_cache = array()

	$description_trans = array()

Protected Attributes
	$trans_loaded = []

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 13 of file class.ilObjectDataCache.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectDataCache::__construct ( )

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

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

References $DIC, and $ilDB.

Member Function Documentation

◆ __isObjectCached()

ilObjectDataCache::__isObjectCached ( $a_obj_id )

checks whether an object is aleady in cache or not

@access private

Parameters

int $a_obj_id object id

Returns: boolean

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

    {
        static $cached = 0;
        static $not_cached = 0;
            
 
        if (@$this->object_data_cache[$a_obj_id]) {
            #echo "Object ". ++$cached ."cached<br>";
            return true;
        }
        #echo "Object ". ++$not_cached ." not cached<br>";
        return false;
    }

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

Here is the caller graph for this function:

◆ __isReferenceCached()

ilObjectDataCache::__isReferenceCached ( $a_ref_id )

checks whether an reference id is already in cache or not

@access private

Parameters

int $a_ref_id reference id

Returns: boolean

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

    {
        #return false;
        #static $cached = 0;
        #static $not_cached = 0;
 
        if (@$this->reference_cache[$a_ref_id]) {
            #echo "Reference ". ++$cached ."cached<br>";
            return true;
        }
        #echo "Reference ". ++$not_cached ." not cached<br>";
        return false;
    }

Referenced by lookupObjId().

Here is the caller graph for this function:

◆ __storeObjectData()

ilObjectDataCache::__storeObjectData	(	$a_obj_id,
		$a_lang = `""`
	)

Stores object data in cache.

@access private

Parameters

int $a_obj_id object id

Returns: bool

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

    {
        global $DIC;
 
        $ilDB = $this->db;
        $objDefinition = $DIC["objDefinition"];
        $ilUser = $DIC["ilUser"];
        
        if (is_object($ilUser) && $a_lang == "") {
            $a_lang = $ilUser->getLanguage();
        }
 
        $query = "SELECT object_data.*, object_description.description as long_description " .
            "FROM object_data LEFT JOIN object_description ON object_data.obj_id = object_description.obj_id " .
            "WHERE object_data.obj_id = " . $ilDB->quote($a_obj_id, 'integer');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->object_data_cache[$a_obj_id]['title'] = $row->title;
            $this->object_data_cache[$a_obj_id]['description'] = $row->description;
            if ($row->long_description !== null) {
                $this->object_data_cache[$a_obj_id]['description'] = $row->long_description;
            }
            $this->object_data_cache[$a_obj_id]['type'] = $row->type;
            $this->object_data_cache[$a_obj_id]['owner'] = $row->owner;
            $this->object_data_cache[$a_obj_id]['last_update'] = $row->last_update;
            $this->object_data_cache[$a_obj_id]['offline'] = $row->offline;
            
            if (is_object($objDefinition)) {
                $translation_type = $objDefinition->getTranslationType($row->type);
            }
 
            if ($translation_type == "db") {
                if (!$this->trans_loaded[$a_obj_id]) {
                    $q = "SELECT title,description FROM object_translation " .
                         "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
                         "AND lang_code = " . $ilDB->quote($a_lang, 'text');
                    $r = $ilDB->query($q);
 
                    $row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
                    if ($row) {
                        $this->object_data_cache[$a_obj_id]['title'] = $row->title;
                        $this->object_data_cache[$a_obj_id]['description'] = $row->description;
                        $this->description_trans[] = $a_obj_id;
                    }
                    $this->trans_loaded[$a_obj_id] = true;
                }
            }
        }
        
        return true;
    }

References $db, $DIC, $ilDB, $ilUser, $query, $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 ( $a_ref_id )

Stores Reference in cache.

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

@access private

Parameters

int $a_ref_id reference id

Returns: int $obj_id

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

    {
        $ilDB = $this->db;
        
        $query = "SELECT obj_id FROM object_reference WHERE ref_id = " . $ilDB->quote($a_ref_id, 'integer');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $this->reference_cache[$a_ref_id] = $row['obj_id'];
        }
        return (int) @$this->reference_cache[$a_ref_id];
    }

References $db, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by lookupObjId().

Here is the caller graph for this function:

◆ deleteCachedEntry()

ilObjectDataCache::deleteCachedEntry ( $a_obj_id )

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

    {
        unset($this->object_data_cache[$a_obj_id]);
    }

◆ isTranslatedDescription()

ilObjectDataCache::isTranslatedDescription ( $a_obj_id )

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

    {
        return (is_array($this->description_trans) &&
            in_array($a_obj_id, $this->description_trans));
    }

◆ lookupDescription()

ilObjectDataCache::lookupDescription ( $a_obj_id )

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

    {
        if (!$this->__isObjectCached($a_obj_id)) {
            $this->__storeObjectData($a_obj_id);
        }
        return @$this->object_data_cache[$a_obj_id]['description'];
    }

References __isObjectCached(), and __storeObjectData().

Here is the call graph for this function:

◆ lookupLastUpdate()

ilObjectDataCache::lookupLastUpdate ( $a_obj_id )

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

    {
        if (!$this->__isObjectCached($a_obj_id)) {
            $this->__storeObjectData($a_obj_id);
        }
        return @$this->object_data_cache[$a_obj_id]['last_update'];
    }

References __isObjectCached(), and __storeObjectData().

Here is the call graph for this function:

◆ lookupObjId()

ilObjectDataCache::lookupObjId ( $a_ref_id )

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

    {
        if (!$this->__isReferenceCached($a_ref_id)) {
            //echo"-objidmissed-$a_ref_id-";
            $obj_id = $this->__storeReference($a_ref_id);
            $this->__storeObjectData($obj_id);
        }
        return (int) @$this->reference_cache[$a_ref_id];
    }

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

Here is the call graph for this function:

◆ lookupOfflineStatus()

ilObjectDataCache::lookupOfflineStatus ( $a_obj_id )

Check if supports centralized offline handling and is offline.

Parameters

$a_obj_id

Returns: bool

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

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

References __isObjectCached(), and __storeObjectData().

Here is the call graph for this function:

◆ lookupOwner()

ilObjectDataCache::lookupOwner ( $a_obj_id )

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

    {
        if (!$this->__isObjectCached($a_obj_id)) {
            $this->__storeObjectData($a_obj_id);
        }
        return @$this->object_data_cache[$a_obj_id]['owner'];
    }

References __isObjectCached(), and __storeObjectData().

Here is the call graph for this function:

◆ lookupTitle()

ilObjectDataCache::lookupTitle ( $a_obj_id )

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

    {
        if (!$this->__isObjectCached($a_obj_id)) {
            $this->__storeObjectData($a_obj_id);
        }
        return @$this->object_data_cache[$a_obj_id]['title'];
    }

References __isObjectCached(), and __storeObjectData().

Here is the call graph for this function:

◆ lookupType()

ilObjectDataCache::lookupType ( $a_obj_id )

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

    {
        if (!$this->__isObjectCached($a_obj_id)) {
            //echo"-typemissed-$a_obj_id-";
            $this->__storeObjectData($a_obj_id);
        }
        return @$this->object_data_cache[$a_obj_id]['type'];
    }

References __isObjectCached(), and __storeObjectData().

Here is the call graph for this function:

◆ preloadObjectCache()

ilObjectDataCache::preloadObjectCache	(	$a_obj_ids,
		$a_lang = `""`
	)

Stores object data in cache.

@access private

Parameters

int $a_obj_id object id

Returns: bool

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

    {
        global $DIC;
 
        $ilDB = $this->db;
        $objDefinition = $DIC["objDefinition"];
        $ilUser = $DIC["ilUser"];
 
        if (is_object($ilUser) && $a_lang == "") {
            $a_lang = $ilUser->getLanguage();
        }
        if (!is_array($a_obj_ids)) {
            return;
        }
        if (count($a_obj_ids) == 0) {
            return;
        }
 
        $query = "SELECT object_data.*, object_description.description as long_description " .
            "FROM object_data LEFT JOIN object_description ON object_data.obj_id = object_description.obj_id " .
            "WHERE " . $ilDB->in('object_data.obj_id', $a_obj_ids, false, 'integer');
        $res = $ilDB->query($query);
        $db_trans = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
 
            // this if fixes #9960
            if (!$this->trans_loaded[$row->obj_id]) {
                $this->object_data_cache[$row->obj_id]['title'] = $row->title;
                $this->object_data_cache[$row->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[$row->obj_id]['type'] = $row->type;
            $this->object_data_cache[$row->obj_id]['owner'] = $row->owner;
            $this->object_data_cache[$row->obj_id]['last_update'] = $row->last_update;
            $this->object_data_cache[$row->obj_id]['offline'] = $row->offline;
 
            if (is_object($objDefinition)) {
                $translation_type = $objDefinition->getTranslationType($row->type);
            }
 
            if ($translation_type == "db") {
                $db_trans[$row->obj_id] = $row->obj_id;
            }
        }
        if (count($db_trans) > 0) {
            $this->preloadTranslations($db_trans, $a_lang);
        }
    }

References $db, $DIC, $ilDB, $ilUser, $query, $res, ilDBConstants\FETCHMODE_OBJECT, and preloadTranslations().

Referenced by preloadReferenceCache().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ preloadReferenceCache()

ilObjectDataCache::preloadReferenceCache	(	$a_ref_ids,
		$a_incl_obj = `true`
	)

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

    {
        $ilDB = $this->db;
        
        if (!is_array($a_ref_ids)) {
            return;
        }
        if (count($a_ref_ids) == 0) {
            return;
        }
        
        $query = "SELECT ref_id, obj_id FROM object_reference " .
            "WHERE " . $ilDB->in('ref_id', $a_ref_ids, false, 'integer');
        $res = $ilDB->query($query);
        
        $obj_ids = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $this->reference_cache[$row['ref_id']] = $row['obj_id'];
            //echo "<br>store_ref-".$row['ref_id']."-".$row['obj_id']."-";
            $obj_ids[] = $row['obj_id'];
        }
        if ($a_incl_obj) {
            $this->preloadObjectCache($obj_ids);
        }
    }

References $db, $ilDB, $query, $res, ilDBConstants\FETCHMODE_ASSOC, and preloadObjectCache().

Here is the call graph for this function:

◆ preloadTranslations()

ilObjectDataCache::preloadTranslations	(	$a_obj_ids,
		$a_lang
	)

Preload translation informations.

Parameters

array $a_obj_ids array of object ids

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

    {
        $ilDB = $this->db;
 
        $obj_ids = array();
        foreach ($a_obj_ids as $id) {
            // do not load an id more than one time
            if (!$this->trans_loaded[$id]) {
                $obj_ids[] = $id;
                $this->trans_loaded[$id] = true;
            }
        }
        if (count($obj_ids) > 0) {
            $q = "SELECT obj_id, title, description FROM object_translation " .
                 "WHERE " . $ilDB->in('obj_id', $obj_ids, false, 'integer') . " " .
                 "AND lang_code = " . $ilDB->quote($a_lang, 'text');
            $r = $ilDB->query($q);
            while ($row2 = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                $this->object_data_cache[$row2->obj_id]['title'] = $row2->title;
                $this->object_data_cache[$row2->obj_id]['description'] = $row2->description;
                $this->description_trans[] = $row2->obj_id;
            }
        }
    }