| 1441 |
ariadna |
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/>.
|
|
|
16 |
|
|
|
17 |
namespace core_cache;
|
|
|
18 |
|
|
|
19 |
use moodleform;
|
|
|
20 |
use stdClass;
|
|
|
21 |
|
|
|
22 |
/**
|
|
|
23 |
* Cache store feature: configurable.
|
|
|
24 |
*
|
|
|
25 |
* This feature should be implemented by all cache stores that are configurable when adding an instance.
|
|
|
26 |
* It requires the implementation of methods required to convert form data into the a configuration array for the
|
|
|
27 |
* store instance, and then the reverse converting configuration data into an array that can be used to set the
|
|
|
28 |
* data for the edit form.
|
|
|
29 |
*
|
|
|
30 |
* Can be implemented by classes already implementing store.
|
|
|
31 |
* @package core_cache
|
|
|
32 |
* @copyright Sam Hemelryk
|
|
|
33 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
34 |
*/
|
|
|
35 |
interface configurable_cache_interface {
|
|
|
36 |
/**
|
|
|
37 |
* Given the data from the add instance form this function creates a configuration array.
|
|
|
38 |
*
|
|
|
39 |
* @param stdClass $data
|
|
|
40 |
* @return array
|
|
|
41 |
*/
|
|
|
42 |
public static function config_get_configuration_array($data);
|
|
|
43 |
|
|
|
44 |
/**
|
|
|
45 |
* Allows the cache store to set its data against the edit form before it is shown to the user.
|
|
|
46 |
*
|
|
|
47 |
* @param moodleform $editform
|
|
|
48 |
* @param array $config
|
|
|
49 |
*/
|
|
|
50 |
public static function config_set_edit_form_data(moodleform $editform, array $config);
|
|
|
51 |
}
|
|
|
52 |
|
|
|
53 |
// Alias this class to the old name.
|
|
|
54 |
// This file will be autoloaded by the legacyclasses autoload system.
|
|
|
55 |
// In future all uses of this class will be corrected and the legacy references will be removed.
|
|
|
56 |
class_alias(configurable_cache_interface::class, \cache_is_configurable::class);
|