eightmarq/doctrine-behaviors

Doctrine Behavior Traits

2.7.1 2024-03-06 10:04 UTC

Requires

• php: >=8.1
• doctrine/common: ^3.4
• doctrine/dbal: ^3.7
• doctrine/doctrine-bundle: ^2.11
• doctrine/orm: ^2.17
• doctrine/persistence: ^2.5|^3.0
• nette/utils: ^3.2
• ramsey/uuid: ^4.2
• symfony/cache: ^6.4|^7.0
• symfony/dependency-injection: ^6.4|^7.0
• symfony/framework-bundle: ^6.4|^7.0
• symfony/http-kernel: ^6.4|^7.0
• symfony/security-bundle: ^6.4|^7.0
• symfony/string: ^6.4|^7.0
• symfony/translation-contracts: ^2.4|^3.0

Requires (Dev)

• ext-pdo_mysql: *
• ext-pdo_pgsql: *
• ext-pdo_sqlite: *
• php-parallel-lint/php-parallel-lint: ^1.3
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ^1.7.10
• phpstan/phpstan-doctrine: ^1.3
• phpstan/phpstan-phpunit: ^1.1
• phpunit/phpunit: ^9.5
• psr/log: ^1.1
• rector/rector: ^0.19
• symplify/easy-ci: ^10.2.9
• symplify/easy-coding-standard: ^10.2.9
• symplify/package-builder: ^10.2.9
• symplify/phpstan-extensions: ^10.2.9
• symplify/phpstan-rules: ^10.2.9

MIT

• Knplabs

• tree
• behaviors
• translatable
• timestampable
• doctrine
• Blameable
• softdeletable
• uuid

README

This PHP library is a collection of traits and interfaces that add behaviors to Doctrine entities and repositories.

It currently handles:

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

Install

composer require eightmarq/doctrine-behaviors

Usage

All you have to do is to define a Doctrine entity:

• implemented interface
• add a trait

For some behaviors like tree, you can use repository traits:

<?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à!

You now have a working Category that behaves like.

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()

Include phpstan-extension.neon in your project's PHPStan config:

# 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:

  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.

composer require rector/rector --dev

Create rector.php config:

vendor/bin/rector init

Add Doctrine Behaviors upgrade set to rector.php:

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:

vendor/bin/rector process src

Docker

Usage

• Install Docker and Docker Compose
• Build or rebuild service: docker compose build
• Create or start container: docker compose up -d
• Enter the php container: docker compose exec php /bin/sh
• Run commands:
  • composer check-cs
  • composer phpstan
  • vendor/bin/phpunit