Moodle  2.2.1
http://www.collinsharper.com
context_coursecat Class Reference
Inheritance diagram for context_coursecat:
Collaboration diagram for context_coursecat:

Public Member Functions

 get_context_name ($withprefix=true, $short=false)
 get_url ()
 get_capabilities ()
 get_child_contexts ()

Static Public Member Functions

static get_level_name ()
static instance ($instanceid, $strictness=MUST_EXIST)

Protected Member Functions

 __construct (stdClass $record)

Static Protected Member Functions

static create_level_instances ()
static get_cleanup_sql ()
static build_paths ($force)

Detailed Description

Course category context class

Author:
Petr Skoda (http://skodak.org)
Since:
2.2

Definition at line 5852 of file accesslib.php.


Constructor & Destructor Documentation

__construct ( stdClass $  record) [protected]

Please use context_coursecat::instance($coursecatid) if you need the instance of context. Alternatively if you know only the context id use context::instance_by_id($contextid)

Parameters:
stdClass$record

Reimplemented from context.

Definition at line 5859 of file accesslib.php.


Member Function Documentation

static build_paths ( force) [static, protected]

Rebuild context paths and depths at course category context level.

Parameters:
$force

Reimplemented from context.

Definition at line 6020 of file accesslib.php.

Here is the call graph for this function:

static create_level_instances ( ) [static, protected]

Create missing context instances at course category context level

Reimplemented from context.

Definition at line 5985 of file accesslib.php.

Returns array of relevant context capability records.

Returns:
array

Reimplemented from context.

Definition at line 5910 of file accesslib.php.

Returns immediate child contexts of category and all subcategories, children of subcategories and courses are not returned.

Returns:
array

Reimplemented from context.

Definition at line 5964 of file accesslib.php.

Here is the call graph for this function:

static get_cleanup_sql ( ) [static, protected]

Returns sql necessary for purging of stale context instances.

Returns:
string cleanup SQL

Reimplemented from context.

Definition at line 6003 of file accesslib.php.

get_context_name ( withprefix = true,
short = false 
)

Returns human readable context identifier.

Parameters:
boolean$withprefixwhether to prefix the name of the context with Category
boolean$shortdoes not apply to course categories
Returns:
string the human readable context name.

Reimplemented from context.

Definition at line 5883 of file accesslib.php.

Here is the call graph for this function:

static get_level_name ( ) [static]

Returns human readable context level name.

Returns:
string the human readable context level name.

Definition at line 5872 of file accesslib.php.

get_url ( )

Returns the most relevant URL for this context.

Returns:
moodle_url

Reimplemented from context.

Definition at line 5901 of file accesslib.php.

static instance ( instanceid,
strictness = MUST_EXIST 
) [static]

Returns course category context instance.

Parameters:
int$instanceid
int$strictness
Returns:
context_coursecat context instance

Definition at line 5931 of file accesslib.php.

Here is the call graph for this function:

Here is the caller graph for this function:


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations