[Summary view]

Differences Between: [Versions 310 and 400] [Versions 311 and 400] [Versions 39 and 400] [Versions 400 and 401] [Versions 400 and 402] [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 preference for the navigation drawer. */
  44      const DRAWER_OPEN_NAV = 'drawer-open-nav';
  45  
  46      /** The user preferences for the course index. */
  47      const DRAWER_OPEN_INDEX = 'drawer-open-index';
  48  
  49      /** The user preferences for the blocks drawer. */
  50      const DRAWER_OPEN_BLOCK = 'drawer-open-block';
  51  
  52      /**
  53       * Returns meta data about this system.
  54       *
  55       * @param  collection $items The initialised item collection to add items to.
  56       * @return collection A listing of user data stored through this system.
  57       */
  58      public static function get_metadata(collection $items) : collection {
  59          $items->add_user_preference(self::DRAWER_OPEN_NAV, 'privacy:metadata:preference:draweropennav');
  60          $items->add_user_preference(self::DRAWER_OPEN_INDEX, 'privacy:metadata:preference:draweropenindex');
  61          $items->add_user_preference(self::DRAWER_OPEN_BLOCK, 'privacy:metadata:preference:draweropenblock');
  62          return $items;
  63      }
  64  
  65      /**
  66       * Store all user preferences for the plugin.
  67       *
  68       * @param int $userid The userid of the user whose data is to be exported.
  69       */
  70      public static function export_user_preferences(int $userid) {
  71          $draweropennavpref = get_user_preferences(self::DRAWER_OPEN_NAV, null, $userid);
  72  
  73          if (isset($draweropennavpref)) {
  74              $preferencestring = get_string('privacy:drawernavclosed', 'theme_boost');
  75              if ($draweropennavpref == 'true') {
  76                  $preferencestring = get_string('privacy:drawernavopen', 'theme_boost');
  77              }
  78              \core_privacy\local\request\writer::export_user_preference(
  79                  'theme_boost',
  80                  self::DRAWER_OPEN_NAV,
  81                  $draweropennavpref,
  82                  $preferencestring
  83              );
  84          }
  85  
  86          $draweropenindexpref = get_user_preferences(self::DRAWER_OPEN_INDEX, null, $userid);
  87  
  88          if (isset($draweropenindexpref)) {
  89              $preferencestring = get_string('privacy:drawerindexclosed', 'theme_boost');
  90              if ($draweropenindexpref == 1) {
  91                  $preferencestring = get_string('privacy:drawerindexopen', 'theme_boost');
  92              }
  93              \core_privacy\local\request\writer::export_user_preference(
  94                  'theme_boost',
  95                  self::DRAWER_OPEN_INDEX,
  96                  $draweropenindexpref,
  97                  $preferencestring
  98              );
  99          }
 100  
 101          $draweropenblockpref = get_user_preferences(self::DRAWER_OPEN_BLOCK, null, $userid);
 102  
 103          if (isset($draweropenblockpref)) {
 104              $preferencestring = get_string('privacy:drawerblockclosed', 'theme_boost');
 105              if ($draweropenblockpref == 1) {
 106                  $preferencestring = get_string('privacy:drawerblockopen', 'theme_boost');
 107              }
 108              \core_privacy\local\request\writer::export_user_preference(
 109                  'theme_boost',
 110                  self::DRAWER_OPEN_BLOCK,
 111                  $draweropenblockpref,
 112                  $preferencestring
 113              );
 114          }
 115      }
 116  }