fix for PreUpdate listeners dispatching

[vgarvardt]

Catchable Fatal Error: Argument 3 passed to Doctrine\ORM\Event\PreUpdateEventArgs::__construct() must be an array, null given

[beberlei]

Why empty()? Can this just be if ($this->changes...[$oid]) as before?

[vgarvardt]

When $this->entityChangeSets[$oid] is not set PHP Notice is thrown.
Maybe isset(...) may be used instead of !empty(...), but not the original code IMO.

[asm89]

We've been trying to come up with ways of how this can happen and were unable to reproduce it. Can you re-open a PR with a failing testcase? Or explain exactly what your code does?

[dcousineau]

Closing this ticket was premature, our application also encountered this edge case however it is understandably difficult to reproduce. The code simply does sanity checks on keys to ensure they exist before accessing them, which is a good habit to have when working with PHP.

[jdewit]

I just came across this error today using a postUpdate listener in Symfony2 using Doctrine 2.2.x.

My listener is similar to the one in this post

This patch fixed the error.

[stof]

You should never flush from inside a lifecycle listener. This means that you are nesting a flush inside another one, leading to unexpected behaviors.

[jdewit]

Thanks for the tip stof. Would firing a separate event after flush to update another entity be the way to go?

[calumbrodie]

I would also be interested in what the correct thing to do in this instance is. I'm using a lifecycle listener in order to log changes on my entities (I create a new 'Log' entity detailing the nature of the change and then persist/flush it).

I perform this after the initial flush has happened (postUpdate/postPersist).

I've not ran into any issue with doing this yet, but it did feel like the wrong thing to do (a flush inside a flush).

[ostretsov]

Also interested in best practice

[stephpy]

I've same issue atm. I would like to update a counter from an other one entity on postUpdate/persist/remove, I guess i have to call flush method during theses lifecycle. Any other solution ? ping @stof

[guilhermeblanco]

When interested to update an entity during the postInsert or postUpdate, as everyone already said, you can't call flush.
The alternative, since the graph was already calculated (so you cannot just update the entity), is to schedule an extra update. Here is an example:

class EntryListener extends ContainerAware
{
    /**
     * @var array
     */
    protected $postInsertScheduleList = array();

    /**
     * Handle Doctrine onFlush event
     *
     * @param \Doctrine\ORM\Event\OnFlushEventArgs $eventArgs "On Flush" event arguments
     */
    public function onFlush(OnFlushEventArgs $eventArgs)
    {
        $entityManager = $eventArgs->getEntityManager();
        $unitOfWork    = $entityManager->getUnitOfWork();

        foreach ($unitOfWork->getScheduledEntityInsertions() as $entity) {
            $entry = $this->scheduleEntryForInsert(EntryType::TYPE_CREATE, $entity, $entityManager);

            $this->postInsertScheduleList[spl_object_hash($entity)] = $entry;
        }

        foreach ($unitOfWork->getScheduledEntityUpdates() as $entity) {
            $this->scheduleEntryForInsert(EntryType::TYPE_UPDATE, $entity, $entityManager);
        }

        foreach ($unitOfWork->getScheduledEntityDeletions() as $entity) {
            $this->scheduleEntryForInsert(EntryType::TYPE_DELETE, $entity, $entityManager);
        }
    }

    /**
     * Post-persist event hook
     *
     * @param LifecycleEventArgs $args Life cycle event arguments
     */
    public function postPersist(LifecycleEventArgs $args)
    {
        $entity     = $args->getEntity();
        $objectHash = spl_object_hash($entity);

        if ( ! isset($this->postInsertScheduleList[$objectHash])) {
            return;
        }

        $entityManager = $args->getEntityManager();
        $unitOfWork    = $entityManager->getUnitOfWork();
        $classMetadata = $entityManager->getClassMetadata(get_class($entity));

        $entityIdentifierList = $unitOfWork->getEntityIdentifier($entity);

        $unitOfWork->scheduleExtraUpdate(
            $this->postInsertScheduleList[$objectHash],
            array(
                'objectId' => array(null, $entityIdentifierList[$classMetadata->identifier[0]])
            )
        );

        unset($this->postInsertScheduleList[$objectHash]);
    }

    /**
     * Schedule a Journal Entry for insertion
     *
     * @param string                                        $entryType     Type of entry
     * @param Entity $entity        Entity
     * @param \Doctrine\ORM\EntityManager                   $entityManager Entity manager
     *
     * @return Entry
     */
    protected function scheduleEntryForInsert($entryType, $entity, $entityManager)
    {
        $service = $this->container->get('entry_builder');
        $entry   = $service->buildEntry($entryType, $entity, $entityManager);

        $unitOfWork    = $entityManager->getUnitOfWork();
        $classMetadata = $entityManager->getClassMetadata(get_class($entry));

        $entityManager->persist($entry);
        $unitOfWork->computeChangeSet($classMetadata, $entry);

        return $entry;
    }
}

[stephpy]

I tried this solution, it fixes my issue, thanks ;)

[jmather]

I got popped over here by someone -- I wanted to say, this is an awesome solution @guilhermeblanco. Amazingly elegant.

[pedrofs]

@guilhermeblanco and if I want to update another entity inside the postUpdate. I tried something similar to what you said:

public function postUpdate($eventArgs)
    {
        $this->em = $eventArgs->getEntityManager();
        $this->uow = $this->em->getUnitOfWork();

        $entity = $eventArgs->getEntity();

        if ($entity instanceof Team) {
            $teams = $this->getTeamsWithSameName($entity);

                foreach ($teams as $t) {
                    $t->setLabel($entity->getLabel());

                    $this->em->persist($t);
                    $classMetadata = $this->em->getClassMetadata(get_class($t));
                    $this->uow->computeChangeSet($classMetadata, $t);
                }
            }
        }
    }

It is not working as expected. Does not update the entities that I need. If I just use the flush method it throws that error. (I have the preUpdate event set by the FOS users)