Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Static Public Member Functions | List of all members
cache_is_configurable Interface Reference

Cache store feature: configurable. More...

Inheritance diagram for cache_is_configurable:
cachestore_apcu cachestore_file cachestore_memcached cachestore_mongodb cachestore_redis

Static Public Member Functions

static config_get_configuration_array ($data)
 Given the data from the add instance form this function creates a configuration array. More...
 
static config_set_edit_form_data (moodleform $editform, array $config)
 Allows the cache store to set its data against the edit form before it is shown to the user. More...
 

Detailed Description

Cache store feature: configurable.

This feature should be implemented by all cache stores that are configurable when adding an instance. It requires the implementation of methods required to convert form data into the a configuration array for the store instance, and then the reverse converting configuration data into an array that can be used to set the data for the edit form.

Can be implemented by classes already implementing cache_store.

Member Function Documentation

◆ config_get_configuration_array()

static cache_is_configurable::config_get_configuration_array (   $data)
static

Given the data from the add instance form this function creates a configuration array.

Parameters
stdClass$data
Return values
array

Implemented in cachestore_redis, cachestore_mongodb, cachestore_memcached, cachestore_file, and cachestore_apcu.

◆ config_set_edit_form_data()

static cache_is_configurable::config_set_edit_form_data ( moodleform  $editform,
array  $config 
)
static

Allows the cache store to set its data against the edit form before it is shown to the user.

Parameters
moodleform$editform
array$config

Implemented in cachestore_redis, cachestore_mongodb, cachestore_memcached, cachestore_file, and cachestore_apcu.


The documentation for this interface was generated from the following file: