Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

This file defines an item of metadata which encapsulates data which is exported to an external location.

Copyright: 2018 Andrew Nicols <andrew@nicols.co.uk>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 112 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

external_location:: (4 methods):
  __construct()
  get_name()
  get_privacy_fields()
  get_summary()


Class: external_location  - X-Ref

The external_location type.

__construct($name, array $privacyfields = [], $summary = '')   X-Ref
Constructor to create a new external_location type.

param: string  $name A name for the type of data exported.
param: array   $privacyfields A list of fields with their description.
param: string  $summary A description of what the table is used for. This is a language string identifier

get_name()   X-Ref
The name to describe the type of information exported.

return: string

get_privacy_fields()   X-Ref
Get the list of fields which contain user data, with a description of each field.

return: array

get_summary()   X-Ref
A summary of what this type of exported data is used for.

return: string