cache_data_source Interface Reference

Inheritance diagram for cache_data_source:

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 core_course\cache\course_image, mod_assign\cache\overrides, mod_lesson\cache\overrides, mod_quiz\cache\overrides, and 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

$key

The key to load.

Return values

mixed

What ever data should be returned, or false if it can't be loaded.

Implemented in core_course\cache\course_image, core_message\time_last_message_between_users, mod_assign\cache\overrides, mod_lesson\cache\overrides, mod_quiz\cache\overrides, and question_finder.

load_many_for_cache()

cache_data_source::load_many_for_cache

(

array

$keys

)

Loads several keys for the cache.

Parameters

array

$keys

An array of keys each of which will be string|int.

Return values

array

An array of matching data items.

Implemented in core_course\cache\course_image, core_message\time_last_message_between_users, mod_assign\cache\overrides, mod_lesson\cache\overrides, mod_quiz\cache\overrides, and question_finder.

---

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

• cache/classes/interfaces.php