mod_forum\privacy\provider Class Reference

Implementation of the privacy subsystem plugin provider for the forum activity module. More...

Inheritance diagram for mod_forum\privacy\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	export_user_data (approved_contextlist $contextlist)
	Export all user data for the specified user, in the specified contexts.
static	export_user_preferences (int $userid)
	Store all user preferences for the plugin.
static	get_contexts_for_userid (int $userid)
	Get the list of contexts that contain user information for the specified user.
static	get_metadata (collection $items)
	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	export_all_posts (int $userid, array $mappings)
	Store all information about all posts that we have detected this user to have access to.
static	export_all_posts_in_discussion (int $userid, context $context, stdClass $discussion)
	Store all information about all posts that we have detected this user to have access to.
static	export_digest_data (int $userid, stdClass $forum, int $maildigest)
	Store data about daily digest preferences.
static	export_discussion_data (int $userid, array $mappings)
	Store all information about all discussions that we have detected this user to have access to.
static	export_discussion_subscription_data (int $userid, context_module $context, stdClass $discussion)
	Store data about whether the user subscribes to this particular discussion.
static	export_grade_data (int $grade, context $context, stdClass $forum, array $path)
static	export_grading_data (int $userid, stdClass $forum, int $grade)
static	export_post_data (int $userid, context $context, $postarea, $post)
	Export all data in the post.
static	export_posts_in_structure (int $userid, context $context, $parentarea, stdClass $structure)
	Export all posts in the provided structure.
static	export_read_data (int $userid, context_module $context, array $postarea, stdClass $post)
	Store read-tracking information about a particular forum post.
static	export_subscription_data (int $userid, stdClass $forum, int $subscribed)
	Store data about whether the user subscribes to forum.
static	export_tracking_data (int $userid, stdClass $forum, int $tracked)
	Store forum read-tracking data about a particular forum.

Detailed Description

Implementation of the privacy subsystem plugin provider for the forum activity module.

Copyright

2018 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

License

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

Member Function Documentation

delete_data_for_all_users_in_context()

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

static

Delete all data for all users in the specified context.

Parameters

context

$context

The specific context to delete data for.

Implements core_privacy\local\request\core_user_data_provider.

delete_data_for_user()

static mod_forum\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

$contextlist

The approved contexts and user information to delete information for.

Implements core_privacy\local\request\core_user_data_provider.

delete_data_for_users()

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

static

Delete multiple users within a single context.

Parameters

approved_userlist

$userlist

The approved context and user information to delete information for.

Implements core_privacy\local\request\core_userlist_provider.

export_all_posts()

static mod_forum\privacy\provider::export_all_posts ( int $userid, array $mappings )

staticprotected

Store all information about all posts that we have detected this user to have access to.

Parameters

int	$userid	The userid of the user whose data is to be exported.
array	$mappings	A list of mappings from forumid => contextid.

Return values

array

Which forums had data written for them.

export_all_posts_in_discussion()

static mod_forum\privacy\provider::export_all_posts_in_discussion ( int $userid, context $context, stdClass $discussion )

staticprotected

Store all information about all posts that we have detected this user to have access to.

Parameters

int	$userid	The userid of the user whose data is to be exported.
context	$context	The instance of the forum context.
stdClass	$discussion	The discussion whose data is being exported.

export_digest_data()

static mod_forum\privacy\provider::export_digest_data ( int $userid, stdClass $forum, int $maildigest )

staticprotected

Store data about daily digest preferences.

Parameters

int	$userid	The userid of the user whose data is to be exported.
stdClass	$forum	The forum whose data is being exported.
int	$maildigest	The mail digest setting for this forum.

Return values

bool	Whether any data was stored.

export_discussion_data()

static mod_forum\privacy\provider::export_discussion_data ( int $userid, array $mappings )

staticprotected

Store all information about all discussions that we have detected this user to have access to.

Parameters

int	$userid	The userid of the user whose data is to be exported.
array	$mappings	A list of mappings from forumid => contextid.

Return values

array

Which forums had data written for them.

export_discussion_subscription_data()

static mod_forum\privacy\provider::export_discussion_subscription_data ( int $userid, context_module $context, stdClass $discussion )

staticprotected

Store data about whether the user subscribes to this particular discussion.

Parameters

int	$userid	The userid of the user whose data is to be exported.
context_module	$context	The instance of the forum context.
stdClass	$discussion	The discussion whose data is being exported.

Return values

bool	Whether any data was stored.

export_post_data()

static mod_forum\privacy\provider::export_post_data ( int $userid, context $context, $postarea, $post )

staticprotected

Export all data in the post.

Parameters

int	$userid	The userid of the user whose data is to be exported.
context	$context	The instance of the forum context.
array	$postarea	The subcontext of the parent.
stdClass	$post	The post structure and all of its children

export_posts_in_structure()

static mod_forum\privacy\provider::export_posts_in_structure ( int $userid, context $context, $parentarea, stdClass $structure )

staticprotected

Export all posts in the provided structure.

Parameters

int	$userid	The userid of the user whose data is to be exported.
context	$context	The instance of the forum context.
array	$parentarea	The subcontext of the parent.
stdClass	$structure	The post structure and all of its children

export_read_data()

static mod_forum\privacy\provider::export_read_data ( int $userid, context_module $context, array $postarea, stdClass $post )

staticprotected

Store read-tracking information about a particular forum post.

Parameters

int	$userid	The userid of the user whose data is to be exported.
context_module	$context	The instance of the forum context.
array	$postarea	The subcontext for this post.
stdClass	$post	The post whose data is being exported.

Return values

bool	Whether any data was stored.

export_subscription_data()

static mod_forum\privacy\provider::export_subscription_data ( int $userid, stdClass $forum, int $subscribed )

staticprotected

Store data about whether the user subscribes to forum.

Parameters

int	$userid	The userid of the user whose data is to be exported.
stdClass	$forum	The forum whose data is being exported.
int	$subscribed	if the user is subscribed

Return values

bool	Whether any data was stored.

export_tracking_data()

static mod_forum\privacy\provider::export_tracking_data ( int $userid, stdClass $forum, int $tracked )

staticprotected

Store forum read-tracking data about a particular forum.

This is whether a forum has read-tracking enabled or not.

Parameters

int	$userid	The userid of the user whose data is to be exported.
stdClass	$forum	The forum whose data is being exported.
int	$tracke	if the user is subscribed

Return values

bool	Whether any data was stored.

export_user_data()

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

static

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

Parameters

approved_contextlist

$contextlist

The approved contexts to export information for.

Implements core_privacy\local\request\core_user_data_provider.

export_user_preferences()

static mod_forum\privacy\provider::export_user_preferences ( int $userid )

static

Store all user preferences for the plugin.

Parameters

int

$userid

The userid of the user whose data is to be exported.

Implements core_privacy\local\request\user_preference_provider.

get_contexts_for_userid()

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

static

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

In the case of forum, that is any forum where the user has made any post, rated any content, or has any preferences.

Parameters

int

$userid

The user to search.

Return values

contextlist\$contextlist

The contextlist containing the list of contexts used in this plugin.

Implements core_privacy\local\request\core_user_data_provider.

get_metadata()

static mod_forum\privacy\provider::get_metadata ( collection $items )

static

Returns meta data about this system.

Parameters

collection

$items

The initialised collection to add items to.

Return values

collection

A listing of user data stored through this system.

Implements core_privacy\local\metadata\provider.

get_users_in_context()

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

static

Get the list of users within a specific context.

Parameters

userlist

$userlist

The 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:

• mod/forum/classes/privacy/provider.php