Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Static Public Member Functions | Static Protected Member Functions | List of all members
mod_wiki\privacy\provider Class Reference

Data provider class. More...

Inheritance diagram for mod_wiki\privacy\provider:
core_privacy\local\metadata\provider core_privacy\local\request\core_userlist_provider core_privacy\local\request\plugin\provider core_privacy\local\request\userlist_provider core_privacy\local\request\core_user_data_provider core_privacy\local\request\core_data_provider core_privacy\local\request\data_provider

Static Public Member Functions

static delete_data_for_all_users_in_context (\context $context)
 Delete all data for all users in the specified context. More...
 
static delete_data_for_all_users_in_context (context $context)
 Delete all data for all users in the specified context. More...
 
static delete_data_for_user (approved_contextlist $contextlist)
 Delete all user data for the specified user, in the specified contexts. More...
 
static delete_data_for_users (approved_userlist $userlist)
 Delete multiple users within a single context. More...
 
static export_user_data (approved_contextlist $contextlist)
 Export all user data for the specified user, in the specified contexts. More...
 
static get_contexts_for_userid (int $userid)
 Get the list of contexts that contain user information for the specified user. More...
 
static get_metadata (collection $collection)
 Returns metadata. More...
 
static get_users_in_context (userlist $userlist)
 Get the list of users who have data within a context. More...
 

Static Protected Member Functions

static export_subwiki ($user, context $context, $subwiki, $wikimode)
 Add one subwiki to the export. More...
 
static export_used_files ($context, $subwikiid, $alltexts)
 Analyze which files are used in the texts and export. More...
 
static get_page_comments ($user, context $context, $pageid, $onlyforthisuser=true)
 Retrieves page comments. More...
 
static text_has_files ($str)
 Check if text has embedded files. More...
 

Detailed Description

Data provider class.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ delete_data_for_all_users_in_context() [1/2]

static core_privacy\local\request\core_user_data_provider::delete_data_for_all_users_in_context ( \context  $context)
staticinherited

Delete all data for all users in the specified context.

Parameters
context$contextThe specific context to delete data for.

Implemented in profilefield_textarea\privacy\provider, profilefield_text\privacy\provider, profilefield_menu\privacy\provider, profilefield_datetime\privacy\provider, profilefield_checkbox\privacy\provider, core_user\privacy\provider, core_tag\privacy\provider, search_solr\privacy\provider, search_simpledb\privacy\provider, core_rss\privacy\provider, repository_youtube\privacy\provider, repository_wikimedia\privacy\provider, repository_picasa\privacy\provider, repository_onedrive\privacy\provider, repository_merlot\privacy\provider, repository_googledocs\privacy\provider, repository_flickr_public\privacy\provider, repository_flickr\privacy\provider, repository_dropbox\privacy\provider, core_repository\privacy\provider, repository_boxnet\privacy\provider, report_stats\privacy\provider, core_question\privacy\provider, core_portfolio\privacy\provider, core_notes\privacy\provider, mod_workshop\privacy\provider, mod_scorm\privacy\provider, mod_quiz\privacy\provider, ltiservice_memberships\privacy\provider, ltiservice_gradebookservices\privacy\provider, ltiservice_basicoutcomes\privacy\provider, mod_lti\privacy\provider, mod_glossary\privacy\provider, mod_forum\privacy\provider, mod_feedback\privacy\provider, mod_data\privacy\provider, mod_choice\privacy\provider, mod_assignment\privacy\provider, mod_assign\privacy\provider, mnetservice_enrol\privacy\provider, message_jabber\privacy\provider, message_email\privacy\provider, message_airnotifier\privacy\provider, core_message\privacy\provider, editor_atto\privacy\provider, core\privacy\provider, core_group\privacy\provider, core_grading\privacy\provider, fileconverter_googledrive\privacy\provider, core_files\privacy\provider, enrol_paypal\privacy\provider, enrol_meta\privacy\provider, enrol_lti\privacy\provider, enrol_flatfile\privacy\provider, enrol_cohort\privacy\provider, core_enrol\privacy\provider, core_course\privacy\provider, core_cohort\privacy\provider, core_calendar\privacy\provider, cachestore_session\privacy\provider, cachestore_redis\privacy\provider, cachestore_mongodb\privacy\provider, cachestore_memcached\privacy\provider, block_tag_flickr\privacy\provider, block_rss_client\privacy\provider, block_recentlyaccesseditems\privacy\provider, block_recent_activity\privacy\provider, block_html\privacy\provider, block_comments\privacy\provider, core_backup\privacy\provider, auth_oauth2\privacy\provider, auth_mnet\privacy\provider, core_analytics\privacy\provider, tool_policy\privacy\provider, tool_monitor\privacy\provider, tool_mobile\privacy\provider, tool_cohortroles\privacy\provider, and core_role\privacy\provider.

◆ delete_data_for_all_users_in_context() [2/2]

static mod_wiki\privacy\provider::delete_data_for_all_users_in_context ( context  $context)
static

Delete all data for all users in the specified context.

Parameters
context$contextThe specific context to delete data for.

◆ delete_data_for_user()

static mod_wiki\privacy\provider::delete_data_for_user ( approved_contextlist  $contextlist)
static

Delete all user data for the specified user, in the specified contexts.

Parameters
approved_contextlist$contextlistThe approved contexts and user information to delete information for.

Implements core_privacy\local\request\core_user_data_provider.

◆ delete_data_for_users()

static mod_wiki\privacy\provider::delete_data_for_users ( approved_userlist  $userlist)
static

Delete multiple users within a single context.

Parameters
approved_userlist$userlistThe approved context and user information to delete information for.

Implements core_privacy\local\request\core_userlist_provider.

◆ export_subwiki()

static mod_wiki\privacy\provider::export_subwiki (   $user,
context  $context,
  $subwiki,
  $wikimode 
)
staticprotected

Add one subwiki to the export.

Each page is added as related data because all pages in one subwiki share the same filearea

Parameters
stdClass$user
context$context
array$subwiki
string$wikimode

◆ export_used_files()

static mod_wiki\privacy\provider::export_used_files (   $context,
  $subwikiid,
  $alltexts 
)
staticprotected

Analyze which files are used in the texts and export.

Parameters
context$context
int$subwikiid
string$alltexts
Return values
int|void

◆ export_user_data()

static mod_wiki\privacy\provider::export_user_data ( approved_contextlist  $contextlist)
static

Export all user data for the specified user, in the specified contexts.

Parameters
approved_contextlist$contextlistThe approved contexts to export information for.

Implements core_privacy\local\request\core_user_data_provider.

◆ get_contexts_for_userid()

static mod_wiki\privacy\provider::get_contexts_for_userid ( int  $userid)
static

Get the list of contexts that contain user information for the specified user.

Parameters
int$useridThe user to search.
Return values
contextlist::$contextlistThe contextlist containing the list of contexts used in this plugin.

Implements core_privacy\local\request\core_user_data_provider.

◆ get_metadata()

static mod_wiki\privacy\provider::get_metadata ( collection  $collection)
static

Returns metadata.

Parameters
collection$collectionThe initialised collection to add items to.
Return values
collectionA listing of user data stored through this system.

Implements core_privacy\local\metadata\provider.

◆ get_page_comments()

static mod_wiki\privacy\provider::get_page_comments (   $user,
context  $context,
  $pageid,
  $onlyforthisuser = true 
)
staticprotected

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.

Parameters
stdClass$user
context$context
int$pageid
bool$onlyforthisuser
Return values
array

◆ get_users_in_context()

static mod_wiki\privacy\provider::get_users_in_context ( userlist  $userlist)
static

Get the list of users who have data within a context.

Parameters
userlist$userlistThe userlist containing the list of users who have data in this context/plugin combination.

Implements core_privacy\local\request\core_userlist_provider.

◆ text_has_files()

static mod_wiki\privacy\provider::text_has_files (   $str)
staticprotected

Check if text has embedded files.

Parameters
string$str
Return values
bool

The documentation for this class was generated from the following file: