Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Static Public Member Functions | List of all members
cache_data_source Interface Reference
Inheritance diagram for cache_data_source:
core_message\time_last_message_between_users question_finder

Public Member Functions

 load_for_cache ($key)
 Loads the data for the key provided ready formatted for caching. More...
 
 load_many_for_cache (array $keys)
 Loads several keys for the cache. More...
 

Static Public Member Functions

static get_instance_for_cache (cache_definition $definition)
 Returns an instance of the data source class that the cache can use for loading data using the other methods specified by this interface. More...
 

Member Function Documentation

◆ get_instance_for_cache()

static cache_data_source::get_instance_for_cache ( cache_definition  $definition)
static

Returns an instance of the data source class that the cache can use for loading data using the other methods specified by this interface.

Parameters
cache_definition$definition
Return values
object

Implemented in question_finder.

◆ load_for_cache()

cache_data_source::load_for_cache (   $key)

Loads the data for the key provided ready formatted for caching.

Parameters
string | int$keyThe key to load.
Return values
mixedWhat ever data should be returned, or false if it can't be loaded.

Implemented in core_message\time_last_message_between_users, and question_finder.

◆ load_many_for_cache()

cache_data_source::load_many_for_cache ( array  $keys)

Loads several keys for the cache.

Parameters
array$keysAn array of keys each of which will be string|int.
Return values
arrayAn array of matching data items.

Implemented in core_message\time_last_message_between_users, and question_finder.


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