688b986bbf91ecd82aa42b529247cc3d24bd1c50
[moodle.git] / lib / db / caches.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  * Core cache definitions.
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 $definitions = array(
31     // Used to store processed lang files.
32     // The keys used are the revision, lang and component of the string file.
33     // The persistent max size has been based upon student access of the site.
34     // NOTE: this data may be safely stored in local caches on cluster nodes.
35     'string' => array(
36         'mode' => cache_store::MODE_APPLICATION,
37         'simplekeys' => true,
38         'simpledata' => true,
39         'persistentdata' => true,
40         'persistentmaxsize' => 30
41     ),
43     // Used to store cache of all available translations.
44     // NOTE: this data may be safely stored in local caches on cluster nodes.
45     'langmenu' => array(
46         'mode' => cache_store::MODE_APPLICATION,
47         'simplekeys' => true,
48         'simpledata' => true,
49         'persistent' => true,
50     ),
52     // Used to store database meta information.
53     // The database meta information includes information about tables and there columns.
54     // Its keys are the table names.
55     // When creating an instance of this definition you must provide the database family that is being used.
56     'databasemeta' => array(
57         'mode' => cache_store::MODE_APPLICATION,
58         'requireidentifiers' => array(
59             'dbfamily'
60         ),
61         'persistentdata' => true,
62         'persistentmaxsize' => 15
63     ),
65     // Event invalidation cache.
66     // This cache is used to manage event invalidation, its keys are the event names.
67     // Whenever something is invalidated it is both purged immediately and an event record created with the timestamp.
68     // When a new cache is initialised all timestamps are looked at and if past data is once more invalidated.
69     // Data guarantee is required in order to ensure invalidation always occurs.
70     // Persistence has been turned on as normally events are used for frequently used caches and this event invalidation
71     // cache will likely be used either lots or never.
72     'eventinvalidation' => array(
73         'mode' => cache_store::MODE_APPLICATION,
74         'persistentdata' => true,
75         'requiredataguarantee' => true,
76         'simpledata' => true,
77     ),
79     // Cache for question definitions. This is used by the question_bank class.
80     // Users probably do not need to know about this cache. They will just call
81     // question_bank::load_question.
82     'questiondata' => array(
83         'mode' => cache_store::MODE_APPLICATION,
84         'simplekeys' => true, // The id of the question is used.
85         'requiredataguarantee' => false,
86         'datasource' => 'question_finder',
87         'datasourcefile' => 'question/engine/bank.php',
88     ),
90     // HTML Purifier cache
91     // This caches the html purifier cleaned text. This is done because the text is usually cleaned once for every user
92     // and context combo. Text caching handles caching for the combination, this cache is responsible for caching the
93     // cleaned text which is shareable.
94     // NOTE: this data may be safely stored in local caches on cluster nodes.
95     'htmlpurifier' => array(
96         'mode' => cache_store::MODE_APPLICATION,
97     ),
99     // Used to store data from the config + config_plugins table in the database.
100     // The key used is the component:
101     //   - core for all core config settings
102     //   - plugin component for all plugin settings.
103     // Persistence is used because normally several settings within a script.
104     'config' => array(
105         'mode' => cache_store::MODE_APPLICATION,
106         'persistentdata' => true,
107         'simpledata' => true
108     ),
110     // Groupings belonging to a course.
111     // A simple cache designed to replace $GROUPLIB_CACHE->groupings.
112     // Items are organised by course id and are essentially course records.
113     'groupdata' => array(
114         'mode' => cache_store::MODE_APPLICATION,
115         'simplekeys' => true, // The course id the groupings exist for.
116         'simpledata' => true, // Array of stdClass objects containing only strings.
117         'persistentdata' => true, // Likely there will be a couple of calls to this.
118         'persistmaxsize' => 2, // The original cache used 1, we've increased that to two.
119     ),
121     // Used to cache calendar subscriptions.
122     'calendar_subscriptions' => array(
123         'mode' => cache_store::MODE_APPLICATION,
124         'simplekeys' => true,
125         'simpledata' => true,
126         'persistentdata' => true,
127     ),
129     // YUI Module cache.
130     // This stores the YUI module metadata for Shifted YUI modules in Moodle.
131     'yuimodules' => array(
132         'mode' => cache_store::MODE_APPLICATION,
133     ),
135     // Cache for the list of event observers.
136     'observers' => array(
137         'mode' => cache_store::MODE_APPLICATION,
138         'simplekeys' => true,
139         'simpledata' => true,
140         'persistentdata' => true,
141         'persistentmaxsize' => 2,
142     ),
144     // Cache used by the {@link plugin_manager} class.
145     // NOTE: this must be a shared cache.
146     'plugin_manager' => array(
147         'mode' => cache_store::MODE_APPLICATION,
148         'simplekeys' => true,
149         'simpledata' => true,
150         'persistentdata' => true,
151         'persistentmaxsize' => 2,
152     ),
154     // Cache used by the {@link plugininfo_mod} class.
155     'plugininfo_mod' => array(
156         'mode' => cache_store::MODE_APPLICATION,
157         'simplekeys' => true,
158         'simpledata' => true,
159         'persistentdata' => true,
160         'persistentmaxsize' => 1,
161     ),
163     // Cache used by the {@link plugininfo_block} class.
164     'plugininfo_block' => array(
165         'mode' => cache_store::MODE_APPLICATION,
166         'simplekeys' => true,
167         'simpledata' => true,
168         'persistentdata' => true,
169         'persistentmaxsize' => 1,
170     ),
172     // Cache used by the {@link plugininfo_filter} class.
173     'plugininfo_filter' => array(
174         'mode' => cache_store::MODE_APPLICATION,
175         'simplekeys' => true,
176         'simpledata' => true,
177         'persistentdata' => true,
178         'persistentmaxsize' => 1,
179     ),
181     // Cache used by the {@link plugininfo_repository} class.
182     'plugininfo_repository' => array(
183         'mode' => cache_store::MODE_APPLICATION,
184         'simplekeys' => true,
185         'simpledata' => true,
186         'persistentdata' => true,
187         'persistentmaxsize' => 1,
188     ),
190     // Cache used by the {@link plugininfo_portfolio} class.
191     'plugininfo_portfolio' => array(
192         'mode' => cache_store::MODE_APPLICATION,
193         'simplekeys' => true,
194         'simpledata' => true,
195         'persistentdata' => true,
196         'persistentmaxsize' => 1,
197 >>>>>>> MDL-40903 cache: converted persistent into persistentdata
198     ),
200     // Used to store the full tree of course categories.
201     'coursecattree' => array(
202         'mode' => cache_store::MODE_APPLICATION,
203         'persistentdata' => true,
204         'invalidationevents' => array(
205             'changesincoursecat',
206         )
207     ),
208     // Used to store data for course categories visible to current user. Helps to browse list of categories.
209     'coursecat' => array(
210         'mode' => cache_store::MODE_SESSION,
211         'persistentdata' => true,
212         'invalidationevents' => array(
213             'changesincoursecat',
214             'changesincourse',
215         ),
216         'ttl' => 600,
217     ),
218     // Used to store data for course categories visible to current user. Helps to browse list of categories.
219     'coursecatrecords' => array(
220         'mode' => cache_store::MODE_REQUEST,
221         'simplekeys' => true,
222         'invalidationevents' => array(
223             'changesincoursecat',
224         ),
225     ),
226     // Cache course contacts for the courses.
227     'coursecontacts' => array(
228         'mode' => cache_store::MODE_APPLICATION,
229         'persistentdata' => true,
230         'simplekeys' => true,
231     ),
232     // Used to store data for repositories to avoid repetitive DB queries within one request.
233     'repositories' => array(
234         'mode' => cache_store::MODE_REQUEST,
235     ),
236     // Used to store external badges.
237     'externalbadges' => array(
238         'mode' => cache_store::MODE_APPLICATION,
239         'simplekeys' => true,
240         'ttl' => 3600,
241     ),
242     // Accumulated information about course modules and sections used to print course view page (user-independed).
243     // Used in function get_fast_modinfo(), reset in function rebuild_course_cache().
244     'coursemodinfo' => array(
245         'mode' => cache_store::MODE_APPLICATION,
246         'simplekeys' => true,
247     ),
248 );