Permalink
Browse files

Merge branch 'wip-MDL-36768-m24-r2' of git://github.com/samhemelryk/m…

…oodle
  • Loading branch information...
stronk7 committed Nov 26, 2012
2 parents 93e4906 + 75cde6b commit f725158ea6398af77984fdae68f137b6df189869
View
@@ -89,6 +89,7 @@ The following points highlight things you should know about stores.
** Data guarantee - Data is guaranteed to exist in the cache once it is set there. It is never cleaned up to free space or because it has not been recently used.
** Multiple identifiers - Rather than a single string key, the parts that make up the key are passed as an array.
** Native TTL support - When required, the store supports native ttl and doesn't require the cache API to manage ttl of things given to the store.
+* There are two reserved store names, base and dummy. These are both used internally.
### Definition
_Definitions were not a part of the previous proposal._
View
@@ -182,7 +182,7 @@ public function load() {
if (!class_exists($class)) {
continue;
}
- if (!array_key_exists('cache_store', class_implements($class))) {
+ if (!array_key_exists('cache_store', class_parents($class))) {
continue;
}
if (!array_key_exists('configuration', $store) || !is_array($store['configuration'])) {
@@ -37,7 +37,7 @@
* @copyright 2012 Sam Hemelryk
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-class cachestore_dummy implements cache_store {
+class cachestore_dummy extends cache_store {
/**
* The name of this store.
@@ -135,30 +135,6 @@ public static function is_supported_mode($mode) {
return true;
}
- /**
- * Returns true if this store supports data guarantee.
- * @return bool
- */
- public function supports_data_guarantee() {
- return false;
- }
-
- /**
- * Returns true if this store supports multiple identifiers.
- * @return bool
- */
- public function supports_multiple_identifiers() {
- return false;
- }
-
- /**
- * Returns true if this store supports a native ttl.
- * @return bool
- */
- public function supports_native_ttl() {
- return true;
- }
-
/**
* Returns the data for the given key
* @param string $key
@@ -230,227 +230,6 @@ public function check_lock_state($key);
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
*
View
@@ -638,19 +638,22 @@ public function set_many(array $keyvaluearray) {
public function has($key, $tryloadifpossible = false) {
$parsedkey = $this->parse_key($key);
if ($this->is_in_persist_cache($parsedkey)) {
+ // Hoorah, that was easy. It exists in the persist cache so we definitely have it.
return true;
}
- if (($this->has_a_ttl() && !$this->store_supports_native_ttl()) || !$this->store_supports_key_awareness()) {
- if ($this->store_supports_key_awareness() && !$this->store->has($parsedkey)) {
- return false;
- }
+ if ($this->has_a_ttl() && !$this->store_supports_native_ttl()) {
+ // The data has a TTL and the store doesn't support it natively.
+ // We must fetch the data and expect a ttl wrapper.
$data = $this->store->get($parsedkey);
- if (!$this->store_supports_native_ttl()) {
- $has = ($data instanceof cache_ttl_wrapper && !$data->has_expired());
- } else {
- $has = ($data !== false);
- }
+ $has = ($data instanceof cache_ttl_wrapper && !$data->has_expired());
+ } else if (!$this->store_supports_key_awareness()) {
+ // The store doesn't support key awareness, get the data and check it manually... puke.
+ // Either no TTL is set of the store supports its handling natively.
+ $data = $this->store->get($parsedkey);
+ $has = ($data !== false);
} else {
+ // The store supports key awareness, this is easy!
+ // Either no TTL is set of the store supports its handling natively.
$has = $this->store->has($parsedkey);
}
if (!$has && $tryloadifpossible) {
Oops, something went wrong.

0 comments on commit f725158

Please sign in to comment.