ilApc Class Reference

Class ilApc. More...

Inheritance diagram for ilApc:

Collaboration diagram for ilApc:

Public Member Functions
	exists ($key)
	set ($key, $serialized_value, $ttl=0)
	get ($key)
	delete ($key)
	flush ($complete=false)
	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...

Data Fields
const	MIN_MEMORY = 16
const	CACHE_ID = 'user'

Protected Member Functions
	getActive ()
	getInstallable ()
	getMemoryLimit ()
	getMinMemory ()
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 ilApc.

Author

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

Version

1.0.0

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

Member Function Documentation

delete()

ilApc::delete

(

$key

)

Parameters

$key

Returns

bool|string[]

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

References $key, and ilGlobalCacheService\returnKey().

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

Here is the call graph for this function:

exists()

ilApc::exists

(

$key

)

Parameters

$key

Returns

bool

Definition at line 25 of file class.ilApc.php.

References $key, and ilGlobalCacheService\returnKey().

    {
        if (function_exists('apcu_exists')) {
            return apcu_exists($this->returnKey($key));
        } else {
            return apcu_fetch($this->returnKey($key));
        }
    }

Here is the call graph for this function:

flush()

ilApc::flush

(

$complete = false

)

Parameters

bool

$complete

Returns

bool

Definition at line 75 of file class.ilApc.php.

References ilGlobalCacheService\returnKey().

    {
        if ($complete) {
            return apcu_clear_cache();
        }

        $key_prefix = $this->returnKey('');
        $apcu_iterator = new APCUIterator();
        $apcu_iterator->rewind();
        while ($current_key = $apcu_iterator->key()) {
            // "begins with"
            if (substr($current_key, 0, strlen($key_prefix)) === $key_prefix) {
                $this->delete($current_key);
            }
            $apcu_iterator->next();
        }
        return true;
    }

Here is the call graph for this function:

get()

ilApc::get

(

$key

)

Parameters

$key

Returns

mixed

Definition at line 53 of file class.ilApc.php.

References $key, and ilGlobalCacheService\returnKey().

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

Here is the call graph for this function:

getActive()

ilApc::getActive ( )

protected

Definition at line 151 of file class.ilApc.php.

    {
        return function_exists('apcu_store');
    }

getInfo()

ilApc::getInfo

(

)

Returns

array

Definition at line 120 of file class.ilApc.php.

References $key, ilGlobalCacheService\getComponent(), and ilGlobalCacheService\getServiceId().

    {
        $return = array();

        $cache_info = apc_cache_info();

        unset($cache_info['cache_list']);
        unset($cache_info['slot_distribution']);

        $return['__cache_info'] = array(
            'apc.enabled' => ini_get('apc.enabled'),
            'apc.shm_size' => ini_get('apc.shm_size'),
            'apc.shm_segments' => ini_get('apc.shm_segments'),
            'apc.gc_ttl' => ini_get('apc.gc_ttl'),
            'apc.user_ttl' => ini_get('apc.ttl'),
            'info' => $cache_info,
        );

        $cache_info = apc_cache_info();
        foreach ($cache_info['cache_list'] as $dat) {
            $key = $dat['key'];

            if (preg_match('/' . $this->getServiceId() . '_' . $this->getComponent() . '/', $key)) {
                $return[$key] = apc_fetch($key);
            }
        }

        return $return;
    }

Here is the call graph for this function:

getInstallable()

ilApc::getInstallable ( )

protected

Returns

bool

Definition at line 160 of file class.ilApc.php.

    {
        return function_exists('apcu_store');
    }

getMemoryLimit()

ilApc::getMemoryLimit ( )

protected

Returns

string

Definition at line 169 of file class.ilApc.php.

References ilRuntime\getInstance(), and getMinMemory().

    {
        if (ilRuntime::getInstance()->isHHVM()) {
            return $this->getMinMemory() . 'M';
        }

        return ini_get('apc.shm_size');
    }

Here is the call graph for this function:

getMinMemory()

ilApc::getMinMemory ( )

protected

Definition at line 182 of file class.ilApc.php.

Referenced by getMemoryLimit().

    {
        return self::MIN_MEMORY;
    }

Here is the caller graph for this function:

isValid()

ilApc::isValid

(

$key

)

Definition at line 191 of file class.ilApc.php.

    {
        return true;
    }

serialize()

ilApc::serialize

(

$value

)

Parameters

$value

Returns

mixed|string

Definition at line 100 of file class.ilApc.php.

    {
        return ($value);
    }

set()

ilApc::set	(		$key,
			$serialized_value,
			$ttl = 0
	)

Parameters

	$key
	$serialized_value
int	$ttl

Returns

array|bool

Definition at line 42 of file class.ilApc.php.

References $key, and ilGlobalCacheService\returnKey().

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

Here is the call graph for this function:

unserialize()

ilApc::unserialize

(

$serialized_value

)

Parameters

$serialized_value

Returns

mixed

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

    {
        return ($serialized_value);
    }

Field Documentation

CACHE_ID

const ilApc::CACHE_ID = 'user'

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

MIN_MEMORY

const ilApc::MIN_MEMORY = 16

Definition at line 16 of file class.ilApc.php.

---

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

• Services/GlobalCache/classes/Apc/class.ilApc.php