MDL-36768 cache: replaced cache_store interface with abstract class
This commit is contained in:
Sam Hemelryk
Vendored
-221
@@ -230,227 +230,6 @@ interface cache_loader_with_locking {
|
||||
public function release_lock($key);
|
||||
}
|
||||
|
||||
/**
|
||||
* Cache store.
|
||||
*
|
||||
* This interface outlines the requirements for a cache store plugin.
|
||||
* It must be implemented by all such plugins and provides a reference to interacting with cache stores.
|
||||
*
|
||||
* Must be implemented by all cache store plugins.
|
||||
*
|
||||
* @package core
|
||||
* @category cache
|
||||
* @copyright 2012 Sam Hemelryk
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
interface cache_store {
|
||||
|
||||
/**#@+
|
||||
* Constants for features a cache store can support
|
||||
*/
|
||||
/**
|
||||
* Supports multi-part keys
|
||||
*/
|
||||
const SUPPORTS_MULTIPLE_IDENTIFIERS = 1;
|
||||
/**
|
||||
* Ensures data remains in the cache once set.
|
||||
*/
|
||||
const SUPPORTS_DATA_GUARANTEE = 2;
|
||||
/**
|
||||
* Supports a native ttl system.
|
||||
*/
|
||||
const SUPPORTS_NATIVE_TTL = 4;
|
||||
/**#@-*/
|
||||
|
||||
/**#@+
|
||||
* Constants for the modes of a cache store
|
||||
*/
|
||||
/**
|
||||
* Application caches. These are shared caches.
|
||||
*/
|
||||
const MODE_APPLICATION = 1;
|
||||
/**
|
||||
* Session caches. Just access to the PHP session.
|
||||
*/
|
||||
const MODE_SESSION = 2;
|
||||
/**
|
||||
* Request caches. Static caches really.
|
||||
*/
|
||||
const MODE_REQUEST = 4;
|
||||
/**#@-*/
|
||||
|
||||
/**
|
||||
* Static method to check if the store requirements are met.
|
||||
*
|
||||
* @return bool True if the stores software/hardware requirements have been met and it can be used. False otherwise.
|
||||
*/
|
||||
public static function are_requirements_met();
|
||||
|
||||
/**
|
||||
* Static method to check if a store is usable with the given mode.
|
||||
*
|
||||
* @param int $mode One of cache_store::MODE_*
|
||||
*/
|
||||
public static function is_supported_mode($mode);
|
||||
|
||||
/**
|
||||
* Returns the supported features as a binary flag.
|
||||
*
|
||||
* @param array $configuration The configuration of a store to consider specifically.
|
||||
* @return int The supported features.
|
||||
*/
|
||||
public static function get_supported_features(array $configuration = array());
|
||||
|
||||
/**
|
||||
* Returns the supported modes as a binary flag.
|
||||
*
|
||||
* @param array $configuration The configuration of a store to consider specifically.
|
||||
* @return int The supported modes.
|
||||
*/
|
||||
public static function get_supported_modes(array $configuration = array());
|
||||
|
||||
/**
|
||||
* Returns true if this cache store instance supports multiple identifiers.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function supports_multiple_identifiers();
|
||||
|
||||
/**
|
||||
* Returns true if this cache store instance promotes data guarantee.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function supports_data_guarantee();
|
||||
|
||||
/**
|
||||
* Returns true if this cache store instance supports ttl natively.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function supports_native_ttl();
|
||||
|
||||
/**
|
||||
* Used to control the ability to add an instance of this store through the admin interfaces.
|
||||
*
|
||||
* @return bool True if the user can add an instance, false otherwise.
|
||||
*/
|
||||
public static function can_add_instance();
|
||||
|
||||
/**
|
||||
* Constructs an instance of the cache store.
|
||||
*
|
||||
* This method should not create connections or perform and processing, it should be used
|
||||
*
|
||||
* @param string $name The name of the cache store
|
||||
* @param array $configuration The configuration for this store instance.
|
||||
*/
|
||||
public function __construct($name, array $configuration = array());
|
||||
|
||||
/**
|
||||
* Returns the name of this store instance.
|
||||
* @return string
|
||||
*/
|
||||
public function my_name();
|
||||
|
||||
/**
|
||||
* Initialises a new instance of the cache store given the definition the instance is to be used for.
|
||||
*
|
||||
* This function should prepare any given connections etc.
|
||||
*
|
||||
* @param cache_definition $definition
|
||||
*/
|
||||
public function initialise(cache_definition $definition);
|
||||
|
||||
/**
|
||||
* Returns true if this cache store instance has been initialised.
|
||||
* @return bool
|
||||
*/
|
||||
public function is_initialised();
|
||||
|
||||
/**
|
||||
* Returns true if this cache store instance is ready to use.
|
||||
* @return bool
|
||||
*/
|
||||
public function is_ready();
|
||||
|
||||
/**
|
||||
* Retrieves an item from the cache store given its key.
|
||||
*
|
||||
* @param string $key The key to retrieve
|
||||
* @return mixed The data that was associated with the key, or false if the key did not exist.
|
||||
*/
|
||||
public function get($key);
|
||||
|
||||
/**
|
||||
* Retrieves several items from the cache store in a single transaction.
|
||||
*
|
||||
* If not all of the items are available in the cache then the data value for those that are missing will be set to false.
|
||||
*
|
||||
* @param array $keys The array of keys to retrieve
|
||||
* @return array An array of items from the cache. There will be an item for each key, those that were not in the store will
|
||||
* be set to false.
|
||||
*/
|
||||
public function get_many($keys);
|
||||
|
||||
/**
|
||||
* Sets an item in the cache given its key and data value.
|
||||
*
|
||||
* @param string $key The key to use.
|
||||
* @param mixed $data The data to set.
|
||||
* @return bool True if the operation was a success false otherwise.
|
||||
*/
|
||||
public function set($key, $data);
|
||||
|
||||
/**
|
||||
* Sets many items in the cache in a single transaction.
|
||||
*
|
||||
* @param array $keyvaluearray An array of key value pairs. Each item in the array will be an associative array with two
|
||||
* keys, 'key' and 'value'.
|
||||
* @return int The number of items successfully set. It is up to the developer to check this matches the number of items
|
||||
* sent ... if they care that is.
|
||||
*/
|
||||
public function set_many(array $keyvaluearray);
|
||||
|
||||
/**
|
||||
* Deletes an item from the cache store.
|
||||
*
|
||||
* @param string $key The key to delete.
|
||||
* @return bool Returns true if the operation was a success, false otherwise.
|
||||
*/
|
||||
public function delete($key);
|
||||
|
||||
/**
|
||||
* Deletes several keys from the cache in a single action.
|
||||
*
|
||||
* @param array $keys The keys to delete
|
||||
* @return int The number of items successfully deleted.
|
||||
*/
|
||||
public function delete_many(array $keys);
|
||||
|
||||
/**
|
||||
* Purges the cache deleting all items within it.
|
||||
*
|
||||
* @return boolean True on success. False otherwise.
|
||||
*/
|
||||
public function purge();
|
||||
|
||||
/**
|
||||
* Performs any necessary clean up when the store instance is being deleted.
|
||||
*/
|
||||
public function cleanup();
|
||||
|
||||
/**
|
||||
* Generates an instance of the cache store that can be used for testing.
|
||||
*
|
||||
* Returns an instance of the cache store, or false if one cannot be created.
|
||||
*
|
||||
* @param cache_definition $definition
|
||||
* @return cache_store|false
|
||||
*/
|
||||
public static function initialise_test_instance(cache_definition $definition);
|
||||
}
|
||||
|
||||
/**
|
||||
* Cache store feature: locking
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user