ILIAS\Cache\Adaptor\Memcached Class Reference

Inheritance diagram for ILIAS\Cache\Adaptor\Memcached:

Collaboration diagram for ILIAS\Cache\Adaptor\Memcached:

Public Member Functions
	__construct (Config $config)
	isAvailable ()
	has (string $container, string $key)
	get (string $container, string $key)
	set (string $container, string $key, string $value, int $ttl)
	delete (string $container, string $key)
	flushContainer (string $container)
	flush ()
Public Member Functions inherited from ILIAS\Cache\Adaptor\BaseAdaptor
	__construct (protected Config $config)

Protected Member Functions
	initServer (Config $config)
Protected Member Functions inherited from ILIAS\Cache\Adaptor\BaseAdaptor
	buildKey (string $container, string $key)
	buildContainerPrefix (string $container)

Private Attributes
const	PERSISTENT_ID = 'ilias_cache'
Memcached	$server = null

Additional Inherited Members
Data Fields inherited from ILIAS\Cache\Adaptor\Adaptor\Adaptor
const	CONTAINER_PREFIX_SEPARATOR = ':'
Protected Attributes inherited from ILIAS\Cache\Adaptor\BaseAdaptor
const	LOCK_UNTIL = '_lock_until'

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 28 of file Memcached.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Cache\Adaptor\Memcached::__construct

(

Config

$config

)

Implements ILIAS\Cache\Adaptor\Adaptor\Adaptor.

Definition at line 36 of file Memcached.php.

References ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Cache\Config\getNodes(), and ILIAS\Cache\Adaptor\Memcached\initServer().

    {
        parent::__construct($config);
        if (!class_exists(\Memcached::class)) {
            return;
        }
        if ($config->getNodes() === []) {
            return;
        }
        $this->initServer($config);
    }

Here is the call graph for this function:

Member Function Documentation

delete()

ILIAS\Cache\Adaptor\Memcached::delete	(	string	$container,
		string	$key
	)

Implements ILIAS\Cache\Adaptor\Adaptor\Adaptor.

Definition at line 69 of file Memcached.php.

References ILIAS\Cache\Adaptor\BaseAdaptor\buildKey(), and ILIAS\UI\examples\Progress\Bar\server().

                                                          : void
    {
        $this->server->delete($this->buildKey($container, $key), 0);
    }

Here is the call graph for this function:

flush()

ILIAS\Cache\Adaptor\Memcached::flush

(

)

Implements ILIAS\Cache\Adaptor\Adaptor\Adaptor.

Definition at line 93 of file Memcached.php.

References ILIAS\UI\examples\Progress\Bar\server().

                           : void
    {
        $this->server->flush();
    }

Here is the call graph for this function:

flushContainer()

ILIAS\Cache\Adaptor\Memcached::flushContainer

(

string

$container

)

Implements ILIAS\Cache\Adaptor\Adaptor\Adaptor.

Definition at line 74 of file Memcached.php.

References ILIAS\Cache\Adaptor\BaseAdaptor\buildContainerPrefix(), and ILIAS\UI\examples\Progress\Bar\server().

                                                     : void
    {
        $prefix = $this->buildContainerPrefix($container);
        foreach ($this->server->getAllKeys() as $key) {
            if (str_starts_with((string) $key, $prefix)) {
                $this->server->set($key, false, 0);
            }
        }
        foreach ($this->server->getAllKeys() as $key) {
            if (str_starts_with((string) $key, $prefix)) {
                $this->server->get(
                    $key
                ); // invalidates the key, see https://www.php.net/manual/en/memcached.expiration.php
            }
        }
        $this->server->flushBuffers();
        // $this->lock(1);// see https://github.com/memcached/memcached/issues/307
    }

Here is the call graph for this function:

get()

ILIAS\Cache\Adaptor\Memcached::get	(	string	$container,
		string	$key
	)

Implements ILIAS\Cache\Adaptor\Adaptor\Adaptor.

Definition at line 59 of file Memcached.php.

References ILIAS\Cache\Adaptor\BaseAdaptor\buildKey(), null, and ILIAS\UI\examples\Progress\Bar\server().

                                                       : ?string
    {
        return $this->server->get($this->buildKey($container, $key)) ?: null;
    }

Here is the call graph for this function:

has()

ILIAS\Cache\Adaptor\Memcached::has	(	string	$container,
		string	$key
	)

Implements ILIAS\Cache\Adaptor\Adaptor\Adaptor.

Definition at line 54 of file Memcached.php.

References ILIAS\Cache\Adaptor\BaseAdaptor\buildKey(), and ILIAS\UI\examples\Progress\Bar\server().

                                                       : bool
    {
        return $this->server->get($this->buildKey($container, $key)) !== false;
    }

Here is the call graph for this function:

initServer()

ILIAS\Cache\Adaptor\Memcached::initServer ( Config  $config )

protected

Definition at line 98 of file Memcached.php.

References ILIAS\Cache\Config\getNodes(), and ILIAS\UI\examples\Progress\Bar\server().

Referenced by ILIAS\Cache\Adaptor\Memcached\__construct().

                                                 : void
    {
        $this->server = new \Memcached(self::PERSISTENT_ID);
        $nodes = $config->getNodes();
        foreach ($nodes as $node) {
            $this->server->addServer(
                $node->getHost(),
                $node->getPort(),
                $node->getWeight() ?? 100 / count($nodes)
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isAvailable()

ILIAS\Cache\Adaptor\Memcached::isAvailable

(

)

Implements ILIAS\Cache\Adaptor\Adaptor\Adaptor.

Definition at line 49 of file Memcached.php.

References null, and ILIAS\UI\examples\Progress\Bar\server().

                                 : bool
    {
        return class_exists(\Memcached::class) && $this->server !== null && $this->server->getVersion() !== false;
    }

Here is the call graph for this function:

set()

ILIAS\Cache\Adaptor\Memcached::set	(	string	$container,
		string	$key,
		string	$value,
		int	$ttl
	)

Implements ILIAS\Cache\Adaptor\Adaptor\Adaptor.

Definition at line 64 of file Memcached.php.

References ILIAS\Cache\Adaptor\BaseAdaptor\buildKey(), and ILIAS\UI\examples\Progress\Bar\server().

                                                                                : void
    {
        $this->server->set($this->buildKey($container, $key), $value, $ttl);
    }

Here is the call graph for this function:

Field Documentation

$server

Memcached ILIAS\Cache\Adaptor\Memcached::$server = null

private

Definition at line 34 of file Memcached.php.

PERSISTENT_ID

const ILIAS\Cache\Adaptor\Memcached::PERSISTENT_ID = 'ilias_cache'

private

Definition at line 33 of file Memcached.php.

---

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

• components/ILIAS/Cache/src/Adaptor/Memcached.php