ilGlobalCacheServiceInterface Interface Reference

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

Inheritance diagram for ilGlobalCacheServiceInterface:

Collaboration diagram for ilGlobalCacheServiceInterface:

Public Member Functions
	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...

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 ilGlobalCacheService Base class for all concrete cache implementations.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

1.0.1

Definition at line 25 of file class.ilGlobalCacheServiceInterface.php.

Member Function Documentation

delete()

ilGlobalCacheServiceInterface::delete

(

string

$key

)

Implemented in ilApc, ilGlobalCacheService, ilMemcache, ilShm, and ilStaticCache.

exists()

ilGlobalCacheServiceInterface::exists

(

string

$key

)

Implemented in ilApc, ilGlobalCacheService, ilMemcache, ilShm, and ilStaticCache.

flush()

ilGlobalCacheServiceInterface::flush

(

bool

$complete = false

)

Implemented in ilApc, ilGlobalCacheService, ilMemcache, ilShm, and ilStaticCache.

get()

ilGlobalCacheServiceInterface::get

(

string

$key

)

Returns

mixed

Implemented in ilApc, ilGlobalCacheService, ilMemcache, ilShm, and ilStaticCache.

getComponent()

ilGlobalCacheServiceInterface::getComponent

(

)

Implemented in ilGlobalCacheService.

getInfo()

ilGlobalCacheServiceInterface::getInfo

(

)

Implemented in ilApc, ilGlobalCacheService, and ilMemcache.

getInstallationFailureReason()

ilGlobalCacheServiceInterface::getInstallationFailureReason

(

)

Implemented in ilGlobalCacheService, and ilMemcache.

getServiceId()

ilGlobalCacheServiceInterface::getServiceId

(

)

Implemented in ilGlobalCacheService.

getServiceType()

ilGlobalCacheServiceInterface::getServiceType

(

)

Implemented in ilGlobalCacheService.

isActive()

ilGlobalCacheServiceInterface::isActive

(

)

Implemented in ilGlobalCacheService.

isInstallable()

ilGlobalCacheServiceInterface::isInstallable

(

)

Implemented in ilGlobalCacheService.

isValid()

ilGlobalCacheServiceInterface::isValid

(

string

$key

)

Checks whether the cache key is valid or not.

Implemented in ilApc, ilGlobalCacheService, and ilMemcache.

returnKey()

ilGlobalCacheServiceInterface::returnKey

(

string

$key

)

Implemented in ilGlobalCacheService.

set()

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

Parameters

mixed

$serialized_value

Implemented in ilApc, ilGlobalCacheService, ilMemcache, ilShm, and ilStaticCache.

setComponent()

ilGlobalCacheServiceInterface::setComponent

(

string

$component

)

Implemented in ilGlobalCacheService.

setServiceId()

ilGlobalCacheServiceInterface::setServiceId

(

string

$service_id

)

Implemented in ilGlobalCacheService.

setServiceType()

ilGlobalCacheServiceInterface::setServiceType

(

int

$service_type

)

Implemented in ilGlobalCacheService.

setValid()

ilGlobalCacheServiceInterface::setValid

(

string

$key

)

Declare a key as valid.

If the key is already known no action is taken.

Implemented in ilGlobalCacheService.

unserialize()

ilGlobalCacheServiceInterface::unserialize

(

$serialized_value

)

Parameters

mixed

$serialized_value

Returns

mixed

Implemented in ilApc, ilGlobalCacheService, ilMemcache, ilShm, and ilStaticCache.

---

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

• Services/GlobalCache/classes/class.ilGlobalCacheServiceInterface.php