[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 an interface to describe classes which provide user data in some form to core.
  19   *
  20   * @package     core_privacy
  21   * @copyright   2018 Andrew Nicols <andrew@nicols.co.uk>
  22   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace core_privacy\local\request;
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The interface is used to describe a provider which is capable of identifying the users who have data within it.
  30   *
  31   * It describes data how these requests are serviced in a specific format.
  32   *
  33   * @package     core_privacy
  34   * @copyright   2018 Andrew Nicols <andrew@nicols.co.uk>
  35   */
  36  interface core_userlist_provider extends userlist_provider {
  37  
  38      /**
  39       * Get the list of users who have data within a context.
  40       *
  41       * @param   userlist    $userlist   The userlist containing the list of users who have data in this context/plugin combination.
  42       */
  43      public static function get_users_in_context(userlist $userlist);
  44  
  45      /**
  46       * Delete multiple users within a single context.
  47       *
  48       * @param   approved_userlist       $userlist The approved context and user information to delete information for.
  49       */
  50      public static function delete_data_for_users(approved_userlist $userlist);
  51  }