MDL-65394 portfolio: add cache for portfolio_add_button
[moodle.git] / lib / db / caches.php
CommitLineData
d6a1f63b 1<?php
167ad91e
SH
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/>.
16
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 */
d6a1f63b
SH
28
29$definitions = array(
a560d636 30
170f821b 31 // Used to store processed lang files.
598a82c9 32 // The keys used are the revision, lang and component of the string file.
b51fed38 33 // The static acceleration size has been based upon student access of the site.
d6a1f63b
SH
34 'string' => array(
35 'mode' => cache_store::MODE_APPLICATION,
47834bcd 36 'simplekeys' => true,
2e1e266c 37 'simpledata' => true,
d074fb09 38 'staticacceleration' => true,
4350192a 39 'staticaccelerationsize' => 30,
ae3c6ee4 40 'canuselocalstore' => true,
d6a1f63b 41 ),
a560d636 42
598a82c9 43 // Used to store cache of all available translations.
598a82c9
PS
44 'langmenu' => array(
45 'mode' => cache_store::MODE_APPLICATION,
46 'simplekeys' => true,
47 'simpledata' => true,
b51fed38 48 'staticacceleration' => true,
ae3c6ee4 49 'canuselocalstore' => true,
598a82c9
PS
50 ),
51
170f821b 52 // Used to store database meta information.
47834bcd
SH
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.
d6a1f63b
SH
56 'databasemeta' => array(
57 'mode' => cache_store::MODE_APPLICATION,
58 'requireidentifiers' => array(
59 'dbfamily'
60 ),
d22a01fd 61 'simpledata' => true, // This is a read only class, so leaving references in place is safe.
d074fb09
SH
62 'staticacceleration' => true,
63 'staticaccelerationsize' => 15
d6a1f63b 64 ),
a560d636 65
170f821b 66 // Event invalidation cache.
47834bcd
SH
67 // This cache is used to manage event invalidation, its keys are the event names.
68 // Whenever something is invalidated it is both purged immediately and an event record created with the timestamp.
69 // When a new cache is initialised all timestamps are looked at and if past data is once more invalidated.
70 // Data guarantee is required in order to ensure invalidation always occurs.
71 // Persistence has been turned on as normally events are used for frequently used caches and this event invalidation
72 // cache will likely be used either lots or never.
d6a1f63b
SH
73 'eventinvalidation' => array(
74 'mode' => cache_store::MODE_APPLICATION,
d074fb09 75 'staticacceleration' => true,
2e1e266c
SH
76 'requiredataguarantee' => true,
77 'simpledata' => true,
a560d636
TH
78 ),
79
80 // Cache for question definitions. This is used by the question_bank class.
81 // Users probably do not need to know about this cache. They will just call
82 // question_bank::load_question.
83 'questiondata' => array(
84 'mode' => cache_store::MODE_APPLICATION,
47834bcd 85 'simplekeys' => true, // The id of the question is used.
a560d636
TH
86 'requiredataguarantee' => false,
87 'datasource' => 'question_finder',
88 'datasourcefile' => 'question/engine/bank.php',
89 ),
e85c56cc
SH
90
91 // HTML Purifier cache
92 // This caches the html purifier cleaned text. This is done because the text is usually cleaned once for every user
10aabcb2 93 // and context combo. Text caching handles caching for the combination, this cache is responsible for caching the
e85c56cc
SH
94 // cleaned text which is shareable.
95 'htmlpurifier' => array(
96 'mode' => cache_store::MODE_APPLICATION,
ae3c6ee4 97 'canuselocalstore' => true,
a9135060
EL
98 ),
99
007bfe8b
SH
100 // Used to store data from the config + config_plugins table in the database.
101 // The key used is the component:
102 // - core for all core config settings
103 // - plugin component for all plugin settings.
104 // Persistence is used because normally several settings within a script.
105 'config' => array(
106 'mode' => cache_store::MODE_APPLICATION,
d074fb09 107 'staticacceleration' => true,
007bfe8b
SH
108 'simpledata' => true
109 ),
e17dbeeb
SH
110
111 // Groupings belonging to a course.
112 // A simple cache designed to replace $GROUPLIB_CACHE->groupings.
113 // Items are organised by course id and are essentially course records.
114 'groupdata' => array(
115 'mode' => cache_store::MODE_APPLICATION,
116 'simplekeys' => true, // The course id the groupings exist for.
117 'simpledata' => true, // Array of stdClass objects containing only strings.
d074fb09 118 'staticacceleration' => true, // Likely there will be a couple of calls to this.
b51fed38 119 'staticaccelerationsize' => 2, // The original cache used 1, we've increased that to two.
59573bb4 120 ),
dbaaeb93
DM
121
122 // Used to cache calendar subscriptions.
e73b527c
AA
123 'calendar_subscriptions' => array(
124 'mode' => cache_store::MODE_APPLICATION,
36546841
SH
125 'simplekeys' => true,
126 'simpledata' => true,
d074fb09 127 'staticacceleration' => true,
aa135c4d
ARN
128 ),
129
c4172077
MG
130 // Cache the course categories where the user has any enrolment and all categories that this user can manage.
131 'calendar_categories' => array(
132 'mode' => cache_store::MODE_SESSION,
133 'simplekeys' => true,
134 'simpledata' => true,
135 'invalidationevents' => array(
136 'changesincoursecat',
b30b66c5 137 'changesincategoryenrolment',
c4172077
MG
138 ),
139 'ttl' => 900,
140 ),
141
aa701743
TL
142 // Cache the capabilities list DB table. See get_all_capabilities in accesslib.
143 'capabilities' => array(
144 'mode' => cache_store::MODE_APPLICATION,
145 'simplekeys' => true,
146 'simpledata' => true,
147 'staticacceleration' => true,
148 'staticaccelerationsize' => 1,
149 'ttl' => 3600, // Just in case.
150 ),
151
aa135c4d
ARN
152 // YUI Module cache.
153 // This stores the YUI module metadata for Shifted YUI modules in Moodle.
154 'yuimodules' => array(
155 'mode' => cache_store::MODE_APPLICATION,
aa135c4d 156 ),
c2eb74df 157
d8a1f426
PS
158 // Cache for the list of event observers.
159 'observers' => array(
160 'mode' => cache_store::MODE_APPLICATION,
161 'simplekeys' => true,
162 'simpledata' => true,
d074fb09
SH
163 'staticacceleration' => true,
164 'staticaccelerationsize' => 2,
d8a1f426
PS
165 ),
166
e87214bd 167 // Cache used by the {@link core_plugin_manager} class.
bde002b8
PS
168 // NOTE: this must be a shared cache.
169 'plugin_manager' => array(
ad3ed98b
DM
170 'mode' => cache_store::MODE_APPLICATION,
171 'simplekeys' => true,
172 'simpledata' => true,
083fa877
SH
173 ),
174
175 // Used to store the full tree of course categories.
eabbfa82 176 'coursecattree' => array(
b33389d2 177 'mode' => cache_store::MODE_APPLICATION,
d074fb09 178 'staticacceleration' => true,
eabbfa82
MG
179 'invalidationevents' => array(
180 'changesincoursecat',
181 )
182 ),
083fa877 183 // Used to store data for course categories visible to current user. Helps to browse list of categories.
eabbfa82
MG
184 'coursecat' => array(
185 'mode' => cache_store::MODE_SESSION,
eabbfa82
MG
186 'invalidationevents' => array(
187 'changesincoursecat',
188 'changesincourse',
189 ),
190 'ttl' => 600,
191 ),
083fa877 192 // Used to store data for course categories visible to current user. Helps to browse list of categories.
eabbfa82
MG
193 'coursecatrecords' => array(
194 'mode' => cache_store::MODE_REQUEST,
b33389d2 195 'simplekeys' => true,
eabbfa82
MG
196 'invalidationevents' => array(
197 'changesincoursecat',
198 ),
b33389d2 199 ),
083fa877 200 // Cache course contacts for the courses.
36ba8fde
MG
201 'coursecontacts' => array(
202 'mode' => cache_store::MODE_APPLICATION,
d074fb09 203 'staticacceleration' => true,
36ba8fde 204 'simplekeys' => true,
a6d4a363 205 'ttl' => 3600,
36ba8fde 206 ),
083fa877 207 // Used to store data for repositories to avoid repetitive DB queries within one request.
118ca9e9
MG
208 'repositories' => array(
209 'mode' => cache_store::MODE_REQUEST,
118ca9e9 210 ),
2d3c0fae
YB
211 // Used to store external badges.
212 'externalbadges' => array(
213 'mode' => cache_store::MODE_APPLICATION,
214 'simplekeys' => true,
215 'ttl' => 3600,
216 ),
299cfee5
MG
217 // Accumulated information about course modules and sections used to print course view page (user-independed).
218 // Used in function get_fast_modinfo(), reset in function rebuild_course_cache().
219 'coursemodinfo' => array(
220 'mode' => cache_store::MODE_APPLICATION,
221 'simplekeys' => true,
ae3c6ee4 222 'canuselocalstore' => true,
299cfee5 223 ),
df460b5a
SH
224 // This is the session user selections cache.
225 // It's a special cache that is used to record user selections that should persist for the lifetime of the session.
226 // Things such as which categories the user has expanded can be stored here.
227 // It uses simple keys and simple data, please ensure all uses conform to those two constraints.
228 'userselections' => array(
229 'mode' => cache_store::MODE_SESSION,
230 'simplekeys' => true,
231 'simpledata' => true
232 ),
cbd063f4 233
3871db0a
MW
234 // Used to cache activity completion status.
235 'completion' => array(
236 'mode' => cache_store::MODE_APPLICATION,
237 'simplekeys' => true,
5c2ef08f 238 'simpledata' => true,
0cc9d709
MG
239 'ttl' => 3600,
240 'staticacceleration' => true,
241 'staticaccelerationsize' => 2, // Should be current course and site course.
3871db0a
MW
242 ),
243
ddce4f4b
DW
244 // Used to cache course completion status.
245 'coursecompletion' => array(
246 'mode' => cache_store::MODE_APPLICATION,
247 'simplekeys' => true,
248 'simpledata' => true,
249 'ttl' => 3600,
250 'staticacceleration' => true,
251 'staticaccelerationsize' => 30, // Will be users list of current courses in nav.
252 ),
253
cbd063f4
SH
254 // A simple cache that stores whether a user can expand a course in the navigation.
255 // The key is the course ID and the value will either be 1 or 0 (cast to bool).
256 // The cache isn't always up to date, it should only ever be used to save a costly call to
257 // can_access_course on the first page request a user makes.
258 'navigation_expandcourse' => array(
259 'mode' => cache_store::MODE_SESSION,
260 'simplekeys' => true,
261 'simpledata' => true
eeb9ee8e
DB
262 ),
263
03ecddb4
SH
264 // Caches suspended userids by course.
265 // The key is the courseid, the value is an array of user ids.
266 'suspended_userids' => array(
eeb9ee8e
DB
267 'mode' => cache_store::MODE_REQUEST,
268 'simplekeys' => true,
269 'simpledata' => true,
270 ),
9effa148 271
e705e69e
TL
272 // Cache system-wide role definitions.
273 'roledefs' => array(
274 'mode' => cache_store::MODE_APPLICATION,
275 'simplekeys' => true,
276 'simpledata' => true,
277 'staticacceleration' => true,
278 'staticaccelerationsize' => 30,
279 ),
280
9effa148
DM
281 // Caches plugins existing functions by function name and file.
282 // Set static acceleration size to 5 to load a few functions.
283 'plugin_functions' => array(
284 'mode' => cache_store::MODE_APPLICATION,
285 'simplekeys' => true,
286 'simpledata' => true,
287 'staticacceleration' => true,
288 'staticaccelerationsize' => 5
c026a28d
MG
289 ),
290
291 // Caches data about tag collections and areas.
292 'tags' => array(
293 'mode' => cache_store::MODE_REQUEST,
294 'simplekeys' => true,
8de48ad0 295 'staticacceleration' => true,
db48207e
DM
296 ),
297
8f8517ec 298 // Grade categories. Stored at session level as invalidation is very aggressive.
28774c92 299 'grade_categories' => array(
8f8517ec 300 'mode' => cache_store::MODE_SESSION,
28774c92 301 'simplekeys' => true,
8f8517ec
DM
302 'invalidationevents' => array(
303 'changesingradecategories',
304 )
28774c92 305 ),
ef474575 306
26e7ecee
SL
307 // Store temporary tables information.
308 'temp_tables' => array(
309 'mode' => cache_store::MODE_REQUEST,
f18561a2
DM
310 'simplekeys' => true,
311 'simpledata' => true
4218ad93
MG
312 ),
313
314 // Caches tag index builder results.
315 'tagindexbuilder' => array(
316 'mode' => cache_store::MODE_SESSION,
317 'simplekeys' => true,
318 'simplevalues' => true,
319 'staticacceleration' => true,
320 'staticaccelerationsize' => 10,
321 'ttl' => 900, // 15 minutes.
322 'invalidationevents' => array(
323 'resettagindexbuilder',
324 ),
325 ),
20ab51fd 326
1611308b
DM
327 // Caches contexts with insights.
328 'contextwithinsights' => array(
40fcb365
DM
329 'mode' => cache_store::MODE_APPLICATION,
330 'simplekeys' => true,
331 'simpledata' => true,
332 'staticacceleration' => true,
333 'staticaccelerationsize' => 1
334 ),
335
20ab51fd
AA
336 // Caches message processors.
337 'message_processors_enabled' => array(
338 'mode' => cache_store::MODE_APPLICATION,
339 'simplekeys' => true,
340 'simpledata' => true,
341 'staticacceleration' => true,
342 'staticaccelerationsize' => 3
343 ),
fb1469d8 344
fb04293b 345 // Caches the time of the last message in a conversation.
74138e92 346 'message_time_last_message_between_users' => array(
fb1469d8 347 'mode' => cache_store::MODE_APPLICATION,
fb04293b 348 'simplekeys' => true, // The conversation id is used.
fb1469d8 349 'simplevalues' => true,
74138e92 350 'datasource' => '\core_message\time_last_message_between_users',
fb1469d8 351 ),
7e8940b5
DW
352
353 // Caches font awesome icons.
354 'fontawesomeiconmapping' => array(
355 'mode' => cache_store::MODE_APPLICATION,
356 'simplekeys' => true,
357 'simpledata' => true,
358 'staticacceleration' => true,
359 'staticaccelerationsize' => 1
360 ),
361
4cc2f33b
SL
362 // Caches processed CSS.
363 'postprocessedcss' => array(
364 'mode' => cache_store::MODE_APPLICATION,
365 'simplekeys' => true,
366 'simpledata' => true,
367 'staticacceleration' => false,
368 ),
0897d658
SR
369
370 // Caches grouping and group ids of a user.
371 'user_group_groupings' => array(
372 'mode' => cache_store::MODE_APPLICATION,
373 'simplekeys' => true,
374 'simpledata' => true,
375 'staticacceleration' => true,
376 ),
25dbbdf9
MG
377
378 // This is the user's pre sign-up session cache.
379 // This cache is used to record the user's pre sign-up data such as
380 // age of digital consent (minor) status, accepted policies, etc.
381 'presignup' => array(
382 'mode' => cache_store::MODE_SESSION,
383 'simplekeys' => true,
384 'simpledata' => true,
c654e350 385 'ttl' => 1800
25dbbdf9 386 ),
352ab746
DM
387
388 // Caches the first time we analysed models' analysables.
389 'modelfirstanalyses' => array(
390 'mode' => cache_store::MODE_REQUEST,
391 'simplekeys' => true,
392 'simpledata' => true,
393 ),
76fbbf7e
RW
394
395 // Cache the list of portfolio instances for the logged in user
396 // in the portfolio_add_button constructor to avoid loading the
397 // same data multiple times.
398 'portfolio_add_button_portfolio_instances' => [
399 'mode' => cache_store::MODE_REQUEST,
400 'simplekeys' => true,
401 'staticacceleration' => true
402 ],
d6a1f63b 403);