forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-62218 analytics: Privacy API implementation
- Loading branch information
David Monllao
committed
May 3, 2018
1 parent
cee0641
commit 97b0a6c
Showing
9 changed files
with
1,037 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
Large diffs are not rendered by default.
Oops, something went wrong.
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,147 @@ | ||
<?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/>. | ||
|
||
/** | ||
* Test analyser | ||
* | ||
* @package core | ||
* @copyright 2017 David Monllao {@link http://www.davidmonllao.com} | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
/** | ||
* Test analyser | ||
* | ||
* @package core | ||
* @copyright 2017 David Monllao {@link http://www.davidmonllao.com} | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
class test_site_users_analyser extends \core_analytics\local\analyser\sitewide { | ||
|
||
/** | ||
* Samples origin is course table. | ||
* | ||
* @return string | ||
*/ | ||
public function get_samples_origin() { | ||
return 'user'; | ||
} | ||
|
||
/** | ||
* Returns the sample analysable | ||
* | ||
* @param int $sampleid | ||
* @return \core_analytics\analysable | ||
*/ | ||
public function get_sample_analysable($sampleid) { | ||
return new \core_analytics\site(); | ||
} | ||
|
||
/** | ||
* Data this analyer samples provide. | ||
* | ||
* @return string[] | ||
*/ | ||
protected function provided_sample_data() { | ||
return array('user'); | ||
} | ||
|
||
/** | ||
* Returns the sample context. | ||
* | ||
* @param int $sampleid | ||
* @return \context | ||
*/ | ||
public function sample_access_context($sampleid) { | ||
return \context_system::instance(); | ||
} | ||
|
||
/** | ||
* Returns all site courses. | ||
* | ||
* @param \core_analytics\analysable $site | ||
* @return array | ||
*/ | ||
protected function get_all_samples(\core_analytics\analysable $site) { | ||
global $DB; | ||
|
||
$users = $DB->get_records('user'); | ||
$userids = array_keys($users); | ||
$sampleids = array_combine($userids, $userids); | ||
|
||
$users = array_map(function($user) { | ||
return array('user' => $user); | ||
}, $users); | ||
|
||
return array($sampleids, $users); | ||
} | ||
|
||
/** | ||
* Return all complete samples data from sample ids. | ||
* | ||
* @param int[] $sampleids | ||
* @return array | ||
*/ | ||
public function get_samples($sampleids) { | ||
global $DB; | ||
|
||
list($userssql, $params) = $DB->get_in_or_equal($sampleids, SQL_PARAMS_NAMED); | ||
$users = $DB->get_records_select('user', "id {$userssql}", $params); | ||
$userids = array_keys($users); | ||
$sampleids = array_combine($userids, $userids); | ||
|
||
$users = array_map(function($user) { | ||
return array('user' => $user); | ||
}, $users); | ||
|
||
return array($sampleids, $users); | ||
} | ||
|
||
/** | ||
* Returns the description of a sample. | ||
* | ||
* @param int $sampleid | ||
* @param int $contextid | ||
* @param array $sampledata | ||
* @return array array(string, \renderable) | ||
*/ | ||
public function sample_description($sampleid, $contextid, $sampledata) { | ||
$description = fullname($samplesdata['user']); | ||
$userimage = new \pix_icon('i/user', get_string('user')); | ||
return array($description, $userimage); | ||
} | ||
|
||
/** | ||
* We need to delete associated data if a user requests his data to be deleted. | ||
* | ||
* @return bool | ||
*/ | ||
public function processes_user_data() { | ||
return true; | ||
} | ||
|
||
/** | ||
* Join the samples origin table with the user id table. | ||
* | ||
* @param string $sampletablealias | ||
* @return string | ||
*/ | ||
public function join_sample_user($sampletablealias) { | ||
return "JOIN {user} u ON u.id = {$sampletablealias}.sampleid"; | ||
} | ||
} |
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,60 @@ | ||
<?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/>. | ||
|
||
/** | ||
* Test target. | ||
* | ||
* @package core_analytics | ||
* @copyright 2017 David Monllaó {@link http://www.davidmonllao.com} | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
require_once(__DIR__ . '/test_target_shortname.php'); | ||
|
||
/** | ||
* Test target. | ||
* | ||
* @package core_analytics | ||
* @copyright 2018 David Monllaó {@link http://www.davidmonllao.com} | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
class test_target_course_users extends test_target_site_users { | ||
|
||
/** | ||
* get_analyser_class | ||
* | ||
* @return string | ||
*/ | ||
public function get_analyser_class() { | ||
return '\core\analytics\analyser\student_enrolments'; | ||
} | ||
|
||
/** | ||
* Returns a lang_string object representing the name for the indicator. | ||
* | ||
* Used as column identificator. | ||
* | ||
* If there is a corresponding '_help' string this will be shown as well. | ||
* | ||
* @return \lang_string | ||
*/ | ||
public static function get_name() : \lang_string { | ||
// Using a string that exists and contains a corresponding '_help' string. | ||
return new \lang_string('adminhelpedituser'); | ||
} | ||
} |
Oops, something went wrong.