[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 Subsystem implementation for cachestore_mongodb.
  19   *
  20   * @package    cachestore_mongodb
  21   * @category   privacy
  22   * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  namespace cachestore_mongodb\privacy;
  27  
  28  use core_privacy\local\metadata\collection;
  29  use core_privacy\local\request\approved_contextlist;
  30  use core_privacy\local\request\approved_userlist;
  31  use core_privacy\local\request\contextlist;
  32  use core_privacy\local\request\userlist;
  33  
  34  defined('MOODLE_INTERNAL') || die();
  35  
  36  /**
  37   * Privacy Subsystem for cachestore_mongodb.
  38   *
  39   * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  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\plugin\provider,
  45          \core_privacy\local\request\core_userlist_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('mongodb', [
  55                  'data' => 'privacy:metadata:mongodb:data',
  56              ], 'privacy:metadata:mongodb');
  57          return $collection;
  58      }
  59  
  60      /**
  61       * Get the list of contexts that contain user information for the specified user.
  62       *
  63       * @param   int         $userid     The user to search.
  64       * @return  contextlist $contextlist  The contextlist containing the list of contexts used in this plugin.
  65       */
  66      public static function get_contexts_for_userid(int $userid) : contextlist {
  67          return new contextlist();
  68      }
  69  
  70      /**
  71       * Get the list of users who have data within a context.
  72       *
  73       * @param   userlist    $userlist   The userlist containing the list of users who have data in this context/plugin combination.
  74       */
  75      public static function get_users_in_context(userlist $userlist) {
  76      }
  77  
  78      /**
  79       * Export all user data for the specified user, in the specified contexts.
  80       *
  81       * @param approved_contextlist $contextlist The approved contexts to export information for.
  82       */
  83      public static function export_user_data(approved_contextlist $contextlist) {
  84      }
  85  
  86      /**
  87       * Delete all use data which matches the specified deletion_criteria.
  88       *
  89       * @param \context $context A user context.
  90       */
  91      public static function delete_data_for_all_users_in_context(\context $context) {
  92      }
  93  
  94      /**
  95       * Delete all user data for the specified user, in the specified contexts.
  96       *
  97       * @param   approved_contextlist    $contextlist    The approved contexts and user information to delete information for.
  98       */
  99      public static function delete_data_for_user(approved_contextlist $contextlist) {
 100      }
 101  
 102      /**
 103       * Delete multiple users within a single context.
 104       *
 105       * @param   approved_userlist       $userlist The approved context and user information to delete information for.
 106       */
 107      public static function delete_data_for_users(approved_userlist $userlist) {
 108      }
 109  }