Plugin/Events/Privacy

From Joomla! Documentation

< Plugin‎ | Events

Events of Privacy. Combining the events mentioned here into a single plugin can be found in the J3.x:Integrate_Extensions_with_the_Privacy_Component page

onPrivacyCanRemoveData

Description

This method is used to determine if the user can remove data on a user request. For example in Joomla core it forbids the user object being removed if the user is a super user. It can also be because you require data to be required for legal reasons or because the user is

Parameters

  • PrivacyTableRequest The request record being processed.
  • JUser The user object of the user requesting record removal (if available).

Return Value

A list of PrivacyRemovalStatus objects. The property canRemove will be checked and the request will be blocked if any of these properties is true. The reason for the first failed plugin will be shown to the user running the deletion.

Called in files

  • administrator/components/com_privacy/models/remove.php

onPrivacyExportRequest

Description

Processes an export request for the data managed by the privacy plugin.

Parameters

  • PrivacyTableRequest The request record being processed.
  • JUser The user object of the user requesting record removal (if available).

Return Value

A list of PrivacyExportDomain associative arrays. These must be classes.

Example:

return array(
	$this->createDomain('user_notes', 'joomla_user_notes_data'),
	$this->createDomain('user_profile', 'joomla_user_profile_data'),
	$this->createCustomFieldsDomain('com_users.user', array($userTable)),
);


Called in files

  • administrator/components/com_privacy/models/export.php

onPrivacyRemoveData

Description

Processes a data deletion request for the data managed by the current privacy plugin.

Parameters

  • PrivacyTableRequest The request record being processed.
  • JUser The user object of the user requesting record removal (if available).

Return Value

void

Called in files

  • administrator/components/com_privacy/models/remove.php