[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   * This file contains the \core_privacy\local\request\data_provider interface to describe
  19   * a class which provides data in some form.
  20   *
  21   * @package core_privacy
  22   * @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
  23   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  namespace core_privacy\local\request;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The data_provider interface is used to describe a provider
  31   * which services user requests in any fashion. This includes both
  32   * -- component <-> core; and
  33   * -- component <-> component.
  34   *
  35   * It does not define a specific way of doing so and different types of
  36   * data will need to extend this interface in order to define their own
  37   * contract.
  38   *
  39   * It should not be implemented directly, but should be extended by other
  40   * interfaces in core.
  41   *
  42   * This is the base interface for any component which stores any form of
  43   * user data.
  44   *
  45   * @package core_privacy
  46   * @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
  47   */
  48  interface data_provider {
  49  }