origami/consent

Helper interface for user consent in laravel projects

Laravel Consent

About

The origami/consent helper package contains a Laravel model trait to make saving, comparing and revoking consent easier. The package saves all updates to consent to the consent table and provides a GivesConsent trait for models like the User model., _(*1)

The necessity for the package came about through GDPR and the UK Information Commissioner's Office guidance on "Consent"., _(*2)

Installation

This package is designed for Laravel >= 6.0. You can pull in this package through composer., _(*3)

composer require origami/consent

You should publish the consent table migration with:, _(*4)

php artisan vendor:publish --provider="Origami\Consent\ConsentServiceProvider" --tag="migrations"

The migrate the database:, _(*5)

php artisan migrate

Usage

To use the package, add the GivesConsent trait to a model you'd like to track consent for., _(*6)

use Origami\Consent\GivesConsent;

class User extends Model {

  use GivesConsent;

}

Give consent

You can mark explicit consent given like this:, _(*7)

$model->giveConsentTo('consent-name');

GDPR requires you to keep a record of exactly what was shown at the time. You can do this in the text attribute, and pass anything extra in meta, _(*8)

$model->giveConsentTo('consent-name', [
  'text' => 'You are consenting to ...',
  'meta' => [
    'ip' => '192.168.0.1',
  ]
]);

Give consent

You can revoke a user's consent like so:, _(*9)

$model->revokeConsentTo('consent-name');

Checking consent

You can check if consent is given like so:, _(*10)

if ( $model->hasGivenConsent('consent-name') ) {

}

If consent has not been set, the default is false. You can change that in the 2nd paramter., _(*11)

if ( $model->hasGivenConsent('consent-name', true) ) {

}

Current consent

You can get the user's current consent status like so. This will be an instance of Origami\Consent\Consent, _(*12)

$consent = $model->getConsent('consent-name');

Contributing

Please submit improvements and fixes :), _(*13)

Author

Papertank Limited, _(*14)

License

View the license, _(*15)