Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
cache_config_disabled Class Reference

The cache config class used when the Cache has been disabled. More...

Inheritance diagram for cache_config_disabled:

Public Member Functions

 add_store_instance ($name, $plugin, array $configuration=array())
 Adds a plugin instance.
 
 delete_store_instance ($name)
 Deletes a store instance.
 
 edit_store_instance ($name, $plugin, $configuration)
 Edits a give plugin instance.
 
 set_definition_mappings ($definition, $mappings)
 Sets the mappings for a given definition.
 
 set_mode_mappings (array $modemappings)
 Sets the mode mappings.
 

Static Public Member Functions

static create_default_configuration ($forcesave=false)
 Creates the default configuration and saves it.
 
static instance ()
 Returns an instance of the configuration writer.
 
static update_definitions ($coreonly=false)
 Updates the definition in the configuration from those found in the cache files.
 

Protected Member Functions

 config_save ()
 Saves the current configuration.
 
 generate_configuration_array ()
 Generates a configuration array suitable to be written to the config file.
 

Static Protected Member Functions

static locate_definitions ($coreonly=false)
 Locates all of the definition files.
 

Detailed Description

The cache config class used when the Cache has been disabled.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ add_store_instance()

cache_config_disabled::add_store_instance ( $name,
$plugin,
array $configuration = array() )

Adds a plugin instance.

Parameters
string$nameUnused.
string$pluginUnused.
array$configurationUnused.
Return values
bool
Exceptions
cache_exception

◆ create_default_configuration()

static cache_config_disabled::create_default_configuration ( $forcesave = false)
static

Creates the default configuration and saves it.

Parameters
bool$forcesaveIgnored because we are disabled!
Return values
array

◆ delete_store_instance()

cache_config_disabled::delete_store_instance ( $name)

Deletes a store instance.

Parameters
string$nameUnused.
Return values
bool
Exceptions
cache_exception

◆ edit_store_instance()

cache_config_disabled::edit_store_instance ( $name,
$plugin,
$configuration )

Edits a give plugin instance.

Parameters
string$nameUnused.
string$pluginUnused.
array$configurationUnused.
Return values
bool
Exceptions
cache_exception

◆ generate_configuration_array()

cache_config_disabled::generate_configuration_array ( )
protected

Generates a configuration array suitable to be written to the config file.

Return values
array

◆ instance()

static cache_config_disabled::instance ( )
static

Returns an instance of the configuration writer.

Return values
cache_config_disabled

◆ locate_definitions()

static cache_config_disabled::locate_definitions ( $coreonly = false)
staticprotected

Locates all of the definition files.

Parameters
bool$coreonlyUnused.
Return values
array

◆ set_definition_mappings()

cache_config_disabled::set_definition_mappings ( $definition,
$mappings )

Sets the mappings for a given definition.

Parameters
string$definitionUnused.
array$mappingsUnused.
Exceptions
coding_exception

◆ set_mode_mappings()

cache_config_disabled::set_mode_mappings ( array $modemappings)

Sets the mode mappings.

Parameters
array$modemappingsUnused.
Return values
bool
Exceptions
cache_exception

◆ update_definitions()

static cache_config_disabled::update_definitions ( $coreonly = false)
static

Updates the definition in the configuration from those found in the cache files.

Parameters
bool$coreonlyUnused.

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