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-61959 scormreport_objectives: Implement privacy API
- Loading branch information
Showing
3 changed files
with
182 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
<?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 scormreport_objectives. | ||
* | ||
* @package scormreport_objectives | ||
* @copyright 2018 Sara Arjona <sara@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
|
||
namespace scormreport_objectives\privacy; | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
use \core_privacy\local\metadata\collection; | ||
use \core_privacy\local\request\transform; | ||
use \core_privacy\local\request\writer; | ||
|
||
/** | ||
* Privacy Subsystem for scormreport_objectives. | ||
* | ||
* @copyright 2018 Sara Arjona <sara@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\user_preference_provider { | ||
|
||
/** | ||
* Returns meta data about this system. | ||
* | ||
* @param collection $collection 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 $collection) : collection { | ||
// User preferences shared between different scorm reports. | ||
$collection->add_user_preference('scorm_report_pagesize', 'privacy:metadata:preference:scorm_report_pagesize'); | ||
|
||
// User preferences specific for this scorm report. | ||
$collection->add_user_preference( | ||
'scorm_report_objectives_score', | ||
'privacy:metadata:preference:scorm_report_objectives_score' | ||
); | ||
|
||
return $collection; | ||
} | ||
|
||
/** | ||
* 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) { | ||
static::get_and_export_user_preference($userid, 'scorm_report_pagesize'); | ||
static::get_and_export_user_preference($userid, 'scorm_report_objectives_score', true); | ||
} | ||
|
||
/** | ||
* Get and export a user preference. | ||
* | ||
* @param int $userid The userid of the user whose data is to be exported. | ||
* @param string $userpreference The user preference to export. | ||
* @param boolean $transform If true, transform value to yesno. | ||
*/ | ||
protected static function get_and_export_user_preference(int $userid, string $userpreference, $transform = false) { | ||
$prefvalue = get_user_preferences($userpreference, null, $userid); | ||
if ($prefvalue !== null) { | ||
if ($transform) { | ||
$transformedvalue = transform::yesno($prefvalue); | ||
} else { | ||
$transformedvalue = $prefvalue; | ||
} | ||
writer::export_user_preference( | ||
'scormreport_objectives', | ||
$userpreference, | ||
$transformedvalue, | ||
get_string('privacy:metadata:preference:'.$userpreference, 'scormreport_objectives') | ||
); | ||
} | ||
} | ||
} |
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,85 @@ | ||
<?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/>. | ||
|
||
/** | ||
* Unit tests for the scormreport_objectives implementation of the privacy API. | ||
* | ||
* @package scormreport_objectives | ||
* @category test | ||
* @copyright 2018 Sara Arjona <sara@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
use core_privacy\local\request\writer; | ||
use scormreport_objectives\privacy\provider; | ||
|
||
/** | ||
* Unit tests for the scormreport_objectives implementation of the privacy API. | ||
* | ||
* @copyright 2018 Sara Arjona <sara@moodle.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
class scormreport_objectives_privacy_testcase extends \core_privacy\tests\provider_testcase { | ||
|
||
/** | ||
* Basic setup for these tests. | ||
*/ | ||
public function setUp() { | ||
$this->resetAfterTest(true); | ||
} | ||
|
||
/** | ||
* Ensure that export_user_preferences returns no data if the user has no data. | ||
*/ | ||
public function test_export_user_preferences_not_defined() { | ||
$user = \core_user::get_user_by_username('admin'); | ||
provider::export_user_preferences($user->id); | ||
|
||
$writer = writer::with_context(\context_system::instance()); | ||
$this->assertFalse($writer->has_any_data()); | ||
} | ||
|
||
/** | ||
* Ensure that export_user_preferences returns single preferences. | ||
*/ | ||
public function test_export_user_preferences_single() { | ||
// Define a user preference. | ||
$user = $this->getDataGenerator()->create_user(); | ||
$this->setUser($user); | ||
set_user_preference('scorm_report_pagesize', 50); | ||
set_user_preference('scorm_report_objectives_score', 1); | ||
|
||
// Validate exported data. | ||
provider::export_user_preferences($user->id); | ||
$context = \context_user::instance($user->id); | ||
$writer = writer::with_context($context); | ||
$this->assertTrue($writer->has_any_data()); | ||
$prefs = $writer->get_user_preferences('scormreport_objectives'); | ||
$this->assertCount(2, (array) $prefs); | ||
$this->assertEquals( | ||
get_string('privacy:metadata:preference:scorm_report_pagesize', 'scormreport_objectives'), | ||
$prefs->scorm_report_pagesize->description | ||
); | ||
$this->assertEquals(50, $prefs->scorm_report_pagesize->value); | ||
$this->assertEquals( | ||
get_string('privacy:metadata:preference:scorm_report_objectives_score', 'scormreport_objectives'), | ||
$prefs->scorm_report_objectives_score->description | ||
); | ||
$this->assertEquals(get_string('yes'), $prefs->scorm_report_objectives_score->value); | ||
} | ||
} |