adonko3xbitters/symfony-archivable

A reusable Symfony trait for archiving entities using Doctrine filters.

1.0.0 2025-05-08 15:41 UTC

Requires

• php: >=8.1
• doctrine/orm: ^2.14
• symfony/framework-bundle: ^6.0 || ^7.0

MIT

• adonko3xbitters

README

A lightweight Symfony package that provides a reusable Archivable trait and a Doctrine filter to automatically exclude archived entities from queries.

📦 Installation

Install the package via Composer:

composer require adonko3xBitters/symfony-archivable

🚀 Features

• Easily mark entities as archived using a single trait.
• Automatically exclude archived records from Doctrine queries.
• Enable or disable the filter at runtime.

🧑‍💻 Usage/Examples

1. Use the Archivable trait in your entities

use adonko3xBitters\SymfonyArchivable\Archivable;

#[ORM\Entity]
class Article
{
    use Archivable;

    // other properties...
}

2. Register the Doctrine filter in your configuration

In config/packages/doctrine.yaml:

doctrine:
    orm:
        filters:
            archived:
                class: adonko3xBitters\SymfonyArchivable\Doctrine\ArchivedFilter
                enabled: true

3. Archive an entity

To archive an entity, simply set the archivedAt property:

$article->setArchivedAt(new \DateTimeImmutable());
$entityManager->flush();

4. Doctrine queries will exclude archived entities by default

The filter automatically applies archived_at IS NULL to all entities using the Archivable trait.

5. Disable the filter manually (when needed)

If you want to include archived entities in a specific query:

$entityManager = $this->getDoctrine()->getManager();
$entityManager->getFilters()->disable('archived');

// perform query including archived entities...

$entityManager->getFilters()->enable('archived');

📂 Directory Structure

src/
├── Archivable.php
└── Doctrine/
    └── ArchivedFilter.php

📄 License

This package is open-sourced software licensed under the MIT license.

👤 Authors

• @adonko3xBitters