Moodle PHP Documentation 5.1
Moodle 5.1dev (Build: 20250706) (a6b17d8f6bd)
core_cache\disabled_config Class Reference
Inheritance diagram for core_cache\disabled_config:

Public Member Functions

 add_store_instance ($name, $plugin, array $configuration=[])
 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.
 

Member Function Documentation

◆ add_store_instance()

core_cache\disabled_config::add_store_instance ( $name,
$plugin,
array $configuration = [] )

Adds a plugin instance.

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

◆ create_default_configuration()

static core_cache\disabled_config::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()

core_cache\disabled_config::delete_store_instance ( $name)

Deletes a store instance.

Parameters
string$nameUnused.
Return values
bool
Exceptions
cache_exception

◆ edit_store_instance()

core_cache\disabled_config::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()

core_cache\disabled_config::generate_configuration_array ( )
protected

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

Return values
array

◆ instance()

static core_cache\disabled_config::instance ( )
static

Returns an instance of the configuration writer.

Return values
disabled_config

◆ locate_definitions()

static core_cache\disabled_config::locate_definitions ( $coreonly = false)
staticprotected

Locates all of the definition files.

Parameters
bool$coreonlyUnused.
Return values
array

◆ set_definition_mappings()

core_cache\disabled_config::set_definition_mappings ( $definition,
$mappings )

Sets the mappings for a given definition.

Parameters
string$definitionUnused.
array$mappingsUnused.
Exceptions
coding_exception

◆ set_mode_mappings()

core_cache\disabled_config::set_mode_mappings ( array $modemappings)

Sets the mode mappings.

Parameters
array$modemappingsUnused.
Return values
bool
Exceptions
cache_exception

◆ update_definitions()

static core_cache\disabled_config::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: