Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Protected Attributes | List of all members
core_privacy\local\metadata\types\plugintype_link Class Reference

The plugintype link. More...

Inheritance diagram for core_privacy\local\metadata\types\plugintype_link:
core_privacy\local\metadata\types\type

Public Member Functions

 __construct ($name, $privacyfields=[], $summary='')
 Constructor for the plugintype_link. More...
 
 get_name ()
 Function to return the name of this plugintype_link type. More...
 
 get_privacy_fields ()
 A plugintype link does not define any fields itself. More...
 
 get_summary ()
 A summary of what this plugintype is used for. More...
 

Protected Attributes

The $name
 name of the core plugintype to link.
 
array $privacyfields
 The list of data names and descriptions.
 
string $summary
 A description of what this plugintype is used to store.
 

Detailed Description

The plugintype link.

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

Constructor & Destructor Documentation

◆ __construct()

core_privacy\local\metadata\types\plugintype_link::__construct (   $name,
  $privacyfields = [],
  $summary = '' 
)

Constructor for the plugintype_link.

Parameters
string$nameThe name of the plugintype to link.
string$summaryA description of what is stored within this plugintype.

Member Function Documentation

◆ get_name()

core_privacy\local\metadata\types\plugintype_link::get_name ( )

Function to return the name of this plugintype_link type.

Return values
string::$name

Implements core_privacy\local\metadata\types\type.

◆ get_privacy_fields()

core_privacy\local\metadata\types\plugintype_link::get_privacy_fields ( )

A plugintype link does not define any fields itself.

Return values
array

Implements core_privacy\local\metadata\types\type.

◆ get_summary()

core_privacy\local\metadata\types\plugintype_link::get_summary ( )

A summary of what this plugintype is used for.

Return values
string::$summary

Implements core_privacy\local\metadata\types\type.


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