[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    fileconverter_googledrive
  21   * @copyright  2018 Mihail Geshoski <mihail@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace fileconverter_googledrive\privacy;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  use \core_privacy\local\metadata\collection;
  30  use \core_privacy\local\request\contextlist;
  31  use \core_privacy\local\request\approved_contextlist;
  32  use \core_privacy\local\request\userlist;
  33  use \core_privacy\local\request\approved_userlist;
  34  
  35  /**
  36   * Privacy class for requesting user data.
  37   *
  38   * @package    fileconverter_googledrive
  39   * @copyright  2018 Mihail Geshoski <mihail@moodle.com>
  40   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class provider implements
  43          \core_privacy\local\metadata\provider,
  44          \core_privacy\local\request\core_userlist_provider,
  45          \core_privacy\local\request\plugin\provider {
  46  
  47      /**
  48       * Returns meta data about this system.
  49       *
  50       * @param   collection $collection The initialised collection to add items to.
  51       * @return  collection A listing of user data stored through this system.
  52       */
  53      public static function get_metadata(collection $collection) : collection {
  54          $collection->add_external_location_link('googledrive', [
  55              'params' => 'privacy:metadata:fileconverter_googledrive:params',
  56              'filecontent' => 'privacy:metadata:fileconverter_googledrive:filecontent',
  57              'filemimetype' => 'privacy:metadata:fileconverter_googledrive:filemimetype',
  58          ], 'privacy:metadata:fileconverter_googledrive:externalpurpose');
  59          return $collection;
  60      }
  61  
  62      /**
  63       * Get the list of contexts that contain user information for the specified user.
  64       *
  65       * @param   int         $userid     The user to search.
  66       * @return  contextlist $contextlist  The contextlist containing the list of contexts used in this plugin.
  67       */
  68      public static function get_contexts_for_userid(int $userid) : contextlist {
  69          $contextlist = new contextlist();
  70          return $contextlist;
  71      }
  72  
  73      /**
  74       * Get the list of users who have data within a context.
  75       *
  76       * @param   userlist    $userlist   The userlist containing the list of users who have data in this context/plugin combination.
  77       */
  78      public static function get_users_in_context(userlist $userlist) {
  79      }
  80  
  81      /**
  82       * Export all user data for the specified user, in the specified contexts.
  83       *
  84       * @param approved_contextlist $contextlist The approved contexts to export information for.
  85       */
  86      public static function export_user_data(approved_contextlist $contextlist) {
  87      }
  88  
  89      /**
  90       * Delete all use data which matches the specified deletion_criteria.
  91       *
  92       * @param \context $context A user context.
  93       */
  94      public static function delete_data_for_all_users_in_context(\context $context) {
  95      }
  96  
  97      /**
  98       * Delete multiple users within a single context.
  99       *
 100       * @param   approved_userlist       $userlist The approved context and user information to delete information for.
 101       */
 102      public static function delete_data_for_users(approved_userlist $userlist) {
 103      }
 104  
 105      /**
 106       * Delete all user data for the specified user, in the specified contexts.
 107       *
 108       * @param   approved_contextlist    $contextlist    The approved contexts and user information to delete information for.
 109       */
 110      public static function delete_data_for_user(approved_contextlist $contextlist) {
 111      }
 112  }