PHPackages heimrichhannot/contao-privacy-bundle - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Security](/categories/security) 4. / 5. heimrichhannot/contao-privacy-bundle Abandoned → [heimrichhannot/contao-privacy-protocol-bundle](/?search=heimrichhannot%2Fcontao-privacy-protocol-bundle)Contao-bundle[Security](/categories/security) heimrichhannot/contao-privacy-bundle ==================================== This bundle contains functionality concerning privacy and the European Union's "General Data Protection Regulation" (GDPR). 1.5.0(2y ago)01.0kLGPL-3.0-or-laterPHPPHP ^7.4 | ^8.0 Since Jun 4Pushed 1y ago4 watchersCompare [ Source](https://github.com/heimrichhannot/contao-privacy-bundle)[ Packagist](https://packagist.org/packages/heimrichhannot/contao-privacy-bundle)[ RSS](/packages/heimrichhannot-contao-privacy-bundle/feed)WikiDiscussions master Synced today READMEChangelog (8)Dependencies (15)Versions (14)Used By (0) Contao Privacy Bundle ===================== [](#contao-privacy-bundle) > This bundle is deprecated. Please migration to it's successor [contoa-privacy-protocol-bundle](https://github.com/heimrichhannot/contao-privacy-protocol-bundle). This bundle contains functionality concerning privacy and the European Union's "General Data Protection Regulation" ( GDPR, in German: "Datenschutz-Grundverordnung", DSGVO). Legal disclaimer ---------------- [](#legal-disclaimer) Use this bundle at your own risk. Although we as the developer try our best to design this bundle to fulfill the legal requirements we **CAN'T GUARANTEE** anything in terms completeness and correctness. Also we don't offer any legal consulting. We strongly encourage you to consult a lawyer if you have any questions or concerns. Features -------- [](#features) - privacy protocol - adds the new Contao entities `tl_privacy_protocol_archive` and `tl_privacy_protocol_entry` for storing privacy relevant actions like opt-ins, ... - offers a simply API for adding new entries into the privacy protocol - offers functionality to create new privacy protocol entries for dca callbacks (`oncreate_callback`, `onversion_callback`, `ondelete_callback`) - opt-in/out form for the frontend with connection to privacy protocol - backend opt in email module for "inviting" users to opt into a privacy relevant agreement Installation ------------ [](#installation) 1. Simply install using composer: `composer require heimrichhannot/contao-privacy-bundle` 2. Update your database and clear your caches. 3. Now you have the new menu entry "privacy" in the Contao menu on the left Export the privacy protocol --------------------------- [](#export-the-privacy-protocol) Export entries from the privacy protocol as `csv` or `excel` is already possible. In order to avail this feature, simply install one of the following composer modules: `composer require heimrichhannot/contao-exporter-bundle` Usage ----- [](#usage) ### The privacy protocol [](#the-privacy-protocol) 1. Add a new protocol archive and select the fields you'd like to store (CAUTION: Do NOT store personal data for which you don't have the user's permission!). 2. Choose one of the following functions for adding new entries programmatically and/or create entries after creating, updating or deleting members automatically. #### Create entries on `tl_member` CRUD actions [](#create-entries-on-tl_member-crud-actions) You can activate the automated creation of privacy protocol entries for the following `tl_member` callbacks: - `oncreate_callback` - `onversion_callback` (this represents updating a member where at least one attribute has actually been changed) - `ondelete_callback` Just open contao's global settings (`tl_settings`) and configure to your needs in the "privacy" section. #### Create entries programmatically [](#create-entries-programmatically) Before you can add new entries to the privacy protocol, create a privacy protocol config (go to the privacy protocol in the backend and click "configurations" on the upper left). ##### Add a new entry from the context of a module [](#add-a-new-entry-from-the-context-of-a-module) ``` // this represents your function for sending the opt in email $success = $this->sendOptInEmail($firstname, $lastname, $email); // only create a protocol entry if the email has indeed been sent if ($success) { System::getContainer()->get(\HeimrichHannot\PrivacyBundle\Manager\ProtocolManager::class)->addEntryFromModuleByConfig( // the id of the privacy protocol config 1, // the data you want to add to the protocol entry to be created // CAUTION: Do NOT store personal data for which you don't have the user's permission! [ 'firstname' => $firstname, 'lastname' => $lastname, 'email' => $email ], // the contao module you're calling from $this, // optional: composer package name of the bundle your module lives in (version is retrieved automatically from composer.lock) 'acme/contao-my-bundle' ); } ``` ##### Add a new entry from the context of a content element [](#add-a-new-entry-from-the-context-of-a-content-element) Same as in *Add a new entry from the context of a module*. Use `addEntryFromContentElementByConfig()` instead. ##### Add a new entry from a general context [](#add-a-new-entry-from-a-general-context) Same as in *Add a new entry from the context of a module*. Use `addEntryByConfig()` instead. ### The Protocol Entry Editor [](#the-protocol-entry-editor) The module `ModuleProtocolEntryEditor` can be used to create entries in the privacy protocol. Typically you have the following scenarios: #### Do a double opt-in for getting an agreement for some action (e.g. send advertising emails) [](#do-a-double-opt-in-for-getting-an-agreement-for-some-action-eg-send-advertising-emails) In this scenario you can: - show a form with fields of a DCA specified by you (typically this would be `tl_member`) -> here the user can type in his data *(ATTENTION: Only ask for fields that are necessary for the action you're requesting the opt-in here)* - this form can be prefilled using a prepared URL that can be generated by the insert tag `privacy_opt_url` (see InsertTag chapter) - you can also avoid showing any fields by not selected any in the module configuration - after clicking "submit" in the form, the user typically gets an email (using contao notification center) for confirming his agreement (you can skip the confirmation only if that's legally ok in your country) - you can specify which protocol entries should generated after submit and after confirm #### Do a single opt-out for revoking the agreement for some action (e.g. send advertising emails) [](#do-a-single-opt-out-for-revoking-the-agreement-for-some-action-eg-send-advertising-emails) You can do that as you would do a single ### The Backend Opt-In Form [](#the-backend-opt-in-form) Navigate to "opt-in" in the privacy section on the left for sending an opt-in email to a certain email address. The form works as follows: 1. The information you type into the form is converted into an encrypted JWT token and appended to a prepared link ( created with the insert tag `privacy_opt_url`) in a notification email. 2. After the user clicks the link, he is redirected to a page containing the module `ModuleProtocolEntryEditor`. This module recognizes the JWT parameter and uses it to prefill the form for the user so that he only has to click " Submit". - HINT: The data you type into the backend opt-in form isn't directly stored into your database. The only case this happens is in an encrypted way as a JWT token in the notification queue of contao notification center. So use a module like `heimrichhannot/contao-cleaner-bundle` to periodically delete this token data. \* ### Insert Tags [](#insert-tags) NameArgumentsExampleprivacy\_opt\_url1. The data for prefilling the form of `ModuleProtocolEntryEditor` and for the resulting privacy protocol entry in the format: `fieldName1:fieldValue1#fieldName2:fieldValue2` 2. The jumpTo page id 3. The data for finding a corresponding database entity to be linked to the protocol entry (reference table and field is defined in the protocol entry editor's backend config): `referenceFieldValue` (optional)`{{privacy_opt_url::email:john@example.org#firstname:John#lastname:Doe::1::john@example.org}}` ### Health Score 33 — LowBetter than 72% of packages Maintenance31 Infrequent updates — may be unmaintained Popularity17 Limited adoption so far Community8 Small or concentrated contributor base Maturity64 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~89 days Recently: every ~237 days Total 13 Last Release 780d ago PHP version history (4 changes)1.0.0PHP ^7.4 1.2.0PHP ^7.2 1.4.0PHP ^7.2|^8.0 1.5.0PHP ^7.4 | ^8.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/28ad3224d8727b622ebd229840eea6b9dbcb83eb0bd609e6ce65b614830ff538?d=identicon)[digitales@heimrich-hannot.de](/maintainers/digitales@heimrich-hannot.de) --- Top Contributors [![koertho](https://avatars.githubusercontent.com/u/12064642?v=4)](https://github.com/koertho "koertho (5 commits)") ### Code Quality TestsPHPUnit Code StylePHP CS Fixer ### Embed Badge ![Health badge](/badges/heimrichhannot-contao-privacy-bundle/health.svg) ``` [![Health](https://phpackages.com/badges/heimrichhannot-contao-privacy-bundle/health.svg)](https://phpackages.com/packages/heimrichhannot-contao-privacy-bundle) ``` ### Alternatives [markocupic/calendar-event-booking-bundle Contao Calendar Event Booking Bundle 135.2k1](/packages/markocupic-calendar-event-booking-bundle)[heimrichhannot/contao-encore-bundle This bundle brings deep integration for symfony encore into contao. On the one hand, your can prepare your bundles to define own webpack entries, which added with just one command to your webpack entries. On the other hand, this bundle allows you to add encore entries only on the pages you need them for optimizing your website performance. 1016.6k](/packages/heimrichhannot-contao-encore-bundle) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)