Proyectos de Subversion Moodle

<?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_universe.
 *
 * @package    theme_universe
 * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace theme_universe\privacy;

use \core_privacy\local\metadata\collection;

/**
 * The universe 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 DARK_MODE_ON = 'darkmode-on';

    /** The user preference for the Course Filter. */
    const COURSE_FILTER_ON = 'coursefilter-on';

    /** The user preference for the sidebar. */
    const RIGHT_SIDEBAR_OPEN = 'sidepre-open';
    const COURSE_TAB2_OPEN = 'course-tab-open';
    /** 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::DARK_MODE_ON, 'privacy:metadata:preference:darkmodeon');
        $items->add_user_preference(self::COURSE_FILTER_ON, 'privacy:metadata:preference:coursefilteron');
        $items->add_user_preference(self::RIGHT_SIDEBAR_OPEN, 'privacy:metadata:preference:sidebaropen');
        $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) {
        
        // Dark Mode.
        $darkmodepref = get_user_preferences(self::DARK_MODE_ON, null, $userid);
        if (isset($darkmodepref)) {
            $preferencestring = get_string('privacy:darkmodeoff', 'theme_universe');
            if ($darkmodepref !== null) {
                $preferencestring = get_string('privacy:darkmodeon', 'theme_universe');
            }
            \core_privacy\local\request\writer::export_user_preference(
                'theme_universe',
                self::DARK_MODE_ON,
                $darkmodepref,
                $preferencestring
            );
        }

        // Course Filter.
        $coursefilterpref = get_user_preferences(self::COURSE_FILTER_ON, null, $userid);
        if (isset($coursefilterpref)) {
            $preferencestring = get_string('privacy:coursefilteroff', 'theme_universe');
            if ($coursefilterpref !== null) {
                $preferencestring = get_string('privacy:coursefilteron', 'theme_universe');
            }
            \core_privacy\local\request\writer::export_user_preference(
                'theme_universe',
                self::COURSE_FILTER_ON,
                $coursefilterpref,
                $preferencestring
            );
        }

        // Drawer Index.
        if (isset($draweropenindexpref)) {
            $preferencestring = get_string('privacy:drawerindexclosed', 'theme_universe');
            if ($draweropenindexpref == 1) {
                $preferencestring = get_string('privacy:drawerindexopen', 'theme_universe');
            }
            \core_privacy\local\request\writer::export_user_preference(
                'theme_universe',
                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_universe');
            if ($draweropenblockpref == 1) {
                $preferencestring = get_string('privacy:drawerblockopen', 'theme_universe');
            }
            \core_privacy\local\request\writer::export_user_preference(
                'theme_universe',
                self::DRAWER_OPEN_BLOCK,
                $draweropenblockpref,
                $preferencestring
            );
        }

        $rightdraweropennpref = get_user_preferences(self::RIGHT_SIDEBAR_OPEN, null, $userid);
        if (isset($rightdraweropennpref)) {
            $preferencestring = get_string('privacy:rightdrawerclosed', 'theme_universe');
            if ($rightdraweropennpref !== null) {
                $preferencestring = get_string('privacy:rightdraweropen', 'theme_universe');
            }
            \core_privacy\local\request\writer::export_user_preference(
                'theme_universe',
                self::RIGHT_SIDEBAR_OPEN,
                $rightdraweropennpref,
                $preferencestring
            );
        }
    }
}