是否有内置方法来获取Doctrine 2实体中的所有已更改/更新的字段

问题描述 投票:73回答:8

让我们假设我检索一个实体$e并用setter修改它的状态:

$e->setFoo('a');
$e->setBar('b');

有没有可能检索已更改的字段数组?

在我的例子的情况下,我想要检索foo => a, bar => b作为结果

PS:是的,我知道我可以修改所有的访问者并手动实现这个功能,但我正在寻找一些方便的方法来做到这一点

php symfony doctrine-orm doctrine
8个回答
129
投票

你可以使用Doctrine\ORM\EntityManager#getUnitOfWork来获得Doctrine\ORM\UnitOfWork

然后通过Doctrine\ORM\UnitOfWork#computeChangeSets()触发变更集计算(仅适用于托管实体)。

如果您确切地知道要检查的内容而不迭代整个对象图,则也可以使用类似于Doctrine\ORM\UnitOfWork#recomputeSingleEntityChangeSet(Doctrine\ORM\ClassMetadata $meta, $entity)的方法。

之后,您可以使用Doctrine\ORM\UnitOfWork#getEntityChangeSet($entity)检索对象的所有更改。

把它放在一起:

$entity = $em->find('My\Entity', 1);
$entity->setTitle('Changed Title!');
$uow = $em->getUnitOfWork();
$uow->computeChangeSets(); // do not compute changes if inside a listener
$changeset = $uow->getEntityChangeSet($entity);

注意。如果尝试在preUpdate侦听器中获取更新的字段,请不要重新计算更改集,因为它已经完成。只需调用getEntityChangeSet即可获得对实体所做的所有更改。

警告:如评论中所述,不应在Doctrine事件侦听器之外使用此解决方案。这将打破Doctrine的行为。


36
投票

对于那些想要使用上述方法检查实体更改的人来说,要注意大的标志。

$uow = $em->getUnitOfWork();
$uow->computeChangeSets();

$uow->computeChangeSets()方法由持久化例程在内部使用,使得上述解决方案无法使用。这也是对方法的评论中写的:@internal Don't call from the outside。在使用$uow->computeChangeSets()检查实体的更改后,在方法结束时执行以下代码(每个管理实体):

if ($changeSet) {
    $this->entityChangeSets[$oid]   = $changeSet;
    $this->originalEntityData[$oid] = $actualData;
    $this->entityUpdates[$oid]      = $entity;
}

$actualData数组保存实体属性的当前更改。一旦这些写入$this->originalEntityData[$oid],这些尚未持久的更改将被视为实体的原始属性。

后来,当调用$em->persist($entity)来保存对实体的更改时,它也涉及方法$uow->computeChangeSets(),但现在它将无法找到实体的更改,因为这些尚未持久的更改被认为是原始属性实体。


28
投票

检查这个公共(而不是内部)功能:

$this->em->getUnitOfWork()->getOriginalEntityData($entity);

来自学说repo

/**
 * Gets the original data of an entity. The original data is the data that was
 * present at the time the entity was reconstituted from the database.
 *
 * @param object $entity
 *
 * @return array
 */
public function getOriginalEntityData($entity)

您所要做的就是在您的实体中实现toArrayserialize函数并制作差异。像这样的东西:

$originalData = $em->getUnitOfWork()->getOriginalEntityData($entity);
$toArrayEntity = $entity->toArray();
$changes = array_diff_assoc($toArrayEntity, $originalData);

5
投票

您可以使用Notify policies跟踪更改。

首先,实现NotifyPropertyChanged接口:

/**
 * @Entity
 * @ChangeTrackingPolicy("NOTIFY")
 */
class MyEntity implements NotifyPropertyChanged
{
    // ...

    private $_listeners = array();

    public function addPropertyChangedListener(PropertyChangedListener $listener)
    {
        $this->_listeners[] = $listener;
    }
}

然后,只需在每个更改数据的方法上调用_onPropertyChanged,如下所示:

class MyEntity implements NotifyPropertyChanged
{
    // ...

    protected function _onPropertyChanged($propName, $oldValue, $newValue)
    {
        if ($this->_listeners) {
            foreach ($this->_listeners as $listener) {
                $listener->propertyChanged($this, $propName, $oldValue, $newValue);
            }
        }
    }

    public function setData($data)
    {
        if ($data != $this->data) {
            $this->_onPropertyChanged('data', $this->data, $data);
            $this->data = $data;
        }
    }
}

1
投票

那么......当我们想要在Doctrine生命周期之外找到变更集时该怎么办?正如我在上面关于@Ocramius的帖子的评论中所提到的,也许有可能创建一个“readonly”方法,它不会混淆实际的Doctrine持久性,但会让用户看到已经发生了什么变化。

这是我正在考虑的一个例子......

/**
 * Try to get an Entity changeSet without changing the UnitOfWork
 *
 * @param EntityManager $em
 * @param $entity
 * @return null|array
 */
public static function diffDoctrineObject(EntityManager $em, $entity) {
    $uow = $em->getUnitOfWork();

    /*****************************************/
    /* Equivalent of $uow->computeChangeSet($this->em->getClassMetadata(get_class($entity)), $entity);
    /*****************************************/
    $class = $em->getClassMetadata(get_class($entity));
    $oid = spl_object_hash($entity);
    $entityChangeSets = array();

    if ($uow->isReadOnly($entity)) {
        return null;
    }

    if ( ! $class->isInheritanceTypeNone()) {
        $class = $em->getClassMetadata(get_class($entity));
    }

    // These parts are not needed for the changeSet?
    // $invoke = $uow->listenersInvoker->getSubscribedSystems($class, Events::preFlush) & ~ListenersInvoker::INVOKE_MANAGER;
    // 
    // if ($invoke !== ListenersInvoker::INVOKE_NONE) {
    //     $uow->listenersInvoker->invoke($class, Events::preFlush, $entity, new PreFlushEventArgs($em), $invoke);
    // }

    $actualData = array();

    foreach ($class->reflFields as $name => $refProp) {
        $value = $refProp->getValue($entity);

        if ($class->isCollectionValuedAssociation($name) && $value !== null) {
            if ($value instanceof PersistentCollection) {
                if ($value->getOwner() === $entity) {
                    continue;
                }

                $value = new ArrayCollection($value->getValues());
            }

            // If $value is not a Collection then use an ArrayCollection.
            if ( ! $value instanceof Collection) {
                $value = new ArrayCollection($value);
            }

            $assoc = $class->associationMappings[$name];

            // Inject PersistentCollection
            $value = new PersistentCollection(
                $em, $em->getClassMetadata($assoc['targetEntity']), $value
            );
            $value->setOwner($entity, $assoc);
            $value->setDirty( ! $value->isEmpty());

            $class->reflFields[$name]->setValue($entity, $value);

            $actualData[$name] = $value;

            continue;
        }

        if (( ! $class->isIdentifier($name) || ! $class->isIdGeneratorIdentity()) && ($name !== $class->versionField)) {
            $actualData[$name] = $value;
        }
    }

    $originalEntityData = $uow->getOriginalEntityData($entity);
    if (empty($originalEntityData)) {
        // Entity is either NEW or MANAGED but not yet fully persisted (only has an id).
        // These result in an INSERT.
        $originalEntityData = $actualData;
        $changeSet = array();

        foreach ($actualData as $propName => $actualValue) {
            if ( ! isset($class->associationMappings[$propName])) {
                $changeSet[$propName] = array(null, $actualValue);

                continue;
            }

            $assoc = $class->associationMappings[$propName];

            if ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE) {
                $changeSet[$propName] = array(null, $actualValue);
            }
        }

        $entityChangeSets[$oid] = $changeSet; // @todo - remove this?
    } else {
        // Entity is "fully" MANAGED: it was already fully persisted before
        // and we have a copy of the original data
        $originalData           = $originalEntityData;
        $isChangeTrackingNotify = $class->isChangeTrackingNotify();
        $changeSet              = $isChangeTrackingNotify ? $uow->getEntityChangeSet($entity) : array();

        foreach ($actualData as $propName => $actualValue) {
            // skip field, its a partially omitted one!
            if ( ! (isset($originalData[$propName]) || array_key_exists($propName, $originalData))) {
                continue;
            }

            $orgValue = $originalData[$propName];

            // skip if value haven't changed
            if ($orgValue === $actualValue) {
                continue;
            }

            // if regular field
            if ( ! isset($class->associationMappings[$propName])) {
                if ($isChangeTrackingNotify) {
                    continue;
                }

                $changeSet[$propName] = array($orgValue, $actualValue);

                continue;
            }

            $assoc = $class->associationMappings[$propName];

            // Persistent collection was exchanged with the "originally"
            // created one. This can only mean it was cloned and replaced
            // on another entity.
            if ($actualValue instanceof PersistentCollection) {
                $owner = $actualValue->getOwner();
                if ($owner === null) { // cloned
                    $actualValue->setOwner($entity, $assoc);
                } else if ($owner !== $entity) { // no clone, we have to fix
                    // @todo - what does this do... can it be removed?
                    if (!$actualValue->isInitialized()) {
                        $actualValue->initialize(); // we have to do this otherwise the cols share state
                    }
                    $newValue = clone $actualValue;
                    $newValue->setOwner($entity, $assoc);
                    $class->reflFields[$propName]->setValue($entity, $newValue);
                }
            }

            if ($orgValue instanceof PersistentCollection) {
                // A PersistentCollection was de-referenced, so delete it.
    // These parts are not needed for the changeSet?
    //            $coid = spl_object_hash($orgValue);
    //
    //            if (isset($uow->collectionDeletions[$coid])) {
    //                continue;
    //            }
    //
    //            $uow->collectionDeletions[$coid] = $orgValue;
                $changeSet[$propName] = $orgValue; // Signal changeset, to-many assocs will be ignored.

                continue;
            }

            if ($assoc['type'] & ClassMetadata::TO_ONE) {
                if ($assoc['isOwningSide']) {
                    $changeSet[$propName] = array($orgValue, $actualValue);
                }

    // These parts are not needed for the changeSet?
    //            if ($orgValue !== null && $assoc['orphanRemoval']) {
    //                $uow->scheduleOrphanRemoval($orgValue);
    //            }
            }
        }

        if ($changeSet) {
            $entityChangeSets[$oid]     = $changeSet;
    // These parts are not needed for the changeSet?
    //        $originalEntityData         = $actualData;
    //        $uow->entityUpdates[$oid]   = $entity;
        }
    }

    // These parts are not needed for the changeSet?
    //// Look for changes in associations of the entity
    //foreach ($class->associationMappings as $field => $assoc) {
    //    if (($val = $class->reflFields[$field]->getValue($entity)) !== null) {
    //        $uow->computeAssociationChanges($assoc, $val);
    //        if (!isset($entityChangeSets[$oid]) &&
    //            $assoc['isOwningSide'] &&
    //            $assoc['type'] == ClassMetadata::MANY_TO_MANY &&
    //            $val instanceof PersistentCollection &&
    //            $val->isDirty()) {
    //            $entityChangeSets[$oid]   = array();
    //            $originalEntityData = $actualData;
    //            $uow->entityUpdates[$oid]      = $entity;
    //        }
    //    }
    //}
    /*********************/

    return $entityChangeSets[$oid];
}

它在这里被称为静态方法,但可能成为UnitOfWork中的一个方法......?

我不能快速掌握Doctrine的所有内部,所以可能错过了一些副作用或误解了这个方法的一部分,但是(非常)快速测试它似乎给了我预期的结果查看。

我希望这有助于某人!


1
投票

如果有人仍然对接受的答案采取不同的方式感兴趣(这对我不起作用,而且在个人看来我发现它比这种方式更麻烦)。

我安装了JMS Serializer Bundle并在每个实体和我考虑更改的每个属性上添加了@Group({“changed_entity_group”})。这样,我就可以在旧实体和更新后的实体之间进行序列化,之后只需说$ oldJson == $ updatedJson即可。如果您感兴趣的属性或您想要考虑的属性发生更改,则JSON将不同,如果您甚至想要注册具体更改的内容,则可以将其转换为数组并搜索差异。

我使用这种方法,因为我主要对一堆实体的一些属性感兴趣,而不是完全在实体中。这将是有用的一个例子是,如果你有一个@PrePersist @PreUpdate并且你有一个last_update日期,那将永远更新,因此你将始终得到实体是使用工作单元和类似的东西更新的。

希望这种方法对任何人都有帮助。


0
投票

在我的例子中,对于从远程WS到本地DB的同步数据,我使用这种方式比较两个实体(检查旧实体是否有来自编辑实体的差异)。

我简单地克隆了持久化实体,使两个对象不被持久化:

<?php

$entity = $repository->find($id);// original entity exists
if (null === $entity) {
    $entity    = new $className();// local entity not exists, create new one
}
$oldEntity = clone $entity;// make a detached "backup" of the entity before it's changed
// make some changes to the entity...
$entity->setX('Y');

// now compare entities properties/values
$entityCloned = clone $entity;// clone entity for detached (not persisted) entity comparaison
if ( ! $em->contains( $entity ) || $entityCloned != $oldEntity) {// do not compare strictly!
    $em->persist( $entity );
    $em->flush();
}

unset($entityCloned, $oldEntity, $entity);

另一种可能性而不是直接比较对象:

<?php
// here again we need to clone the entity ($entityCloned)
$entity_diff = array_keys(
    array_diff_key(
        get_object_vars( $entityCloned ),
        get_object_vars( $oldEntity )
    )
);
if(count($entity_diff) > 0){
    // persist & flush
}

0
投票

它将返回更改

$entityManager->getUnitOfWork()->getEntityChangeSet($entity)
© www.soinside.com 2019 - 2024. All rights reserved.