ILIAS\Cache\Container\Container Interface Reference

Inheritance diagram for ILIAS\Cache\Container\Container:

Collaboration diagram for ILIAS\Cache\Container\Container:

Public Member Functions
	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...
	isLocked ()
	Returns true if the container is locked. 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...

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

Member Function Documentation

delete()

ILIAS\Cache\Container\Container::delete

(

string

$key

)

Deletes the value for the given key.

Implemented in ILIAS\Cache\Container\ActiveContainer, and ILIAS\Cache\Container\VoidContainer.

flush()

ILIAS\Cache\Container\Container::flush

(

)

Deletes all values in the container.

Implemented in ILIAS\Cache\Container\ActiveContainer, and ILIAS\Cache\Container\VoidContainer.

get()

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

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

Implemented in ILIAS\Cache\Container\ActiveContainer, and ILIAS\Cache\Container\VoidContainer.

getAdaptorName()

ILIAS\Cache\Container\Container::getAdaptorName

(

)

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

Implemented in ILIAS\Cache\Container\ActiveContainer, and ILIAS\Cache\Container\VoidContainer.

getContainerName()

ILIAS\Cache\Container\Container::getContainerName

(

)

Returns the name of the container.

Implemented in ILIAS\Cache\Container\ActiveContainer, and ILIAS\Cache\Container\VoidContainer.

has()

ILIAS\Cache\Container\Container::has

(

string

$key

)

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

Implemented in ILIAS\Cache\Container\ActiveContainer, and ILIAS\Cache\Container\VoidContainer.

isLocked()

ILIAS\Cache\Container\Container::isLocked

(

)

Returns true if the container is locked.

Implemented in ILIAS\Cache\Container\ActiveContainer, and ILIAS\Cache\Container\VoidContainer.

lock()

ILIAS\Cache\Container\Container::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

InvalidArgumentException if $seconds is greater than 300 or less than 0

Implemented in ILIAS\Cache\Container\ActiveContainer, and ILIAS\Cache\Container\VoidContainer.

set()

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

Sets the value for the given key.

Implemented in ILIAS\Cache\Container\ActiveContainer.

---

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

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