[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   * Logstore userlist provider interface.
  19   *
  20   * @package    tool_log
  21   * @copyright  2018 Adrian Greeve
  22   * @author     Adrian Greeve <adriangreeve.com>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  namespace tool_log\local\privacy;
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Logstore userlist provider interface.
  31   *
  32   * Logstore subplugins providers must implement this interface.
  33   *
  34   * @package    tool_log
  35   * @copyright  2018 Adrian Greeve
  36   * @author     Adrian Greeve <adriangreeve.com>
  37   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  38   */
  39  interface logstore_userlist_provider extends
  40          \core_privacy\local\request\plugin\subplugin_provider,
  41          \core_privacy\local\request\shared_userlist_provider
  42      {
  43  
  44      /**
  45       * Add user IDs that contain user information for the specified context.
  46       *
  47       * @param \core_privacy\local\request\userlist $userlist The userlist to add the users to.
  48       * @return void
  49       */
  50      public static function add_userids_for_context(\core_privacy\local\request\userlist $userlist);
  51  
  52  
  53      /**
  54       * Delete all data for a list of users in the specified context.
  55       *
  56       * @param \core_privacy\local\request\approved_userlist $userlist The specific context and users to delete data for.
  57       * @return void
  58       */
  59      public static function delete_data_for_userlist(\core_privacy\local\request\approved_userlist $userlist);
  60  }