Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402]
Data provider.
Author: | Frédéric Massart <fred@branchup.tech> |
Copyright: | 2018 Frédéric Massart |
License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
File Size: | 414 lines (15 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
provider:: (9 methods):
get_metadata()
get_contexts_for_userid()
get_users_in_context()
export_user_data()
delete_data_for_all_users_in_context()
delete_data_for_user()
delete_data_for_users()
get_survey_id_from_context()
recordset_loop_and_export()
get_metadata(collection $collection) X-Ref |
Returns metadata. param: collection $collection The initialised collection to add items to. return: collection A listing of user data stored through this system. |
get_contexts_for_userid(int $userid) X-Ref |
Get the list of contexts that contain user information for the specified user. param: int $userid The user to search. return: contextlist $contextlist The contextlist containing the list of contexts used in this plugin. |
get_users_in_context(userlist $userlist) X-Ref |
Get the list of users who have data within a context. param: userlist $userlist The userlist containing the list of users who have data in this context/plugin combination. |
export_user_data(approved_contextlist $contextlist) X-Ref |
Export all user data for the specified user, in the specified contexts. param: approved_contextlist $contextlist The approved contexts to export information for. |
delete_data_for_all_users_in_context(context $context) X-Ref |
Delete all data for all users in the specified context. param: context $context The specific context to delete data for. |
delete_data_for_user(approved_contextlist $contextlist) X-Ref |
Delete all user data for the specified user, in the specified contexts. param: approved_contextlist $contextlist The approved contexts and user information to delete information for. |
delete_data_for_users(approved_userlist $userlist) X-Ref |
Delete multiple users within a single context. param: approved_userlist $userlist The approved context and user information to delete information for. |
get_survey_id_from_context(context_module $context) X-Ref |
Get a survey ID from its context. param: context_module $context The module context. return: int |
recordset_loop_and_export(\moodle_recordset $recordset, $splitkey, $initial,callable $reducer, callable $export) X-Ref |
Loop and export from a recordset. param: moodle_recordset $recordset The recordset. param: string $splitkey The record key to determine when to export. param: mixed $initial The initial data to reduce from. param: callable $reducer The function to return the dataset, receives current dataset, and the current record. param: callable $export The function to export the dataset, receives the last value from $splitkey and the dataset. return: void |