context_helper Class Reference

Inheritance diagram for context_helper:

Public Member Functions
	__get ($name)
	Magic method getter, redirects to read only values. More...
	__isset ($name)
	Full support for isset on our magic read only properties. More...
	__set ($name, $value)
	Magic setter method, we do not want anybody to modify properties from the outside. More...
	__unset ($name)
	All properties are read only, sorry. More...
	delete ()
	Delete the context content and the context record itself.
	delete_capabilities ()
	Unassign all capabilities from a context.
	delete_content ()
	Delete all data linked to content, do not delete the context record itself.
	get_capabilities (string $sort=self::DEFAULT_CAPABILITY_SORT)
	not used More...
	get_child_contexts ()
	Recursive function which, given a context, find all its children context ids. More...
	get_context_name ($withprefix=true, $short=false, $escape=true)
	Returns human readable context identifier. More...
	get_course_context ($strict=true)
	Is this context part of any course? If yes return course context. More...
	get_parent_context ()
	Returns parent context. More...
	get_parent_context_ids ($includeself=false)
	Returns parent context ids of this context in reversed order, i.e. More...
	get_parent_context_paths ($includeself=false)
	Returns parent context paths of this context. More...
	get_parent_contexts ($includeself=false)
	Returns parent contexts of this context in reversed order, i.e. More...
	get_url ()
	not used More...
	getIterator ()
	Create an iterator because magic vars can't be seen by 'foreach'. More...
	is_child_of (context $possibleparent, bool $includeself)
	Determine if the current context is a child of the possible parent. More...
	is_locked ()
	Whether the current context is locked. More...
	is_parent_of (context $possiblechild, bool $includeself)
	Determine if the current context is a parent of the possible child. More...
	mark_dirty ()
	Mark a context as dirty (with timestamp) so as to force reloading of the context.
	reload_if_dirty ()
	Reset all cached permissions and definitions if the necessary. More...
	reset_paths ($rebuild=true)
	Remove all context path info and optionally rebuild it. More...
	set_locked (bool $locked)
	Set whether this context has been locked or not. More...
	update_moved (context $newparent)
	Update context info after moving context in the tree structure. More...

Static Public Member Functions
static	build_all_paths ($force=false)
	Rebuild paths and depths in all context levels. More...
static	cleanup_instances ()
	Remove stale contexts that belonged to deleted instances. More...
static	create_instances ($contextlevel=null, $buildpaths=true)
	Create all context instances at the given level and above. More...
static	delete_instance ($contextlevel, $instanceid)
	Delete context instance. More...
static	get_all_levels ()
	Returns a list of all context levels. More...
static	get_class_for_level ($contextlevel)
	Returns a class name of the context level class. More...
static	get_level_name ($contextlevel)
	Returns the name of specified context level. More...
static	get_navigation_filter_context (?context $context)
	Gets the current context to be used for navigation tree filtering. More...
static	get_preload_record_columns ($tablealias)
	Returns all fields necessary for context preloading from user $rec. More...
static	get_preload_record_columns_sql ($tablealias)
	Returns all fields necessary for context preloading from user $rec. More...
static	instance_by_id ($id, $strictness=MUST_EXIST)
	Get a context instance as an object, from a given context id. More...
static	preload_contexts_by_id (array $contextids)
	Preload a set of contexts using their contextid. More...
static	preload_course ($courseid)
	Preload all contexts instances from course. More...
static	preload_from_record (stdClass $rec)
	Preloads context information from db record and strips the cached info. More...
static	reset_caches ()
	Resets the cache to remove all data. More...
static	reset_levels ()
	Reset internal context levels array.

Protected Member Functions
	__construct ()
	Instance does not make sense here, only static use.

Static Protected Member Functions
static	build_paths ($force)
	Rebuild context paths and depths at context level. More...
static	cache_add (context $context)
	Adds a context to the cache. More...
static	cache_get ($contextlevel, $instance)
	Gets a context from the cache. More...
static	cache_get_by_id ($id)
	Gets a context from the cache based on its id. More...
static	cache_remove (context $context)
	Removes a context from the cache. More...
static	create_instance_from_record (stdClass $record)
	This function is also used to work around 'protected' keyword problems in context_helper. More...
static	create_level_instances ()
	Create missing context instances at given level. More...
static	get_cleanup_sql ()
	Returns sql necessary for purging of stale context instances. More...
static	insert_context_record ($contextlevel, $instanceid, $parentpath)
	Utility method for context creation. More...
static	merge_context_temp_table ()
	Copy prepared new contexts from temp table to context table, we do this in db specific way for perf reasons only.

Protected Attributes
int	$_contextlevel
	The context level Can be accessed publicly through $context->contextlevel One of CONTEXT_* e.g. More...
int	$_depth
	The depth of the context in relation to parent contexts Can be accessed publicly through $context->depth.
int	$_id
	The context id Can be accessed publicly through $context->id.
int	$_instanceid
	Id of the item this context is related to e.g. More...
int	$_locked
	Whether this context is locked or not. More...
string	$_path
	The path to the context always starting from the system context Can be accessed publicly through $context->path.
string const	DEFAULT_CAPABILITY_SORT = 'contextlevel, component, name'
	Default sorting of capabilities in {. More...

Static Protected Attributes
static int	$cache_count = 0
	Context count Why do we do count contexts? Because count($array) is horribly slow for large arrays.
static array	$cache_preloaded = array()
	Context caching info.
static context_system	$systemcontext = null
	The system context once initialised.

---

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

• lib/accesslib.php