[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 grading method interface.
  19   *
  20   * Grading method plugins should implement this if they store personal information.
  21   *
  22   * @deprecated since Moodle 3.6 MDL-62535 Please use the gradingform_provider_v2 interface
  23   * @todo MDL-63167 Remove this file.
  24   *
  25   * @package    core_grading
  26   * @copyright  2018 Sara Arjona <sara@moodle.com>
  27   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  28   */
  29  
  30  namespace core_grading\privacy;
  31  
  32  defined('MOODLE_INTERNAL') || die();
  33  
  34  use core_privacy\local\request\approved_contextlist;
  35  
  36  interface gradingform_provider extends
  37      \core_privacy\local\request\plugin\subsystem_provider,
  38      \core_privacy\local\deprecated {
  39  
  40      /**
  41       * This method is used to export any user data this sub-plugin has using the object to get the context and userid.
  42       *
  43       * @deprecated since Moodle 3.6 MDL-62535 Please use the methods in the gradingform_provider_v2 interface
  44       * @todo MDL-63167 Remove this file.
  45       *
  46       * @param \context $context Context owner of the data.
  47       * @param \stdClass $definition Grading definition entry to export.
  48       * @param  int $userid The user whose information is to be exported.
  49       *
  50       * @return \stdClass The data to export.
  51       */
  52      public static function get_gradingform_export_data(\context $context, $definition, int $userid);
  53  
  54      /**
  55       * Any call to this method should delete all user data for the context defined.
  56       *
  57       * @deprecated since Moodle 3.6 MDL-62535 Please use the methods in the gradingform_provider_v2 interface
  58       * @todo MDL-63167 Remove this file.
  59       *
  60       * @param \context $context Context owner of the data.
  61       */
  62      public static function delete_gradingform_for_context(\context $context);
  63  
  64      /**
  65       * A call to this method should delete user data (where practicle) from the userid and context.
  66       *
  67       * @deprecated since Moodle 3.6 MDL-62535 Please use the methods in the gradingform_provider_v2 interface
  68       * @todo MDL-63167 Remove this file.
  69       *
  70       * @param int $userid The user to delete.
  71       * @param \context $context the context to refine the deletion.
  72       */
  73      public static function delete_gradingform_for_userid(int $userid, \context $context);
  74  }