ilMemcache Class Reference

Class ilMemcache. More...

Inheritance diagram for ilMemcache:

Collaboration diagram for ilMemcache:

Public Member Functions
	exists ($key)
	set ($key, $serialized_value, $ttl=null)
	get ($key)
	delete ($key)
	flush ($complete=false)
	getInstallationFailureReason ()
	serialize ($value)
	unserialize ($serialized_value)
	getInfo ()
	isValid ($key)
Public Member Functions inherited from ilGlobalCacheService
	__construct ($service_id, $component)
	unserialize ($serialized_value)
	get ($key)
	set ($key, $serialized_value, $ttl=null)
	serialize ($value)
	getServiceId ()
	setServiceId ($service_id)
	getComponent ()
	setComponent ($component)
	isActive ()
	isInstallable ()
	returnKey ($key)
	getInfo ()
	getInstallationFailureReason ()
	exists ($key)
	delete ($key)
	flush ($complete=false)
	setServiceType ($service_type)
	getServiceType ()
	setValid ($key)
	Declare a key as valid. More...
	setInvalid ($key=null)
	Set the key as invalid. More...
	isValid ($key)
	Checks whether the cache key is valid or not. More...

Protected Member Functions
	getMemcacheObject ()
	getActive ()
	getInstallable ()
Protected Member Functions inherited from ilGlobalCacheService
	getActive ()
	getInstallable ()
	getMemoryLimit ()
	getMinMemory ()
	checkMemory ()

Static Protected Attributes
static	$memcache_object
Static Protected Attributes inherited from ilGlobalCacheService
static	$active = array()
static	$installable = array()

Additional Inherited Members
Protected Attributes inherited from ilGlobalCacheService
	$current_time = 0
	$valid_keys = array()
	$service_id = ''
	$component = ''
	$service_type = ilGlobalCache::TYPE_STATIC
	$valid_key_hash = ''

Detailed Description

Class ilMemcache.

Author

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

Version

1.0.0

Definition at line 12 of file class.ilMemcache.php.

Member Function Documentation

delete()

ilMemcache::delete

(

$key

)

Parameters

$key

Returns

bool

Definition at line 104 of file class.ilMemcache.php.

References $key, getMemcacheObject(), and ilGlobalCacheService\returnKey().

    {
        return $this->getMemcacheObject()->delete($this->returnKey($key));
    }

Here is the call graph for this function:

exists()

ilMemcache::exists

(

$key

)

Parameters

$key

Returns

bool

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

References $key, getMemcacheObject(), and ilGlobalCacheService\returnKey().

    {
        return $this->getMemcacheObject()->get($this->returnKey($key)) != null;
    }

Here is the call graph for this function:

flush()

ilMemcache::flush

(

$complete = false

)

Parameters

bool

$complete

Returns

bool

Definition at line 115 of file class.ilMemcache.php.

References getMemcacheObject().

    {
        // currently a partial flushing is missing
        return $this->getMemcacheObject()->flush();
    }

Here is the call graph for this function:

get()

ilMemcache::get

(

$key

)

Parameters

$key

Returns

mixed

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

References $key, getMemcacheObject(), and ilGlobalCacheService\returnKey().

    {
        return $this->getMemcacheObject()->get($this->returnKey($key));
    }

Here is the call graph for this function:

getActive()

ilMemcache::getActive ( )

protected

Returns

bool

Definition at line 125 of file class.ilMemcache.php.

References $server, Sabre\VObject\$stats, getInstallable(), and getMemcacheObject().

    {
        if ($this->getInstallable()) {
            $stats = $this->getMemcacheObject()->getStats();

            if (!is_array($stats)) {
                return false;
            }

            foreach ($stats as $server) {
                if ($server['pid'] > 0) {
                    return true;
                }
            }

            return false;
        }

        return false;
    }

Here is the call graph for this function:

getInfo()

ilMemcache::getInfo

(

)

Returns

array

Definition at line 198 of file class.ilMemcache.php.

References $key, and getMemcacheObject().

    {
        if (self::isInstallable()) {
            $return = array();
            $return['__cache_info'] = $this->getMemcacheObject()->getStats();
            foreach ($this->getMemcacheObject()->getAllKeys() as $key) {
                $return[$key] = $this->getMemcacheObject()->get($key);
            }

            return $return;
        }
    }

Here is the call graph for this function:

getInstallable()

ilMemcache::getInstallable ( )

protected

Returns

bool

Definition at line 150 of file class.ilMemcache.php.

Referenced by getActive().

    {
        return class_exists('Memcached');
    }

Here is the caller graph for this function:

getInstallationFailureReason()

ilMemcache::getInstallationFailureReason

(

)

Returns

string

Definition at line 159 of file class.ilMemcache.php.

References Sabre\VObject\$stats, and getMemcacheObject().

    {
        if ($this->getMemcacheObject() instanceof Memcached) {
            $stats = $this->getMemcacheObject()->getStats();

            if (!$stats[self::STD_SERVER . ':' . self::STD_PORT]['pid'] > 0) {
                return 'No Memcached-Server available';
            }
        }

        return parent::getInstallationFailureReason();
    }

Here is the call graph for this function:

getMemcacheObject()

ilMemcache::getMemcacheObject ( )

protected

Returns

Memcached

Definition at line 57 of file class.ilMemcache.php.

Referenced by delete(), exists(), flush(), get(), getActive(), getInfo(), getInstallationFailureReason(), and set().

    {
        return self::$memcache_object;
    }

Here is the caller graph for this function:

isValid()

ilMemcache::isValid

(

$key

)

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

    {
        return true;
    }

serialize()

ilMemcache::serialize

(

$value

)

Parameters

$value

Returns

mixed

Definition at line 178 of file class.ilMemcache.php.

    {
        return serialize($value);
    }

set()

ilMemcache::set	(		$key,
			$serialized_value,
			$ttl = null
	)

Parameters

	$key
	$serialized_value
null | int	$ttl

Returns

bool

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

References $key, getMemcacheObject(), and ilGlobalCacheService\returnKey().

    {
        return $this->getMemcacheObject()
                    ->set($this->returnKey($key), $serialized_value, (int) $ttl);
    }

Here is the call graph for this function:

unserialize()

ilMemcache::unserialize

(

$serialized_value

)

Parameters

$serialized_value

Returns

mixed

Definition at line 189 of file class.ilMemcache.php.

    {
        return unserialize($serialized_value);
    }

Field Documentation

$memcache_object

ilMemcache::$memcache_object

staticprotected

Definition at line 18 of file class.ilMemcache.php.

---

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

• Services/GlobalCache/classes/Memcache/class.ilMemcache.php