ecommit/doctrine-orm-refetch

Refetch ORM Doctrine objects. Or detach all entities attached since a snapshot

v1.1.1 2024-06-21 19:40 UTC

Requires

• php: ^8.1
• doctrine/collections: ^1.5|^2.0
• doctrine/common: ^2.11|^3.0
• doctrine/orm: ^2.13|^3.0

Requires (Dev)

• doctrine/cache: ^1.11|^2.0
• doctrine/data-fixtures: ^1.4.1
• fakerphp/faker: ^1.9
• friendsofphp/php-cs-fixer: ^3.0
• phpunit/phpunit: ^10.0
• symfony/cache: *
• vimeo/psalm: ^5

MIT

• Hubert Lecorche

• snapshot
• doctrine
• refetch

README

This library allows to

• re-fetch Doctrine ORM objects after clear the object manager
• detach all entities attached since a snapshot

Installation

To install doctrine-orm-refetch with Composer just run :

$ composer require ecommit/doctrine-orm-refetch

Usage

Create the utility ($entityManager is the Doctrine ORM entity manager):

use Ecommit\DoctrineOrmRefetch\RefetchManager;

$refetchManager = RefetchManager::create($entityManager);

Refetch an object

$myObject = $refetchManager->getFetchedObject($myObject);
//or $refetchManager->refreshObject($myObject);

Example:

use Ecommit\DoctrineOrmRefetch\RefetchManager;

$refetchManager = RefetchManager::create($entityManager);

$author = $entityManager->getRepository(Author::class)->find(1);

$queryBuilder = $entityManager->getRepository(Book::class)->createQueryBuilder('b');
$queryBuilder->select('b')
    ->andWhere('b.bookId != :bookId')
    ->setParameter('bookId', 7);
$iterableResult = $queryBuilder->getQuery()->iterate();

$i = 0;
foreach ($iterableResult as $row) {
    ++$i;
    $book = current($row);

    if (!$book->getAuthors()->contains($author)) {
        $book->addAuthor($author);
    }

    if (0 === $i % 20) {
        //$author is managed
        $entityManager->flush();
        $entityManager->clear();
        //$author is not managed
        $author = $refetchManager->getObject($author);
        //$author is managed
    }
}

$entityManager->flush();
$entityManager->clear();

Get collection by critera

$collection = $refetchManager->getCollectionFromCriteria($criteria, 'MyClass');

Example:

use Doctrine\Common\Collections\Criteria;
use Ecommit\DoctrineOrmRefetch\RefetchManager;

$refetchManager = RefetchManager::create($entityManager);

$ctiteria = Criteria::create()
    ->andWhere(Criteria::expr()->gt('authorId', 2));
$authors = $refetchManager->getCollectionFromCriteria($ctiteria, Author::class);

$queryBuilder = $entityManager->getRepository(Book::class)->createQueryBuilder('b');
$queryBuilder->select('b')
    ->andWhere('b.bookId != :bookId')
    ->setParameter('bookId', 9);
$iterableResult = $queryBuilder->getQuery()->iterate();

$i = 0;
foreach ($iterableResult as $row) {
    ++$i;
    $book = current($row);

    foreach ($authors as $author) {
        if (!$book->getAuthors()->contains($author)) {
            $book->addAuthor($author);
        }
    }

    if (0 === $i % 20) {
        $entityManager->flush();
        $entityManager->clear();
        $authors = $refetchManager->getCollectionFromCriteria($ctiteria, Author::class);
    }
}

$entityManager->flush();
$entityManager->clear();

Snapshot

Detach all entities attached since a snapshot (entities attached before the snapshot are kept)

use Ecommit\DoctrineOrmRefetch\SnapshotManager;

$snapshotManager = SnapshotManager::create($entityManager);

$author = $entityManager->getRepository(Author::class)->find(1);

$snapshotManager->snapshot();

$queryBuilder = $entityManager->getRepository(Book::class)->createQueryBuilder('b');
$queryBuilder->select('b')
    ->andWhere('b.bookId != :bookId')
    ->setParameter('bookId', 7);
$iterableResult = $queryBuilder->getQuery()->iterate();

$i = 0;
foreach ($iterableResult as $row) {
    ++$i;
    /** @var Book $book */
    $book = current($row);

    if (!$book->getAuthors()->contains($author)) {
        $book->addAuthor($author);
    }

    if (0 === $i % 2) {
        // $author and $book are managed
        $entityManager->flush();
        $snapshotManager->clear(); // Detach all entities attached since the snapshot
        // Only $author is managed
    }
}

$entityManager->flush();
$snapshotManager->clear();

License

This librairy is under the MIT license. See the complete license in LICENSE file.