Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Static Public Member Functions | List of all members
tool_dataprivacy\output\data_registry_page Class Reference

Class containing the data registry renderable. More...

Inheritance diagram for tool_dataprivacy\output\data_registry_page:
renderable templatable

Public Member Functions

 __construct ($defaultcontextlevel=false, $defaultcontextid=false)
 Constructor. More...
 
 export_for_template (renderer_base $output)
 Export this data so it can be used as the context for a mustache template. More...
 

Static Public Member Functions

static category_options ($categories, $includenotset=true, $includeinherit=true)
 From a list of category persistents to a list of id => name categories. More...
 
static get_blocks_branch (\context $coursecontext)
 Gets the blocks branch for the provided course. More...
 
static get_courses_branch (\context $catcontext)
 Gets the courses branch for the provided category. More...
 
static get_modules_branch (\context $coursecontext)
 Gets the modules branch for the provided course. More...
 
static purpose_options ($purposes, $includenotset=true, $includeinherit=true)
 From a list of purpose persistents to a list of id => name purposes. More...
 

Detailed Description

Class containing the data registry renderable.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

◆ __construct()

tool_dataprivacy\output\data_registry_page::__construct (   $defaultcontextlevel = false,
  $defaultcontextid = false 
)

Constructor.

Parameters
int$defaultcontextlevel
int$defaultcontextid
Return values
null

Member Function Documentation

◆ category_options()

static tool_dataprivacy\output\data_registry_page::category_options (   $categories,
  $includenotset = true,
  $includeinherit = true 
)
static

From a list of category persistents to a list of id => name categories.

Parameters
tool_dataprivacy::category[]$categories
bool$includenotset
bool$includeinherit
Return values
string[]

◆ export_for_template()

tool_dataprivacy\output\data_registry_page::export_for_template ( renderer_base  $output)

Export this data so it can be used as the context for a mustache template.

Parameters
renderer_base$output
Return values
stdClass

Implements templatable.

◆ get_blocks_branch()

static tool_dataprivacy\output\data_registry_page::get_blocks_branch ( \context  $coursecontext)
static

Gets the blocks branch for the provided course.

Parameters
context$coursecontext
Return values
null

◆ get_courses_branch()

static tool_dataprivacy\output\data_registry_page::get_courses_branch ( \context  $catcontext)
static

Gets the courses branch for the provided category.

Parameters
context$catcontext
Return values
array

◆ get_modules_branch()

static tool_dataprivacy\output\data_registry_page::get_modules_branch ( \context  $coursecontext)
static

Gets the modules branch for the provided course.

Parameters
context$coursecontext
Return values
array

◆ purpose_options()

static tool_dataprivacy\output\data_registry_page::purpose_options (   $purposes,
  $includenotset = true,
  $includeinherit = true 
)
static

From a list of purpose persistents to a list of id => name purposes.

Parameters
tool_dataprivacy::purpose[]$purposes
bool$includenotset
bool$includeinherit
Return values
string[]

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