Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
- Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
- PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/cache/classes/ -> administration_helper.php (source)
Differences Between: [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403]
Cache administration helper. This file is part of Moodle's cache API, affectionately called MUC. It contains the components that are requried in order to use caching.
| Author: | Peter Burnett <peterburnett@catalyst-au.net> |
| Copyright: | 2020 Catalyst IT |
| Copyright: | 2012 Sam Hemelryk |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 407 lines (17 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
administration_helper:: (11 methods):
get_store_instance_summaries()
get_store_plugin_summaries()
get_definition_summaries()
get_default_mode_stores()
get_lock_summaries()
get_definition_sharing_options()
get_definition_store_options()
get_store_plugin_actions()
get_store_instance_actions()
get_definition_actions()
get_addable_lock_options()
Class: administration_helper - X-Ref
Administration helper base class.Defines abstract methods for a subclass to define the admin page.
| get_store_instance_summaries() X-Ref |
| Returns an array containing all of the information about stores a renderer needs. return: array |
| get_store_plugin_summaries() X-Ref |
| Returns an array of information about plugins, everything a renderer needs. return: array for each store, an array containing various information about each store. |
| get_definition_summaries() X-Ref |
| Returns an array about the definitions. All the information a renderer needs. return: array for each store, an array containing various information about each store. |
| get_default_mode_stores() X-Ref |
| Get the default stores for all modes. return: array An array containing sub-arrays, one for each mode. |
| get_lock_summaries() X-Ref |
| Returns an array summarising the locks available in the system. return: array array of lock summaries. |
| get_definition_sharing_options(int $sharingoption, bool $isselectedoptions = true) X-Ref |
| Given a sharing option hash this function returns an array of strings that can be used to describe it. param: int $sharingoption The sharing option hash to get strings for. param: bool $isselectedoptions Set to true if the strings will be used to view the selected options. return: array An array of lang_string's. |
| get_definition_store_options(string $component, string $area) X-Ref |
| Get an array of stores that are suitable to be used for a given definition. param: string $component param: string $area return: array Array containing 3 elements |
| get_store_plugin_actions(string $name, array $plugindetails) X-Ref |
| This function must be implemented to display options for store plugins. param: string $name the name of the store plugin. param: array $plugindetails array of store plugin details. return: array array of actions. |
| get_store_instance_actions(string $name, array $storedetails) X-Ref |
| This function must be implemented to display options for store instances. param: string $name the store instance name. param: array $storedetails array of store instance details. return: array array of actions. |
| get_definition_actions(\context $context, array $definitionsummary) X-Ref |
| This function must be implemented to display options for definition mappings. param: context $context the context for the definition. param: array $definitionsummary the definition summary. return: array array of actions. |
| get_addable_lock_options() X-Ref |
| This function must be implemented to get addable locks. return: array array of locks that are addable. |
