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

[Source view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

Privacy class for requesting user data.

Copyright: 2018 Zig Tan <zig@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 704 lines (31 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

provider:: (15 methods):
  get_metadata()
  get_contexts_for_userid()
  get_users_in_context()
  export_user_data()
  export_user_preferences()
  delete_data_for_all_users_in_context()
  delete_data_for_users()
  delete_data_for_user()
  export_user_calendar_event_data()
  export_user_calendar_subscription_data()
  get_calendar_event_ids_by_context()
  get_calendar_subscription_ids_by_context()
  get_calendar_event_details_by_contextlist()
  get_calendar_subscription_details_by_contextlist()
  delete_batch_records()


Class: provider  - X-Ref

Privacy Subsystem for core_calendar implementing metadata, plugin, and user_preference providers.

get_metadata(collection $collection)   X-Ref
Provides meta data that is stored about a user with core_calendar.

param: collection $collection A collection of meta data items to be added to.
return: collection Returns the collection of metadata.

get_contexts_for_userid(int $userid)   X-Ref
Get the list of contexts that contain calendar 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.

export_user_preferences(int $userid)   X-Ref
Export all user preferences for the plugin.

param: int $userid The userid of the user whose data is to be exported.

delete_data_for_all_users_in_context(\context $context)   X-Ref
Delete all Calendar Event and Calendar Subscription data for all users in the specified context.

param: context $context Transform 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_user_calendar_event_data(approved_contextlist $contextlist)   X-Ref
Helper function to export Calendar Events data by a User's contextlist.

param: approved_contextlist $contextlist

export_user_calendar_subscription_data(approved_contextlist $contextlist)   X-Ref
Helper function to export Calendar Subscriptions data by a User's contextlist.

param: approved_contextlist $contextlist

get_calendar_event_ids_by_context(\context $context, $userids = array()   X-Ref
Helper function to return all Calendar Event id results for a specified context and optionally
included user list.

param: \context $context
param: array $userids
return: array|null

get_calendar_subscription_ids_by_context(\context $context, $userids = array()   X-Ref
Helper function to return all Calendar Subscription id results for a specified context and optionally
included user list.

param: \context $context
param: array $userids
return: array

get_calendar_event_details_by_contextlist(approved_contextlist $contextlist)   X-Ref
Helper function to return the Calendar Events for a given user and context list.

param: approved_contextlist $contextlist
return: array

get_calendar_subscription_details_by_contextlist(approved_contextlist $contextlist)   X-Ref
Helper function to return the Calendar Subscriptions for a given user and context list.

param: approved_contextlist $contextlist
return: array

delete_batch_records($tablename, $field, $values)   X-Ref
Helper function to delete records in batches in order to minimise amount of deletion queries.

param: string    $tablename  The table name to delete from.
param: string    $field      The table column field name to delete records by.
param: array     $values     The table column field values to delete records by.