Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Référence de la classe PlgSystemPrivacyconsent
+ Graphe d'héritage de PlgSystemPrivacyconsent:

Fonctions membres publiques

 __construct (&$subject, $config)
 
 onContentPrepareForm ($form, $data)
 
 onUserBeforeSave ($user, $isNew, $data)
 
 onUserAfterSave ($data, $isNew, $result, $error)
 
 onUserAfterDelete ($user, $success, $msg)
 
 onAfterRoute ()
 
 onPrivacyCheckPrivacyPolicyPublished (&$policy)
 
 onAfterRender ()
 

Attributs protégés

 $autoloadLanguage = true
 
 $app
 
 $db
 

Fonctions membres privées

 getRedirectMessage ()
 
 isUserConsented ($userId)
 
 getPrivacyArticleId ()
 
 remindExpiringConsents ()
 
 clearCacheGroups (array $clearGroups, array $cacheClients=array(0, 1))
 

Description détaillée

An example custom privacyconsent plugin.

Depuis
3.9.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( $subject,
  $config 
)

Constructor

Paramètres
object&$subjectThe object to observe
array$configAn array that holds the plugin configuration
Depuis
3.9.0

Références $config, et $subject.

Documentation des fonctions membres

◆ clearCacheGroups()

clearCacheGroups ( array  $clearGroups,
array  $cacheClients = array(0, 1) 
)
private

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

Paramètres
array$clearGroupsThe cache groups to clean
array$cacheClientsThe 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

◆ 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$userIdID of uer to check
Renvoie
boolean
Depuis
3.9.0

Références $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, $now, et $query.

◆ 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,
  $data 
)

Adds additional fields to the user editing form

Paramètres
JForm$formThe form to be altered.
mixed$dataThe associated data for the form.
Renvoie
boolean
Depuis
3.9.0

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

◆ onPrivacyCheckPrivacyPolicyPublished()

onPrivacyCheckPrivacyPolicyPublished ( $policy)

Event to specify whether a privacy policy has been published.

Paramètres
array&$policyThe 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$userHolds the user data
boolean$successTrue if user was successfully stored in the database
string$msgMessage
Renvoie
boolean
Depuis
3.9.0

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

◆ onUserAfterSave()

onUserAfterSave (   $data,
  $isNew,
  $result,
  $error 
)

Saves user privacy confirmation

Paramètres
array$dataentered user data
boolean$isNewtrue if this is a new user
boolean$resulttrue if saving the user worked
string$errorerror message
Renvoie
boolean
Depuis
3.9.0

Références $data, $form, $message, $option, $task, $userId, et JPATH_ADMINISTRATOR.

◆ onUserBeforeSave()

onUserBeforeSave (   $user,
  $isNew,
  $data 
)

Method is called before user data is stored in the database

Paramètres
array$userHolds the old user data.
boolean$isNewTrue if a new user is stored.
array$dataHolds the new user data.
Renvoie
boolean
Depuis
3.9.0
Exceptions
InvalidArgumentExceptionon 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, $users, et elseif.

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 :