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.
/portfolio/classes/privacy/ -> provider.php (source)

[Source view]

Privacy class for requesting user data.

Copyright: 2018 Jake Dallimore <jrhdallimore@gmail.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 311 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

provider:: (11 methods):
  get_metadata()
  get_contexts_for_userid()
  get_users_in_context()
  export_user_data()
  delete_data_for_all_users_in_context()
  delete_data_for_users()
  delete_data_for_user()
  export_portfolio_user_data()
  delete_portfolio_for_context()
  delete_portfolio_for_user()
  call_plugin_method()


Class: provider  - X-Ref

Provider for the portfolio API.

get_metadata(collection $collection)   X-Ref
Returns meta data about this system.

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 within a specific context.

param: userlist $userlist The userlist containing the list of users who have data in this context/plugin combination.

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

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.

export_portfolio_user_data(int $userid, \context $context, array $subcontext, array $linkarray)   X-Ref
Export all portfolio data from each portfolio plugin for the specified userid and context.

param: int         $userid The user to export.
param: \context    $context The context to export.
param: array       $subcontext The subcontext within the context to export this information to.
param: array       $linkarray The weird and wonderful link array used to display information for a specific item

delete_portfolio_for_context(\context $context)   X-Ref
Deletes all user content for a context in all portfolio plugins.

param: \context $context The context to delete user data for.

delete_portfolio_for_user(int $userid, \context $context)   X-Ref
Deletes all user content for a user in a context in all portfolio plugins.

param: int      $userid    The user to delete
param: \context $context   The context to refine the deletion.

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

param: string $methodname Name of the method to call on the plugins.
param: array $params     The parameters that go with the method being called.