knplabs/doctrine-behaviors

Doctrine2 behavior traits

Doctrine Behaviors

, _(*1)

This PHP library is a collection of traits and interfaces that add behaviors to Doctrine entities and repositories., _(*2)

It currently handles:, _(*3)

• Blameable
• Loggable
• Sluggable
• SoftDeletable
• Uuidable
• Timestampable
• Translatable
• Tree

Install

composer require knplabs/doctrine-behaviors

Usage

All you have to do is to define a Doctrine entity:, _(*4)

• implemented interface
• add a trait

For some behaviors like tree, you can use repository traits:, _(*5)

<?php

declare(strict_types=1);

namespace App\Repository;

use Doctrine\ORM\EntityRepository;
use Knp\DoctrineBehaviors\ORM\Tree\TreeTrait;

final class CategoryRepository extends EntityRepository
{
    use TreeTrait;
}

Voilà!, _(*6)

You now have a working Category that behaves like., _(*7)

PHPStan

A PHPStan extension is available and provides the following features: - Provides correct return type for TranslatableInterface::getTranslations() and TranslatableInterface::getNewTranslations() - Provides correct return type for TranslatableInterface::translate() - Provides correct return type for TranslationInterface::getTranslatable(), _(*8)

Include phpstan-extension.neon in your project's PHPStan config:, _(*9)

# phpstan.neon
includes:
    - vendor/knplabs/doctrine-behaviors/phpstan-extension.neon

3 Steps to Contribute

• 1 feature per pull-request
• New feature needs tests

• Tests and static analysis must pass:, _(*10)

  vendor/bin/phpunit
  composer fix-cs
  composer phpstan
  

Upgrade 1.x to 2

There have been many changes between 1 and 2, but don't worry. This package uses Rector, that handles upgrade for you., _(*11)

composer require rector/rector --dev

Create rector.php config:, _(*12)

vendor/bin/rector init

Add Doctrine Behaviors upgrade set to rector.php:, _(*13)

use Rector\Core\Configuration\Option;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Rector\Doctrine\Set\DoctrineSetList;

return static function (ContainerConfigurator $containerConfigurator): void {
    $containerConfigurator->import(DoctrineSetList::DOCTRINE_BEHAVIORS_20);
};

Run Rector:, _(*14)

vendor/bin/rector process src