arObjectCache Class Reference

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

Collaboration diagram for arObjectCache:

Static Public Member Functions
static	isCached ($class, $id)
static	store (ActiveRecord $activeRecord)
static	printStats ()
static	get ($class, $id)
static	purge (ActiveRecord $activeRecord)
static	flush ($class_name)

Static Protected Attributes
static array	$cache = []

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 Class arObjectCache

Version

2.0.7

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Member Function Documentation

flush()

static arObjectCache::flush (   $class_name )

static

Parameters

$class_name

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

                                             : void
    {
        new $class_name();

        if ($class_name instanceof ActiveRecord) {
            $class_name = $class_name::class;
        }
        unset(self::$cache[$class_name]);
    }

get()

static arObjectCache::get (   $class,   $id  )

static

Parameters

$class
$id

Exceptions

arException

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

References $id, and arException\GET_UNCACHED_OBJECT.

Referenced by ActiveRecord\additionalParams(), and ActiveRecord\buildFromArray().

                                           : \ActiveRecord
    {
        new $class();
        if (!self::isCached($class, $id)) {
            throw new arException(arException::GET_UNCACHED_OBJECT, $class . ': ' . $id);
        }

        return self::$cache[$class][$id];
    }

Here is the caller graph for this function:

isCached()

static arObjectCache::isCached (   $class,   $id  )

static

Parameters

$class
$id

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

References $id.

Referenced by ActiveRecord\additionalParams(), and ActiveRecord\buildFromArray().

                                                : bool
    {
        new $class();

        if (!isset(self::$cache[$class])) {
            return false;
        }
        if (!isset(self::$cache[$class][$id])) {
            return false;
        }
        if (!self::$cache[$class][$id] instanceof ActiveRecord) {
            return false;
        }

        return array_key_exists($id, self::$cache[$class]);
    }

Here is the caller graph for this function:

printStats()

static arObjectCache::printStats ( )

static

Definition at line 56 of file class.arObjectCache.php.

                                       : void
    {
        foreach (self::$cache as $class => $objects) {
            echo $class;
            echo ": ";
            echo is_countable($objects) ? count($objects) : 0;
            echo " Objects<br>";
        }
    }

purge()

static arObjectCache::purge ( ActiveRecord  $activeRecord )

static

Definition at line 81 of file class.arObjectCache.php.

References ActiveRecord\getPrimaryFieldValue().

Referenced by ActiveRecord\delete().

                                                            : void
    {
        unset(self::$cache[$activeRecord::class][$activeRecord->getPrimaryFieldValue()]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

store()

static arObjectCache::store ( ActiveRecord  $activeRecord )

static

Definition at line 49 of file class.arObjectCache.php.

References ActiveRecord\getPrimaryFieldValue().

Referenced by ActiveRecord\buildFromArray(), ActiveRecord\create(), ActiveRecord\read(), ActiveRecord\storeObjectToCache(), and ActiveRecord\update().

                                                            : void
    {
        if (!isset($activeRecord->is_new)) {
            self::$cache[$activeRecord::class][$activeRecord->getPrimaryFieldValue()] = $activeRecord;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$cache

array arObjectCache::$cache = []

staticprotected

Definition at line 26 of file class.arObjectCache.php.

---

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

• components/ILIAS/ActiveRecord/Cache/class.arObjectCache.php