ilApc Class Reference

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

Inheritance diagram for ilApc:

Collaboration diagram for ilApc:

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

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

Private Attributes
const	MIN_MEMORY = 16

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

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 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 25 of file class.ilApc.php.

Member Function Documentation

delete()

ilApc::delete

(

string

$key

)

Returns

bool|string[]

Implements ilGlobalCacheServiceInterface.

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

References ilGlobalCacheService\returnKey().

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

Here is the call graph for this function:

exists()

ilApc::exists

(

string

$key

)

Implements ilGlobalCacheServiceInterface.

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

References ilGlobalCacheService\returnKey().

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

Here is the call graph for this function:

flush()

ilApc::flush

(

bool

$complete = false

)

Implements ilGlobalCacheServiceInterface.

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

                                                 : bool
    {
        // incomplete flushing is not supported by APCu, an own implementation coused issues like https://mantis.ilias.de/view.php?id=28201
        return function_exists('apcu_clear_cache') && apcu_clear_cache();
    }

get()

ilApc::get

(

string

$key

)

Returns

mixed

Implements ilGlobalCacheServiceInterface.

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

References ilGlobalCacheService\returnKey().

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

Here is the call graph for this function:

getActive()

ilApc::getActive ( )

protected

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

                                  : bool
    {
        return function_exists('apcu_store');
    }

getInfo()

ilApc::getInfo

(

)

Implements ilGlobalCacheServiceInterface.

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

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

                             : array
    {
        $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

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

                                       : bool
    {
        return function_exists('apcu_store');
    }

getMemoryLimit()

ilApc::getMemoryLimit ( )

protected

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

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

                                       : string
    {
        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 137 of file class.ilApc.php.

Referenced by getMemoryLimit().

                                     : int
    {
        return self::MIN_MEMORY;
    }

Here is the caller graph for this function:

isValid()

ilApc::isValid

(

string

$key

)

Checks whether the cache key is valid or not.

Implements ilGlobalCacheServiceInterface.

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

                                        : bool
    {
        return true;
    }

serialize()

ilApc::serialize

(

$value

)

Parameters

mixed

$value

Returns

mixed|string

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

    {
        return ($value);
    }

set()

ilApc::set	(	string	$key,
			$serialized_value,
		int	$ttl = null
	)

Parameters

mixed

$serialized_value

Implements ilGlobalCacheServiceInterface.

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

References ilGlobalCacheService\returnKey().

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

Here is the call graph for this function:

unserialize()

ilApc::unserialize

(

$serialized_value

)

Parameters

mixed

$serialized_value

Returns

mixed

Implements ilGlobalCacheServiceInterface.

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

    {
        return ($serialized_value);
    }

Field Documentation

MIN_MEMORY

const ilApc::MIN_MEMORY = 16

private

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

---

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

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