A collection of metadata items.
More...
|
| __construct ($component) |
| Constructor for a component's privacy collection class.
|
|
| add_database_table ($name, array $privacyfields, $summary='') |
| Function to add a database table which contains user data to this collection.
|
|
| add_external_location_link ($name, array $privacyfields, $summary='') |
| Function to indicate that data may be exported to an external location.
|
|
| add_plugintype_link ($name, array $privacyfields=[], $summary='') |
| Function to link a plugin to the component.
|
|
| add_subsystem_link ($name, array $privacyfields=[], $summary='') |
| Function to link a subsystem to the component.
|
|
| add_type (type $type) |
| Function to add an object that implements type interface to the current collection.
|
|
| add_user_preference ($name, $summary='') |
| Add a type of user preference to the collection.
|
|
| get_collection () |
| The content of this collection.
|
|
| get_component () |
| Function to return the current component name.
|
|
| link_external_location ($name, array $privacyfields, $summary='') |
| Old function to indicate that data may be exported to an external location.
|
|
| link_plugintype ($name, $summary='') |
| Old function to link a plugin to the component.
|
|
| link_subsystem ($name, $summary='') |
| Old function to link a subsystem to the component.
|
|
|
type[] | $collection = [] |
| The collection of metadata items.
|
|
string | $component |
| The component that the items in the collection belong to.
|
|
◆ __construct()
core_privacy\local\metadata\collection::__construct |
( |
| $component | ) |
|
Constructor for a component's privacy collection class.
- Parameters
-
string | $component | component name. |
◆ add_database_table()
core_privacy\local\metadata\collection::add_database_table |
( |
| $name, |
|
|
array | $privacyfields, |
|
|
| $summary = '' ) |
Function to add a database table which contains user data to this collection.
- Parameters
-
string | $name | the name of the database table. |
array | $privacyfields | An associative array of fieldname to description. |
string | $summary | A description of what the table is used for. |
- Return values
-
◆ add_external_location_link()
core_privacy\local\metadata\collection::add_external_location_link |
( |
| $name, |
|
|
array | $privacyfields, |
|
|
| $summary = '' ) |
Function to indicate that data may be exported to an external location.
- Parameters
-
string | $name | A name for the type of data exported. |
array | $privacyfields | A list of fields with their description. |
string | $summary | A description of what the table is used for. This is a language string identifier within the component. |
- Return values
-
◆ add_plugintype_link()
core_privacy\local\metadata\collection::add_plugintype_link |
( |
| $name, |
|
|
array | $privacyfields = [], |
|
|
| $summary = '' ) |
Function to link a plugin to the component.
- Parameters
-
string | $name | the name of the plugin to link. |
array | $privacyfields | An optional associative array of fieldname to description. |
string | $summary | A description of what is stored within this plugin. |
- Return values
-
◆ add_subsystem_link()
core_privacy\local\metadata\collection::add_subsystem_link |
( |
| $name, |
|
|
array | $privacyfields = [], |
|
|
| $summary = '' ) |
Function to link a subsystem to the component.
- Parameters
-
string | $name | the name of the subsystem to link. |
array | $privacyfields | An optional associative array of fieldname to description. |
string | $summary | A description of what is stored within this subsystem. |
- Return values
-
◆ add_type()
core_privacy\local\metadata\collection::add_type |
( |
type | $type | ) |
|
Function to add an object that implements type interface to the current collection.
- Parameters
-
type | $type | to add to collection. |
- Return values
-
◆ add_user_preference()
core_privacy\local\metadata\collection::add_user_preference |
( |
| $name, |
|
|
| $summary = '' ) |
Add a type of user preference to the collection.
Typically this is a single user preference, but in some cases the name of a user preference fits a particular format.
- Parameters
-
string | $name | The name of the user preference. |
string | $summary | A description of what the preference is used for. |
- Return values
-
◆ get_collection()
core_privacy\local\metadata\collection::get_collection |
( |
| ) |
|
The content of this collection.
- Return values
-
◆ get_component()
core_privacy\local\metadata\collection::get_component |
( |
| ) |
|
Function to return the current component name.
- Return values
-
◆ link_external_location()
core_privacy\local\metadata\collection::link_external_location |
( |
| $name, |
|
|
array | $privacyfields, |
|
|
| $summary = '' ) |
Old function to indicate that data may be exported to an external location.
This function is legacy and is not recommended. Please use add_external_location_link() instead.
- Parameters
-
string | $name | A name for the type of data exported. |
array | $privacyfields | A list of fields with their description. |
string | $summary | A description of what the table is used for. This is a language string identifier within the component. |
- Return values
-
◆ link_plugintype()
core_privacy\local\metadata\collection::link_plugintype |
( |
| $name, |
|
|
| $summary = '' ) |
Old function to link a plugin to the component.
This function is legacy and is not recommended. Please use add_plugintype_link() instead.
- Parameters
-
string | $name | the name of the plugin to link. |
string | $summary | A description of what is stored within this plugin. |
- Return values
-
◆ link_subsystem()
core_privacy\local\metadata\collection::link_subsystem |
( |
| $name, |
|
|
| $summary = '' ) |
Old function to link a subsystem to the component.
This function is legacy and is not recommended. Please use add_subsystem_link() instead.
- Parameters
-
string | $name | the name of the subsystem to link. |
string | $summary | A description of what is stored within this subsystem. |
- Return values
-
The documentation for this class was generated from the following file:
- privacy/classes/local/metadata/collection.php