Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core_portfolio\privacy\provider Class Reference

Provider for the portfolio API. More...

Inheritance diagram for core_portfolio\privacy\provider:
core_privacy\local\metadata\provider core_privacy\local\request\plugin\provider core_privacy\local\request\core_userlist_provider core_privacy\local\request\subsystem\plugin_provider core_privacy\local\request\shared_userlist_provider core_privacy\local\request\core_user_data_provider core_privacy\local\request\userlist_provider core_privacy\local\request\shared_data_provider core_privacy\local\request\userlist_provider core_privacy\local\request\core_data_provider core_privacy\local\request\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.
 
static delete_data_for_user (approved_contextlist $contextlist)
 Delete all user data for the specified user, in the specified contexts.
 
static delete_data_for_users (approved_userlist $userlist)
 Delete multiple users within a single context.
 
static delete_portfolio_for_context (\context $context)
 Deletes all user content for a context in all portfolio plugins.
 
static delete_portfolio_for_user (int $userid, context $context)
 Deletes all user content for a user in a context in all portfolio plugins.
 
static export_portfolio_user_data (int $userid, context $context, array $subcontext, array $linkarray)
 Export all portfolio data from each portfolio plugin for the specified userid and context.
 
static export_user_data (approved_contextlist $contextlist)
 Export all user data for the specified user, in the specified contexts.
 
static get_contexts_for_userid (int $userid)
 Get the list of contexts that contain user information for the specified user.
 
static get_metadata (collection $collection)
 Returns meta data about this system.
 
static get_users_in_context (userlist $userlist)
 Get the list of users within a specific context.
 

Static Protected Member Functions

static call_plugin_method ($methodname, $params)
 Internal method for looping through all of the portfolio plugins and calling a method.
 

Detailed Description

Provider for the portfolio API.

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

Member Function Documentation

◆ call_plugin_method()

static core_portfolio\privacy\provider::call_plugin_method ( $methodname,
$params )
staticprotected

Internal method for looping through all of the portfolio plugins and calling a method.

Parameters
string$methodnameName of the method to call on the plugins.
array$paramsThe parameters that go with the method being called.

◆ delete_data_for_all_users_in_context()

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

Implements core_privacy\local\request\core_user_data_provider.

◆ delete_data_for_user()

static core_portfolio\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_portfolio\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_portfolio_for_context()

static core_portfolio\privacy\provider::delete_portfolio_for_context ( \context $context)
static

Deletes all user content for a context in all portfolio plugins.

Parameters
context$contextThe context to delete user data for.

◆ delete_portfolio_for_user()

static core_portfolio\privacy\provider::delete_portfolio_for_user ( int $userid,
context $context )
static

Deletes all user content for a user in a context in all portfolio plugins.

Parameters
int$useridThe user to delete
context$contextThe context to refine the deletion.

◆ export_portfolio_user_data()

static core_portfolio\privacy\provider::export_portfolio_user_data ( int $userid,
context $context,
array $subcontext,
array $linkarray )
static

Export all portfolio data from each portfolio plugin for the specified userid and context.

Parameters
int$useridThe user to export.
context$contextThe context to export.
array$subcontextThe subcontext within the context to export this information to.
array$linkarrayThe weird and wonderful link array used to display information for a specific item

◆ export_user_data()

static core_portfolio\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_portfolio\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_portfolio\privacy\provider::get_metadata ( collection $collection)
static

Returns meta data about this system.

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_portfolio\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.


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