xcentric/soft-deleteable-extension-bundle

Provides cascade functionality to Gedmo Doctrine Extensions soft-delete. Adjusted from E-vence/SoftDeleteableListenerExtensionBundle.

v3.0.4 2023-12-06 13:14 UTC

Requires

• php: ^7.4|^8.0
• doctrine/doctrine-bundle: ^2.4
• doctrine/orm: ^2.9
• gedmo/doctrine-extensions: ^3.1
• symfony/dependency-injection: ^5.3
• symfony/framework-bundle: ^5.3
• symfony/property-access: ^5.3
• symfony/yaml: ^5.3

MIT

• Dusan Jankovic
• Ruben Harms

• gedmo
• doctrine
• doctrine-extensions
• soft-deleteable

README

Extensions to Gedmo's softDeleteable listener which has had this issue reported since 2012 : https://github.com/Atlantic18/DoctrineExtensions/issues/505.

Provides the onSoftDelete functionality to an association of a doctrine entity. This functionality behaves like the SQL onDelete function (when the owner side is deleted). It will prevent Doctrine errors when a reference is soft-deleted.

Cascade delete the entity

To (soft-)delete an entity when its parent record is soft-deleted :

 @Xcentric\onSoftDelete(type="CASCADE")

Set reference to null (instead of deleting the entity)

 @Xcentric\onSoftDelete(type="SET NULL")

Entity example

<?php

namespace AppBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Gedmo\Mapping\Annotation as Gedmo;
use Xcentric\SoftDeleteableExtensionBundle\Mapping\Annotation as Xcentric;

/*
 * @ORM\Entity(repositoryClass="AppBundle\Entity\AdvertisementRepository")
 * @Gedmo\SoftDeleteable(fieldName="deletedAt")
 */
class Advertisement
{

    ...

    /**
     * @ORM\ManyToOne(targetEntity="AppBundle\Entity\Shop")
     * @ORM\JoinColumn(name="shop_id", referencedColumnName="id")
     * @Xcentric\onSoftDelete(type="CASCADE")
     */
    private $shop;

    ...
}

Optional - Caching class map

Add property xcentric_class_map_path

# app/config/parameters.yml

    xcentric_class_map_path: '%kernel.root_dir%/config/classMap.yaml'

Execute command xcentric:softdelete:map:generate

Install

Install with composer:

composer require xcentric/soft-deleteable-extension-bundle

Add the bundle to app/AppKernel.php:

# app/AppKernel.php

$bundles = array(
    ...
    new Xcentric\SoftDeleteableExtensionBundle\XcentricSoftDeleteableExtensionBundle(),
);