Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

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

Defines 1 class


Class: provider  - X-Ref

Data provider class.

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_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.

param: stdClass $user
param: \context $context
param: int $pageid
param: bool $onlyforthisuser
return: array

text_has_files($str)   X-Ref
Check if text has embedded files

param: string $str
return: bool

export_used_files($context, $subwikiid, $alltexts)   X-Ref
Analyze which files are used in the texts and export

param: context $context
param: int $subwikiid
param: string $alltexts
return: int|void

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.