ilXcache Class Reference

Class ilXcache. More...

Inheritance diagram for ilXcache:

Collaboration diagram for ilXcache:

Public Member Functions
	__construct ($serviceId, $component)
	ilXcache constructor. More...
	exists ($key)
	set ($key, $serialized_value, $ttl=null)
	get ($key)
	delete ($key)
	flush ($complete=false)
	serialize ($value)
	unserialize ($serialized_value)
	getInfo ()
	__destruct ()
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...

Data Fields
const	MIN_MEMORY = 32

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

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 = ''
Static Protected Attributes inherited from ilGlobalCacheService
static	$active = array()
static	$installable = array()

Detailed Description

Class ilXcache.

Concrete XCache implementation.

Author

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

Version

1.0.1

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

Constructor & Destructor Documentation

__construct()

ilXcache::__construct	(		$serviceId,
			$component
	)

ilXcache constructor.

Parameters

$serviceId
$component

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

References ilGlobalCacheService\$component, and readValid().

    {
        parent::__construct($serviceId, $component);
        $this->readValid();
    }

Here is the call graph for this function:

__destruct()

ilXcache::__destruct

(

)

Definition at line 195 of file class.ilXcache.php.

References saveValid().

    {
        $this->saveValid();
    }

Here is the call graph for this function:

Member Function Documentation

delete()

ilXcache::delete

(

$key

)

Parameters

$key

Returns

bool

Definition at line 70 of file class.ilXcache.php.

References $key, and ilGlobalCacheService\returnKey().

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

Here is the call graph for this function:

exists()

ilXcache::exists

(

$key

)

Parameters

$key

Returns

bool

Definition at line 35 of file class.ilXcache.php.

References $key, and ilGlobalCacheService\returnKey().

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

Here is the call graph for this function:

flush()

ilXcache::flush

(

$complete = false

)

Parameters

bool

$complete

Returns

bool

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

References $_SERVER.

    {
        $_SERVER["PHP_AUTH_USER"] = "xcache";
        $_SERVER["PHP_AUTH_PW"] = "xcache";

        xcache_clear_cache(XC_TYPE_VAR, 0);

        return true;
    }

get()

ilXcache::get

(

$key

)

Parameters

$key

Returns

mixed

Definition at line 59 of file class.ilXcache.php.

References $key, and ilGlobalCacheService\returnKey().

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

Here is the call graph for this function:

getActive()

ilXcache::getActive ( )

protected

Returns

bool

Definition at line 117 of file class.ilXcache.php.

References ilGlobalCacheService\$active.

    {
        $function_exists = function_exists('xcache_set');
        $var_size = ini_get('xcache.var_size') != '0M';
        $var_count = ini_get('xcache.var_count') > 0;
        $api = (php_sapi_name() !== 'cli');

        $active = $function_exists and $var_size and $var_count and $api;

        return $active;
    }

getInfo()

ilXcache::getInfo

(

)

Returns

array

Definition at line 142 of file class.ilXcache.php.

References ilGlobalCacheService\isActive().

    {
        if ($this->isActive()) {
            return xcache_info(XC_TYPE_VAR, 0);
        }
    }

Here is the call graph for this function:

getInstallable()

ilXcache::getInstallable ( )

protected

Returns

bool

Definition at line 133 of file class.ilXcache.php.

    {
        return function_exists('xcache_set');
    }

getMemoryLimit()

ilXcache::getMemoryLimit ( )

protected

Returns

int|string

Definition at line 153 of file class.ilXcache.php.

    {
        return ini_get('xcache.var_size');
    }

getMinMemory()

ilXcache::getMinMemory ( )

protected

Returns

int

Definition at line 162 of file class.ilXcache.php.

    {
        return self::MIN_MEMORY;
    }

readValid()

ilXcache::readValid ( )

protected

Returns

void

set self::$valid_keys from GlobalCache

Definition at line 187 of file class.ilXcache.php.

References ilGlobalCacheService\isActive(), ilGlobalCacheService\isInstallable(), serialize(), and unserialize().

Referenced by __construct().

    {
        if ($this->isActive() && $this->isInstallable()) {
            $this->valid_keys = $this->unserialize($this->get('valid_keys'));
            $this->valid_key_hash = md5(serialize($this->valid_keys));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveValid()

ilXcache::saveValid ( )

protected

Returns

void

save self::$valid_keys to GlobalCache

Definition at line 172 of file class.ilXcache.php.

References ilGlobalCacheService\isActive(), and serialize().

Referenced by __destruct().

    {
        if ($this->isActive()) {
            if ($this->valid_key_hash != md5(serialize($this->valid_keys))) {
                $this->set('valid_keys', $this->serialize($this->valid_keys));
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

serialize()

ilXcache::serialize

(

$value

)

Parameters

$value

Returns

mixed

Definition at line 97 of file class.ilXcache.php.

Referenced by readValid(), and saveValid().

    {
        return serialize($value);
    }

Here is the caller graph for this function:

set()

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

Parameters

	$key
	$serialized_value
null	$ttl

Returns

bool

Definition at line 48 of file class.ilXcache.php.

References $key, and ilGlobalCacheService\returnKey().

    {
        return xcache_set($this->returnKey($key), $serialized_value, $ttl);
    }

Here is the call graph for this function:

unserialize()

ilXcache::unserialize

(

$serialized_value

)

Parameters

$serialized_value

Returns

mixed

Definition at line 108 of file class.ilXcache.php.

Referenced by readValid().

    {
        return unserialize($serialized_value);
    }

Here is the caller graph for this function:

Field Documentation

MIN_MEMORY

const ilXcache::MIN_MEMORY = 32

Definition at line 14 of file class.ilXcache.php.

---

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

• Services/GlobalCache/classes/Xcache/class.ilXcache.php