Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
- Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/lib/classes/context/ -> course.php (source)
(no description)
| File Size: | 298 lines (10 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
course:: (15 methods):
__construct()
get_short_name()
get_level_name()
get_context_name()
get_url()
get_instance_table()
get_behat_reference_columns()
get_compatible_role_archetypes()
get_possible_parent_levels()
get_capabilities()
get_course_context()
instance()
create_level_instances()
get_cleanup_sql()
build_paths()
Course context class
| __construct(stdClass $record) X-Ref |
| Please use \core\context\course::instance($courseid) if you need the instance of context. Alternatively if you know only the context id use \core\context::instance_by_id($contextid) param: stdClass $record |
| get_short_name() X-Ref |
| Returns short context name. return: string |
| get_level_name() X-Ref |
| Returns human readable context level name. return: string the human readable context level name. |
| get_context_name($withprefix = true, $short = false, $escape = true) X-Ref |
| Returns human readable context identifier. param: boolean $withprefix whether to prefix the name of the context with Course param: boolean $short whether to use the short name of the thing. param: bool $escape Whether the returned category name is to be HTML escaped or not. return: string the human readable context name. |
| get_url() X-Ref |
| Returns the most relevant URL for this context. return: moodle_url |
| get_instance_table() X-Ref |
| Returns context instance database name. return: string|null table name for all levels except system. |
| get_behat_reference_columns() X-Ref |
| Returns list of columns that can be used from behat to look up context by reference. return: array list of column names from instance table |
| get_compatible_role_archetypes() X-Ref |
| Returns list of all role archetypes that are compatible with role assignments in context level. return: int[] |
| get_possible_parent_levels() X-Ref |
| Returns list of all possible parent context levels. return: int[] |
| get_capabilities(string $sort = self::DEFAULT_CAPABILITY_SORT) X-Ref |
| Returns array of relevant context capability records. param: string $sort return: array |
| get_course_context($strict = true) X-Ref |
| Is this context part of any course? If yes return course context. param: bool $strict true means throw exception if not found, false means return false if not found return: course context of the enclosing course, null if not found or exception |
| instance($courseid, $strictness = MUST_EXIST) X-Ref |
| Returns course context instance. param: int $courseid id from {course} table param: int $strictness return: course|false context instance |
| create_level_instances() X-Ref |
| Create missing context instances at course context level |
| get_cleanup_sql() X-Ref |
| Returns sql necessary for purging of stale context instances. return: string cleanup SQL |
| build_paths($force) X-Ref |
| Rebuild context paths and depths at course context level. param: bool $force |
