[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   * Test provider which has issues.
  19   *
  20   * @package core_privacy
  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 mod_component_broken\privacy;
  26  
  27  use core_privacy\local\metadata\collection;
  28  use core_privacy\local\request\contextlist;
  29  use core_privacy\local\request\approved_contextlist;
  30  
  31  /**
  32   * Mock core_user_data_provider for unit tests.
  33   *
  34   * @package core_privacy
  35   * @copyright 2018 Andrew Nicols <andrew@nicols.co.uk>
  36   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class provider implements
  39          \core_privacy\local\metadata\provider,
  40          \core_privacy\local\request\plugin\provider {
  41  
  42      /**
  43       * Get metadata.
  44       *
  45       * @param   collection     $collection The initialised collection to add items to.
  46       * @return  collection     A listing of user data stored through this system.
  47       */
  48      public static function get_metadata(collection $collection) : collection {
  49          throw new \coding_exception(__FUNCTION__);
  50      }
  51  
  52      /**
  53       * Get the list of contexts that contain user information for the specified user.
  54       *
  55       * @param   int         $userid     The user to search.
  56       * @return  contextlist   $contextlist  The contextlist containing the list of contexts used in this plugin.
  57       */
  58      public static function get_contexts_for_userid(int $userid) : \core_privacy\local\request\contextlist {
  59          throw new \coding_exception(__FUNCTION__);
  60      }
  61  
  62      /**
  63       * Export all user data for the specified user, in the specified contexts.
  64       *
  65       * @param   approved_contextlist    $contextlist    The approved contexts to export information for.
  66       */
  67      public static function export_user_data(approved_contextlist $contextlist) {
  68          throw new \coding_exception(__FUNCTION__);
  69      }
  70  
  71      /**
  72       * Delete all data for all users in the specified context.
  73       *
  74       * @param   context                 $context   The specific context to delete data for.
  75       */
  76      public static function delete_data_for_all_users_in_context(\context $context) {
  77          throw new \coding_exception(__FUNCTION__);
  78      }
  79  
  80      /**
  81       * Delete all user data for the specified user, in the specified contexts.
  82       *
  83       * @param   approved_contextlist    $contextlist    The approved contexts and user information to delete information for.
  84       */
  85      public static function delete_data_for_user(approved_contextlist $contextlist) {
  86          throw new \coding_exception(__FUNCTION__);
  87      }
  88  }