[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 assignsubmission_user_provider interface.
  19   *
  20   * Assignment Sub plugins should implement this if they store personal information and can retrieve a userid.
  21   *
  22   * @package mod_assign
  23   * @copyright 2018 Adrian Greeve <adrian@moodle.com>
  24   *
  25   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  26   */
  27  namespace mod_assign\privacy;
  28  
  29  use core_privacy\local\request\userlist;
  30  
  31  defined('MOODLE_INTERNAL') || die();
  32  
  33  interface assignsubmission_user_provider extends
  34          \core_privacy\local\request\plugin\subplugin_provider,
  35          \core_privacy\local\request\shared_userlist_provider
  36      {
  37  
  38      /**
  39       * If you have tables that contain userids and you can generate entries in your tables without creating an
  40       * entry in the assign_submission table then please fill in this method.
  41       *
  42       * @param  userlist $userlist The userlist object
  43       */
  44      public static function get_userids_from_context(userlist $userlist);
  45  
  46      /**
  47       * Deletes all submissions for the submission ids / userids provided in a context.
  48       * assign_plugin_request_data contains:
  49       * - context
  50       * - assign object
  51       * - submission ids (pluginids)
  52       * - user ids
  53       * @param  assign_plugin_request_data $deletedata A class that contains the relevant information required for deletion.
  54       */
  55      public static function delete_submissions(assign_plugin_request_data $deletedata);
  56  
  57  }