Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Static Public Member Functions | Static Protected Member Functions | List of all members
core_webservice\privacy\provider Class Reference

Data provider class. More...

Inheritance diagram for core_webservice\privacy\provider:
core_privacy\local\metadata\provider core_privacy\local\request\core_userlist_provider core_privacy\local\request\subsystem\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 within a specific context. More...
 

Static Protected Member Functions

static delete_user_data ($userid)
 Delete user data. More...
 
static recordset_loop_and_export (\moodle_recordset $recordset, $splitkey, $initial, callable $reducer, callable $export)
 Loop and export from a recordset. More...
 
static transform_token ($record)
 Transform a token entry. More...
 

Detailed Description

Data provider class.

Author
Frédéric Massart fred@.nosp@m.bran.nosp@m.chup..nosp@m.tech
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 core_role\privacy\provider, tool_cohortroles\privacy\provider, tool_mobile\privacy\provider, tool_monitor\privacy\provider, tool_policy\privacy\provider, core_analytics\privacy\provider, auth_mnet\privacy\provider, auth_oauth2\privacy\provider, core_backup\privacy\provider, block_comments\privacy\provider, block_html\privacy\provider, block_recent_activity\privacy\provider, block_recentlyaccesseditems\privacy\provider, block_rss_client\privacy\provider, block_tag_flickr\privacy\provider, cachestore_memcached\privacy\provider, cachestore_mongodb\privacy\provider, cachestore_redis\privacy\provider, cachestore_session\privacy\provider, core_calendar\privacy\provider, core_cohort\privacy\provider, core_contentbank\privacy\provider, core_course\privacy\provider, core_enrol\privacy\provider, enrol_cohort\privacy\provider, enrol_flatfile\privacy\provider, enrol_lti\privacy\provider, enrol_meta\privacy\provider, enrol_paypal\privacy\provider, core_files\privacy\provider, fileconverter_googledrive\privacy\provider, core_grading\privacy\provider, core_group\privacy\provider, core\privacy\provider, editor_atto\privacy\provider, core_message\privacy\provider, message_airnotifier\privacy\provider, message_email\privacy\provider, message_jabber\privacy\provider, mnetservice_enrol\privacy\provider, mod_assign\privacy\provider, mod_assignment\privacy\provider, mod_choice\privacy\provider, mod_data\privacy\provider, mod_feedback\privacy\provider, mod_forum\privacy\provider, mod_glossary\privacy\provider, mod_h5pactivity\privacy\provider, mod_lti\privacy\provider, ltiservice_basicoutcomes\privacy\provider, ltiservice_gradebookservices\privacy\provider, ltiservice_memberships\privacy\provider, quizaccess_seb\privacy\provider, mod_quiz\privacy\provider, mod_scorm\privacy\provider, mod_workshop\privacy\provider, core_notes\privacy\provider, core_portfolio\privacy\provider, core_question\privacy\provider, report_stats\privacy\provider, repository_boxnet\privacy\provider, core_repository\privacy\provider, repository_dropbox\privacy\provider, repository_flickr\privacy\provider, repository_flickr_public\privacy\provider, repository_googledocs\privacy\provider, repository_merlot\privacy\provider, repository_onedrive\privacy\provider, repository_picasa\privacy\provider, repository_wikimedia\privacy\provider, repository_youtube\privacy\provider, core_rss\privacy\provider, search_simpledb\privacy\provider, search_solr\privacy\provider, core_tag\privacy\provider, core_user\privacy\provider, profilefield_checkbox\privacy\provider, profilefield_datetime\privacy\provider, profilefield_menu\privacy\provider, profilefield_text\privacy\provider, and profilefield_textarea\privacy\provider.

◆ delete_data_for_all_users_in_context() [2/2]

static core_webservice\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 core_webservice\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 core_webservice\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.

◆ delete_user_data()

static core_webservice\privacy\provider::delete_user_data (   $userid)
staticprotected

Delete user data.

Parameters
int$useridThe user ID.
Return values
void

◆ export_user_data()

static core_webservice\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 core_webservice\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 core_webservice\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_users_in_context()

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

Get the list of users within a specific 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.

◆ recordset_loop_and_export()

static core_webservice\privacy\provider::recordset_loop_and_export ( \moodle_recordset  $recordset,
  $splitkey,
  $initial,
callable  $reducer,
callable  $export 
)
staticprotected

Loop and export from a recordset.

Parameters
moodle_recordset$recordsetThe recordset.
string$splitkeyThe record key to determine when to export.
mixed$initialThe initial data to reduce from.
callable$reducerThe function to return the dataset, receives current dataset, and the current record.
callable$exportThe function to export the dataset, receives the last value from $splitkey and the dataset.
Return values
void

◆ transform_token()

static core_webservice\privacy\provider::transform_token (   $record)
staticprotected

Transform a token entry.

Parameters
object$recordThe token record.
Return values
array

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