Référence de la classe PlgSystemPrivacyconsent

Graphe d'héritage de PlgSystemPrivacyconsent:

Fonctions membres publiques
	onContentPrepareForm (Form $form, $data)
	onUserBeforeSave ($user, $isNew, $data)
	onUserAfterDelete ($user, $success, $msg)
	onAfterRoute ()
	onPrivacyCheckPrivacyPolicyPublished (&$policy)
	onAfterRender ()
Fonctions membres publiques hérités de CMSPlugin
	__construct (&$subject, $config=array())
	loadLanguage ($extension='', $basePath=JPATH_ADMINISTRATOR)
	setApplication (CMSApplicationInterface $application)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)
Fonctions membres publiques hérités de PluginInterface
	registerListeners ()

Attributs protégés
	$autoloadLanguage = true
	$app
	$db
Attributs protégés hérités de CMSPlugin
	$_name = null
	$_type = null
	$autoloadLanguage = false
	$allowLegacyListeners = true

Fonctions membres privées
	getRedirectMessage ()
	isUserConsented ($userId)
	getPrivacyArticleId ()
	getPrivacyItemId ()
	remindExpiringConsents ()
	clearCacheGroups (array $clearGroups, array $cacheClients=[0, 1])

Membres hérités additionnels
Champs de données hérités de CMSPlugin
	$params = null
Fonctions membres protégées hérités de CMSPlugin
	registerLegacyListener (string $methodName)
	registerListener (string $methodName)
	getApplication ()

Description détaillée

An example custom privacyconsent plugin.

Depuis

3.9.0

Documentation des fonctions membres

clearCacheGroups()

clearCacheGroups ( array  $clearGroups, array  $cacheClients = [0, 1]    )

private

Clears cache groups. We use it to clear the plugins cache after we update the last run timestamp.

Paramètres

array	$clearGroups	The cache groups to clean
array	$cacheClients	The cache clients (site, admin) to clean

Renvoie

void

Depuis

3.9.0

Références $options, JPATH_ADMINISTRATOR, et JPATH_SITE.

getPrivacyArticleId()

getPrivacyArticleId ( )

private

Get privacy article ID. If the site is a multilingual website and there is associated article for the current language, ID of the associated article will be returned

Renvoie

integer

Depuis

3.9.0

getPrivacyItemId()

getPrivacyItemId ( )

private

Get privacy menu item ID. If the site is a multilingual website and there is associated menu item for the current language, ID of the associated menu item will be returned.

Renvoie

integer

Depuis

4.0.0

Références $itemId.

getRedirectMessage()

getRedirectMessage ( )

private

Returns the configured redirect message and falls back to the default version.

Renvoie

string redirect message

Depuis

3.9.0

isUserConsented()

isUserConsented (   $userId )

private

Method to check if the given user has consented yet

Paramètres

integer

$userId

ID of uer to check

Renvoie

boolean

Depuis

3.9.0

Références $db, $query, et $userId.

onAfterRender()

onAfterRender

(

)

The privacy consent expiration check code is triggered after the page has fully rendered.

Renvoie

void

Depuis

3.9.0

Références $db, $last, $now, $query, et $result.

onAfterRoute()

onAfterRoute

(

)

If logged in users haven't agreed to privacy consent, redirect them to profile edit page, ask them to agree to privacy consent before allowing access to any other pages

Renvoie

void

Depuis

3.9.0

Références $id, $layout, $link, $option, $task, $userId, et $view.

onContentPrepareForm()

onContentPrepareForm	(	Form	$form,
			$data
	)

Adds additional fields to the user editing form

Paramètres

Form	$form	The form to be altered.
mixed	$data	The associated data for the form.

Renvoie

boolean

Depuis

3.9.0

Références $data, $form, $name, $userId, et __DIR__.

onPrivacyCheckPrivacyPolicyPublished()

onPrivacyCheckPrivacyPolicyPublished

(

&

$policy

)

Event to specify whether a privacy policy has been published.

Paramètres

array

&$policy

The privacy policy status data, passed by reference, with keys "published", "editLink" and "articlePublished".

Renvoie

void

Depuis

3.9.0

Références $article, $articleId, et $query.

onUserAfterDelete()

onUserAfterDelete	(		$user,
			$success,
			$msg
	)

Remove all user privacy consent information for the given user ID

Method is called after user data is deleted from the database

Paramètres

array	$user	Holds the user data
boolean	$success	True if user was successfully stored in the database
string	$msg	Message

Renvoie

void

Depuis

3.9.0

Références $query, $user, et $userId.

onUserBeforeSave()

onUserBeforeSave	(		$user,
			$isNew,
			$data
	)

Method is called before user data is stored in the database

Paramètres

array	$user	Holds the old user data.
boolean	$isNew	True if a new user is stored.
array	$data	Holds the new user data.

Renvoie

boolean

Depuis

3.9.0

Exceptions

InvalidArgumentException

on missing required data.

Références $form, $option, $task, $user, et $userId.

remindExpiringConsents()

remindExpiringConsents ( )

private

Method to send the remind for privacy consents renew

Renvoie

integer

Depuis

3.9.0

Références $app, $db, $now, $query, $user, $userId, et MailTemplate\addTemplateData().

Documentation des champs

$app

$app

protected

$autoloadLanguage

$autoloadLanguage = true

protected

$db

$db

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• privacyconsent.php