PHPackages                             motomedialab/compliance - 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. motomedialab/compliance

ActiveLibrary[Security](/categories/security)

motomedialab/compliance
=======================

A package for enforcing GDPR compliance rules

v2.0.0(8mo ago)1664↓50%MITPHPPHP ^8.0CI passing

Since Nov 26Pushed 8mo ago1 watchersCompare

[ Source](https://github.com/motomedialab/compliance)[ Packagist](https://packagist.org/packages/motomedialab/compliance)[ RSS](/packages/motomedialab-compliance/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (5)Dependencies (5)Versions (7)Used By (0)

Compliance: Your Automated Data Retention Guardian
==================================================

[](#compliance-your-automated-data-retention-guardian)

In today's world of data privacy regulations like GDPR, you can't hold onto user data forever. But manually tracking and deleting old records is a headache waiting to happen. Compliance is a configurable Laravel package that automates this process, ensuring you stay on the right side of the law by effortlessly deleting records that are no longer needed.

Think of it as a fire-and-forget solution for data retention. Set up your rules, and let Compliance handle the rest.

How It Works: The Two-Step Deletion Process
-------------------------------------------

[](#how-it-works-the-two-step-deletion-process)

Compliance operates on a safe, two-step cycle to ensure records are never deleted by mistake. This gives you a grace period to act, for instance, by notifying a user that their account is about to be removed.

1. **The Check (`artisan compliance:check`)**:

    - Every day, a scheduled command runs through your specified models (like `User`).
    - It looks for records that meet your defined deletion criteria (e.g., users who haven't logged in for 3 years).
    - When a record matches, Compliance creates a `ComplianceCheck` entry in your database, marking the record with a future deletion date.
    - At this point, the `ComplianceRecordPendingDeletion` event is fired. This is your chance to hook in and, for example, send a notification email.
2. **The Prune (`artisan compliance:prune`)**:

    - A second daily command scans for `ComplianceCheck` records where the deletion date has passed.
    - It performs a final check on the model to ensure it *still* meets the deletion criteria. This is a safety net... If a user logs in after being marked for deletion, their account will be spared.
    - If the criteria are still met, the `ComplianceDeleting` event is fired just before the model is permanently deleted.

Installation
------------

[](#installation)

Getting started is easy, just follow these three steps...

1. **Install via Composer:**

    ```
    composer require motomedialab/compliance
    ```
2. **Publish Configuration & Run Migrations:**Publish the configuration file to specify which models to monitor. Then, run the migrations to create the `compliance_checks` table.

    ```
    php artisan vendor:publish --provider="Motomedialab\Compliance\Providers\ComplianceServiceProvider" --tag="config"
    php artisan migrate
    ```

Quick Start: The Basic User Model
---------------------------------

[](#quick-start-the-basic-user-model)

Out of the box, the package is configured to handle a typical `User` model. Just implement the `HasCompliance` contract and use the `ComplianceRules` trait.

```
// app/Models/User.php
namespace App\Models;

use Motomedialab\Compliance\Traits\Compliance;
use Motomedialab\Compliance\Contracts\HasCompliance;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable implements HasCompliance
{
    use Compliance;
    // ... your other model code
}
```

Next, add your `User` model to the `config/compliance.php` file.

```
// config/compliance.php
return [
    'models' => [
        App\Models\User::class => [
            // The column to check
            'column' => 'last_login_at',
            // How old the record must be to be considered for deletion
            'delete_after_days' => 365 * 3, // 3 years
            // The grace period between being marked and being deleted
            'deletion_grace_period' => 15 // 15 days
        ],
    ],
];
```

And that's it! The package will now automatically schedule users for deletion if their `last_login_at` date is over three years old.

Advanced Scenarios & Powerful Examples
------------------------------------------

[](#advanced-scenarios--powerful-examples)

The real power of this package lies in its flexibility. You can override several methods from the `ComplianceRules` trait to build highly custom logic.

### Example 1: Deleting Only Users Who Have *Never* Logged In

[](#example-1-deleting-only-users-who-have-never-logged-in)

You might want to clean up accounts that were created but never used. You can override the `complianceQueryBuilder` method to define a completely custom query.

```
// app/Models/User.php
use Illuminate\Database\Eloquent\Builder;

class User extends Authenticatable implements HasCompliance
{
    use Compliance;

    /**
     * Override the default query to only find users who have never logged in.
     */
    public function complianceQueryBuilder(Builder $builder): Builder
    {
        return $builder->whereNull('last_login_at');
    }
}
```

### Example 2: Protecting VIPs or Active Subscribers

[](#example-2-protecting-vips-or-active-subscribers)

You never want to accidentally delete a paying customer. The `complianceMeetsDeletionCriteria` method is your safety check, which runs both during the initial check and right before the final deletion.

```
// app/Models/User.php
class User extends Authenticatable implements HasCompliance
{
    use Compliance;

    /**
     * This method is the final gatekeeper.
     * Only return true if the record can be safely deleted.
     */
    public function complianceMeetsDeletionCriteria(): bool
    {
        // Don't delete if the user is an admin or has an active subscription.
        if ($this->is_admin || $this->hasActiveSubscription()) {
            return false;
        }
        return true;
    }
}
```

### Example 3: Notifying Users of Pending Deletion

[](#example-3-notifying-users-of-pending-deletion)

Compliance fires events to let you hook into the lifecycle. Here’s how you can listen for the `ComplianceRecordPendingDeletion` event to email a user.

First, create a listener: `php artisan make:listener NotifyUserOfPendingDeletion`

Then, register it in your `EventServiceProvider`:

```
// app/Providers/EventServiceProvider.php
protected $listen = [
    \Motomedialab\Compliance\Events\ComplianceRecordPendingDeletion::class => [
        \App\Listeners\NotifyUserOfPendingDeletion::class,
    ],
];
```

Finally, implement the listener's logic:

```
// app/Listeners/NotifyUserOfPendingDeletion.php
namespace App\Listeners;

use Illuminate\Support\Facades\Mail;
use App\Mail\AccountDeletionWarning;
use Motomedialab\Compliance\Events\ComplianceRecordPendingDeletion;

class NotifyUserOfPendingDeletion
{
    public function handle(ComplianceRecordPendingDeletion $event): void
    {
        $user = $event->record->model;
        $deletionDate = $event->record->deletion_date;

        // Send an email to the user
        Mail::to($user)->send(new AccountDeletionWarning($user, $deletionDate));
    }
}
```

### Example 4: Cleaning Up Old Log Entries

[](#example-4-cleaning-up-old-log-entries)

This package isn't just for users. You can apply it to any model. Imagine you have a `Log` model and you only want to keep records for 90 days.

```
// config/compliance.php
'models' => [
    // ... other models
    App\Models\Log::class => [
        'column' => 'created_at',
        'delete_after_days' => 90,
        'deletion_grace_period' => 0 // Delete immediately
    ],
],
```

Then, simply apply the trait and interface to your `Log` model.

```
// app/Models/Log.php
namespace App\Models;

use Motomedialab\Compliance\Traits\Compliance;
use Motomedialab\Compliance\Contracts\HasCompliance;
use Illuminate\Database\Eloquent\Model;

class Log extends Model implements HasCompliance
{
    use Compliance;
}
```

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance59

Moderate activity, may be stable

Popularity18

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 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 ~67 days

Total

5

Last Release

265d ago

Major Versions

v0.2.1 → v1.0.02025-06-16

v1.0.0 → v2.0.02025-08-20

### Community

Maintainers

![](https://www.gravatar.com/avatar/805ae1048fb81d8f02871f57cc0a34699089da17f7021210e554ffdba4df918a?d=identicon)[chrispage1](/maintainers/chrispage1)

---

Top Contributors

[![chrispage1](https://avatars.githubusercontent.com/u/2487374?v=4)](https://github.com/chrispage1 "chrispage1 (14 commits)")

---

Tags

gdprcomplianceconsentmotomedialab

###  Code Quality

TestsPest

Static AnalysisPHPStan

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/motomedialab-compliance/health.svg)

```
[![Health](https://phpackages.com/badges/motomedialab-compliance/health.svg)](https://phpackages.com/packages/motomedialab-compliance)
```

###  Alternatives

[devrabiul/laravel-cookie-consent

A GDPR-compliant cookie consent solution for Laravel applications with fully customizable cookie banners, granular consent control, and enterprise-grade compliance features.

17633.8k1](/packages/devrabiul-laravel-cookie-consent)[soved/laravel-gdpr

GDPR compliance with ease

299127.5k2](/packages/soved-laravel-gdpr)[jfeltkamp/cookiesjsr

COOKiES JSR is a consent management tool and provides UI and API to manage 3rd party services within the GDPR.

27807.9k](/packages/jfeltkamp-cookiesjsr)[martin-schenk/laravel-cookie-consent

GDPR-compliant cookie consent system with minimal dependencies for Laravel 11 and 12

101.3k](/packages/martin-schenk-laravel-cookie-consent)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)