library doctrine {🖫 819, ⚐ 13, ★ 0}

huttopia/doctrine

Add some features and fix to doctrine, without forking it

Friday, June 29, 2018
by huttopia
Repository
4 Watchers
0 Stars
819 Installations

PHP
0 Dependents
0 Suggesters
0 Forks
0 Open issues
13 Versions
16 % Grown

The README.md

Total Downloads , _(*1)

huttopia/doctrine

Doctrine is a really good ORM, with nice features, we love it !, _(*2)

But, to be honest, no major version since 2 april 2015 (2.6 is here, but too much bugs for now), several bugs are not fixed and it takes too much time to create patch version when you create a PR to fix something., _(*3)

So, we decided to create huttopia/doctrine, to fix what we need, without waiting for a release. We can add features too., _(*4)

We decide to not fork Doctrine, because we want to follow Doctrine releases. Forking it now is nice and amazing, but in 2 years..., _(*5)

When we need to override a class, we do it with steevanb/composer-overload-class. That's a good way when you need it, without renaming namespace everywhere (we can't, that's not a fork ;))., _(*6)

Changelog, _(*7)

Installation

Add it to your composer.json :, _(*8)

composer require huttopia/doctrine ^1.3.2

# app/AppKernel.php

class AppKernel extends Kernel
{
    public function registerBundles(): array
    {
        $bundles = [
            new Huttopia\Doctrine\Bridge\Symfony3\HuttopiaDoctrineBundle()
        ];

        return $bundles;
    }
}

Change Doctrine configuration :, _(*10)

# app/config/config.yml

doctrine:
    orm:
        repository_factory: huttopia.doctrine.repository_factory
        default_repository_class: Huttopia\Doctrine\Orm\EntityRepository

Configuration :, _(*11)

# app/config/config.yml

huttopia_doctrine:
    repository_factory_service: huttopia.doctrine.repository_factory # this is default value

Doctrine bugs

Bugs who are fixed or not fixed by Doctrine, for some reasons : - fixed by steevanb/doctrine-events Fix a Doctrine UnitOfwork bug with extraUpdates, who are not removed when you add and remove your entity before calling flush() - #6042 (not fixed) getId() lazy load entity if getId() is in trait : not fixed, just to remember why we don't use trait for getId() - #6110 (fixed) Clear $this->collection even when empty, to reset keys - #6509 (fixed here) PersistentCollection::clear() and removeElement() with orphanRemoval will remove your entity, although you don't want, _(*12)

For now, we fix 2.5.6 for doctrine/orm dependency : >2.5.6 and 2.6 has wrong tag (some dependencies are on dev-master, whithout version), some BC etc., _(*13)

We will change it when 2.6 will be more tested., _(*14)

Repositories as service

Yes, you need it too ;) Repositories as service is one of the biggest improvement., _(*15)

Now, we can define your repository as service, with huttopia.repository tag :, _(*16)

services:
    bar_repository:
        class: Foo\Repository\BarRepository
        arguments: ['@service', '%parameter%']
        tags:
            - { name: huttopia.repository, entity: Foo\Bar }

You need to change extends Doctrine\ORM\EntityRepository by extends Huttopia\Doctrine\Orm\EntityRepository in your repositories., _(*17)

Take care, our repository remove magic methods (findOneById() for example)., _(*18)

But it add a lot of methods : - getClassName(): string - getClassTableName(): string - createQueryBuilderWithoutSelect(string $alias, string $indexBy = null): QueryBuilder - get(int $id): Entity - getOneBy(array $criteria, array $orderBy = null): Entity - countAll(): int - countBy(array $params): int - findReadOnlyBy(array $criteria, array $fields = null, array $orderBy = null, $limit = null, $offset = null): array - getPartialReference(int $id), _(*19)

Difference between find() and get(), and findOneBy() and getOneBy() : when entity is not found, find() will return null, as get() will throw an exception., _(*20)

When you use PARTIAL, you can call createQueryBuilderWithoutSelect() instead of createQueryBuilder(), who will not select all root entity fields., _(*21)

Remove useless discriminator in SQL for single table inheritance

With SINGLE_TABLE_INHERITANCE entities, Doctrine add discriminator columns into all SQL queries., _(*22)

But if you want to query all entities, Doctrine add useless WHERE clause with discriminator : not really good for performances ;), _(*23)

Huttopia\Doctrine\SqlWalker\IgnoreDiscriminator override Doctrine SqlWalker, to add WHERE clause only when needed., _(*24)

Add it for a single query :, _(*25)

use Huttopia\Doctrine\SqlWalker\IgnoreDiscriminator

$queryBuilder
    ->getQuery()
    ->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, IgnoreDiscriminator::class);

Add it for all queries :, _(*26)

# app/AppKernel.php

class AppKernel
{
    public function boot(): void
    {
        parent::boot();

        foreach ($this->getContainer()->get('doctrine')->getManagers() as $manager) {
            if ($manager instanceof EntityManagerInterface) {
                $manager->getConfiguration()->setDefaultQueryHint(
                    Query::HINT_CUSTOM_OUTPUT_WALKER,
                    IgnoreDiscriminator::class
                );
            }
        }
    }
}

#6509 Fix PersistentCollection orphanRemoval management

When you call remove(), removeElement() or clear() on PersistentCollection, and your manyToOne configuration define orphanRemoval as true, PersistentCollection will add your deleted entity in UnitOfWork::$orphanRemovals., _(*27)

flush() will read UnitOfWork::$orphanRemovals, and delete all entities, although they are deleted then added., _(*28)

So, if you remove an entity, then add it again, then flush(), finally, your entity will be deleted., _(*29)

To fix it, we override PersistentCollection, and unschedule orphanRemovals when we add entity to PersistentCollection., _(*30)

See ComposerOverloadClass installation., _(*31)

Override PersistentCollection to fix it :, _(*32)

{
    "extra": {
        "composer-overload-class": {
            "Doctrine\\ORM\\PersistentCollection": {
                "original-file": "vendor/doctrine/orm/lib/Doctrine/ORM/PersistentCollection.php",
                "overload-file": "vendor/huttopia/doctrine/ComposerOverloadClass/Orm/PersistentCollection.php",
                "replace": true
            }
        }
    }
}

Enable steevanb/doctrine-events

It will replace EntityManager, to add some events : onCreateEntityOverrideLocalValues, onCreateEntityDefineFieldValues, onNewEntityInstance etc., _(*33)

See Installation to install it., _(*34)

Enable steevanb/doctrine-entity-merger

When you use PARTIAL in DQL, you retrieve only fields you need, instead of all Entity fields., _(*35)

But, if you execute 2 PARTIAL on same entity, but not same fields, your final entity will not have second PARTIAL data, only first one is hydrated., _(*36)

See Installation to install it., _(*37)