[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   * Privacy class for requesting user data.
  19   *
  20   * @package    core_plagiarism
  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  
  25  namespace core_plagiarism\privacy;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Provider for the plagiarism API.
  31   *
  32   * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  33   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  interface plagiarism_provider extends
  36          // The plagiarism_provider should be implemented by plugins which only provide information to a subsystem.
  37          \core_privacy\local\request\plugin\subsystem_provider {
  38  
  39      /**
  40       * Export all plagiarism data from each plagiarism plugin for the specified userid and context.
  41       *
  42       * @param   int         $userid The user to export.
  43       * @param   \context    $context The context to export.
  44       * @param   array       $subcontext The subcontext within the context to export this information to.
  45       * @param   array       $linkarray The weird and wonderful link array used to display information for a specific item
  46       */
  47      public static function export_plagiarism_user_data(int $userid, \context $context, array $subcontext, array $linkarray);
  48  
  49      /**
  50       * Delete all user information for the provided context.
  51       *
  52       * @param  \context $context The context to delete user data for.
  53       */
  54      public static function delete_plagiarism_for_context(\context $context);
  55  
  56      /**
  57       * Delete all user information for the provided user and context.
  58       *
  59       * @param  int      $userid    The user to delete
  60       * @param  \context $context   The context to refine the deletion.
  61       */
  62      public static function delete_plagiarism_for_user(int $userid, \context $context);
  63  }