Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
- Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
- PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
Differences Between: [Versions 310 and 400] [Versions 311 and 400] [Versions 39 and 400]
Data registry renderable.
| Copyright: | 2018 David Monllao |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 475 lines (16 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
data_registry_page:: (12 methods):
__construct()
export_for_template()
get_default_tree_structure()
get_all_category_branches()
get_courses_branch()
get_modules_branch()
get_blocks_branch()
add_to_parent_category_branch()
complete()
purpose_options()
category_options()
base_options()
Class: data_registry_page - X-Ref
Class containing the data registry renderable| __construct($defaultcontextlevel = false, $defaultcontextid = false) X-Ref |
| Constructor. return: null param: int $defaultcontextlevel param: int $defaultcontextid |
| export_for_template(renderer_base $output) X-Ref |
| Export this data so it can be used as the context for a mustache template. return: stdClass param: renderer_base $output |
| get_default_tree_structure() X-Ref |
| Returns the tree default structure. return: array |
| get_all_category_branches() X-Ref |
| Returns the hierarchy of system course categories. return: array |
| get_courses_branch(\context $catcontext) X-Ref |
| Gets the courses branch for the provided category. return: array param: \context $catcontext |
| get_modules_branch(\context $coursecontext) X-Ref |
| Gets the modules branch for the provided course. return: array param: \context $coursecontext |
| get_blocks_branch(\context $coursecontext) X-Ref |
| Gets the blocks branch for the provided course. return: null param: \context $coursecontext |
| add_to_parent_category_branch($category, $newnode, &$categoriesbranch) X-Ref |
| Adds the provided category to the categories branch. return: bool param: stdClass $category param: array $newnode param: array $categoriesbranch |
| complete($node, $currentcontextlevel = false, $currentcontextid = false) X-Ref |
| Completes tree nodes with default values. return: array param: array $node param: int|false $currentcontextlevel param: int|false $currentcontextid |
| purpose_options($purposes, $includenotset = true, $includeinherit = true) X-Ref |
| From a list of purpose persistents to a list of id => name purposes. return: string[] param: \tool_dataprivacy\purpose[] $purposes param: bool $includenotset param: bool $includeinherit |
| category_options($categories, $includenotset = true, $includeinherit = true) X-Ref |
| From a list of category persistents to a list of id => name categories. return: string[] param: \tool_dataprivacy\category[] $categories param: bool $includenotset param: bool $includeinherit |
| base_options($includenotset = true, $includeinherit = true) X-Ref |
| Base not set and inherit options. return: array param: bool $includenotset param: bool $includeinherit |
