ILIAS\Cache\Container\ActiveContainer Class Reference

Inheritance diagram for ILIAS\Cache\Container\ActiveContainer:

Collaboration diagram for ILIAS\Cache\Container\ActiveContainer:

Public Member Functions
	__construct (private Request $request, private Adaptor $adaptor, private Config $config)
	isLocked ()
	Returns true if the container is locked. More...
	lock (float $seconds)
	Locks the container for a given amount of seconds (max 300), in this time, get() will return null and has() will return false. More...
	has (string $key)
	Returns true if the container contains a value for the given key. More...
	get (string $key, Transformation $transformation)
	Returns the value for the given key, or null if the key does not exist. More...
	set (string $key, string|int|array|bool|null $value, ?int $ttl=null)
	Sets the value for the given key. More...
	delete (string $key)
	Deletes the value for the given key. More...
	flush ()
	Deletes all values in the container. More...
	getAdaptorName ()
	Returns the name of the adaptop used (such as apc, memcache, phpstatic) More...
	getContainerName ()
	Returns the name of the container. More...

Protected Member Functions
	buildFinalTransformation (Transformation $transformation)
	getNullFallback ()

Private Member Functions
	pack (mixed $value)
	packRecursive (array $value)
	unprefix (string $value)
	unpack (?string $value)
	unpackRecursive (array $value)

Private Attributes
const	LOCK_UNTIL = '_lock_until'
const	GLUE = '|||||'
const	STRING_PREFIX = 'string'
const	ARRAY_PREFIX = 'array'
const	INT_PREFIX = 'int'
const	BOOL_PREFIX = 'bool'
const	NULL_PREFIX = 'null'
const	TRUE = 'true'
const	FALSE = 'false'
Factory	$data_factory
	$null_trafo
string	$prefix_pattern

Detailed Description

Author

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

Definition at line 32 of file ActiveContainer.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Cache\Container\ActiveContainer::__construct	(	private Request	$request,
		private Adaptor	$adaptor,
		private Config	$config
	)

Definition at line 75 of file ActiveContainer.php.

References null.

      {
        $this->data_factory = new Factory();
        // see comment in buildFinalTransformation why this is not a good solution.
        $this->null_trafo = new \ILIAS\Refinery\Custom\Transformation(fn($value): null => null);
        $this->prefix_pattern = '(' . implode('|', [
                preg_quote(self::STRING_PREFIX, '/'),
                preg_quote(self::ARRAY_PREFIX, '/'),
                preg_quote(self::INT_PREFIX, '/'),
                preg_quote(self::BOOL_PREFIX, '/'),
                preg_quote(self::NULL_PREFIX, '/')
            ]) . ')';
    }

Member Function Documentation

buildFinalTransformation()

ILIAS\Cache\Container\ActiveContainer::buildFinalTransformation ( Transformation  $transformation )

protected

Definition at line 177 of file ActiveContainer.php.

References ILIAS\Cache\Container\ActiveContainer\getNullFallback().

Referenced by ILIAS\Cache\Container\ActiveContainer\get().

                                                                               : ByTrying
    {
        // This is a workaround for the fact that the ByTrying transformation cannot be created by
        // $DIC->refinery()->byTrying() since we are in a hell of dependencies. E.g. we cant instantiate the
        // caching service with $DIC->refinery() since the Refinery needs ilLanguage, but ilLanguage
        // needs the caching service...
        return new ByTrying([$transformation, $this->getNullFallback()], $this->data_factory);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ILIAS\Cache\Container\ActiveContainer::delete

(

string

$key

)

Deletes the value for the given key.

Implements ILIAS\Cache\Container\Container.

Definition at line 245 of file ActiveContainer.php.

References ILIAS\Cache\Container\ActiveContainer\isLocked().

                                       : void
    {
        if ($this->isLocked()) {
            return;
        }
        $this->adaptor->delete($this->request->getContainerKey(), $key);
    }

Here is the call graph for this function:

flush()

ILIAS\Cache\Container\ActiveContainer::flush

(

)

Deletes all values in the container.

Implements ILIAS\Cache\Container\Container.

Definition at line 253 of file ActiveContainer.php.

                           : void
    {
        $this->adaptor->flushContainer($this->request->getContainerKey());
    }

get()

ILIAS\Cache\Container\ActiveContainer::get	(	string	$key,
		Transformation	$transformation
	)

Returns the value for the given key, or null if the key does not exist.

Implements ILIAS\Cache\Container\Container.

Definition at line 218 of file ActiveContainer.php.

References ILIAS\Cache\Container\ActiveContainer\buildFinalTransformation(), ILIAS\Cache\Container\ActiveContainer\isLocked(), null, and ILIAS\Cache\Container\ActiveContainer\unpack().

                                                                    : string|int|array|bool|null
    {
        if ($this->isLocked()) {
            return null;
        }
        $unpacked_values = $this->unpack(
            $this->adaptor->get($this->request->getContainerKey(), $key)
        );

        return $this->buildFinalTransformation($transformation)->transform($unpacked_values);
    }

Here is the call graph for this function:

getAdaptorName()

ILIAS\Cache\Container\ActiveContainer::getAdaptorName

(

)

Returns the name of the adaptop used (such as apc, memcache, phpstatic)

Implements ILIAS\Cache\Container\Container.

Definition at line 258 of file ActiveContainer.php.

                                    : string
    {
        return $this->config->getAdaptorName();
    }

getContainerName()

ILIAS\Cache\Container\ActiveContainer::getContainerName

(

)

Returns the name of the container.

Implements ILIAS\Cache\Container\Container.

Definition at line 263 of file ActiveContainer.php.

                                      : string
    {
        return $this->request->getContainerKey();
    }

getNullFallback()

ILIAS\Cache\Container\ActiveContainer::getNullFallback ( )

protected

Definition at line 186 of file ActiveContainer.php.

References ILIAS\Cache\Container\ActiveContainer\$null_trafo.

Referenced by ILIAS\Cache\Container\ActiveContainer\buildFinalTransformation().

                                        : Transformation
    {
        return $this->null_trafo;
    }

Here is the caller graph for this function:

has()

ILIAS\Cache\Container\ActiveContainer::has

(

string

$key

)

Returns true if the container contains a value for the given key.

Implements ILIAS\Cache\Container\Container.

Definition at line 209 of file ActiveContainer.php.

References ILIAS\Cache\Container\ActiveContainer\isLocked().

                                    : bool
    {
        if ($this->isLocked()) {
            return false;
        }

        return $this->adaptor->has($this->request->getContainerKey(), $key);
    }

Here is the call graph for this function:

isLocked()

ILIAS\Cache\Container\ActiveContainer::isLocked

(

)

Returns true if the container is locked.

Implements ILIAS\Cache\Container\Container.

Definition at line 191 of file ActiveContainer.php.

References null.

Referenced by ILIAS\Cache\Container\ActiveContainer\delete(), ILIAS\Cache\Container\ActiveContainer\get(), ILIAS\Cache\Container\ActiveContainer\has(), and ILIAS\Cache\Container\ActiveContainer\set().

                              : bool
    {
        // see comment in buildFinalTransformation why this is not a good solution.
        $lock_until = $this->adaptor->get($this->request->getContainerKey(), self::LOCK_UNTIL);
        $lock_until = $lock_until === null ? null : (float) $lock_until;

        return $lock_until !== null && $lock_until > microtime(true);
    }

Here is the caller graph for this function:

lock()

ILIAS\Cache\Container\ActiveContainer::lock

(

float

$seconds

)

Locks the container for a given amount of seconds (max 300), in this time, get() will return null and has() will return false.

Exceptions

Implements ILIAS\Cache\Container\Container.

Definition at line 200 of file ActiveContainer.php.

                                        : void
    {
        if ($seconds > 300.0 || $seconds < 0.0) {
            throw new \InvalidArgumentException('Locking for more than 5 minutes is not allowed.');
        }
        $lock_until = (string) (microtime(true) + $seconds);
        $this->adaptor->set($this->request->getContainerKey(), self::LOCK_UNTIL, $lock_until, 300);
    }

pack()

ILIAS\Cache\Container\ActiveContainer::pack ( mixed  $value )

private

Definition at line 92 of file ActiveContainer.php.

References ILIAS\Cache\Container\ActiveContainer\packRecursive().

Referenced by ILIAS\Cache\Container\ActiveContainer\packRecursive(), and ILIAS\Cache\Container\ActiveContainer\set().

                                       : string
    {
        if (is_string($value)) {
            return self::STRING_PREFIX . self::GLUE . $value;
        }
        if (is_array($value)) {
            $value = $this->packRecursive($value);

            return self::ARRAY_PREFIX . self::GLUE . json_encode($value, JSON_THROW_ON_ERROR);
        }
        if (is_int($value)) {
            return self::INT_PREFIX . self::GLUE . $value;
        }
        if (is_bool($value)) {
            return self::BOOL_PREFIX . self::GLUE . ($value ? self::TRUE : self::FALSE);
        }
        if (is_null($value)) {
            return self::NULL_PREFIX . self::GLUE;
        }

        throw new \InvalidArgumentException(
            'Only strings, integers and arrays containing those values are allowed, ' . gettype($value) . ' given.'
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

packRecursive()

ILIAS\Cache\Container\ActiveContainer::packRecursive ( array  $value )

private

Definition at line 117 of file ActiveContainer.php.

References ILIAS\Cache\Container\ActiveContainer\pack().

Referenced by ILIAS\Cache\Container\ActiveContainer\pack().

                                                : array
    {
        array_walk($value, function (&$item): void {
            $item = is_array($item) ? $this->packRecursive($item) : $this->pack($item);
        });
        return $value;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

set()

ILIAS\Cache\Container\ActiveContainer::set	(	string	$key,
		string|int|array|bool|null	$value,
		?int	$ttl = null
	)

Sets the value for the given key.

Implements ILIAS\Cache\Container\Container.

Definition at line 230 of file ActiveContainer.php.

References ILIAS\Cache\Container\ActiveContainer\isLocked(), and ILIAS\Cache\Container\ActiveContainer\pack().

                                                                                         : void
    {
        if ($this->isLocked()) {
            return;
        }
        $ttl = $ttl ?? $this->config->getDefaultTTL();

        $this->adaptor->set(
            $this->request->getContainerKey(),
            $key,
            $this->pack($value),
            $ttl
        );
    }

Here is the call graph for this function:

unpack()

ILIAS\Cache\Container\ActiveContainer::unpack ( ?string  $value )

private

Definition at line 135 of file ActiveContainer.php.

References null, ILIAS\Cache\Container\ActiveContainer\unpackRecursive(), and ILIAS\Cache\Container\ActiveContainer\unprefix().

Referenced by ILIAS\Cache\Container\ActiveContainer\get(), and ILIAS\Cache\Container\ActiveContainer\unpackRecursive().

                                           : string|int|array|bool|null
    {
        // simple detection
        if ($value === null) {
            return null;
        }
        if ($value === self::NULL_PREFIX . self::GLUE) {
            return null;
        }

        // type detection
        [$type, $unprefixed_value] = $this->unprefix($value);

        switch ($type) {
            case self::STRING_PREFIX:
                return $unprefixed_value;
            case self::BOOL_PREFIX:
                return $unprefixed_value === self::TRUE;
            case self::ARRAY_PREFIX:
                $unprefixed_value = json_decode((string) $unprefixed_value, true, 512);
                if (!is_array($unprefixed_value)) {
                    return null;
                }

                return $this->unpackRecursive($unprefixed_value);
            case self::INT_PREFIX:
                return (int) $unprefixed_value;
            default:
                return null;
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

unpackRecursive()

ILIAS\Cache\Container\ActiveContainer::unpackRecursive ( array  $value )

private

Definition at line 169 of file ActiveContainer.php.

References ILIAS\Cache\Container\ActiveContainer\unpack().

Referenced by ILIAS\Cache\Container\ActiveContainer\unpack().

                                                  : array
    {
        array_walk($value, function (&$item): void {
            $item = is_array($item) ? $this->unpackRecursive($item) : $this->unpack($item);
        });
        return $value;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

unprefix()

ILIAS\Cache\Container\ActiveContainer::unprefix ( string  $value )

private

Definition at line 125 of file ActiveContainer.php.

References null.

Referenced by ILIAS\Cache\Container\ActiveContainer\unpack().

                                            : array
    {
        $str = '/^' . $this->prefix_pattern . preg_quote(self::GLUE, '/') . '(.*)/is';
        if (!preg_match($str, $value, $matches)) {
            return [self::NULL_PREFIX, null];
        }

        return [$matches[1], $matches[2]];
    }

Here is the caller graph for this function:

Field Documentation

$data_factory

Factory ILIAS\Cache\Container\ActiveContainer::$data_factory

private

Definition at line 71 of file ActiveContainer.php.

$null_trafo

ILIAS\Cache\Container\ActiveContainer::$null_trafo

private

Definition at line 72 of file ActiveContainer.php.

Referenced by ILIAS\Cache\Container\ActiveContainer\getNullFallback().

$prefix_pattern

string ILIAS\Cache\Container\ActiveContainer::$prefix_pattern

private

Definition at line 73 of file ActiveContainer.php.

ARRAY_PREFIX

const ILIAS\Cache\Container\ActiveContainer::ARRAY_PREFIX = 'array'

private

Definition at line 49 of file ActiveContainer.php.

BOOL_PREFIX

const ILIAS\Cache\Container\ActiveContainer::BOOL_PREFIX = 'bool'

private

Definition at line 57 of file ActiveContainer.php.

FALSE

const ILIAS\Cache\Container\ActiveContainer::FALSE = 'false'

private

Definition at line 69 of file ActiveContainer.php.

GLUE

const ILIAS\Cache\Container\ActiveContainer::GLUE = '|||||'

private

Definition at line 41 of file ActiveContainer.php.

INT_PREFIX

const ILIAS\Cache\Container\ActiveContainer::INT_PREFIX = 'int'

private

Definition at line 53 of file ActiveContainer.php.

LOCK_UNTIL

const ILIAS\Cache\Container\ActiveContainer::LOCK_UNTIL = '_lock_until'

private

Definition at line 37 of file ActiveContainer.php.

NULL_PREFIX

const ILIAS\Cache\Container\ActiveContainer::NULL_PREFIX = 'null'

private

Definition at line 61 of file ActiveContainer.php.

STRING_PREFIX

const ILIAS\Cache\Container\ActiveContainer::STRING_PREFIX = 'string'

private

Definition at line 45 of file ActiveContainer.php.

TRUE

const ILIAS\Cache\Container\ActiveContainer::TRUE = 'true'

private

Definition at line 65 of file ActiveContainer.php.

---

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

• components/ILIAS/Cache/src/Container/ActiveContainer.php