[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 block_accessreview.
  19   *
  20   * @package    block_accessreview
  21   * @copyright  2020 Brickfield Education Labs, www.brickfield.ie
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace block_accessreview\privacy;
  26  
  27  use \core_privacy\local\metadata\collection;
  28  
  29  defined('MOODLE_INTERNAL') || die();
  30  
  31  /**
  32   * The accessreview block stores a user preference data.
  33   *
  34   * @copyright  2020 Brickfield Education Labs, www.brickfield.ie
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class provider implements
  38      // This plugin has data.
  39      \core_privacy\local\metadata\provider,
  40      // This plugin has some sitewide user preferences to export.
  41      \core_privacy\local\request\user_preference_provider {
  42  
  43      /** The user preference for the toggle state. */
  44      const TOGGLE_STATE = 'block_accessreviewtogglestate';
  45  
  46      /**
  47       * Returns meta data about this system.
  48       *
  49       * @param  collection $items The initialised item collection to add items to.
  50       * @return collection A listing of user data stored through this system.
  51       */
  52      public static function get_metadata(collection $items) : collection {
  53          $items->add_user_preference(self::TOGGLE_STATE, 'privacy:metadata:preference:block_accessreviewtogglestate');
  54          return $items;
  55      }
  56  
  57      /**
  58       * Store all user preferences for the plugin.
  59       *
  60       * @param int $userid The userid of the user whose data is to be exported.
  61       */
  62      public static function export_user_preferences(int $userid) {
  63          $togglestate = get_user_preferences(self::TOGGLE_STATE, null, $userid);
  64  
  65          if (isset($togglestate)) {
  66              $preferencestring = get_string('privacy:togglestateoff', 'block_accessreview');
  67              if ($togglestate == true) {
  68                  $preferencestring = get_string('privacy:togglestateon', 'block_accessreview');
  69              }
  70              \core_privacy\local\request\writer::export_user_preference(
  71                  'block_accessreview',
  72                  self::TOGGLE_STATE,
  73                  ($togglestate) ? 'On' : 'Off',
  74                  $preferencestring
  75              );
  76          }
  77      }
  78  }