[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 quiz_overview..
  19   *
  20   * @package    quiz_overview
  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 quiz_overview\privacy;
  26  
  27  use \core_privacy\local\request\writer;
  28  use \core_privacy\local\request\transform;
  29  use \core_privacy\local\metadata\collection;
  30  use \core_privacy\manager;
  31  
  32  defined('MOODLE_INTERNAL') || die();
  33  
  34  /**
  35   * Privacy Subsystem implementation for quiz_overview..
  36   *
  37   * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  38   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39   */
  40  class provider implements
  41      \core_privacy\local\metadata\provider,
  42      \core_privacy\local\request\user_preference_provider {
  43  
  44      /**
  45       * Returns meta data about this system.
  46       *
  47       * @param   collection     $collection The initialised collection to add items to.
  48       * @return  collection     A listing of user data stored through this system.
  49       */
  50      public static function get_metadata(collection $collection) : collection {
  51          $collection->add_user_preference('quiz_overview_slotmarks', 'privacy:metadata:preference:quiz_overview_slotmarks');
  52  
  53          return $collection;
  54      }
  55  
  56      /**
  57       * Export all user preferences for the plugin.
  58       *
  59       * @param   int         $userid The userid of the user whose data is to be exported.
  60       */
  61      public static function export_user_preferences(int $userid) {
  62          $preference = get_user_preferences('quiz_overview_slotmarks', null, $userid);
  63          if (null !== $preference) {
  64              if (empty($preference)) {
  65                  $description = get_string('privacy:preference:slotmarks:no', 'quiz_overview');
  66              } else {
  67                  $description = get_string('privacy:preference:slotmarks:yes', 'quiz_overview');
  68              }
  69  
  70              writer::export_user_preference(
  71                  'quiz_overview',
  72                  'slotmarks',
  73                  transform::yesno($preference),
  74                  $description
  75              );
  76          }
  77      }
  78  }