Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
core_privacy\local\metadata\types\external_location Class Reference

The external_location type. More...

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

Public Member Functions

 __construct ($name, array $privacyfields=[], $summary='')
 Constructor to create a new external_location type.
 
 get_name ()
 The name to describe the type of information exported.
 
 get_privacy_fields ()
 Get the list of fields which contain user data, with a description of each field.
 
 get_summary ()
 A summary of what this type of exported data is used for.
 

Protected Attributes

string $name
 The name to describe the type of information exported.
 
array $privacyfields
 The list of data names and descriptions exported.
 
string $summary
 A description of what this table is used for.
 

Detailed Description

The external_location type.

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor to create a new external_location type.

Parameters
string$nameA name for the type of data exported.
array$privacyfieldsA list of fields with their description.
string$summaryA description of what the table is used for. This is a language string identifier within the component.

Member Function Documentation

◆ get_name()

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

The name to describe the type of information exported.

Return values
string

Implements core_privacy\local\metadata\types\type.

◆ get_privacy_fields()

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

Get the list of fields which contain user data, with a description of each field.

Return values
array

Implements core_privacy\local\metadata\types\type.

◆ get_summary()

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

A summary of what this type of exported data is used for.

Return values
string

Implements core_privacy\local\metadata\types\type.

Member Data Documentation

◆ $summary

string core_privacy\local\metadata\types\external_location::$summary
protected

A description of what this table is used for.

This is a language string identifier.


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