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 repository_wikimedia.

 *

 * @package    repository_wikimedia

 * @copyright  2018 Zig Tan <zig@moodle.com>

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

namespace repository_wikimedia\privacy;

use core_privacy\local\metadata\collection;

use core_privacy\local\request\approved_contextlist;

use core_privacy\local\request\approved_userlist;

use core_privacy\local\request\context;

use core_privacy\local\request\contextlist;

use core_privacy\local\request\userlist;

use core_privacy\local\request\writer;

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

/**

 * Privacy Subsystem for repository_wikimedia implementing metadata and plugin providers.

 *

 * @copyright  2018 Zig Tan <zig@moodle.com>

 * @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\core_userlist_provider,

    \core_privacy\local\request\plugin\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_external_location_link(

            'wikimedia.org',

            [

                'search_text' => 'privacy:metadata:repository_wikimedia:search_text'

            ],

            'privacy:metadata:repository_wikimedia'

        );

        $collection->add_user_preference(

            'repository_wikimedia_maxwidth',

            'privacy:metadata:repository_wikimedia:preference:maxwidth'

        );

        $collection->add_user_preference(

            'repository_wikimedia_maxheight',

            'privacy:metadata:repository_wikimedia:preference:maxheight'

        );

        return $collection;

    }

    /**

     * Get the list of contexts that contain user information for the specified user.

     *

     * @param   int $userid The user to search.

     * @return  contextlist   $contextlist  The contextlist containing the list of contexts used in this plugin.

     */

    public static function get_contexts_for_userid(int $userid): contextlist {

        return new contextlist();

    }

    /**

     * Get the list of users who have data within a context.

     *

     * @param   userlist    $userlist   The userlist containing the list of users who have data in this context/plugin combination.

     */

    public static function get_users_in_context(userlist $userlist) {

    }

    /**

     * Export all user data for the specified user, in the specified contexts.

     *

     * @param   approved_contextlist $contextlist The approved contexts to export information for.

     */

    public static function export_user_data(approved_contextlist $contextlist) {

    }

    /**

     * Delete all data for all users in the specified context.

     *

     * @param   context $context The specific context to delete data for.

     */

    public static function delete_data_for_all_users_in_context(\context $context) {

    }

    /**

     * Delete all user data for the specified user, in the specified contexts.

     *

     * @param   approved_contextlist $contextlist The approved contexts and user information to delete information for.

     */

    public static function delete_data_for_user(approved_contextlist $contextlist) {

    }

    /**

     * Delete multiple users within a single context.

     *

     * @param   approved_userlist       $userlist The approved context and user information to delete information for.

     */

    public static function delete_data_for_users(approved_userlist $userlist) {

    }

    /**

     * 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) {

        $maxwidth = get_user_preferences('repository_wikimedia_maxwidth', null, $userid);

        if ($maxwidth !== null) {

            writer::export_user_preference(

                'repository_wikimedia',

                'repository_wikimedia_maxwidth',

                $maxwidth,

                get_string('privacy:metadata:repository_wikimedia:preference:maxwidth', 'repository_wikimedia')

            );

        }

        $maxheight = get_user_preferences('repository_wikimedia_maxheight', null, $userid);

        if ($maxheight !== null) {

            writer::export_user_preference(

                'repository_wikimedia',

                'repository_wikimedia_maxheight',

                $maxheight,

                get_string('privacy:metadata:repository_wikimedia:preference:maxheight', 'repository_wikimedia')

            );

        }

    }

}