MDL-34346 Cache retrieved repositories
[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 component of the string file.
33     'string' => array(
34         'mode' => cache_store::MODE_APPLICATION,
35         'simplekeys' => true,
36         'simpledata' => true,
37         'persistent' => true,
38         'persistentmaxsize' => 3
39     ),
41     // Used to store database meta information.
42     // The database meta information includes information about tables and there columns.
43     // Its keys are the table names.
44     // When creating an instance of this definition you must provide the database family that is being used.
45     'databasemeta' => array(
46         'mode' => cache_store::MODE_APPLICATION,
47         'requireidentifiers' => array(
48             'dbfamily'
49         ),
50         'persistent' => true,
51         'persistentmaxsize' => 2
52     ),
54     // Event invalidation cache.
55     // This cache is used to manage event invalidation, its keys are the event names.
56     // Whenever something is invalidated it is both purged immediately and an event record created with the timestamp.
57     // When a new cache is initialised all timestamps are looked at and if past data is once more invalidated.
58     // Data guarantee is required in order to ensure invalidation always occurs.
59     // Persistence has been turned on as normally events are used for frequently used caches and this event invalidation
60     // cache will likely be used either lots or never.
61     'eventinvalidation' => array(
62         'mode' => cache_store::MODE_APPLICATION,
63         'persistent' => true,
64         'requiredataguarantee' => true,
65         'simpledata' => true,
66     ),
68     // Cache for question definitions. This is used by the question_bank class.
69     // Users probably do not need to know about this cache. They will just call
70     // question_bank::load_question.
71     'questiondata' => array(
72         'mode' => cache_store::MODE_APPLICATION,
73         'simplekeys' => true, // The id of the question is used.
74         'requiredataguarantee' => false,
75         'datasource' => 'question_finder',
76         'datasourcefile' => 'question/engine/bank.php',
77     ),
79     // HTML Purifier cache
80     // This caches the html purifier cleaned text. This is done because the text is usually cleaned once for every user
81     // and context combo. Text caching handles caching for the combonation, this cache is responsible for caching the
82     // cleaned text which is shareable.
83     'htmlpurifier' => array(
84         'mode' => cache_store::MODE_APPLICATION,
85     ),
87     // Used to store data from the config + config_plugins table in the database.
88     // The key used is the component:
89     //   - core for all core config settings
90     //   - plugin component for all plugin settings.
91     // Persistence is used because normally several settings within a script.
92     'config' => array(
93         'mode' => cache_store::MODE_APPLICATION,
94         'persistent' => true,
95         'simpledata' => true
96     ),
98     // Groupings belonging to a course.
99     // A simple cache designed to replace $GROUPLIB_CACHE->groupings.
100     // Items are organised by course id and are essentially course records.
101     'groupdata' => array(
102         'mode' => cache_store::MODE_APPLICATION,
103         'simplekeys' => true, // The course id the groupings exist for.
104         'simpledata' => true, // Array of stdClass objects containing only strings.
105         'persistent' => true, // Likely there will be a couple of calls to this.
106         'persistmaxsize' => 2, // The original cache used 1, we've increased that to two.
107     ),
109     // Used to cache calendar subscriptions.
110     'calendar_subscriptions' => array(
111         'mode' => cache_store::MODE_APPLICATION,
112         'simplekeys' => true,
113         'simpledata' => true,
114         'persistent' => true,
115     ),
117     // YUI Module cache.
118     // This stores the YUI module metadata for Shifted YUI modules in Moodle.
119     'yuimodules' => array(
120         'mode' => cache_store::MODE_APPLICATION,
121         'persistent' => true,
122     ),
124     // Cache for the list of known plugin and subplugin types - {@see get_plugin_types()}.
125     // Contains two arrays of (string)pluginname => (string)location. The first array with
126     // the key 0 contains locations relative to $CFG->dirroot. The second array with the
127     // key 1 contains absolute paths.
128     'plugintypes' => array(
129         'mode' => cache_store::MODE_APPLICATION,
130         'simplekeys' => true, // 0 or 1 depending on the requested location type.
131         'simpledata' => true, // Array of strings.
132         'persistent' => true, // Likely there will be a couple of calls to this.
133         'persistmaxsize' => 2, // Both arrays should stay loaded in memory.
134     ),
136     // Cache for the list of installed plugins - {@see get_plugin_list()}.
137     // The key consists of the plugin type string (e.g. mod, block, enrol etc).
138     // The value is an associative array of plugin name => plugin location.
139     'pluginlist' => array(
140         'mode' => cache_store::MODE_APPLICATION,
141         'simplekeys' => true,
142         'simpledata' => true,
143         'persistent' => true,
144         'persistentmaxsize' => 2,
145     ),
147     // Cache used by the {@link plugininfo_base} class.
148     'plugininfo_base' => array(
149         'mode' => cache_store::MODE_APPLICATION,
150         'simplekeys' => true,
151         'simpledata' => true,
152         'persistent' => true,
153         'persistentmaxsize' => 2,
154     ),
156     // Cache used by the {@link plugininfo_mod} class.
157     'plugininfo_mod' => array(
158         'mode' => cache_store::MODE_APPLICATION,
159         'simplekeys' => true,
160         'simpledata' => true,
161         'persistent' => true,
162         'persistentmaxsize' => 1,
163     ),
165     // Cache used by the {@link plugininfo_block} class.
166     'plugininfo_block' => array(
167         'mode' => cache_store::MODE_APPLICATION,
168         'simplekeys' => true,
169         'simpledata' => true,
170         'persistent' => true,
171         'persistentmaxsize' => 1,
172     ),
174     // Cache used by the {@link plugininfo_filter} class.
175     'plugininfo_filter' => array(
176         'mode' => cache_store::MODE_APPLICATION,
177         'simplekeys' => true,
178         'simpledata' => true,
179         'persistent' => true,
180         'persistentmaxsize' => 1,
181     ),
183     // Cache used by the {@link plugininfo_repository} class.
184     'plugininfo_repository' => array(
185         'mode' => cache_store::MODE_APPLICATION,
186         'simplekeys' => true,
187         'simpledata' => true,
188         'persistent' => true,
189         'persistentmaxsize' => 1,
190     ),
192     // Cache used by the {@link plugininfo_portfolio} class.
193     'plugininfo_portfolio' => array(
194         'mode' => cache_store::MODE_APPLICATION,
195         'simplekeys' => true,
196         'simpledata' => true,
197         'persistent' => true,
198         'persistentmaxsize' => 1,
199     ),
201     // Used to store the full tree of course categories
202     'coursecattree' => array(
203         'mode' => cache_store::MODE_APPLICATION,
204         'persistent' => true,
205         'invalidationevents' => array(
206             'changesincoursecat',
207         )
208     ),
209     // Used to store data for course categories visible to current user. Helps to browse list of categories
210     'coursecat' => array(
211         'mode' => cache_store::MODE_SESSION,
212         'persistent' => true,
213         'invalidationevents' => array(
214             'changesincoursecat',
215             'changesincourse',
216         ),
217         'ttl' => 600,
218     ),
219     // Used to store data for course categories visible to current user. Helps to browse list of categories
220     'coursecatrecords' => array(
221         'mode' => cache_store::MODE_REQUEST,
222         'simplekeys' => true,
223         'persistent' => true,
224         'invalidationevents' => array(
225             'changesincoursecat',
226         ),
227     ),
228     // Used to store data for repositories to avoid repetitive DB queries within one request
229     'repositories' => array(
230         'mode' => cache_store::MODE_REQUEST,
231         'persistent' => true,
232     ),
233 );