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.
Differences Between: [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403]
Cache display 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: | 795 lines (33 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
administration_display_helper:: (24 methods):
__construct()
get_definition_actions()
get_store_instance_actions()
get_store_plugin_actions()
get_add_store_form()
get_edit_store_form()
get_possible_locks_for_stores()
get_store_configuration_from_data()
get_addable_lock_options()
get_add_lock_form()
get_lock_configuration_from_data()
perform_cache_actions()
action_rescan_definition()
action_addstore()
action_editstore()
action_deletestore()
action_editdefinitionmapping()
action_editdefinitionsharing()
action_editmodemappings()
action_purgedefinition()
action_purge()
action_newlockinstance()
action_deletelock()
generate_admin_page()
Class: administration_display_helper - X-Ref
A cache helper for administration tasks| __construct() X-Ref |
| Please do not call constructor directly. Use cache_factory::get_administration_display_helper() instead. |
| get_definition_actions(\context $context, array $definitionsummary) X-Ref |
| Returns all of the actions that can be performed on a definition. param: context $context the system context. param: array $definitionsummary information about this cache, from the array returned by return: array of actions. Each action is an action_url. |
| get_store_instance_actions(string $name, array $storedetails) X-Ref |
| Returns all of the actions that can be performed on a store. param: string $name The name of the store param: array $storedetails information about this store, from the array returned by return: array of actions. Each action is an action_url. |
| get_store_plugin_actions(string $name, array $plugindetails) X-Ref |
| Returns all of the actions that can be performed on a plugin. param: string $name The name of the plugin param: array $plugindetails information about this store, from the array returned by return: array of actions. Each action is an action_url. |
| get_add_store_form(string $plugin) X-Ref |
| Returns a form that can be used to add a store instance. param: string $plugin The plugin to add an instance of return: cachestore_addinstance_form |
| get_edit_store_form(string $plugin, string $store) X-Ref |
| Returns a form that can be used to edit a store instance. param: string $plugin param: string $store return: cachestore_addinstance_form |
| get_possible_locks_for_stores(string $plugindir, string $plugin) X-Ref |
| Returns an array of suitable lock instances for use with this plugin, or false if the plugin handles locking itself. param: string $plugindir param: string $plugin return: array|false |
| get_store_configuration_from_data(\stdClass $data) X-Ref |
| Processes the results of the add/edit instance form data for a plugin returning an array of config information suitable to store in configuration. param: stdClass $data The mform data. return: array |
| get_addable_lock_options() X-Ref |
| Returns an array of lock plugins for which we can add an instance. Suitable for use within an mform select element. return: array |
| get_add_lock_form(string $plugin, array $lockplugin = null) X-Ref |
| Gets the form to use when adding a lock instance. param: string $plugin param: array $lockplugin return: cache_lock_form |
| get_lock_configuration_from_data(string $plugin, \stdClass $data) X-Ref |
| Gets configuration data from a new lock instance form. param: string $plugin param: stdClass $data return: array |
| perform_cache_actions(string $action, array $forminfo) X-Ref |
| Handles the page actions, based on the parameter. param: string $action the action to handle. param: array $forminfo an empty array to be overridden and set. return: array the empty or overridden forminfo array. |
| action_rescan_definition() X-Ref |
| Performs the rescan definition action. return: void |
| action_addstore() X-Ref |
| Performs the add store action. return: array an array of the form to display to the user, and the page title. |
| action_editstore() X-Ref |
| Performs the edit store action. return: array an array of the form to display, and the page title. |
| action_deletestore(string $action) X-Ref |
| Performs the deletestore action. param: string $action the action calling to this function. return: void |
| action_editdefinitionmapping() X-Ref |
| Performs the edit definition mapping action. return: array an array of the form to display, and the page title. |
| action_editdefinitionsharing() X-Ref |
| Performs the edit definition sharing action. return: array an array of the edit definition sharing form, and the page title. |
| action_editmodemappings() X-Ref |
| Performs the edit mode mappings action. return: array an array of the edit mode mappings form. |
| action_purgedefinition() X-Ref |
| Performs the purge definition action. return: void |
| action_purge() X-Ref |
| Performs the purge action. return: void |
| action_newlockinstance() X-Ref |
| Performs the new lock instance action. return: array An array containing the new lock instance form. |
| action_deletelock(string $action) X-Ref |
| Performs the delete lock action. param: string $action the action calling this function. return: void |
| generate_admin_page(core_cache_renderer $renderer) X-Ref |
| Outputs the main admin page by generating it through the renderer. param: core_cache_renderer $renderer the renderer to use to generate the page. return: string the HTML for the admin page. |
