core_privacy\local\request\context_aware_provider Interface Reference

The provider interface for plugins which need access to all approved contexts to fill in relevant contextual data. More...

Inheritance diagram for core_privacy\local\request\context_aware_provider:

Static Public Member Functions
static	export_context_data (\core_privacy\local\request\contextlist_collection $contextcollection)
	Give the component a chance to include any contextual information deemed relevant to any child contexts which are exporting personal data. More...

Detailed Description

The provider interface for plugins which need access to all approved contexts to fill in relevant contextual data.

Copyright

2018 Adrian Greeve <adriangreeve.com>

License

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

Member Function Documentation

export_context_data()

static core_privacy\local\request\context_aware_provider::export_context_data ( \core_privacy\local\request\contextlist_collection  $contextcollection )

static

Give the component a chance to include any contextual information deemed relevant to any child contexts which are exporting personal data.

By giving the component access to the full list of contexts being exported across all components, it can determine whether a descendant context is being exported, and decide whether to add relevant contextual information about itself. Having access to the full list of contexts being exported is what makes this component a context aware provider.

Parameters

core_privacy\local\request\contextlist_collection

$contextcollection

The collection of approved context lists.

---

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

• privacy/classes/local/request/context_aware_provider.php