13c3017bd24f877839bac0746fbe4000199e8093
[moodle.git] / cache / classes / dummystore.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Cache dummy store.
19  *
20  * This dummy store is used when a load has no other stores that it can make use of.
21  * This shouldn't happen in normal operation... I think.
22  *
23  * This file is part of Moodle's cache API, affectionately called MUC.
24  * It contains the components that are requried in order to use caching.
25  *
26  * @package    core
27  * @category   cache
28  * @copyright  2012 Sam Hemelryk
29  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30  */
32 defined('MOODLE_INTERNAL') || die();
34 /**
35  * The cache dummy store.
36  *
37  * @copyright  2012 Sam Hemelryk
38  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  */
40 class cachestore_dummy extends cache_store {
42     /**
43      * The name of this store.
44      * @var string
45      */
46     protected $name;
48     /**
49      * Gets set to true if this store is going to store data.
50      * This happens when the definition doesn't require static acceleration as the loader will not be storing information and
51      * something has to.
52      * @var bool
53      */
54     protected $persist = false;
56     /**
57      * The stored data array
58      * @var array
59      */
60     protected $store = array();
62     /**
63      * Constructs a dummy store instance.
64      * @param string $name
65      * @param array $configuration
66      */
67     public function __construct($name = 'Dummy store', array $configuration = array()) {
68         $this->name = $name;
69     }
71     /**
72      * Returns true if this store plugin is usable.
73      * @return bool
74      */
75     public static function are_requirements_met() {
76         return true;
77     }
79     /**
80      * Returns true if the user can add an instance.
81      * @return bool
82      */
83     public static function can_add_instance() {
84         return false;
85     }
87     /**
88      * Returns the supported features.
89      * @param array $configuration
90      * @return int
91      */
92     public static function get_supported_features(array $configuration = array()) {
93         return self::SUPPORTS_NATIVE_TTL;
94     }
96     /**
97      * Returns the supported mode.
98      * @param array $configuration
99      * @return int
100      */
101     public static function get_supported_modes(array $configuration = array()) {
102         return self::MODE_APPLICATION + self::MODE_REQUEST + self::MODE_SESSION;
103     }
105     /**
106      * Initialises the store instance for a definition.
107      * @param cache_definition $definition
108      */
109     public function initialise(cache_definition $definition) {
110         // If the definition isn't using static acceleration then we need to be store data here.
111         // The reasoning behind this is that:
112         //   - If the definition is using static acceleration then the cache loader is going to
113         //     store things in its static array.
114         //   - If the definition is not using static acceleration then the cache loader won't try to store anything
115         //     and we will need to store it here in order to make sure it is accessible.
116         $this->persist = !$definition->use_static_acceleration();
117     }
119     /**
120      * Returns true if this has been initialised.
121      * @return bool
122      */
123     public function is_initialised() {
124         return (!empty($this->definition));
125     }
127     /**
128      * Returns true if this is ready.
129      * @return bool
130      */
131     public function is_ready() {
132         return true;
133     }
135     /**
136      * Returns true the given mode is supported.
137      * @param int $mode
138      * @return bool
139      */
140     public static function is_supported_mode($mode) {
141         return true;
142     }
144     /**
145      * Returns the data for the given key
146      * @param string $key
147      * @return string|false
148      */
149     public function get($key) {
150         if ($this->persist && array_key_exists($key, $this->store)) {
151             return $this->store[$key];
152         }
153         return false;
154     }
156     /**
157      * Gets' the values for many keys
158      * @param array $keys
159      * @return bool
160      */
161     public function get_many($keys) {
162         $return = array();
163         foreach ($keys as $key) {
164             if ($this->persist && array_key_exists($key, $this->store)) {
165                 $return[$key] = $this->store[$key];
166             } else {
167                 $return[$key] = false;
168             }
169         }
170         return $return;
171     }
173     /**
174      * Sets an item in the cache
175      * @param string $key
176      * @param mixed $data
177      * @return bool
178      */
179     public function set($key, $data) {
180         if ($this->persist) {
181             $this->store[$key] = $data;
182         }
183         return true;
184     }
186     /**
187      * Sets many items in the cache
188      * @param array $keyvaluearray
189      * @return int
190      */
191     public function set_many(array $keyvaluearray) {
192         if ($this->persist) {
193             foreach ($keyvaluearray as $pair) {
194                 $this->store[$pair['key']] = $pair['value'];
195             }
196             return count($keyvaluearray);
197         }
198         return 0;
199     }
201     /**
202      * Deletes an item from the cache
203      * @param string $key
204      * @return bool
205      */
206     public function delete($key) {
207         unset($this->store[$key]);
208         return true;
209     }
210     /**
211      * Deletes many items from the cache
212      * @param array $keys
213      * @return bool
214      */
215     public function delete_many(array $keys) {
216         if ($this->persist) {
217             foreach ($keys as $key) {
218                 unset($this->store[$key]);
219             }
220         }
221         return count($keys);
222     }
224     /**
225      * Deletes all of the items from the cache.
226      * @return bool
227      */
228     public function purge() {
229         $this->store = array();
230         return true;
231     }
233     /**
234      * Performs any necessary clean up when the store instance is being deleted.
235      */
236     public function cleanup() {
237         $this->purge();
238     }
240     /**
241      * Generates an instance of the cache store that can be used for testing.
242      *
243      * @param cache_definition $definition
244      * @return false
245      */
246     public static function initialise_test_instance(cache_definition $definition) {
247         $cache = new cachestore_dummy('Dummy store test');
248         $cache->initialise($definition);
249         return $cache;
250     }
252     /**
253      * Returns the name of this instance.
254      * @return string
255      */
256     public function my_name() {
257         return $this->name;
258     }