mirror of
https://github.com/moodle/moodle.git
synced 2025-01-18 22:08:20 +01:00
1727c939ba
- Define sitepolicy handler manager class, base class and the core handler - Allow to set a plugin as sitepolicyhandler that implements the sitepolicy API - Modify web services to return information from the 3rd party handler instead of core if needed
78 lines
2.8 KiB
PHP
78 lines
2.8 KiB
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/>.
|
|
|
|
/**
|
|
* Mock handler for site policies
|
|
*
|
|
* @package core_privacy
|
|
* @copyright 2018 Marina Glancy
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Mock handler for site policies
|
|
*
|
|
* @package core_privacy
|
|
* @copyright 2018 Marina Glancy
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class mock_sitepolicy_handler extends \core_privacy\local\sitepolicy\handler {
|
|
|
|
/**
|
|
* Returns URL to redirect user to when user needs to agree to site policy
|
|
*
|
|
* This is a regular interactive page for web users. It should have normal Moodle header/footers, it should
|
|
* allow user to view policies and accept them.
|
|
*
|
|
* @param bool $forguests
|
|
* @return moodle_url|null (returns null if site policy is not defined)
|
|
*/
|
|
public static function get_redirect_url($forguests = false) {
|
|
return 'http://example.com/policy.php';
|
|
}
|
|
|
|
/**
|
|
* Returns URL of the site policy that needs to be displayed to the user (inside iframe or to use in WS such as mobile app)
|
|
*
|
|
* This page should not have any header/footer, it does not also have any buttons/checkboxes. The caller needs to implement
|
|
* the "Accept" button and call {@link self::accept()} on completion.
|
|
*
|
|
* @param bool $forguests
|
|
* @return moodle_url|null
|
|
*/
|
|
public static function get_embed_url($forguests = false) {
|
|
return 'http://example.com/view.htm';
|
|
}
|
|
|
|
/**
|
|
* Accept site policy for the current user
|
|
*
|
|
* @return bool - false if sitepolicy not defined, user is not logged in or user has already agreed to site policy;
|
|
* true - if we have successfully marked the user as agreed to the site policy
|
|
*/
|
|
public static function accept() {
|
|
global $USER, $DB;
|
|
// Accepts policy on behalf of the current user. We set it to 2 here to check that this callback was called.
|
|
$USER->policyagreed = 2;
|
|
if (!isguestuser()) {
|
|
$DB->update_record('user', ['policyagreed' => 2, 'id' => $USER->id]);
|
|
}
|
|
return true;
|
|
}
|
|
}
|