[Summary view]

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403]

   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 theme_boost.
  19   *
  20   * @package    theme_boost
  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 theme_boost\privacy;
  26  
  27  use \core_privacy\local\metadata\collection;
  28  
  29  defined('MOODLE_INTERNAL') || die();
  30  
  31  /**
  32   * The boost theme stores a user preference data.
  33   *
  34   * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  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 preferences for the course index. */
  44      const DRAWER_OPEN_INDEX = 'drawer-open-index';
  45  
  46      /** The user preferences for the blocks drawer. */
  47      const DRAWER_OPEN_BLOCK = 'drawer-open-block';
  48  
  49      /**
  50       * Returns meta data about this system.
  51       *
  52       * @param  collection $items The initialised item collection to add items to.
  53       * @return collection A listing of user data stored through this system.
  54       */
  55      public static function get_metadata(collection $items) : collection {
  56          $items->add_user_preference(self::DRAWER_OPEN_INDEX, 'privacy:metadata:preference:draweropenindex');
  57          $items->add_user_preference(self::DRAWER_OPEN_BLOCK, 'privacy:metadata:preference:draweropenblock');
  58          return $items;
  59      }
  60  
  61      /**
  62       * Store all user preferences for the plugin.
  63       *
  64       * @param int $userid The userid of the user whose data is to be exported.
  65       */
  66      public static function export_user_preferences(int $userid) {
  67  
  68          $draweropenindexpref = get_user_preferences(self::DRAWER_OPEN_INDEX, null, $userid);
  69  
  70          if (isset($draweropenindexpref)) {
  71              $preferencestring = get_string('privacy:drawerindexclosed', 'theme_boost');
  72              if ($draweropenindexpref == 1) {
  73                  $preferencestring = get_string('privacy:drawerindexopen', 'theme_boost');
  74              }
  75              \core_privacy\local\request\writer::export_user_preference(
  76                  'theme_boost',
  77                  self::DRAWER_OPEN_INDEX,
  78                  $draweropenindexpref,
  79                  $preferencestring
  80              );
  81          }
  82  
  83          $draweropenblockpref = get_user_preferences(self::DRAWER_OPEN_BLOCK, null, $userid);
  84  
  85          if (isset($draweropenblockpref)) {
  86              $preferencestring = get_string('privacy:drawerblockclosed', 'theme_boost');
  87              if ($draweropenblockpref == 1) {
  88                  $preferencestring = get_string('privacy:drawerblockopen', 'theme_boost');
  89              }
  90              \core_privacy\local\request\writer::export_user_preference(
  91                  'theme_boost',
  92                  self::DRAWER_OPEN_BLOCK,
  93                  $draweropenblockpref,
  94                  $preferencestring
  95              );
  96          }
  97      }
  98  }