Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Privacy Subsystem implementation for theme_boost.
 *
 * @package    theme_boost
 * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace theme_boost\privacy;

use \core_privacy\local\metadata\collection;

defined('MOODLE_INTERNAL') || die();

/**
 * The boost theme stores a user preference data.
 *
 * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class provider implements
    // This plugin has data.
    \core_privacy\local\metadata\provider,
    // This plugin has some sitewide user preferences to export.
    \core_privacy\local\request\user_preference_provider {

< /** The user preference for the navigation drawer. */ < const DRAWER_OPEN_NAV = 'drawer-open-nav'; <
/** The user preferences for the course index. */ const DRAWER_OPEN_INDEX = 'drawer-open-index'; /** The user preferences for the blocks drawer. */ const DRAWER_OPEN_BLOCK = 'drawer-open-block'; /** * Returns meta data about this system. * * @param collection $items The initialised item collection to add items to. * @return collection A listing of user data stored through this system. */ public static function get_metadata(collection $items) : collection {
< $items->add_user_preference(self::DRAWER_OPEN_NAV, 'privacy:metadata:preference:draweropennav');
$items->add_user_preference(self::DRAWER_OPEN_INDEX, 'privacy:metadata:preference:draweropenindex'); $items->add_user_preference(self::DRAWER_OPEN_BLOCK, 'privacy:metadata:preference:draweropenblock'); return $items; } /** * Store all user preferences for the plugin. * * @param int $userid The userid of the user whose data is to be exported. */ public static function export_user_preferences(int $userid) {
< $draweropennavpref = get_user_preferences(self::DRAWER_OPEN_NAV, null, $userid); < < if (isset($draweropennavpref)) { < $preferencestring = get_string('privacy:drawernavclosed', 'theme_boost'); < if ($draweropennavpref == 'true') { < $preferencestring = get_string('privacy:drawernavopen', 'theme_boost'); < } < \core_privacy\local\request\writer::export_user_preference( < 'theme_boost', < self::DRAWER_OPEN_NAV, < $draweropennavpref, < $preferencestring < ); < }
$draweropenindexpref = get_user_preferences(self::DRAWER_OPEN_INDEX, null, $userid); if (isset($draweropenindexpref)) { $preferencestring = get_string('privacy:drawerindexclosed', 'theme_boost'); if ($draweropenindexpref == 1) { $preferencestring = get_string('privacy:drawerindexopen', 'theme_boost'); } \core_privacy\local\request\writer::export_user_preference( 'theme_boost', self::DRAWER_OPEN_INDEX, $draweropenindexpref, $preferencestring ); } $draweropenblockpref = get_user_preferences(self::DRAWER_OPEN_BLOCK, null, $userid); if (isset($draweropenblockpref)) { $preferencestring = get_string('privacy:drawerblockclosed', 'theme_boost'); if ($draweropenblockpref == 1) { $preferencestring = get_string('privacy:drawerblockopen', 'theme_boost'); } \core_privacy\local\request\writer::export_user_preference( 'theme_boost', self::DRAWER_OPEN_BLOCK, $draweropenblockpref, $preferencestring ); } } }