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

Inheritance diagram for ilMemcache:

Collaboration diagram for ilMemcache:

Public Member Functions
	exists (string $key)

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

	get (string $key)

	delete (string $key)

	flush (bool $complete=false)

	getInstallationFailureReason ()

	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
	getMemcacheObject ()

	getActive ()

	getInstallable ()

Protected Member Functions inherited from ilGlobalCacheService
	getActive ()

	getInstallable ()

	getMemoryLimit ()

	getMinMemory ()

	checkMemory ()

Static Protected Attributes
static Memcached	$memcache_object = null

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

static array	$installable = array()

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 = ''

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 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 24 of file class.ilMemcache.php.

Member Function Documentation

◆ delete()

ilMemcache::delete ( string $key )

Reimplemented from ilGlobalCacheService.

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

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

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

Here is the call graph for this function:

◆ exists()

ilMemcache::exists ( string $key )

Reimplemented from ilGlobalCacheService.

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

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

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

Here is the call graph for this function:

◆ flush()

ilMemcache::flush ( bool $complete = false )

Reimplemented from ilGlobalCacheService.

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

                                                 : bool
    {
        return $this->getMemcacheObject()->flush();
    }

References getMemcacheObject().

Here is the call graph for this function:

◆ get()

ilMemcache::get ( string $key )

Returns: mixed

Reimplemented from ilGlobalCacheService.

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

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

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

Here is the call graph for this function:

◆ getActive()

ilMemcache::getActive ( )

protected

Reimplemented from ilGlobalCacheService.

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

                                  : bool
    {
        if ($this->getInstallable()) {
            $stats = $this->getMemcacheObject()->getStats();
 
            if (!is_array($stats)) {
                return false;
            }
 
            foreach ($stats as $server) {
                if ((int) $server['pid'] > 1) {
                    return true;
                }
            }
 
            return false;
        }
 
        return false;
    }

References $server, getInstallable(), and getMemcacheObject().

Here is the call graph for this function:

◆ getInfo()

ilMemcache::getInfo ( )

Reimplemented from ilGlobalCacheService.

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

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

References ILIAS\LTI\ToolProvider\$key, getMemcacheObject(), and ilGlobalCacheService\isInstallable().

Here is the call graph for this function:

◆ getInstallable()

ilMemcache::getInstallable ( )

protected

Reimplemented from ilGlobalCacheService.

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

                                       : bool
    {
        return class_exists('Memcached');
    }

Referenced by getActive().

Here is the caller graph for this function:

◆ getInstallationFailureReason()

ilMemcache::getInstallationFailureReason ( )

Reimplemented from ilGlobalCacheService.

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

                                                  : string
    {
        $stats = $this->getMemcacheObject()->getStats();
        $server_available = false;
        foreach ($stats as $server) {
            if ($server['pid'] > 0) {
                $server_available = true;
            }
        }
        if (!$server_available) {
            return 'No Memcached-Server available';
        }
        return parent::getInstallationFailureReason();
    }

References $server, and getMemcacheObject().

Here is the call graph for this function:

◆ getMemcacheObject()

ilMemcache::getMemcacheObject ( )

protected

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

                                          : ?\Memcached
    {
        return self::$memcache_object;
    }

References $memcache_object.

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

Here is the caller graph for this function:

◆ isValid()

ilMemcache::isValid ( string $key )

Checks whether the cache key is valid or not.

Reimplemented from ilGlobalCacheService.

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

                                        : bool
    {
        return true;
    }

◆ serialize()

ilMemcache::serialize ( $value )

Parameters

mixed $value

Reimplemented from ilGlobalCacheService.

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

                                     : string
    {
        return serialize($value);
    }

References serialize().

Referenced by serialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set()

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

Parameters

mixed $serialized_value

Reimplemented from ilGlobalCacheService.

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

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

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

Here is the call graph for this function:

◆ unserialize()

ilMemcache::unserialize ( $serialized_value )

Parameters

mixed $serialized_value

Returns: mixed

Reimplemented from ilGlobalCacheService.

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

    {
        return unserialize($serialized_value);
    }

References unserialize().

Referenced by unserialize().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $memcache_object

Memcached ilMemcache::$memcache_object = null

staticprotected

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

Referenced by getMemcacheObject().

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

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

Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ delete()

◆ exists()

◆ flush()

◆ get()

◆ getActive()

◆ getInfo()

◆ getInstallable()

◆ getInstallationFailureReason()

◆ getMemcacheObject()

◆ isValid()

◆ serialize()

◆ set()

◆ unserialize()

Field Documentation

◆ $memcache_object