An application cache. More...

Inheritance diagram for cache_application:

Public Member Functions
	__construct (cache_definition $definition, cache_store $store, $loader=null)
	Overrides the cache construct method. More...

	__clone ()
	Fixes the instance up after a clone.

	acquire_lock ($key)
	Acquires a lock on the given key. More...

	check_lock_state ($key)
	Checks if this cache has a lock on the given key. More...

	delete ($key, $recurse=true)
	Delete the given key from the cache. More...

	delete_many (array $keys, $recurse=true)
	Delete all of the given keys from the cache. More...

	get ($key, $strictness=IGNORE_MISSING)
	Retrieves the value for the given key from the cache. More...

	get_identifier ()
	Returns the identifier to use. More...

	get_many (array $keys, $strictness=IGNORE_MISSING)
	Retrieves an array of values for an array of keys. More...

	has ($key)
	Test is a cache has a key. More...

	has ($key, $tryloadifpossible=false)
	Test is a cache has a key. More...

	has_all (array $keys)
	Test is a cache has all of the given keys. More...

	has_any (array $keys)
	Test if a cache has at least one of the given keys. More...

	purge ()
	Purges the cache store, and loader if there is one. More...

	purge_current_user ()
	Subclasses may support purging cache of all data belonging to the current user. More...

	release_lock ($key)
	Releases the lock this cache has on the given key. More...

	set ($key, $data)
	Sends a key => value pair to the cache. More...

	set_identifiers (array $identifiers)
	Alters the identifiers that have been provided to the definition. More...

	set_many (array $keyvaluearray)
	Sends several key => value pairs to the cache. More...

Static Public Member Functions
static	compare_purge_tokens ($tokena, $tokenb)
	Compare a pair of purge tokens. More...

static	get_purge_token ($reset=false)
	Get a 'purge' token used for cache invalidation handling. More...

static	make ($component, $area, array $identifiers=array(), $unused=null)
	Creates a new cache instance for a pre-defined definition. More...

static	make_from_params ($mode, $component, $area, array $identifiers=array(), array $options=array())
	Creates a new cache instance based upon the given params. More...

static	now ($float=false)
	Returns the timestamp from the first request for the time from the cache API. More...

Protected Member Functions
	deep_clone ($value)
	Creates a reference free clone of the given value. More...

	delete_from_persist_cache ()

	ensure_cachelock_available ()
	Ensure that the dedicated lock store is ready to go. More...

	get_datasource ()
	Returns the data source associated with this cache. More...

	get_definition ()
	Returns the cache definition. More...

	get_from_persist_cache ()

	get_loader ()
	Returns the loader associated with this instance. More...

	get_store ()
	Returns the cache store. More...

	handle_invalidation_events ()
	Process any outstanding invalidation events for the cache we are registering,. More...

	has_a_ttl ()
	Returns true if the cache is making use of a ttl. More...

	is_in_persist_cache ()

	is_using_persist_cache ()

	parse_key ($key)
	Parses the key turning it into a string (or array is required) suitable to be passed to the cache store. More...

	requires_serialisation ($value, $depth=1)
	Checks to see if a var requires serialisation. More...

	set_data_source (cache_data_source $datasource)
	Set the data source for this cache. More...

	set_in_persist_cache ()

	set_is_sub_loader ($setting=true)
	Used to inform the loader of its state as a sub loader, or as the top of the chain. More...

	set_loader (cache_loader $loader)
	Set the loader for this cache. More...

	static_acceleration_delete ($key)
	Deletes an item from the static acceleration array. More...

	static_acceleration_get ($key)
	Returns the item from the static acceleration array if it exists there. More...

	static_acceleration_has ($key)
	Returns true if the requested key exists within the static acceleration array. More...

	static_acceleration_purge ()
	Purge the static acceleration cache.

	static_acceleration_set ($key, $data)
	Sets a key value pair into the static acceleration array. More...

	store_supports_key_awareness ()
	Returns true if the store supports key awareness. More...

	store_supports_native_locking ()
	Returns true if the store natively supports locking. More...

	store_supports_native_ttl ()
	Returns true if the cache store supports native ttl. More...

	unref ($data)
	Removes references where required. More...

	use_static_acceleration ()
	Returns true if this cache is making use of the static acceleration array. More...

Protected Attributes
cache_lock_interface	$cachelockinstance
	Gets set to a cache_store to use for locking if the caches primary store doesn't support locking natively.

string	$lockidentifier
	Lock identifier. More...

cache_store	$nativelocking = null
	Gets set to true if the cache's primary store natively supports locking. More...

bool	$perfdebug = false
	Gets set to true if we want to collect performance information about the cache API.

bool	$requirelocking = false
	Gets set to true if the cache is going to be using locking. More...

bool	$requirelockingread = false
	Gets set to true if the cache must use read locking (get\|has).

bool	$requirelockingwrite = false
	Gets set to true if the cache must use write locking (set\|delete)

strubg	$storetype = 'unknown'
	Gets set to the class name of the store during initialisation. More...

bool	$subloader = false
	Determines if this loader is a sub loader, not the top of the chain.

Static Protected Attributes
static int	$now
	We need a timestamp to use within the cache API. More...

static string	$purgetoken
	A purge token used to distinguish between multiple cache purges in the same second. More...

Detailed Description

An application cache.

This class is used for application caches returned by the cache::make methods. On top of the standard functionality it also allows locking to be required and or manually operated.

This cache class should never be interacted with directly. Instead you should always use the cache::make methods. It is technically possible to call those methods through this class however there is no guarantee that you will get an instance of this class back again.

Constructor & Destructor Documentation

◆ __construct()

cache_application::__construct	(	cache_definition	$definition,
		cache_store	$store,
			$loader = `null`
	)

Overrides the cache construct method.

You should not call this method from your code, instead you should use the cache::make methods.

Parameters

cache_definition	$definition
cache_store	$store
cache_loader \| cache_data_source	$loader

Reimplemented from cache.

Member Function Documentation

◆ acquire_lock()

cache_application::acquire_lock ( $key )

Acquires a lock on the given key.

This is done automatically if the definition requires it. It is recommended to use a definition if you want to have locking although it is possible to do locking without having it required by the definition. The problem with such an approach is that you cannot ensure that code will consistently use locking. You will need to rely on the integrators review skills.

Parameters

string | int $key The key as given to get|set|delete

Return values

bool	Returns true if the lock could be acquired, false otherwise.

Implements cache_loader_with_locking.

◆ check_lock_state()

cache_application::check_lock_state ( $key )

Checks if this cache has a lock on the given key.

Parameters

string | int $key The key as given to get|set|delete

Return values

bool|null Returns true if there is a lock and this cache has it, null if no one has a lock on that key, false if someone else has the lock.

Implements cache_loader_with_locking.

◆ compare_purge_tokens()

static cache::compare_purge_tokens	(	$tokena,
		$tokenb
	)

staticinherited

Compare a pair of purge tokens.

If the two tokens are identical, then the return value is 0. If the time component of token A is newer than token B, then a positive value is returned. If the time component of token B is newer than token A, then a negative value is returned.

Note: This function is intended for use from within the Cache API only and not by plugins, or cache stores.

Parameters

string	$tokena
string	$tokenb

Return values

int

◆ deep_clone()

cache::deep_clone ( $value )

protectedinherited

Creates a reference free clone of the given value.

Parameters

mixed $value

Return values

mixed

◆ delete()

cache_application::delete	(	$key,
		$recurse = `true`
	)

Delete the given key from the cache.

Parameters

string \| int	$key	The key to delete.
bool	$recurse	When set to true the key will also be deleted from all stacked cache loaders and their stores. This happens by default and ensure that all the caches are consistent. It is NOT recommended to change this.

Return values

bool	True of success, false otherwise.

Reimplemented from cache.

◆ delete_from_persist_cache()

cache::delete_from_persist_cache ( )

protectedinherited

Deprecated:: since 2.6

See also: cache::static_acceleration_delete()

◆ delete_many()

cache_application::delete_many	(	array	$keys,
			$recurse = `true`
	)

Delete all of the given keys from the cache.

Parameters

array	$keys	The key to delete.
bool	$recurse	When set to true the key will also be deleted from all stacked cache loaders and their stores. This happens by default and ensure that all the caches are consistent. It is NOT recommended to change this.

Return values

int	The number of items successfully deleted.

Reimplemented from cache.

◆ ensure_cachelock_available()

cache_application::ensure_cachelock_available ( )

protected

Ensure that the dedicated lock store is ready to go.

This should only happen if the cache store doesn't natively support it.

◆ get()

cache_application::get	(	$key,
		$strictness = `IGNORE_MISSING`
	)

Retrieves the value for the given key from the cache.

Parameters

string \| int	$key	The key for the data being requested.
int	$strictness	One of IGNORE_MISSING \| MUST_EXIST

Return values

mixed|false The data from the cache or false if the key did not exist within the cache.

Reimplemented from cache.

◆ get_datasource()

cache::get_datasource ( )

protectedinherited

Returns the data source associated with this cache.

Since: Moodle 2.4.4

Return values

cache_data_source|false

◆ get_definition()

cache::get_definition ( )

protectedinherited

Returns the cache definition.

Return values

cache_definition

◆ get_from_persist_cache()

cache::get_from_persist_cache ( )

protectedinherited

Deprecated:: since 2.6

See also: cache::static_acceleration_get

◆ get_identifier()

cache_application::get_identifier ( )

Returns the identifier to use.

@staticvar int $instances Counts the number of instances. Used as part of the lock identifier.

Return values

string

◆ get_loader()

cache::get_loader ( )

protectedinherited

Returns the loader associated with this instance.

Since: Moodle 2.4.4

Return values

cache|false

◆ get_many()

cache_application::get_many	(	array	$keys,
			$strictness = `IGNORE_MISSING`
	)

Retrieves an array of values for an array of keys.

Using this function comes with potential performance implications. Not all cache stores will support get_many/set_many operations and in order to replicate this functionality will call the equivalent singular method for each item provided. This should not deter you from using this function as there is a performance benefit in situations where the cache store does support it, but you should be aware of this fact.

Parameters

array	$keys	The keys of the data being requested.
int	$strictness	One of IGNORE_MISSING or MUST_EXIST.

Return values

array An array of key value pairs for the items that could be retrieved from the cache. If MUST_EXIST was used and not all keys existed within the cache then an exception will be thrown. Otherwise any key that did not exist will have a data value of false within the results.

Exceptions

coding_exception

Reimplemented from cache.

◆ get_purge_token()

static cache::get_purge_token ( $reset = false )

staticinherited

Get a 'purge' token used for cache invalidation handling.

Note: This function is intended for use from within the Cache API only and not by plugins, or cache stores.

Parameters

bool $reset Whether to reset the token and generate a new one.

Return values

string

◆ get_store()

cache::get_store ( )

protectedinherited

Returns the cache store.

Return values

cache_store

◆ handle_invalidation_events()

cache::handle_invalidation_events ( )

protectedinherited

Process any outstanding invalidation events for the cache we are registering,.

Identifiers and event invalidation are not compatible with each other at this time. As a result the cache does not need to consider identifiers when working out what to invalidate.

◆ has() [1/2]

cache_loader::has ( $key )

inherited

Test is a cache has a key.

The use of the has methods is strongly discouraged. In a high load environment the cache may well change between the test and any subsequent action (get, set, delete etc). Instead it is recommended to write your code in such a way they it performs the following steps:

Attempt to retrieve the information.
Generate the information.
Attempt to set the information

Its also worth mentioning that not all stores support key tests. For stores that don't support key tests this functionality is mimicked by using the equivalent get method. Just one more reason you should not use these methods unless you have a very good reason to do so.

Parameters

string | int $key

Return values

bool	True if the cache has the requested key, false otherwise.

◆ has() [2/2]

cache::has	(	$key,
		$tryloadifpossible = `false`
	)

inherited

Test is a cache has a key.

The use of the has methods is strongly discouraged. In a high load environment the cache may well change between the test and any subsequent action (get, set, delete etc). Instead it is recommended to write your code in such a way they it performs the following steps:

Attempt to retrieve the information.
Generate the information.
Attempt to set the information

Its also worth mentioning that not all stores support key tests. For stores that don't support key tests this functionality is mimicked by using the equivalent get method. Just one more reason you should not use these methods unless you have a very good reason to do so.

Parameters

string \| int	$key
bool	$tryloadifpossible	If set to true, the cache doesn't contain the key, and there is another cache loader or data source then the code will try load the key value from the next item in the chain.

Return values

bool	True if the cache has the requested key, false otherwise.

Reimplemented in cache_session, and cache_disabled.

◆ has_a_ttl()

cache::has_a_ttl ( )

protectedinherited

Returns true if the cache is making use of a ttl.

Return values

bool

◆ has_all()

cache::has_all ( array $keys )

inherited

Test is a cache has all of the given keys.

It is strongly recommended to avoid the use of this function if not absolutely required. In a high load environment the cache may well change between the test and any subsequent action (get, set, delete etc).

Its also worth mentioning that not all stores support key tests. For stores that don't support key tests this functionality is mimicked by using the equivalent get method. Just one more reason you should not use these methods unless you have a very good reason to do so.

Parameters

array $keys

Return values

bool	True if the cache has all of the given keys, false otherwise.

Implements cache_loader.

Reimplemented in cache_session, and cache_disabled.

◆ has_any()

cache::has_any ( array $keys )

inherited

Test if a cache has at least one of the given keys.

It is strongly recommended to avoid the use of this function if not absolutely required. In a high load environment the cache may well change between the test and any subsequent action (get, set, delete etc).

Its also worth mentioning that not all stores support key tests. For stores that don't support key tests this functionality is mimicked by using the equivalent get method. Just one more reason you should not use these methods unless you have a very good reason to do so.

Parameters

array $keys

Return values

bool	True if the cache has at least one of the given keys

Implements cache_loader.

Reimplemented in cache_session, and cache_disabled.

◆ is_in_persist_cache()

cache::is_in_persist_cache ( )

protectedinherited

See also: cache::static_acceleration_has

Deprecated:: since 2.6

◆ is_using_persist_cache()

cache::is_using_persist_cache ( )

protectedinherited

Deprecated:: since 2.6

See also: cache::use_static_acceleration()

◆ make()

static cache::make	(		$component,
			$area,
		array	$identifiers = `array()`,
			$unused = `null`
	)

staticinherited

Creates a new cache instance for a pre-defined definition.

Parameters

string	$component	The component for the definition
string	$area	The area for the definition
array	$identifiers	Any additional identifiers that should be provided to the definition.
string	$unused	Used to be datasourceaggregate but that was removed and this is now unused.

Return values

cache_application|cache_session|cache_store

◆ make_from_params()

static cache::make_from_params	(		$mode,
			$component,
			$area,
		array	$identifiers = `array()`,
		array	$options = `array()`
	)

staticinherited

Creates a new cache instance based upon the given params.

Parameters

int	$mode	One of cache_store::MODE_*
string	$component	The component this cache relates to.
string	$area	The area this cache relates to.
array	$identifiers	Any additional identifiers that should be provided to the definition.
array	$options	An array of options, available options are: simplekeys : Set to true if the keys you will use are a-zA-Z0-9_ simpledata : Set to true if the type of the data you are going to store is scalar, or an array of scalar vars staticacceleration : If set to true the cache will hold onto data passing through it. staticaccelerationsize : The max size for the static acceleration array.

Return values

cache_application|cache_session|cache_store

◆ now()

static cache::now ( $float = false )

staticinherited

Returns the timestamp from the first request for the time from the cache API.

This stamp needs to be used for all ttl and time based operations to ensure that we don't end up with timing issues.

Parameters

bool $float Whether to use floating precision accuracy.

Return values

int|float

◆ parse_key()

cache::parse_key ( $key )

protectedinherited

Parses the key turning it into a string (or array is required) suitable to be passed to the cache store.

Parameters

string | int $key As passed to get|set|delete etc.

Return values

string|array String unless the store supports multi-identifiers in which case an array if returned.

Reimplemented in cache_session.

◆ purge()

cache::purge ( )

inherited

Purges the cache store, and loader if there is one.

Return values

bool	True on success, false otherwise

Reimplemented in cache_session, and cache_disabled.

◆ purge_current_user()

cache::purge_current_user ( )

inherited

Subclasses may support purging cache of all data belonging to the current user.

Reimplemented in cache_session.

◆ release_lock()

cache_application::release_lock ( $key )

Releases the lock this cache has on the given key.

Parameters

string | int $key

Return values

bool	True if the operation succeeded, false otherwise.

Implements cache_loader_with_locking.

◆ requires_serialisation()

cache::requires_serialisation	(	$value,
		$depth = `1`
	)

protectedinherited

Checks to see if a var requires serialisation.

Parameters

mixed	$value	The value to check.
int	$depth	Used to ensure we don't enter an endless loop (think recursion).

Return values

bool	Returns true if the value is going to require serialisation in order to ensure a reference free copy or false if its safe to clone.

◆ set()

cache_application::set	(	$key,
		$data
	)

Sends a key => value pair to the cache.

// This code will add four entries to the cache, one for each url. $cache->set('main', 'http://moodle.org'); $cache->set('docs', 'http://docs.moodle.org'); $cache->set('tracker', 'http://tracker.moodle.org'); $cache->set('qa', 'http://qa.moodle.net');

Parameters

string \| int	$key	The key for the data being requested.
mixed	$data	The data to set against the key.

Return values

bool	True on success, false otherwise.

Reimplemented from cache.

◆ set_data_source()

cache::set_data_source ( cache_data_source $datasource )

protectedinherited

Set the data source for this cache.

Parameters

cache_data_source $datasource

◆ set_identifiers()

cache::set_identifiers ( array $identifiers )

inherited

Alters the identifiers that have been provided to the definition.

This is an advanced method and should not be used unless really needed. It allows the developer to slightly alter the definition without having to re-establish the cache. It will cause more processing as the definition will need to clear and reprepare some of its properties.

Parameters

array $identifiers

◆ set_in_persist_cache()

cache::set_in_persist_cache ( )

protectedinherited

Deprecated:: since 2.6

See also: cache::static_acceleration_set

◆ set_is_sub_loader()

cache::set_is_sub_loader ( $setting = true )

protectedinherited

Used to inform the loader of its state as a sub loader, or as the top of the chain.

This is important as it ensures that we do not have more than one loader keeping static acceleration data. Subloaders need to be "pure" loaders in the sense that they are used to store and retrieve information from stores or the next loader/data source in the chain. Nothing fancy, nothing flash.

Parameters

bool $setting

◆ set_loader()

cache::set_loader ( cache_loader $loader )

protectedinherited

Set the loader for this cache.

Parameters

cache_loader $loader

◆ set_many()

cache_application::set_many ( array $keyvaluearray )

Sends several key => value pairs to the cache.

Using this function comes with potential performance implications. Not all cache stores will support get_many/set_many operations and in order to replicate this functionality will call the equivalent singular method for each item provided. This should not deter you from using this function as there is a performance benefit in situations where the cache store does support it, but you should be aware of this fact.

// This code will add four entries to the cache, one for each url. $cache->set_many(array( 'main' => 'http://moodle.org', 'docs' => 'http://docs.moodle.org', 'tracker' => 'http://tracker.moodle.org', 'qa' => ''http://qa.moodle.net' ));

Parameters

array $keyvaluearray An array of key => value pairs to send to the cache.

Return values

int	The number of items successfully set. It is up to the developer to check this matches the number of items. ... if they care that is.

Reimplemented from cache.

◆ static_acceleration_delete()

cache::static_acceleration_delete ( $key )

protectedinherited

Deletes an item from the static acceleration array.

Parameters

string | int $key As given to get|set|delete

Return values

bool	True on success, false otherwise.

◆ static_acceleration_get()

cache::static_acceleration_get ( $key )

protectedinherited

Returns the item from the static acceleration array if it exists there.

Parameters

string $key The parsed key

Return values

mixed|false Dereferenced data from the static acceleration array or false if it wasn't there.

◆ static_acceleration_has()

cache::static_acceleration_has ( $key )

protectedinherited

Returns true if the requested key exists within the static acceleration array.

Parameters

string $key The parsed key

Return values

bool

◆ static_acceleration_set()

cache::static_acceleration_set	(	$key,
		$data
	)

protectedinherited

Sets a key value pair into the static acceleration array.

Parameters

string	$key	The parsed key
mixed	$data

Return values

bool

◆ store_supports_key_awareness()

cache::store_supports_key_awareness ( )

protectedinherited

Returns true if the store supports key awareness.

Return values

bool

◆ store_supports_native_locking()

cache::store_supports_native_locking ( )

protectedinherited

Returns true if the store natively supports locking.

Return values

bool

◆ store_supports_native_ttl()

cache::store_supports_native_ttl ( )

protectedinherited

Returns true if the cache store supports native ttl.

Return values

bool

◆ unref()

cache::unref ( $data )

protectedinherited

Removes references where required.

Parameters

stdClass | array $data

Return values

mixed What ever was put in but without any references.

◆ use_static_acceleration()

cache::use_static_acceleration ( )

protectedinherited

Returns true if this cache is making use of the static acceleration array.

Return values

bool

Reimplemented in cache_session.

Member Data Documentation

◆ $lockidentifier

string cache_application::$lockidentifier

protected

Lock identifier.

This is used to ensure the lock belongs to the cache instance + definition + user.

◆ $nativelocking

cache_store cache_application::$nativelocking = null

protected

Gets set to true if the cache's primary store natively supports locking.

If it does then we use that, otherwise we need to instantiate a second store to use for locking.

◆ $now

int cache::$now

staticprotectedinherited

We need a timestamp to use within the cache API.

This stamp needs to be used for all ttl and time based operations to ensure that we don't end up with timing issues.

◆ $purgetoken

string cache::$purgetoken

staticprotectedinherited

A purge token used to distinguish between multiple cache purges in the same second.

This is in the format <microtime>-<random string>.

◆ $requirelocking

bool cache_application::$requirelocking = false

protected

Gets set to true if the cache is going to be using locking.

This isn't a requirement, it doesn't need to use locking (most won't) and this bool is used to quickly check things. If required then locking will be forced for the get|set|delete operation.

◆ $storetype

strubg cache::$storetype = 'unknown'

protectedinherited

Gets set to the class name of the store during initialisation.

This is used several times in the cache class internally and having it here helps speed up processing.

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

cache/classes/loaders.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ acquire_lock()

◆ check_lock_state()

◆ compare_purge_tokens()

◆ deep_clone()

◆ delete()

◆ delete_from_persist_cache()

◆ delete_many()

◆ ensure_cachelock_available()

◆ get()

◆ get_datasource()

◆ get_definition()

◆ get_from_persist_cache()

◆ get_identifier()

◆ get_loader()

◆ get_many()

◆ get_purge_token()

◆ get_store()

◆ handle_invalidation_events()

◆ has() [1/2]

◆ has() [2/2]

◆ has_a_ttl()

◆ has_all()

◆ has_any()

◆ is_in_persist_cache()

◆ is_using_persist_cache()

◆ make()

◆ make_from_params()

◆ now()

◆ parse_key()

◆ purge()

◆ purge_current_user()

◆ release_lock()

◆ requires_serialisation()

◆ set()

◆ set_data_source()

◆ set_identifiers()

◆ set_in_persist_cache()

◆ set_is_sub_loader()

◆ set_loader()

◆ set_many()

◆ static_acceleration_delete()

◆ static_acceleration_get()

◆ static_acceleration_has()

◆ static_acceleration_set()

◆ store_supports_key_awareness()

◆ store_supports_native_locking()

◆ store_supports_native_ttl()

◆ unref()

◆ use_static_acceleration()

Member Data Documentation

◆ $lockidentifier

◆ $nativelocking

◆ $now

◆ $purgetoken

◆ $requirelocking

◆ $storetype