arObjectCache Class Reference

Class arObjectCache. More...

Collaboration diagram for arObjectCache:

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

Static Protected Attributes
static	$cache = array()

Detailed Description

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 11 of file class.arObjectCache.php.

Member Function Documentation

flush()

static arObjectCache::flush (   $class_name )

static

Parameters

$class_name

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

References CachedActiveRecord\getCacheIdentifier().

Referenced by ilOrgUnitPosition\getActive(), and ilOrgUnitPosition\getActiveForPosition().

    {
        $instance = new $class_name();
        if ($instance instanceof CachedActiveRecord && $instance->getCacheIdentifier() != '') {
            $instance->getCache()->flush();
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

get()

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

static

Parameters

$class
$id

Exceptions

arException

Returns

ActiveRecord

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

References $id, arException\GET_UNCACHED_OBJECT, and CachedActiveRecord\getCacheIdentifier().

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

    {
        $instance = new $class();
        if ($instance instanceof CachedActiveRecord && $instance->getCacheIdentifier() != '') {
            if ($instance->getCache()->exists($instance->getCacheIdentifier())) {
                return $instance->getCache()->get($instance->getCacheIdentifier());
            }
        }
        if (!self::isCached($class, $id)) {
            throw new arException(arException::GET_UNCACHED_OBJECT, $class . ': ' . $id);
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

isCached()

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

static

Parameters

$class
$id

Returns

bool

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

References $id, and CachedActiveRecord\getCacheIdentifier().

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

    {
        $instance = new $class();
        if ($instance instanceof CachedActiveRecord && $instance->getCacheIdentifier() != '') {
            if ($instance->getCache()->exists($instance->getCacheIdentifier())) {
                return true;
            }
        }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

printStats()

static arObjectCache::printStats ( )

static

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

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

purge()

static arObjectCache::purge ( ActiveRecord  $object )

static

Parameters

ActiveRecord

$object

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

References ActiveRecord\delete(), and ActiveRecord\getPrimaryFieldValue().

Referenced by ActiveRecord\delete().

    {
        if ($object instanceof CachedActiveRecord && $object->getCacheIdentifier() != '') {
            $object->getCache()->delete($object->getCacheIdentifier());
        }
        unset(self::$cache[get_class($object)][$object->getPrimaryFieldValue()]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

store()

static arObjectCache::store ( ActiveRecord  $object )

static

Parameters

ActiveRecord

$object

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().

    {
        if ($object instanceof CachedActiveRecord && $object->getCacheIdentifier() != '') {
            if ($object->getCache()->set($object->getCacheIdentifier(), $object, $object->getTTL())) {
                return;
            }
        }
        if (!isset($object->is_new)) {
            self::$cache[get_class($object)][$object->getPrimaryFieldValue()] = $object;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$cache

arObjectCache::$cache = array()

staticprotected

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

---

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

• Services/ActiveRecord/Cache/class.arObjectCache.php