erhaweb/klaro-consent-manager

Functionally complete, flexible TYPO3 integration of Klaro! Consent Management by KIProtect. Klaro! is a powerful tool that protects your visitors' privacy and data and helps you run a GDPR compliant website.

1.8.2 2024-05-02 11:15 UTC

Requires

• php: ^7.4 || ^8.0 || ^8.1 || ^8.2 || ^8.3
• ext-pdo: *
• typo3/cms-core: ^10.4 || ^11.5 || ^12.4

Requires (Dev)

• roave/security-advisories: dev-latest
• typo3/testing-framework: ^6.9.0

Replaces

• typo3-ter/klaro-consent-manager: 1.8.2

GPL-2.0-or-later

• Eric Harrer

• extension
• typo3
• gdpr
• Klaro
• Consent Manager

README

Functionally complete, flexible TYPO3 integration of Klaro! Consent Management by KIProtect. Klaro! is a powerful tool that protects your visitors' privacy and data and helps you run a GDPR compliant website.

Tutorials

Add custom purposes

Create custom XLIFF file(s)

EXT:sitepackage/Resources/Private/Language/Klaro/locallang.xlf

Add new Keys for purposes

<trans-unit id="purposes.analytics.title">
    <source>Analytics</source>
</trans-unit>
<trans-unit id="purposes.analytics.description">
    <source>These services gather anonymous data for statistical analysis and performance optimization. Enabling analytics services assists website owners in making informed decisions to enhance online services.</source>
</trans-unit>
<trans-unit id="purposes.security.title">
    <source>Security</source>
</trans-unit>
<trans-unit id="purposes.security.description">
    <source>Security services are crucial for safeguarding your online experience. These services help protect your data and privacy by detecting and preventing security threats, such as malware, phishing attempts, and unauthorized access. They ensure a safer browsing environment.</source>
</trans-unit>
<trans-unit id="purposes.livechat.title">
    <source>Live Chat</source>
</trans-unit>
<trans-unit id="purposes.livechat.description">
    <source>Live chat services enable real-time communication with website support teams. They offer a convenient way to ask questions, seek assistance, or engage in discussions while browsing a website. Live chat enhances your online interaction and customer support experience.</source>
</trans-unit>
<trans-unit id="purposes.styling.title">
    <source>Styling</source>
</trans-unit>
<trans-unit id="purposes.styling.description">
    <source>Services related to styling help to improve the appearance of the website. This can also have an impact on usability.</source>
</trans-unit>

The keys are structured according to the following scheme:

• Title of the Purpose: purposes.<PURPOSE-IDENTIFIER>.title
• Description of the Purpose: purposes.<PURPOSE-IDENTIFIER>.description

Add reference in configuration record

Open the Klaro! configuration, go to Display → Translations → Locallang Path and enter the path to your newly created XLIFF file.

Add new items with TSconfig

TCEFORM {
    tx_klaroconsentmanager_service.purposes.addItems {
        analytics = LLL:EXT:sitepackage/Resources/Private/Language/Klaro/locallang.xlf:purposes.analytics.title
        analytics.group = custom
    
        security = LLL:EXT:sitepackage/Resources/Private/Language/Klaro/locallang.xlf:purposes.security.title
        security.group = custom
    
        livechat = LLL:EXT:sitepackage/Resources/Private/Language/Klaro/locallang.xlf:purposes.livechat.title
        livechat.group = custom
    
        styling = LLL:EXT:sitepackage/Resources/Private/Language/Klaro/locallang.xlf:purposes.styling.title
        styling.group = custom
    }
    tx_klaroconsentmanager_configuration.purpose_order.addItems < .tx_klaroconsentmanager_service.purposes.addItems
}

Finished!

Now you are able to select the new purposes in the configuration.

When a custom purpose is selected for a service, it is now also displayed in the frontend, including the description text.