effiana/doctrine-behaviors

Doctrine Behavior Traits

v2.0.7 2020-08-30 23:57 UTC

Requires

• php: ^7.2|^8.0
• doctrine/common: ^2.7|^3.0
• doctrine/dbal: ^2.9
• doctrine/orm: ^2.7
• doctrine/persistence: ^1.3.4|^2.0
• nette/utils: ^3.0
• ramsey/uuid: ^3.9|^4.0
• symfony/cache: ^4.4|^5.1
• symfony/dependency-injection: ^4.4|^5.1
• symfony/framework-bundle: ^4.4|^5.1
• symfony/http-kernel: ^4.4|^5.1
• symfony/polyfill-php80: ^1.18
• symfony/security-core: ^4.4|^5.1
• symfony/string: ^5.0
• symfony/translation-contracts: ^2.1
• symplify/package-builder: ^8.2

Requires (Dev)

• ext-pdo_mysql: *
• ext-pdo_pgsql: *
• ext-pdo_sqlite: *
• doctrine/annotations: ^1.8
• doctrine/doctrine-bundle: ^2.0
• jakub-onderka/php-parallel-lint: ^1.0
• phpstan/phpstan: ^0.12.40
• phpstan/phpstan-doctrine: ^0.12.15
• phpstan/phpstan-phpunit: ^0.12.11
• phpunit/phpunit: ^8.5|^9.2
• psr/log: ^1.1
• rector/rector: ^0.7.33
• slevomat/coding-standard: ^6.3.11
• symplify/changelog-linker: ^8.2
• symplify/easy-coding-standard: ^8.2
• symplify/phpstan-extensions: ^8.2

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 knplabs/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
vendor/bin/rector process src --config vendor/rector/rector/config/set/doctrine-behaviors-20.yaml