Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.

Differences Between: [Versions 311 and 402] [Versions 311 and 403]

Cache dummy store. This dummy store is used when a load has no other stores that it can make use of. This shouldn't happen in normal operation... I think.

Copyright: 2012 Sam Hemelryk
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 283 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

cachestore_dummy:: (20 methods):
  __construct()
  are_requirements_met()
  can_add_instance()
  get_supported_features()
  get_supported_modes()
  initialise()
  is_initialised()
  is_supported_mode()
  get()
  get_many()
  set()
  set_many()
  delete()
  delete_many()
  purge()
  cleanup()
  instance_deleted()
  initialise_test_instance()
  unit_test_configuration()
  my_name()


Class: cachestore_dummy  - X-Ref

The cache dummy store.

__construct($name = 'Dummy store', array $configuration = array()   X-Ref
Constructs a dummy store instance.

param: string $name
param: array $configuration

are_requirements_met()   X-Ref
Returns true if this store plugin is usable.

return: bool

can_add_instance()   X-Ref
Returns true if the user can add an instance.

return: bool

get_supported_features(array $configuration = array()   X-Ref
Returns the supported features.

param: array $configuration
return: int

get_supported_modes(array $configuration = array()   X-Ref
Returns the supported mode.

param: array $configuration
return: int

initialise(cache_definition $definition)   X-Ref
Initialises the store instance for a definition.

param: cache_definition $definition

is_initialised()   X-Ref
Returns true if this has been initialised.

return: bool

is_supported_mode($mode)   X-Ref
Returns true the given mode is supported.

param: int $mode
return: bool

get($key)   X-Ref
Returns the data for the given key

param: string $key
return: string|false

get_many($keys)   X-Ref
Gets' the values for many keys

param: array $keys
return: bool

set($key, $data)   X-Ref
Sets an item in the cache

param: string $key
param: mixed $data
return: bool

set_many(array $keyvaluearray)   X-Ref
Sets many items in the cache

param: array $keyvaluearray
return: int

delete($key)   X-Ref
Deletes an item from the cache

param: string $key
return: bool

delete_many(array $keys)   X-Ref
Deletes many items from the cache

param: array $keys
return: bool

purge()   X-Ref
Deletes all of the items from the cache.

return: bool

cleanup()   X-Ref
Performs any necessary clean up when the store instance is being deleted.


instance_deleted()   X-Ref
Performs any necessary operation when the store instance is being deleted.

This method may be called before the store has been initialised.


initialise_test_instance(cache_definition $definition)   X-Ref
Generates an instance of the cache store that can be used for testing.

param: cache_definition $definition
return: false

unit_test_configuration()   X-Ref
Generates the appropriate configuration required for unit testing.

return: array Array of unit test configuration data to be used by initialise().

my_name()   X-Ref
Returns the name of this instance.

return: string