blameable.md

Blameable

Blameable is able to track entity creators and updaters.

Entity

<?php

declare(strict_types=1);

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Knp\DoctrineBehaviors\Contract\Entity\BlameableInterface;
use Knp\DoctrineBehaviors\Model\Blameable\BlameableTrait;

/**
 * @ORM\Entity
 */
class Category implements BlameableInterface
{
    use BlameableTrait;
}

How it Works

By default, the current user from Symfony\Security is used. If you want to change it, just implement Knp\DoctrineBehaviors\Contract\Provider\UserProviderInterface yourself and override native service.

Usage

Then, you can use it like that:

<?php

/** @var Knp\DoctrineBehaviors\Contract\Entity\BlameableInterface $category */
$category = new Category();
$entityManager->persist($category);

$createdBy = $category->getCreatedBy();
var_dump($createdBy); 
// "App\Entity\User" object

$updatedBy = $category->getUpdatedBy();
var_dump($updatedBy);
// "App\Entity\User" object

Configuration

By default, no user entity is provided. You need to specify the User class with a new parameter in your config:

# services.yaml
parameters:
    doctrine_behaviors_blameable_user_entity: App\Entity\User