Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
tool_dataprivacy\external\category_exporter Class Reference

Class for exporting field data. More...

Inheritance diagram for tool_dataprivacy\external\category_exporter:
core\external\persistent_exporter

Static Public Member Functions

static get_name ($categoryid)
 Utility function that fetches a category name from the given ID.
 

Static Protected Member Functions

static define_class ()
 Defines the persistent class.
 
static define_properties ()
 Persistent exporters get their standard properties from the persistent class.
 
static define_related ()
 Returns a list of objects that are related.
 

Protected Attributes

core persistent $persistent = null
 The persistent object we will export.
 

Detailed Description

Class for exporting field data.

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

Member Function Documentation

◆ define_class()

static tool_dataprivacy\external\category_exporter::define_class ( )
staticprotected

Defines the persistent class.

Return values
string

Reimplemented from core\external\persistent_exporter.

◆ define_properties()

static core\external\persistent_exporter::define_properties ( )
staticfinalprotectedinherited

Persistent exporters get their standard properties from the persistent class.

Return values
arrayKeys are the property names, and value their definition.

◆ define_related()

static tool_dataprivacy\external\category_exporter::define_related ( )
staticprotected

Returns a list of objects that are related.

Return values
array

◆ get_name()

static tool_dataprivacy\external\category_exporter::get_name ( $categoryid)
static

Utility function that fetches a category name from the given ID.

Parameters
int$categoryidThe category ID. Could be INHERIT (false, -1), NOT_SET (0), or the actual ID.
Return values
stringThe purpose name.

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