globaltradingtechnologies/doctrine-auditable-bundle

Symfony bundle for doctrine2 entity changes audit

Doctrine Auditable Bundle helps tracking changes and history of objects

Auditable behavioral implementation helps tracking changes and history of objects. Fast and lightweight alternative for DoctrineExtensions Loggable with some features. Supports only ORM.

Features

• Group of changes
• Comments for changes
• Convenient store (tracked values before and after change stored in the separated columns, instead serialized entity data in the Loggable)
• Supports custom DBAL types
• Supports class inheritance configuration

Installation

1. Install bundle

composer require "gtt/doctrine-auditable-bundle"

2. Add to Kernel.php

public function registerBundles()
{
    $bundles = array(
        ...
        new Gtt\Bundle\DoctrineAuditableBundle\DoctrineAuditableBundle(),
    );
    ...
}

3. Create tables for changes storing

bin/console doctrine:schema:update --force

4. Configure mapping if needed.

Usage

Add attributes for tracking property

<?php

use Gtt\Bundle\DoctrineAuditableBundle\Mapping\Annotation as Auditable;

/**
 * My entity
 */
 #[ORM\Entity]
 #[ORM\Table(name: 'entity')]
 #[Auditable\Entity]
class Entity
{
     #[ORM\Column(name: 'assigned_user', type: 'string', length: 255)]
     #[Auditable\Property]
    protected string $assignedUser;
    
    ...
}

Then somewhere in a service change an entity property and flush the changes.

<?php

use Doctrine\ORM\EntityManagerInterface;
use Gtt\Bundle\DoctrineAuditableBundle as Auditable;

class PayloadService {
    private Auditable\Log\Store $auditable;
    
    private EntityManagerInterface $entityManager;

    /**
     * Operate!
     */
    public function payloadMethod(YourDomain\Entity $entity): void 
    {
        // 1. change some property that supposed to be logged to changelog
        $entity->updateProperty();  // ... just dummy example
        
        // 2. describe this change
        $this->auditable->describe($entity, 'Change description');
      
        // 3. perform update 
        $this->entityManager->flush();
    }
}

doctrine-auditable-bundle's Issues

Support PHP8.3 and symfony 7

ClassNotFoundException - How to install correctly?

I have installed the package with composer successfully, but its classes can't be found after registering its bundles:

composer.json:

    "require": {
        "php": "7.2.*",
        "gtt/doctrine-auditable-bundle": "^3.0",
        "guzzlehttp/guzzle": "^6.3",
        "mailjet/mailjet-apiv3-php": "^1.3",
        "ramsey/uuid": "^3.8",
        "stripe/stripe-php": "^6.17",
        "sylius-labs/sensio-distribution-bundle": "^6.0",
        "sylius/rbac-plugin": "^0.2.1",
        "sylius/sylius": "~1.4.0",
        "symfony/dotenv": "^4.2",
        "symfony/flex": "^1.1",
        "symfony/symfony": "^3.4|^4.1"
    },

AppKernel.php:

    /**
     * {@inheritdoc}
     */
    public function registerBundles(): array
    {
        $bundles = [
            // ....
            new \Gtt\Bundle\DoctrineAdapterBundle\DoctrineAuditableBundle(),
            new \AppBundle\AppBundle()
        ];

        if (in_array($this->getEnvironment(), ['dev', 'test', 'test_cached'], true)) {
            $bundles[] = new \Fidry\AliceDataFixtures\Bridge\Symfony\FidryAliceDataFixturesBundle();
            $bundles[] = new \Nelmio\Alice\Bridge\Symfony\NelmioAliceBundle();
        }

        return array_merge(parent::registerBundles(), $bundles);
    }

Error Message:

(1/1) ClassNotFoundException
Attempted to load class "DoctrineAuditableBundle" from namespace "Gtt\Bundle\DoctrineAdapterBundle".
Did you forget a "use" statement for "Gtt\Bundle\DoctrineAuditableBundle\DoctrineAuditableBundle"?

How can I make it work?

Tests

Need to cover the code by unit tests.