| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
(no description)
| Copyright: | (C) 2018 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 709 lines (25 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
PlgSystemPrivacyconsent:: (14 methods):
onContentPrepareForm()
onUserBeforeSave()
onUserAfterSave()
onUserAfterDelete()
onAfterRoute()
onPrivacyCheckPrivacyPolicyPublished()
getRedirectMessage()
isUserConsented()
getPrivacyArticleId()
getPrivacyItemId()
onAfterRender()
remindExpiringConsents()
invalidateExpiredConsents()
clearCacheGroups()
Class: PlgSystemPrivacyconsent - X-Ref
An example custom privacyconsent plugin.| onContentPrepareForm(Form $form, $data) X-Ref |
| Adds additional fields to the user editing form param: Form $form The form to be altered. param: mixed $data The associated data for the form. return: boolean |
| onUserBeforeSave($user, $isNew, $data) X-Ref |
| Method is called before user data is stored in the database param: array $user Holds the old user data. param: boolean $isNew True if a new user is stored. param: array $data Holds the new user data. return: boolean |
| onUserAfterSave($data, $isNew, $result, $error) X-Ref |
| Saves user privacy confirmation param: array $data entered user data param: boolean $isNew true if this is a new user param: boolean $result true if saving the user worked param: string $error error message return: void |
| onUserAfterDelete($user, $success, $msg) X-Ref |
| Remove all user privacy consent information for the given user ID Method is called after user data is deleted from the database param: array $user Holds the user data param: boolean $success True if user was successfully stored in the database param: string $msg Message return: void |
| onAfterRoute() X-Ref |
| 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 return: void |
| onPrivacyCheckPrivacyPolicyPublished(&$policy) X-Ref |
| Event to specify whether a privacy policy has been published. param: array &$policy The privacy policy status data, passed by reference, with keys "published", "editLink" and "articlePublished". return: void |
| getRedirectMessage() X-Ref |
| Returns the configured redirect message and falls back to the default version. return: string redirect message |
| isUserConsented($userId) X-Ref |
| Method to check if the given user has consented yet param: integer $userId ID of uer to check return: boolean |
| getPrivacyArticleId() X-Ref |
| 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 return: integer |
| getPrivacyItemId() X-Ref |
| 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. return: integer |
| onAfterRender() X-Ref |
| The privacy consent expiration check code is triggered after the page has fully rendered. return: void |
| remindExpiringConsents() X-Ref |
| Method to send the remind for privacy consents renew return: integer |
| invalidateExpiredConsents() X-Ref |
| Method to delete the expired privacy consents return: boolean |
| clearCacheGroups(array $clearGroups, array $cacheClients = [0, 1]) X-Ref |
| Clears cache groups. We use it to clear the plugins cache after we update the last run timestamp. param: array $clearGroups The cache groups to clean param: array $cacheClients The cache clients (site, admin) to clean return: void |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |