mirrored from git://git.moodle.org/moodle.git
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-61819 core_editor: Implement core provider
- Loading branch information
1 parent
8f52e5f
commit 8c9880c
Showing
3 changed files
with
152 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
<?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 class for requesting user data. | ||
* | ||
* @package core_editor | ||
* @copyright 2018 Andrew Nicols <andrew@nicols.co.uk> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
|
||
namespace core_editor\privacy; | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
use \core_privacy\local\metadata\collection; | ||
use core_privacy\local\request\writer; | ||
|
||
/** | ||
* Provider for the editor API. | ||
* | ||
* @copyright 2018 Andrew Nicols <andrew@nicols.co.uk> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
class provider implements | ||
// The Editor subsystem does not store any data itself. | ||
// It has no database tables, and it purely acts as a conduit to the various editors. | ||
\core_privacy\local\metadata\provider, | ||
|
||
// The Editor subsystem has user preferences. | ||
\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('htmleditor', 'privacy:metadata:preference:htmleditor'); | ||
|
||
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) { | ||
$preference = get_user_preferences('htmleditor'); | ||
if (null !== $preference) { | ||
$desc = get_string('privacy:preference:htmleditor', 'core_editor', | ||
get_string('pluginname', "editor_{$preference}")); | ||
writer::export_user_preference('core_editor', 'htmleditor', $preference, $desc); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
<?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 provider tests. | ||
* | ||
* @package core_editor | ||
* @copyright 2018 Andrew Nicols <andrew@nicols.co.uk> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
|
||
use core_privacy\local\metadata\collection; | ||
use core_privacy\local\request\writer; | ||
use core_editor\privacy\provider; | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
/** | ||
* Privacy provider tests class. | ||
* | ||
* @package core_editor | ||
* @copyright 2018 Andrew Nicols <andrew@nicols.co.uk> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
class core_editor_privacy_provider_testcase extends \core_privacy\tests\provider_testcase { | ||
/** | ||
* When no preference exists, there should be no export. | ||
*/ | ||
public function test_no_preference() { | ||
global $USER; | ||
$this->resetAfterTest(); | ||
$this->setAdminUser(); | ||
|
||
provider::export_user_preferences($USER->id); | ||
$this->assertFalse(writer::with_context(\context_system::instance())->has_any_data()); | ||
} | ||
|
||
/** | ||
* When an editor is set, the name of that editor will be reported. | ||
*/ | ||
public function test_editor_atto() { | ||
global $USER; | ||
$this->resetAfterTest(); | ||
$this->setAdminUser(); | ||
|
||
set_user_preference('htmleditor', 'atto'); | ||
|
||
provider::export_user_preferences($USER->id); | ||
$this->assertTrue(writer::with_context(\context_system::instance())->has_any_data()); | ||
|
||
$prefs = writer::with_context(\context_system::instance())->get_user_preferences('core_editor'); | ||
$this->assertNotEmpty($prefs->htmleditor); | ||
$this->assertNotEmpty($prefs->htmleditor->value); | ||
$this->assertNotEmpty($prefs->htmleditor->description); | ||
$this->assertEquals('atto', $prefs->htmleditor->value); | ||
|
||
$this->assertEquals( | ||
get_string( | ||
'privacy:preference:htmleditor', | ||
'core_editor', | ||
get_string('pluginname', "editor_atto") | ||
), | ||
$prefs->htmleditor->description | ||
); | ||
} | ||
} |