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

	unserialize ($serialized_value)

	get (string $key)

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

	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 ()
	@inheritDoc More...

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 @beta

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[]

Reimplemented from ilGlobalCacheService.

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

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

References ilGlobalCacheService\returnKey().

Here is the call graph for this function:

◆ exists()

ilApc::exists ( string $key )

Reimplemented from ilGlobalCacheService.

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

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

References ilGlobalCacheService\returnKey().

Here is the call graph for this function:

◆ flush()

ilApc::flush ( bool $complete = false )

Reimplemented from ilGlobalCacheService.

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

Reimplemented from ilGlobalCacheService.

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

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

References ilGlobalCacheService\returnKey().

Here is the call graph for this function:

◆ getActive()

ilApc::getActive ( )

protected

Reimplemented from ilGlobalCacheService.

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

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

◆ getInfo()

ilApc::getInfo ( )

Reimplemented from ilGlobalCacheService.

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

                             : 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;
    }

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

Here is the call graph for this function:

◆ getInstallable()

ilApc::getInstallable ( )

protected

Reimplemented from ilGlobalCacheService.

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

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

◆ getMemoryLimit()

ilApc::getMemoryLimit ( )

protected

Reimplemented from ilGlobalCacheService.

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

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

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

Here is the call graph for this function:

◆ getMinMemory()

ilApc::getMinMemory ( )

protected

@inheritDoc

Reimplemented from ilGlobalCacheService.

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

                                     : int
    {
        return self::MIN_MEMORY;
    }

References MIN_MEMORY.

Referenced by getMemoryLimit().

Here is the caller graph for this function:

◆ isValid()

ilApc::isValid ( string $key )

Checks whether the cache key is valid or not.

Reimplemented from ilGlobalCacheService.

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

                                        : bool
    {
        return true;
    }

◆ serialize()

ilApc::serialize ( $value )

Parameters

mixed $value

Returns: mixed|string

Reimplemented from ilGlobalCacheService.

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

Reimplemented from ilGlobalCacheService.

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

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

References ilGlobalCacheService\returnKey().

Here is the call graph for this function:

◆ unserialize()

ilApc::unserialize ( $serialized_value )

Parameters

mixed $serialized_value

Returns: mixed

Reimplemented from ilGlobalCacheService.

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.

Referenced by getMinMemory().

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

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

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ delete()

◆ exists()

◆ flush()

◆ get()

◆ getActive()

◆ getInfo()

◆ getInstallable()

◆ getMemoryLimit()

◆ getMinMemory()

◆ isValid()

◆ serialize()

◆ set()

◆ unserialize()

Field Documentation

◆ MIN_MEMORY