[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 using a fake plugin name.
  19   *
  20   * @package core_privacy
  21   * @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
  22   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_testcomponent4\privacy;
  26  
  27  use core_privacy\local\request\writer;
  28  
  29  /**
  30   * Mock core_user_data_provider for unit tests.
  31   * @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
  32   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33   */
  34  class provider implements \core_privacy\local\metadata\null_provider, \core_privacy\local\request\user_preference_provider {
  35  
  36      /**
  37       * Get the language string identifier with the component's language
  38       * file to explain why this plugin stores no data.
  39       *
  40       * @return  string
  41       */
  42      public static function get_reason() : string {
  43          return 'notimplemented';
  44      }
  45  
  46      /**
  47       * Export all user preferences for the plugin.
  48       *
  49       * @param   int         $userid The userid of the user whose data is to be exported.
  50       */
  51      public static function export_user_preferences(int $userid) {
  52          writer::export_user_preference('mod_testcomponent4', 'mykey', 'myvalue', 'mydescription');
  53      }
  54  }