tool_usertours\cache Class Reference

Cache manager. More...

Static Public Member Functions
static	get_enabled_tourdata ()
	Fetch all enabled tours.
static	get_matching_tourdata (\moodle_url $targetmatch)
	Fetch all enabled tours matching the specified target.
static	get_stepdata ($tourid)
	Fetch the tour data for the specified tour.
static	notify_step_change ($tourid)
	Notify of changes to any step to clear the step cache for that tour.
static	notify_tour_change ()
	Notify of changes to any tour to clear the tour cache.

Public Attributes
CACHEKEY_TOUR const	CACHEKEY_TOUR = 'tours'
	The name of the key used for storing tours.
CACHENAME_STEP const	CACHENAME_STEP = 'stepdata'
	The name of the cache used for storing steps.
CACHENAME_TOUR const	CACHENAME_TOUR = 'tourdata'
	The name of the cache used for storing tours.

Detailed Description

Cache manager.

Copyright

2016 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

License

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

Member Function Documentation

get_matching_tourdata()

static tool_usertours\cache::get_matching_tourdata ( \moodle_url $targetmatch )

static

Fetch all enabled tours matching the specified target.

Parameters

moodle_url

$targetmatch

The URL to match.

get_stepdata()

static tool_usertours\cache::get_stepdata ( $tourid )

static

Fetch the tour data for the specified tour.

Parameters

int

$tourid

The ID of the tour to fetch steps for

notify_step_change()

static tool_usertours\cache::notify_step_change ( $tourid )

static

Notify of changes to any step to clear the step cache for that tour.

Parameters

int

$tourid

The ID of the tour to clear the step cache for

---

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

• admin/tool/usertours/classes/cache.php