fluoresce/doctrine-undeletable

Doctrine annotation to make entities undeletable.

Doctrine Undeletable

This library provides an Undeletable annotation for Doctrine entities., _(*1)

When added to an entity class, this annotation causes Doctrine to throw an exception when attempting to delete an entity., _(*2)

Installation

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:, _(*3)

$ composer require fluoresce/doctrine-undeletable

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation., _(*4)

Documentation

Configuration

Symfony

Register the Doctrine event subscriber as a service. In services.yml this would look as follows., _(*5)

services:
    fluoresce.listener.undeletable:
        class: Fluoresce\DoctrineUndeletable\EventListener\UndeletableSubscriber
        arguments: ["@annotation_reader"]
        tags:
            - { name: doctrine.event_subscriber, connection: default }

Basic Usage

This example shows a Book ORM entity which should never be deleted., _(*6)

<?php

use Doctrine\ORM\Mapping as ORM;
use Fluoresce\DoctrineUndeletable\Mapping\Undeletable;

/**
 * @ORM\Entity
 * @Undeletable
 */
class Book
{
    …
}

When you attempt to delete a Book, an exception will be thrown., _(*7)

$book = $entityManager->find('Book', 123);
$entityManager->remove($book);

try {
    $entityManager->flush();
} catch (Fluoresce\DoctrineUndeletable\Exception\UndeletableObjectException $e) {
    // $book was not deleted from the database
}