Data provider.
Copyright: | 2018 Marina Glancy |
License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
File Size: | 632 lines (29 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
provider:: (11 methods):
get_metadata()
get_contexts_for_userid()
get_users_in_context()
export_subwiki()
get_page_comments()
text_has_files()
export_used_files()
export_user_data()
delete_data_for_all_users_in_context()
delete_data_for_user()
delete_data_for_users()
get_metadata(collection $collection) X-Ref |
Returns metadata. return: collection A listing of user data stored through this system. param: collection $collection The initialised collection to add items to. |
get_contexts_for_userid(int $userid) X-Ref |
Get the list of contexts that contain user information for the specified user. return: contextlist $contextlist The contextlist containing the list of contexts used in this plugin. param: int $userid The user to search. |
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_subwiki($user, context $context, $subwiki, $wikimode) X-Ref |
Add one subwiki to the export Each page is added as related data because all pages in one subwiki share the same filearea param: stdClass $user param: context $context param: array $subwiki param: string $wikimode |
get_page_comments($user, \context $context, $pageid, $onlyforthisuser = true) X-Ref |
Retrieves page comments We can not use \core_comment\privacy\provider::export_comments() because it expects each item to have a separate subcontext and we store wiki pages as related data to subwiki because the files are shared between pages. return: array param: stdClass $user param: \context $context param: int $pageid param: bool $onlyforthisuser |
text_has_files($str) X-Ref |
Check if text has embedded files return: bool param: string $str |
export_used_files($context, $subwikiid, $alltexts) X-Ref |
Analyze which files are used in the texts and export return: int|void param: context $context param: int $subwikiid param: string $alltexts |
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. |