Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
|
Public Member Functions | |
__get ($name) | |
Magic method getter, redirects to read only values. | |
__isset ($name) | |
Full support for isset on our magic read only properties. | |
__set ($name, $value) | |
Magic setter method, we do not want anybody to modify properties from the outside. | |
__unset ($name) | |
All properties are read only, sorry. | |
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) | |
Returns array of relevant context capability records. | |
get_child_contexts () | |
Block do not have child contexts... | |
get_context_name ($withprefix=true, $short=false, $escape=true) | |
Returns human readable context identifier. | |
get_course_context ($strict=true) | |
Is this context part of any course? If yes return course context. | |
get_parent_context () | |
Returns parent context. | |
get_parent_context_ids ($includeself=false) | |
Returns parent context ids of this context in reversed order, i.e. | |
get_parent_context_paths ($includeself=false) | |
Returns parent context paths of this context. | |
get_parent_contexts ($includeself=false) | |
Returns parent contexts of this context in reversed order, i.e. | |
get_url () | |
Returns the most relevant URL for this context. | |
getIterator () | |
Create an iterator because magic vars can't be seen by 'foreach'. | |
is_child_of (context $possibleparent, bool $includeself) | |
Determine if the current context is a child of the possible parent. | |
is_locked () | |
Whether the current context is locked. | |
is_parent_of (context $possiblechild, bool $includeself) | |
Determine if the current context is a parent of the possible child. | |
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. | |
reset_paths ($rebuild=true) | |
Remove all context path info and optionally rebuild it. | |
set_locked (bool $locked) | |
Set whether this context has been locked or not. | |
update_moved (context $newparent) | |
Update context info after moving context in the tree structure. | |
Static Public Member Functions | |
static | get_level_name () |
Returns human readable context level name. | |
static | get_possible_parent_levels () |
Returns list of all possible parent context levels. | |
static | get_short_name () |
Returns short context name. | |
static | instance ($blockinstanceid, $strictness=MUST_EXIST) |
Returns block context instance. | |
static | instance_by_id ($id, $strictness=MUST_EXIST) |
Get a context instance as an object, from a given context id. | |
Public Attributes | |
int const | LEVEL = 80 |
numeric context level value matching legacy CONTEXT_BLOCK | |
Protected Member Functions | |
__construct (stdClass $record) | |
Please use core\context\block\instance($blockinstanceid) if you need the instance of context. | |
Static Protected Member Functions | |
static | build_paths ($force) |
Rebuild context paths and depths at context level. | |
static | cache_add (context $context) |
Adds a context to the cache. | |
static | cache_get ($contextlevel, $instance) |
Gets a context from the cache. | |
static | cache_get_by_id ($id) |
Gets a context from the cache based on its id. | |
static | cache_remove (context $context) |
Removes a context from the cache. | |
static | create_instance_from_record (stdClass $record) |
This function is also used to work around 'protected' keyword problems in context_helper. | |
static | create_level_instances () |
Create missing context instances at block context level. | |
static | get_behat_reference_columns () |
Returns list of columns that can be used from behat to look up context by reference. | |
static | get_cleanup_sql () |
Returns sql necessary for purging of stale context instances. | |
static | get_compatible_role_archetypes () |
Returns list of all role archetypes that are compatible with role assignments in context level. | |
static | get_instance_table () |
Returns context instance database name. | |
static | insert_context_record ($contextlevel, $instanceid, $parentpath) |
Utility method for context creation. | |
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. | |
static | preload_from_record (stdClass $rec) |
Preloads context information from db record and strips the cached info. | |
static | reset_caches () |
Resets the cache to remove all data. | |
Protected Attributes | |
int | $_contextlevel |
The context level Can be accessed publicly through $context->contextlevel One of CONTEXT_* e.g. | |
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. | |
int | $_locked |
Whether this context is locked or not. | |
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 {. | |
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. | |
|
protected |
Please use core\context\block\instance($blockinstanceid) if you need the instance of context.
Alternatively if you know only the context id use core\context\instance_by_id($contextid)
stdClass | $record |
Reimplemented from core\context.
|
inherited |
Magic method getter, redirects to read only values.
string | $name |
mixed |
|
inherited |
Full support for isset on our magic read only properties.
string | $name |
bool |
|
inherited |
Magic setter method, we do not want anybody to modify properties from the outside.
string | $name | |
mixed | $value |
|
inherited |
All properties are read only, sorry.
string | $name |
|
staticprotectedinherited |
Rebuild context paths and depths at context level.
bool | $force |
void |
Reimplemented in core\context\course, core\context\coursecat, core\context\module, core\context\system, and core\context\user.
|
staticprotectedinherited |
Adds a context to the cache.
If the cache is full, discards a batch of older entries.
context | $context | New context to add |
void |
|
staticprotectedinherited |
Gets a context from the cache.
int | $contextlevel | Context level |
int | $instance | Instance ID |
context|bool | Context or false if not in cache |
|
staticprotectedinherited |
Gets a context from the cache based on its id.
int | $id | Context ID |
context|bool | Context or false if not in cache |
|
staticprotectedinherited |
Removes a context from the cache.
context | $context | Context object to remove |
void |
|
staticprotectedinherited |
This function is also used to work around 'protected' keyword problems in context_helper.
stdClass | $record |
context | instance |
|
staticprotected |
Create missing context instances at block context level.
Reimplemented from core\context.
|
staticprotectedinherited |
Returns list of columns that can be used from behat to look up context by reference.
array | list of column names from instance table |
Reimplemented in core\context\course, core\context\coursecat, core\context\module, and core\context\user.
core\context\block::get_capabilities | ( | string | $sort = self::DEFAULT_CAPABILITY_SORT | ) |
Returns array of relevant context capability records.
string | $sort |
array |
Reimplemented from core\context.
core\context\block::get_child_contexts | ( | ) |
|
staticprotectedinherited |
Returns sql necessary for purging of stale context instances.
string | cleanup SQL |
Reimplemented in core\context\course, core\context\coursecat, core\context\module, core\context\system, and core\context\user.
|
staticprotectedinherited |
Returns list of all role archetypes that are compatible with role assignments in context level.
string[] |
Reimplemented in core\context\course, core\context\coursecat, core\context\module, and core\context\system.
core\context\block::get_context_name | ( | $withprefix = true, | |
$short = false, | |||
$escape = true ) |
Returns human readable context identifier.
boolean | $withprefix | whether to prefix the name of the context with Block |
boolean | $short | does not apply to block context |
boolean | $escape | does not apply to block context |
string | the human readable context name. |
Reimplemented from core\context.
core\context\block::get_course_context | ( | $strict = true | ) |
Is this context part of any course? If yes return course context.
bool | $strict | true means throw exception if not found, false means return false if not found |
course | context of the enclosing course, null if not found or exception |
Reimplemented from core\context.
|
staticprotectedinherited |
Returns context instance database name.
string|null | table name for all levels except system. |
Reimplemented in core\context\course, core\context\coursecat, core\context\module, and core\context\user.
|
static |
Returns human readable context level name.
string | the human readable context level name. |
|
inherited |
Returns parent context.
context|false |
|
inherited |
Returns parent context ids of this context in reversed order, i.e.
parent first, then grand parent, etc.
bool | $includeself | true means include self too |
array | of context ids |
|
inherited |
Returns parent context paths of this context.
bool | $includeself | true means include self too |
array | of context paths |
|
inherited |
Returns parent contexts of this context in reversed order, i.e.
parent first, then grand parent, etc.
bool | $includeself | true means include self too |
array | of context instances |
|
static |
Returns list of all possible parent context levels.
int[] |
Reimplemented from core\context.
|
static |
core\context\block::get_url | ( | ) |
Returns the most relevant URL for this context.
moodle_url |
Reimplemented from core\context.
|
inherited |
Create an iterator because magic vars can't be seen by 'foreach'.
Now we can convert context object to array using convert_to_array(), and feed it properly to json_encode().
|
staticprotectedinherited |
Utility method for context creation.
int | $contextlevel | |
int | $instanceid | |
string | $parentpath |
stdClass | context record |
|
static |
Returns block context instance.
int | $blockinstanceid | id from {block_instances} table. |
int | $strictness |
block|false | context instance |
|
staticinherited |
Get a context instance as an object, from a given context id.
int | $id | context id |
int | $strictness | IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found; MUST_EXIST means throw exception if no record found |
context|bool | the context object or false if not found |
|
inherited |
Determine if the current context is a child of the possible parent.
context | $possibleparent | |
bool | $includeself | Whether to check the current context |
bool |
|
inherited |
Whether the current context is locked.
bool |
|
inherited |
Determine if the current context is a parent of the possible child.
context | $possiblechild | |
bool | $includeself | Whether to check the current context |
bool |
|
staticprotectedinherited |
Preloads context information from db record and strips the cached info.
stdClass | $rec |
context|null | (modifies $rec) |
Reimplemented in core\context_helper.
|
inherited |
Reset all cached permissions and definitions if the necessary.
void |
|
staticprotectedinherited |
Resets the cache to remove all data.
Reimplemented in core\context_helper.
|
inherited |
Remove all context path info and optionally rebuild it.
bool | $rebuild |
void |
|
inherited |
Set whether this context has been locked or not.
bool | $locked |
$this |
Reimplemented in core\context\system.
|
inherited |
Update context info after moving context in the tree structure.
context | $newparent |
void |
|
protectedinherited |
The context level Can be accessed publicly through $context->contextlevel One of CONTEXT_* e.g.
CONTEXT_COURSE, CONTEXT_MODULE
|
protectedinherited |
Id of the item this context is related to e.g.
COURSE_CONTEXT => course.id Can be accessed publicly through $context->instanceid
|
protectedinherited |
Whether this context is locked or not.
Can be accessed publicly through $context->locked.
|
protectedinherited |
Default sorting of capabilities in {.