provider.php

<?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/>.

/**
 * Theme Boost Campus - Privacy provider
 *
 * @package    theme_boost_campus
 * @copyright  2018 Alexander Bias, Ulm University <alexander.bias@uni-ulm.de>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace theme_boost_campus\privacy;

use \core_privacy\local\metadata\collection;
use core_privacy\local\request\writer;

/**
 * Privacy Subsystem implementing provider.
 *
 * @package    theme_boost_campus
 * @copyright  2020 Kathrin Osswald, Ulm University <kathrin.osswald@uni-ulm.de>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class provider implements \core_privacy\local\metadata\provider,
        \core_privacy\local\request\user_preference_provider {

    /**
     * Returns meta data about this system.
     *
     * @param collection $collection The initialised collection to add items to.
     * @return collection A listing of user data stored through this system.
     */
    public static function get_metadata(collection $collection) : collection {
        $collection->add_user_preference('theme_boost_campus_infobanner_dismissed',
                'privacy:metadata:preference:infobanner_dismissed');

        return $collection;
    }

    /**
     * Export 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) {
        $infobannerpref = get_user_preferences('theme_boost_campus_infobanner_dismissed', null, $userid);
        if ($infobannerpref !== null) {
            switch ($infobannerpref) {
                case 0:
                default:
                    $infobannerprefdesc = get_string('privacy:metadata:request:infobanner_dismissed_no',
                            'theme_boost_campus');
                    break;
                case 1:
                    $infobannerprefdesc = get_string('privacy:metadata:request:infobanner_dismissed_yes',
                            'theme_boost_campus');
                    break;
            }
            writer::export_user_preference('theme_boost_campus', 'theme_boost_campus_infobanner_dismissed',
                    $infobannerpref, $infobannerprefdesc);
        }
    }
}