README

A SilverStripe module for managing user consent records to help with GDPR compliance.

Features

Store user consent records with detailed information
Track consent statements, data, and timestamps
Link to specific legal pages (Terms of Use, Privacy Policy)
Admin interface for viewing and managing consent records
Site configuration integration for legal page management

Installation

composer require mouseketeers/consent-records

Usage

Recording Consent

use Mouseketeers\ConsentRecords\ConsentRecord;

// Simple consent recording
$data = [
    'Email' => 'user@example.com',
    'TermsAndPrivacyConsent' => 'I agree to the terms and privacy policy'
];

ConsentRecord::registerConsent($data);

// Advanced consent recording with custom consent data
$consent = [
    'ConsentType' => 'Newsletter',
    'ConsentID' => 'newsletter_signup_2024',
    'ConsentStatement' => 'I agree to receive newsletters',
    'ConsentData' => ['source' => 'homepage', 'campaign' => 'winter2024']
];

ConsentRecord::registerConsent($data, $consent);

Multiple Consents

$data = [
    'FormData' => ['Name' => 'John Doe', 'Email' => 'john@example.com'],
    'Consents' => [
        [
            'ConsentType' => 'Newsletter',
            'ConsentStatement' => 'I agree to receive newsletters'
        ],
        [
            'ConsentType' => 'Marketing',
            'ConsentStatement' => 'I agree to marketing communications'
        ]
    ]
];

ConsentRecord::registerConsents($data);

Configuration

The module extends SiteConfig to allow you to link legal pages. Go to Settings > Legal Pages in the CMS to configure:

Terms Page
Privacy Policy Page

These pages will be automatically linked to consent records for audit purposes.

Default legal page URLs

When no page is selected in Site Settings, getTermsPageLink() and getPrivacyPageLink() fall back to a configured URL. This is useful when the legal pages live outside SilverStripe, or before a page has been selected:

---
Name: my-consent-defaults
After: '#consent-records'
---
Mouseketeers\ConsentRecords\ConsentRecordsSiteConfigExtension:
  terms_page_url: "https://example.com/terms-and-conditions"
  privacy_page_url: "https://example.com/privacy-policy"

The configured URL is only used when no page is selected, and the label passed to the method is used as the link text:

$siteConfig = SiteConfig::current_site_config();

$termsLink = $siteConfig->getTermsPageLink('Terms of Use');
$privacyLink = $siteConfig->getPrivacyPageLink('Privacy Policy');

Database Fields

ConsentID: Unique identifier for the consent
ConsentStatement: The actual consent text (HTML stripped)
ConsentData: Additional data stored as JSON
ConsentType: Type of consent (e.g., 'TermsAndPrivacyConsent', 'Newsletter')
URL: The URL where consent was given
TermsPageID/Version: Link to Terms page at time of consent
PrivacyPageID/Version: Link to Privacy page at time of consent

Requirements

SilverStripe Framework ^4.0
SilverStripe CMS ^4.0
SilverStripe Admin ^1.0

License

BSD-3-Clause

mouseketeers / silverstripe-consent-records

Package info

Security

Statistics