Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/privacy/classes/local/request/ -> context_aware_provider.php (source)

[Source view]

File containing the provider interface for plugins needing access to all approved contexts to fill in relevant contextual data. Plugins should implement this if they need access to all approved contexts.

Copyright: 2018 Adrian Greeve
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 49 lines (2 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

context_aware_provider:: (1 method):
  export_context_data()


Interface: context_aware_provider  - X-Ref

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

export_context_data(\core_privacy\local\request\contextlist_collection $contextcollection)   X-Ref
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.

param: \core_privacy\local\request\contextlist_collection $contextcollection The collection of approved context lists.