[Summary view]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * File containing the provider interface for plugins needing access to all approved contexts to fill in relevant contextual data.
  19   *
  20   * Plugins should implement this if they need access to all approved contexts.
  21   *
  22   * @package core_privacy
  23   * @copyright 2018 Adrian Greeve <adriangreeve.com>
  24   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25   */
  26  namespace core_privacy\local\request;
  27  
  28  defined('MOODLE_INTERNAL') || die();
  29  
  30  /**
  31   * The provider interface for plugins which need access to all approved contexts to fill in relevant contextual data.
  32   *
  33   * @copyright  2018 Adrian Greeve <adriangreeve.com>
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  interface context_aware_provider extends \core_privacy\local\request\core_data_provider {
  37  
  38      /**
  39       * Give the component a chance to include any contextual information deemed relevant to any child contexts which are
  40       * exporting personal data.
  41       *
  42       * By giving the component access to the full list of contexts being exported across all components, it can determine whether a
  43       * descendant context is being exported, and decide whether to add relevant contextual information about itself. Having access
  44       * to the full list of contexts being exported is what makes this component a context aware provider.
  45       *
  46       * @param  \core_privacy\local\request\contextlist_collection $contextcollection The collection of approved context lists.
  47       */
  48      public static function export_context_data(\core_privacy\local\request\contextlist_collection $contextcollection);
  49  }