Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
|
Required as it is needed for cache_config_disabled which extends cache_config_writer. More...
Public Member Functions | |
__construct (cache_definition $definition, cache_store $store, $loader=null) | |
Constructs the cache. More... | |
delete ($key, $recurse=true) | |
Deletes an item from the cache. More... | |
delete_many (array $keys, $recurse=true) | |
Deletes many items at once from the cache. More... | |
get ($key, $strictness=IGNORE_MISSING) | |
Gets a key from the cache. More... | |
get_many (array $keys, $strictness=IGNORE_MISSING) | |
Gets many keys at once from the cache. More... | |
has ($key) | |
Test is a cache has a key. More... | |
has ($key, $tryloadifpossible=false) | |
Checks if the cache has the requested key. More... | |
has_all (array $keys) | |
Checks if the cache has all of the requested keys. More... | |
has_any (array $keys) | |
Checks if the cache has any of the requested keys. More... | |
purge () | |
Purges all items from the cache. More... | |
purge_current_user () | |
Subclasses may support purging cache of all data belonging to the current user. More... | |
set ($key, $data) | |
Sets a key value pair in the cache. More... | |
set_identifiers (array $identifiers) | |
Alters the identifiers that have been provided to the definition. More... | |
set_many (array $keyvaluearray) | |
Sets many key value pairs in the cache at once. 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 () | |
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 | |
bool | $perfdebug = false |
Gets set to true if we want to collect performance information about the cache API. | |
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... | |
Required as it is needed for cache_config_disabled which extends cache_config_writer.
The cache loader class used when the Cache has been disabled.
cache_disabled::__construct | ( | cache_definition | $definition, |
cache_store | $store, | ||
$loader = null |
|||
) |
Constructs the cache.
cache_definition | $definition | |
cache_store | $store | |
null | $loader | Unused. |
Reimplemented from cache.
|
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.
string | $tokena | |
string | $tokenb |
int |
|
protectedinherited |
Creates a reference free clone of the given value.
mixed | $value |
mixed |
cache_disabled::delete | ( | $key, | |
$recurse = true |
|||
) |
Deletes an item from the cache.
int | string | $key | Unused. |
bool | $recurse | Unused. |
bool |
Reimplemented from cache.
|
protectedinherited |
cache_disabled::delete_many | ( | array | $keys, |
$recurse = true |
|||
) |
Deletes many items at once from the cache.
array | $keys | Unused. |
bool | $recurse | Unused. |
int |
Reimplemented from cache.
cache_disabled::get | ( | $key, | |
$strictness = IGNORE_MISSING |
|||
) |
Gets a key from the cache.
int | string | $key | |
int | $strictness | Unused. |
bool |
Reimplemented from cache.
|
protectedinherited |
Returns the data source associated with this cache.
cache_data_source|false |
|
protectedinherited |
Returns the cache definition.
cache_definition |
|
protectedinherited |
|
protectedinherited |
Returns the loader associated with this instance.
cache|false |
cache_disabled::get_many | ( | array | $keys, |
$strictness = IGNORE_MISSING |
|||
) |
Gets many keys at once from the cache.
array | $keys | |
int | $strictness | Unused. |
array |
Reimplemented from cache.
|
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.
bool | $reset | Whether to reset the token and generate a new one. |
string |
|
protectedinherited |
Returns the cache store.
cache_store |
|
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.
|
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:
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.
string | int | $key |
bool | True if the cache has the requested key, false otherwise. |
cache_disabled::has | ( | $key, | |
$tryloadifpossible = false |
|||
) |
Checks if the cache has the requested key.
int | string | $key | Unused. |
bool | $tryloadifpossible | Unused. |
bool |
Reimplemented from cache.
|
protectedinherited |
Returns true if the cache is making use of a ttl.
bool |
cache_disabled::has_all | ( | array | $keys | ) |
Checks if the cache has all of the requested keys.
array | $keys | Unused. |
bool |
Reimplemented from cache.
cache_disabled::has_any | ( | array | $keys | ) |
Checks if the cache has any of the requested keys.
array | $keys | Unused. |
bool |
Reimplemented from cache.
|
protectedinherited |
|
protectedinherited |
|
staticinherited |
Creates a new cache instance for a pre-defined definition.
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. |
cache_application|cache_session|cache_store |
|
staticinherited |
Creates a new cache instance based upon the given params.
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:
|
cache_application|cache_session|cache_store |
|
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.
bool | $float | Whether to use floating precision accuracy. |
int|float |
|
protectedinherited |
Parses the key turning it into a string (or array is required) suitable to be passed to the cache store.
string | int | $key | As passed to get|set|delete etc. |
string|array | String unless the store supports multi-identifiers in which case an array if returned. |
Reimplemented in cache_session.
cache_disabled::purge | ( | ) |
|
inherited |
Subclasses may support purging cache of all data belonging to the current user.
Reimplemented in cache_session.
|
protectedinherited |
Checks to see if a var requires serialisation.
mixed | $value | The value to check. |
int | $depth | Used to ensure we don't enter an endless loop (think recursion). |
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. |
cache_disabled::set | ( | $key, | |
$data | |||
) |
Sets a key value pair in the cache.
int | string | $key | Unused. |
mixed | $data | Unused. |
bool |
Reimplemented from cache.
|
protectedinherited |
Set the data source for this cache.
cache_data_source | $datasource |
|
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.
array | $identifiers |
|
protectedinherited |
|
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.
bool | $setting |
|
protectedinherited |
Set the loader for this cache.
cache_loader | $loader |
cache_disabled::set_many | ( | array | $keyvaluearray | ) |
Sets many key value pairs in the cache at once.
array | $keyvaluearray | Unused. |
int |
Reimplemented from cache.
|
protectedinherited |
Deletes an item from the static acceleration array.
string | int | $key | As given to get|set|delete |
bool | True on success, false otherwise. |
|
protectedinherited |
Returns the item from the static acceleration array if it exists there.
string | $key | The parsed key |
mixed|false | Dereferenced data from the static acceleration array or false if it wasn't there. |
|
protectedinherited |
Returns true if the requested key exists within the static acceleration array.
string | $key | The parsed key |
bool |
|
protectedinherited |
Sets a key value pair into the static acceleration array.
string | $key | The parsed key |
mixed | $data |
bool |
|
protectedinherited |
Returns true if the store supports key awareness.
bool |
|
protectedinherited |
Returns true if the store natively supports locking.
bool |
|
protectedinherited |
Returns true if the cache store supports native ttl.
bool |
|
protectedinherited |
Removes references where required.
stdClass | array | $data |
mixed | What ever was put in but without any references. |
|
protectedinherited |
Returns true if this cache is making use of the static acceleration array.
bool |
Reimplemented in cache_session.
|
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.
|
staticprotectedinherited |
A purge token used to distinguish between multiple cache purges in the same second.
This is in the format <microtime>-<random string>.
|
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.