MDL-52346 caching: Coding style fixes
[moodle.git] / cache / classes / definition.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 definition class
19  *
20  * This file is part of Moodle's cache API, affectionately called MUC.
21  * It contains the components that are requried in order to use caching.
22  *
23  * @package    core
24  * @category   cache
25  * @copyright  2012 Sam Hemelryk
26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 defined('MOODLE_INTERNAL') || die();
31 /**
32  * The cache definition class.
33  *
34  * Cache definitions need to be defined in db/caches.php files.
35  * They can be constructed with the following options.
36  *
37  * Required settings:
38  *     + mode
39  *          [int] Sets the mode for the definition. Must be one of cache_store::MODE_*
40  *
41  * Optional settings:
42  *     + simplekeys
43  *          [bool] Set to true if your cache will only use simple keys for its items.
44  *          Simple keys consist of digits, underscores and the 26 chars of the english language. a-zA-Z0-9_
45  *          If true the keys won't be hashed before being passed to the cache store for gets/sets/deletes. It will be
46  *          better for performance and possible only becase we know the keys are safe.
47  *     + simpledata
48  *          [bool] If set to true we know that the data is scalar or array of scalar.
49  *     + requireidentifiers
50  *          [array] An array of identifiers that must be provided to the cache when it is created.
51  *     + requiredataguarantee
52  *          [bool] If set to true then only stores that can guarantee data will remain available once set will be used.
53  *     + requiremultipleidentifiers
54  *          [bool] If set to true then only stores that support multiple identifiers will be used.
55  *     + requirelockingread
56  *          [bool] If set to true then a lock will be gained before reading from the cache store. It is recommended not to use
57  *          this setting unless 100% absolutely positively required. Remember 99.9% of caches will NOT need this setting.
58  *          This setting will only be used for application caches presently.
59  *     + requirelockingwrite
60  *          [bool] If set to true then a lock will be gained before writing to the cache store. As above this is not recommended
61  *          unless truly needed. Please think about the order of your code and deal with race conditions there first.
62  *          This setting will only be used for application caches presently.
63  *     + maxsize
64  *          [int] If set this will be used as the maximum number of entries within the cache store for this definition.
65  *          Its important to note that cache stores don't actually have to acknowledge this setting or maintain it as a hard limit.
66  *     + overrideclass
67  *          [string] A class to use as the loader for this cache. This is an advanced setting and will allow the developer of the
68  *          definition to take 100% control of the caching solution.
69  *          Any class used here must inherit the cache_loader interface and must extend default cache loader for the mode they are
70  *          using.
71  *     + overrideclassfile
72  *          [string] Suplements the above setting indicated the file containing the class to be used. This file is included when
73  *          required.
74  *     + datasource
75  *          [string] A class to use as the data loader for this definition.
76  *          Any class used here must inherit the cache_data_loader interface.
77  *     + datasourcefile
78  *          [string] Supplements the above setting indicating the file containing the class to be used. This file is included when
79  *          required.
80  *     + staticacceleration
81  *          The cache loader will keep an array of the items set and retrieved to the cache during the request.
82  *          Consider using this setting when you know that there are going to be many calls to the cache for the same information.
83  *          Requests for data in this array will be ultra fast, but it will cost memory.
84  *     + staticaccelerationsize
85  *          [int] This supplements the above setting by limiting the number of items in the static acceleration array.
86  *          Tweaking this setting lower will allow you to minimise the memory implications above while hopefully still managing to
87  *          offset calls to the cache store.
88  *     + ttl
89  *          [int] A time to live for the data (in seconds). It is strongly recommended that you don't make use of this and
90  *          instead try to create an event driven invalidation system.
91  *          Not all cache stores will support this natively and there are undesired performance impacts if the cache store does not.
92  *     + mappingsonly
93  *          [bool] If set to true only the mapped cache store(s) will be used and the default mode store will not. This is a super
94  *          advanced setting and should not be used unless absolutely required. It allows you to avoid the default stores for one
95  *          reason or another.
96  *     + invalidationevents
97  *          [array] An array of events that should cause this cache to invalidate some or all of the items within it.
98  *     + sharingoptions
99  *          [int] The sharing options that are appropriate for this definition. Should be the sum of the possible options.
100  *     + defaultsharing
101  *          [int] The default sharing option to use. It's highly recommended that you don't set this unless there is a very
102  *          specific reason not to use the system default.
103  *     + canuselocalstore
104  *          [bool] The cache is able to safely run with multiple copies on different webservers without any need for administrator
105  *                 intervention to ensure that data stays in sync across nodes.  This is usually managed by a revision
106  *                 system as seen in modinfo cache or language cache.  Requiring purge on upgrade is not sufficient as
107  *                 it requires administrator intervention on each node to make it work.
108  *
109  * For examples take a look at lib/db/caches.php
110  *
111  * @package    core
112  * @category   cache
113  * @copyright  2012 Sam Hemelryk
114  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
115  */
116 class cache_definition {
118     /** The cache can be shared with everyone */
119     const SHARING_ALL = 1;
120     /** The cache can be shared with other sites using the same siteid. */
121     const SHARING_SITEID = 2;
122     /** The cache can be shared with other sites of the same version. */
123     const SHARING_VERSION = 4;
124     /** The cache can be shared with other sites using the same key */
125     const SHARING_INPUT = 8;
127     /**
128      * The default sharing options available.
129      * All + SiteID + Version + Input.
130      */
131     const SHARING_DEFAULTOPTIONS = 15;
132     /**
133      * The default sharing option that gets used if none have been selected.
134      * SiteID. It is the most restrictive.
135      */
136     const SHARING_DEFAULT = 2;
138     /**
139      * The identifier for the definition
140      * @var string
141      */
142     protected $id;
144     /**
145      * The mode for the defintion. One of cache_store::MODE_*
146      * @var int
147      */
148     protected $mode;
150     /**
151      * The component this definition is associated with.
152      * @var string
153      */
154     protected $component;
156     /**
157      * The area this definition is associated with.
158      * @var string
159      */
160     protected $area;
162     /**
163      * If set to true we know the keys are simple. a-zA-Z0-9_
164      * @var bool
165      */
166     protected $simplekeys = false;
168     /**
169      * Set to true if we know the data is scalar or array of scalar.
170      * @var bool
171      */
172     protected $simpledata = false;
174     /**
175      * An array of identifiers that must be provided when the definition is used to create a cache.
176      * @var array
177      */
178     protected $requireidentifiers = array();
180     /**
181      * If set to true then only stores that guarantee data may be used with this definition.
182      * @var bool
183      */
184     protected $requiredataguarantee = false;
186     /**
187      * If set to true then only stores that support multple identifiers may be used with this definition.
188      * @var bool
189      */
190     protected $requiremultipleidentifiers = false;
192     /**
193      * If set to true then we know that this definition requires the locking functionality.
194      * This gets set during construction based upon the settings requirelockingread and requirelockingwrite.
195      * @var bool
196      */
197     protected $requirelocking = false;
199     /**
200      * Set to true if this definition requires read locking.
201      * @var bool
202      */
203     protected $requirelockingread = false;
205     /**
206      * Gets set to true if this definition requires write locking.
207      * @var bool
208      */
209     protected $requirelockingwrite = false;
211     /**
212      * Gets set to true if this definition requires searchable stores.
213      * @since Moodle 2.4.4
214      * @var bool
215      */
216     protected $requiresearchable = false;
218     /**
219      * Sets the maximum number of items that can exist in the cache.
220      * Please note this isn't a hard limit, and doesn't need to be enforced by the caches. They can choose to do so optionally.
221      * @var int
222      */
223     protected $maxsize = null;
225     /**
226      * The class to use as the cache loader for this definition.
227      * @var string
228      */
229     protected $overrideclass = null;
231     /**
232      * The file in which the override class exists. This will be included if required.
233      * @var string Absolute path
234      */
235     protected $overrideclassfile = null;
237     /**
238      * The data source class to use with this definition.
239      * @var string
240      */
241     protected $datasource = null;
243     /**
244      * The file in which the data source class exists. This will be included if required.
245      * @var string
246      */
247     protected $datasourcefile = null;
249     /**
250      * Deprecated - this is completely unused.
251      * @deprecated since 2.9
252      * @var string
253      */
254     protected $datasourceaggregate = null;
256     /**
257      * Set to true if the cache should hold onto items passing through it to speed up subsequent requests.
258      * @var bool
259      */
260     protected $staticacceleration = false;
262     /**
263      * The maximum number of items that static acceleration cache should hold onto.
264      * @var int
265      */
266     protected $staticaccelerationsize = false;
268     /**
269      * The TTL for data in this cache. Please don't use this, instead use event driven invalidation.
270      * @var int
271      */
272     protected $ttl = 0;
274     /**
275      * Set to true if this cache should only use mapped cache stores and not the default mode cache store.
276      * @var bool
277      */
278     protected $mappingsonly = false;
280     /**
281      * An array of events that should cause this cache to invalidate.
282      * @var array
283      */
284     protected $invalidationevents = array();
286     /**
287      * An array of identifiers provided to this cache when it was initialised.
288      * @var array
289      */
290     protected $identifiers = null;
292     /**
293      * Key prefix for use with single key cache stores
294      * @var string
295      */
296     protected $keyprefixsingle = null;
298     /**
299      * Key prefix to use with cache stores that support multi keys.
300      * @var array
301      */
302     protected $keyprefixmulti = null;
304     /**
305      * A hash identifier of this definition.
306      * @var string
307      */
308     protected $definitionhash = null;
310     /**
311      * The selected sharing mode for this definition.
312      * @var int
313      */
314     protected $sharingoptions;
316     /**
317      * Whether this cache supports local storages.
318      * @var bool
319      */
320     protected $canuselocalstore = false;
322     /**
323      * The selected sharing option.
324      * @var int One of self::SHARING_*
325      */
326     protected $selectedsharingoption = self::SHARING_DEFAULT;
328     /**
329      * The user input key to use if the SHARING_INPUT option has been selected.
330      * @var string Must be ALPHANUMEXT
331      */
332     protected $userinputsharingkey = '';
334     /**
335      * Creates a cache definition given a definition from the cache configuration or from a caches.php file.
336      *
337      * @param string $id
338      * @param array $definition
339      * @param string $unused Used to be datasourceaggregate but that was removed and this is now unused.
340      * @return cache_definition
341      * @throws coding_exception
342      */
343     public static function load($id, array $definition, $unused = null) {
344         global $CFG;
346         if (!array_key_exists('mode', $definition)) {
347             throw new coding_exception('You must provide a mode when creating a cache definition');
348         }
349         if (!array_key_exists('component', $definition)) {
350             throw new coding_exception('You must provide a component when creating a cache definition');
351         }
352         if (!array_key_exists('area', $definition)) {
353             throw new coding_exception('You must provide an area when creating a cache definition');
354         }
355         $mode = (int)$definition['mode'];
356         $component = (string)$definition['component'];
357         $area = (string)$definition['area'];
359         // Set the defaults.
360         $simplekeys = false;
361         $simpledata = false;
362         $requireidentifiers = array();
363         $requiredataguarantee = false;
364         $requiremultipleidentifiers = false;
365         $requirelockingread = false;
366         $requirelockingwrite = false;
367         $requiresearchable = ($mode === cache_store::MODE_SESSION) ? true : false;
368         $maxsize = null;
369         $overrideclass = null;
370         $overrideclassfile = null;
371         $datasource = null;
372         $datasourcefile = null;
373         $staticacceleration = false;
374         $staticaccelerationsize = false;
375         $ttl = 0;
376         $mappingsonly = false;
377         $invalidationevents = array();
378         $sharingoptions = self::SHARING_DEFAULT;
379         $selectedsharingoption = self::SHARING_DEFAULT;
380         $userinputsharingkey = '';
381         $canuselocalstore = false;
383         if (array_key_exists('simplekeys', $definition)) {
384             $simplekeys = (bool)$definition['simplekeys'];
385         }
386         if (array_key_exists('simpledata', $definition)) {
387             $simpledata = (bool)$definition['simpledata'];
388         }
389         if (array_key_exists('requireidentifiers', $definition)) {
390             $requireidentifiers = (array)$definition['requireidentifiers'];
391         }
392         if (array_key_exists('requiredataguarantee', $definition)) {
393             $requiredataguarantee = (bool)$definition['requiredataguarantee'];
394         }
395         if (array_key_exists('requiremultipleidentifiers', $definition)) {
396             $requiremultipleidentifiers = (bool)$definition['requiremultipleidentifiers'];
397         }
399         if (array_key_exists('requirelockingread', $definition)) {
400             $requirelockingread = (bool)$definition['requirelockingread'];
401         }
402         if (array_key_exists('requirelockingwrite', $definition)) {
403             $requirelockingwrite = (bool)$definition['requirelockingwrite'];
404         }
405         $requirelocking = $requirelockingwrite || $requirelockingread;
407         if (array_key_exists('requiresearchable', $definition)) {
408             $requiresearchable = (bool)$definition['requiresearchable'];
409         }
411         if (array_key_exists('maxsize', $definition)) {
412             $maxsize = (int)$definition['maxsize'];
413         }
415         if (array_key_exists('overrideclass', $definition)) {
416             $overrideclass = $definition['overrideclass'];
417         }
418         if (array_key_exists('overrideclassfile', $definition)) {
419             $overrideclassfile = $definition['overrideclassfile'];
420         }
422         if (array_key_exists('datasource', $definition)) {
423             $datasource = $definition['datasource'];
424         }
425         if (array_key_exists('datasourcefile', $definition)) {
426             $datasourcefile = $definition['datasourcefile'];
427         }
429         if (array_key_exists('persistent', $definition)) {
430             // Ahhh this is the legacy persistent option.
431             $staticacceleration = (bool)$definition['persistent'];
432         }
433         if (array_key_exists('staticacceleration', $definition)) {
434             $staticacceleration = (bool)$definition['staticacceleration'];
435         }
436         if (array_key_exists('persistentmaxsize', $definition)) {
437             // Ahhh this is the legacy persistentmaxsize option.
438             $staticaccelerationsize = (int)$definition['persistentmaxsize'];
439         }
440         if (array_key_exists('staticaccelerationsize', $definition)) {
441             $staticaccelerationsize = (int)$definition['staticaccelerationsize'];
442         }
443         if (array_key_exists('ttl', $definition)) {
444             $ttl = (int)$definition['ttl'];
445         }
446         if (array_key_exists('mappingsonly', $definition)) {
447             $mappingsonly = (bool)$definition['mappingsonly'];
448         }
449         if (array_key_exists('invalidationevents', $definition)) {
450             $invalidationevents = (array)$definition['invalidationevents'];
451         }
452         if (array_key_exists('sharingoptions', $definition)) {
453             $sharingoptions = (int)$definition['sharingoptions'];
454         }
455         if (array_key_exists('selectedsharingoption', $definition)) {
456             $selectedsharingoption = (int)$definition['selectedsharingoption'];
457         } else if (array_key_exists('defaultsharing', $definition)) {
458             $selectedsharingoption = (int)$definition['defaultsharing'];
459         } else if ($sharingoptions ^ $selectedsharingoption) {
460             if ($sharingoptions & self::SHARING_SITEID) {
461                 $selectedsharingoption = self::SHARING_SITEID;
462             } else if ($sharingoptions & self::SHARING_VERSION) {
463                 $selectedsharingoption = self::SHARING_VERSION;
464             } else {
465                 $selectedsharingoption = self::SHARING_ALL;
466             }
467         }
468         if (array_key_exists('canuselocalstore', $definition)) {
469             $canuselocalstore = (bool)$definition['canuselocalstore'];
470         }
472         if (array_key_exists('userinputsharingkey', $definition) && !empty($definition['userinputsharingkey'])) {
473             $userinputsharingkey = (string)$definition['userinputsharingkey'];
474         }
476         if (!is_null($overrideclass)) {
477             if (!is_null($overrideclassfile)) {
478                 if (strpos($overrideclassfile, $CFG->dirroot) !== 0) {
479                     $overrideclassfile = $CFG->dirroot.'/'.$overrideclassfile;
480                 }
481                 if (strpos($overrideclassfile, '../') !== false) {
482                     throw new coding_exception('No path craziness allowed within override class file path.');
483                 }
484                 if (!file_exists($overrideclassfile)) {
485                     throw new coding_exception('The override class file does not exist.');
486                 }
487                 require_once($overrideclassfile);
488             }
489             if (!class_exists($overrideclass)) {
490                 throw new coding_exception('The override class does not exist.');
491             }
493             // Make sure that the provided class extends the default class for the mode.
494             if (get_parent_class($overrideclass) !== cache_helper::get_class_for_mode($mode)) {
495                 throw new coding_exception('The override class does not immediately extend the relevant cache class.');
496             }
497         }
499         if (!is_null($datasource)) {
500             if (!is_null($datasourcefile)) {
501                 if (strpos($datasourcefile, $CFG->dirroot) !== 0) {
502                     $datasourcefile = $CFG->dirroot.'/'.$datasourcefile;
503                 }
504                 if (strpos($datasourcefile, '../') !== false) {
505                     throw new coding_exception('No path craziness allowed within data source file path.');
506                 }
507                 if (!file_exists($datasourcefile)) {
508                     throw new coding_exception('The data source class file does not exist.');
509                 }
510                 require_once($datasourcefile);
511             }
512             if (!class_exists($datasource)) {
513                 throw new coding_exception('The data source class does not exist.');
514             }
515             if (!array_key_exists('cache_data_source', class_implements($datasource))) {
516                 throw new coding_exception('Cache data source classes must implement the cache_data_source interface');
517             }
518         }
520         $cachedefinition = new cache_definition();
521         $cachedefinition->id = $id;
522         $cachedefinition->mode = $mode;
523         $cachedefinition->component = $component;
524         $cachedefinition->area = $area;
525         $cachedefinition->simplekeys = $simplekeys;
526         $cachedefinition->simpledata = $simpledata;
527         $cachedefinition->requireidentifiers = $requireidentifiers;
528         $cachedefinition->requiredataguarantee = $requiredataguarantee;
529         $cachedefinition->requiremultipleidentifiers = $requiremultipleidentifiers;
530         $cachedefinition->requirelocking = $requirelocking;
531         $cachedefinition->requirelockingread = $requirelockingread;
532         $cachedefinition->requirelockingwrite = $requirelockingwrite;
533         $cachedefinition->requiresearchable = $requiresearchable;
534         $cachedefinition->maxsize = $maxsize;
535         $cachedefinition->overrideclass = $overrideclass;
536         $cachedefinition->overrideclassfile = $overrideclassfile;
537         $cachedefinition->datasource = $datasource;
538         $cachedefinition->datasourcefile = $datasourcefile;
539         $cachedefinition->staticacceleration = $staticacceleration;
540         $cachedefinition->staticaccelerationsize = $staticaccelerationsize;
541         $cachedefinition->ttl = $ttl;
542         $cachedefinition->mappingsonly = $mappingsonly;
543         $cachedefinition->invalidationevents = $invalidationevents;
544         $cachedefinition->sharingoptions = $sharingoptions;
545         $cachedefinition->selectedsharingoption = $selectedsharingoption;
546         $cachedefinition->userinputsharingkey = $userinputsharingkey;
547         $cachedefinition->canuselocalstore = $canuselocalstore;
549         return $cachedefinition;
550     }
552     /**
553      * Creates an ah-hoc cache definition given the required params.
554      *
555      * Please note that when using an adhoc definition you cannot set any of the optional params.
556      * This is because we cannot guarantee consistent access and we don't want to mislead people into thinking that.
557      *
558      * @param int $mode One of cache_store::MODE_*
559      * @param string $component The component this definition relates to.
560      * @param string $area The area this definition relates to.
561      * @param array $options An array of options, available options are:
562      *   - simplekeys : Set to true if the keys you will use are a-zA-Z0-9_
563      *   - simpledata : Set to true if the type of the data you are going to store is scalar, or an array of scalar vars
564      *   - overrideclass : The class to use as the loader.
565      *   - staticacceleration : If set to true the cache will hold onto data passing through it.
566      *   - staticaccelerationsize : Set it to an int to limit the size of the staticacceleration cache.
567      * @return cache_application|cache_session|cache_request
568      */
569     public static function load_adhoc($mode, $component, $area, array $options = array()) {
570         $id = 'adhoc/'.$component.'_'.$area;
571         $definition = array(
572             'mode' => $mode,
573             'component' => $component,
574             'area' => $area,
575         );
576         if (!empty($options['simplekeys'])) {
577             $definition['simplekeys'] = $options['simplekeys'];
578         }
579         if (!empty($options['simpledata'])) {
580             $definition['simpledata'] = $options['simpledata'];
581         }
582         if (!empty($options['persistent'])) {
583             // Ahhh this is the legacy persistent option.
584             $definition['staticacceleration'] = (bool)$options['persistent'];
585         }
586         if (!empty($options['staticacceleration'])) {
587             $definition['staticacceleration'] = (bool)$options['staticacceleration'];
588         }
589         if (!empty($options['staticaccelerationsize'])) {
590             $definition['staticaccelerationsize'] = (int)$options['staticaccelerationsize'];
591         }
592         if (!empty($options['overrideclass'])) {
593             $definition['overrideclass'] = $options['overrideclass'];
594         }
595         if (!empty($options['sharingoptions'])) {
596             $definition['sharingoptions'] = $options['sharingoptions'];
597         }
598         return self::load($id, $definition, null);
599     }
601     /**
602      * Returns the cache loader class that should be used for this definition.
603      * @return string
604      */
605     public function get_cache_class() {
606         if (!is_null($this->overrideclass)) {
607             return $this->overrideclass;
608         }
609         return cache_helper::get_class_for_mode($this->mode);
610     }
612     /**
613      * Returns the id of this definition.
614      * @return string
615      */
616     public function get_id() {
617         return $this->id;
618     }
620     /**
621      * Returns the name for this definition
622      * @return string
623      */
624     public function get_name() {
625         $identifier = 'cachedef_'.clean_param($this->area, PARAM_STRINGID);
626         $component = $this->component;
627         if ($component === 'core') {
628             $component = 'cache';
629         }
630         return new lang_string($identifier, $component);
631     }
633     /**
634      * Returns the mode of this definition
635      * @return int One more cache_store::MODE_
636      */
637     public function get_mode() {
638         return $this->mode;
639     }
641     /**
642      * Returns the area this definition is associated with.
643      * @return string
644      */
645     public function get_area() {
646         return $this->area;
647     }
649     /**
650      * Returns the component this definition is associated with.
651      * @return string
652      */
653     public function get_component() {
654         return $this->component;
655     }
657     /**
658      * Returns true if this definition is using simple keys.
659      *
660      * Simple keys contain only a-zA-Z0-9_
661      *
662      * @return bool
663      */
664     public function uses_simple_keys() {
665         return $this->simplekeys;
666     }
668     /**
669      * Returns the identifiers that are being used for this definition.
670      * @return array
671      */
672     public function get_identifiers() {
673         if (!isset($this->identifiers)) {
674             return array();
675         }
676         return $this->identifiers;
677     }
679     /**
680      * Returns the ttl in seconds for this definition if there is one, or null if not.
681      * @return int|null
682      */
683     public function get_ttl() {
684         return $this->ttl;
685     }
687     /**
688      * Returns the maximum number of items allowed in this cache.
689      * @return int
690      */
691     public function get_maxsize() {
692         return $this->maxsize;
693     }
695     /**
696      * Returns true if this definition should only be used with mappings.
697      * @return bool
698      */
699     public function is_for_mappings_only() {
700         return $this->mappingsonly;
701     }
703     /**
704      * Returns true if the data is known to be scalar or array of scalar.
705      * @return bool
706      */
707     public function uses_simple_data() {
708         return $this->simpledata;
709     }
711     /**
712      * Returns true if this definition requires a data guarantee from the cache stores being used.
713      * @return bool
714      */
715     public function require_data_guarantee() {
716         return $this->requiredataguarantee;
717     }
719     /**
720      * Returns true if this definition requires that the cache stores support multiple identifiers
721      * @return bool
722      */
723     public function require_multiple_identifiers() {
724         return $this->requiremultipleidentifiers;
725     }
727     /**
728      * Returns true if this definition requires locking functionality. Either read or write locking.
729      * @return bool
730      */
731     public function require_locking() {
732         return $this->requirelocking;
733     }
735     /**
736      * Returns true if this definition requires read locking.
737      * @return bool
738      */
739     public function require_locking_read() {
740         return $this->requirelockingread;
741     }
743     /**
744      * Returns true if this definition requires write locking.
745      * @return bool
746      */
747     public function require_locking_write() {
748         return $this->requirelockingwrite;
749     }
751     /**
752      * Returns true if this definition allows local storage to be used for caching.
753      * @since Moodle 3.1.0
754      * @return bool
755      */
756     public function can_use_localstore() {
757         return $this->canuselocalstore;
758     }
760     /**
761      * Returns true if this definition requires a searchable cache.
762      * @since Moodle 2.4.4
763      * @return bool
764      */
765     public function require_searchable() {
766         return $this->requiresearchable;
767     }
769     /**
770      * Returns true if this definition has an associated data source.
771      * @return bool
772      */
773     public function has_data_source() {
774         return !is_null($this->datasource);
775     }
777     /**
778      * Returns an instance of the data source class used for this definition.
779      *
780      * @return cache_data_source
781      * @throws coding_exception
782      */
783     public function get_data_source() {
784         if (!$this->has_data_source()) {
785             throw new coding_exception('This cache does not use a data source.');
786         }
787         return forward_static_call(array($this->datasource, 'get_instance_for_cache'), $this);
788     }
790     /**
791      * Sets the identifiers for this definition, or updates them if they have already been set.
792      *
793      * @param array $identifiers
794      * @return bool false if no identifiers where changed, true otherwise.
795      * @throws coding_exception
796      */
797     public function set_identifiers(array $identifiers = array()) {
798         // If we are setting the exact same identifiers then just return as nothing really changed.
799         // We don't care about order as cache::make will use the same definition order all the time.
800         if ($identifiers === $this->identifiers) {
801             return false;
802         }
804         foreach ($this->requireidentifiers as $identifier) {
805             if (!isset($identifiers[$identifier])) {
806                 throw new coding_exception('Identifier required for cache has not been provided: '.$identifier);
807             }
808         }
810         if ($this->identifiers === null) {
811             // Initialize identifiers if they have not been.
812             $this->identifiers = array();
813         }
814         foreach ($identifiers as $name => $value) {
815             $this->identifiers[$name] = (string)$value;
816         }
817         // Reset the key prefix's they need updating now.
818         $this->keyprefixsingle = null;
819         $this->keyprefixmulti = null;
821         return true;
822     }
824     /**
825      * Returns the requirements of this definition as a binary flag.
826      * @return int
827      */
828     public function get_requirements_bin() {
829         $requires = 0;
830         if ($this->require_data_guarantee()) {
831             $requires += cache_store::SUPPORTS_DATA_GUARANTEE;
832         }
833         if ($this->require_multiple_identifiers()) {
834             $requires += cache_store::SUPPORTS_MULTIPLE_IDENTIFIERS;
835         }
836         if ($this->require_searchable()) {
837             $requires += cache_store::IS_SEARCHABLE;
838         }
839         return $requires;
840     }
842     /**
843      * Returns true if this definitions cache should be made persistent.
844      *
845      * Please call {@link cache_definition::use_static_acceleration()} instead.
846      *
847      * @see cache_definition::use_static_acceleration()
848      * @deprecated since 2.6
849      * @return bool
850      */
851     public function should_be_persistent() {
852         debugging('Please upgrade your code to use cache_definition::use_static_acceleration', DEBUG_DEVELOPER);
853         return $this->use_static_acceleration();
854     }
856     /**
857      * Returns true if we should hold onto the data flowing through the cache.
858      *
859      * If set to true data flowing through the cache will be stored in a static variable
860      * to make subsequent requests for the data much faster.
861      *
862      * @return bool
863      */
864     public function use_static_acceleration() {
865         if ($this->mode === cache_store::MODE_REQUEST) {
866             // Request caches should never use static acceleration - it just doesn't make sense.
867             return false;
868         }
869         return $this->staticacceleration;
870     }
872     /**
873      * Returns the max size for the static acceleration array.
874      *
875      * Please call {@link cache_definition::get_static_acceleration_size()} instead.
876      *
877      * @see cache_definition::get_static_acceleration_size()
878      * @deprecated since 2.6
879      * @return int
880      */
881     public function get_persistent_max_size() {
882         debugging('Please upgrade your code to call cache_definition::get_static_acceleration_size', DEBUG_DEVELOPER);
883         return $this->get_static_acceleration_size();
884     }
886     /**
887      * Returns the max size for the static acceleration array.
888      * @return int
889      */
890     public function get_static_acceleration_size() {
891         return $this->staticaccelerationsize;
892     }
894     /**
895      * Generates a hash of this definition and returns it.
896      * @return string
897      */
898     public function generate_definition_hash() {
899         if ($this->definitionhash === null) {
900             $this->definitionhash = md5("{$this->mode} {$this->component} {$this->area}");
901         }
902         return $this->definitionhash;
903     }
905     /**
906      * Generates a single key prefix for this definition
907      *
908      * @return string
909      */
910     public function generate_single_key_prefix() {
911         if ($this->keyprefixsingle === null) {
912             $this->keyprefixsingle = $this->mode.'/'.$this->component.'/'.$this->area;
913             $this->keyprefixsingle .= '/'.$this->get_cache_identifier();
914             $identifiers = $this->get_identifiers();
915             if ($identifiers) {
916                 foreach ($identifiers as $key => $value) {
917                     $this->keyprefixsingle .= '/'.$key.'='.$value;
918                 }
919             }
920             $this->keyprefixsingle = md5($this->keyprefixsingle);
921         }
922         return $this->keyprefixsingle;
923     }
925     /**
926      * Generates a multi key prefix for this definition
927      *
928      * @return array
929      */
930     public function generate_multi_key_parts() {
931         if ($this->keyprefixmulti === null) {
932             $this->keyprefixmulti = array(
933                 'mode' => $this->mode,
934                 'component' => $this->component,
935                 'area' => $this->area,
936                 'siteidentifier' => $this->get_cache_identifier()
937             );
938             if (isset($this->identifiers) && !empty($this->identifiers)) {
939                 $identifiers = array();
940                 foreach ($this->identifiers as $key => $value) {
941                     $identifiers[] = htmlentities($key, ENT_QUOTES, 'UTF-8').'='.htmlentities($value, ENT_QUOTES, 'UTF-8');
942                 }
943                 $this->keyprefixmulti['identifiers'] = join('&', $identifiers);
944             }
945         }
946         return $this->keyprefixmulti;
947     }
949     /**
950      * Check if this definition should invalidate on the given event.
951      *
952      * @param string $event
953      * @return bool True if the definition should invalidate on the event. False otherwise.
954      */
955     public function invalidates_on_event($event) {
956         return (in_array($event, $this->invalidationevents));
957     }
959     /**
960      * Check if the definition has any invalidation events.
961      *
962      * @return bool True if it does, false otherwise
963      */
964     public function has_invalidation_events() {
965         return !empty($this->invalidationevents);
966     }
968     /**
969      * Returns all of the invalidation events for this definition.
970      *
971      * @return array
972      */
973     public function get_invalidation_events() {
974         return $this->invalidationevents;
975     }
977     /**
978      * Returns a cache identification string.
979      *
980      * @return string A string to be used as part of keys.
981      */
982     protected function get_cache_identifier() {
983         $identifiers = array();
984         if ($this->selectedsharingoption & self::SHARING_ALL) {
985             // Nothing to do here.
986         } else {
987             if ($this->selectedsharingoption & self::SHARING_SITEID) {
988                 $identifiers[] = cache_helper::get_site_identifier();
989             }
990             if ($this->selectedsharingoption & self::SHARING_VERSION) {
991                 $identifiers[] = cache_helper::get_site_version();
992             }
993             if ($this->selectedsharingoption & self::SHARING_INPUT && !empty($this->userinputsharingkey)) {
994                 $identifiers[] = $this->userinputsharingkey;
995             }
996         }
997         return join('/', $identifiers);
998     }
1000     /**
1001      * Returns true if this definition requires identifiers.
1002      *
1003      * @param bool
1004      */
1005     public function has_required_identifiers() {
1006         return (count($this->requireidentifiers) > 0);
1007     }
1009     /**
1010      * Returns the possible sharing options that can be used with this defintion.
1011      *
1012      * @return int
1013      */
1014     public function get_sharing_options() {
1015         return $this->sharingoptions;
1016     }
1018     /**
1019      * Returns the user entered sharing key for this definition.
1020      *
1021      * @return string
1022      */
1023     public function get_user_input_sharing_key() {
1024         return $this->userinputsharingkey;
1025     }
1027     /**
1028      * Returns the user selected sharing option for this definition.
1029      *
1030      * @return int
1031      */
1032     public function get_selected_sharing_option() {
1033         return $this->selectedsharingoption;
1034     }