Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Protected Member Functions | List of all members
tool_dataprivacy\metadata_registry Class Reference

Class containing helper methods for processing data requests. More...

Public Member Functions

 get_registry_metadata ()
 Returns plugin types / plugins and the user data that it stores in a format that can be sent to a template. More...
 

Protected Member Functions

 format_metadata ($collection, $component, $internaldata)
 Formats the metadata for use with a template. More...
 
 get_contrib_list ()
 Returns a list of contributed plugins installed on the system. More...
 
 get_full_component_list ()
 Return the full list of components. More...
 

Detailed Description

Class containing helper methods for processing data requests.

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

Member Function Documentation

◆ format_metadata()

tool_dataprivacy\metadata_registry::format_metadata (   $collection,
  $component,
  $internaldata 
)
protected

Formats the metadata for use with a template.

Parameters
array$collectionThe collection associated with the component that we want to expand and format.
string$componentThe component that we are dealing in
array$internaldataThe array to add the formatted metadata to.
Return values
arrayThe internal data array with the formatted metadata.

◆ get_contrib_list()

tool_dataprivacy\metadata_registry::get_contrib_list ( )
protected

Returns a list of contributed plugins installed on the system.

Return values
arrayA list of contributed plugins installed.

◆ get_full_component_list()

tool_dataprivacy\metadata_registry::get_full_component_list ( )
protected

Return the full list of components.

Return values
arrayAn array of plugin types which contain plugin data.

◆ get_registry_metadata()

tool_dataprivacy\metadata_registry::get_registry_metadata ( )

Returns plugin types / plugins and the user data that it stores in a format that can be sent to a template.

Return values
arrayAn array with all of the plugin types / plugins and the user data they store.

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