Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
- Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
- PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/lib/classes/analytics/analyser/ -> users.php (source)
Users analyser (insights for users).
| Copyright: | 2019 David Monllao {@link http://www.davidmonllao.com} |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 192 lines (6 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
users:: (11 methods):
get_analysables_iterator()
one_sample_per_analysable()
get_samples_origin()
get_sample_analysable()
provided_sample_data()
sample_access_context()
get_all_samples()
get_samples()
sample_description()
processes_user_data()
join_sample_user()
Users analyser (insights for users).
| get_analysables_iterator(?string $action = null, array $contexts = []) X-Ref |
| The site users are the analysable elements returned by this analyser. return: \Iterator param: string|null $action 'prediction', 'training' or null if no specific action needed. param: \context[] $contexts Only analysables that depend on the provided contexts. All analysables in the system if empty. |
| one_sample_per_analysable() X-Ref |
| Just one sample per analysable. return: bool |
| get_samples_origin() X-Ref |
| Samples origin is user table. return: string |
| get_sample_analysable($sampleid) X-Ref |
| Returns the analysable of a sample return: \core_analytics\analysable param: int $sampleid |
| provided_sample_data() X-Ref |
| This provides samples' user and context. return: string[] |
| sample_access_context($sampleid) X-Ref |
| Returns the context of a sample. return: \context param: int $sampleid |
| get_all_samples(\core_analytics\analysable $user) X-Ref |
| This will return just one user as we analyse users separately. return: array param: \core_analytics\analysable $user |
| get_samples($sampleids) X-Ref |
| Returns samples data from sample ids. return: array param: int[] $sampleids |
| sample_description($sampleid, $contextid, $sampledata) X-Ref |
| Returns the description of a sample. return: array array(string, \renderable) param: int $sampleid param: int $contextid param: array $sampledata |
| processes_user_data() X-Ref |
| We need to delete associated data if a user requests his data to be deleted. return: bool |
| join_sample_user($sampletablealias) X-Ref |
| Join the samples origin table with the user id table. return: string param: string $sampletablealias |
