Gedmo \ Loggable记录未更改的数据

时间:2013-04-26 09:28:29

标签: symfony doctrine-orm symfony-2.2 doctrine-extensions stofdoctrineextensions

我正在使用Symfony2.2和StofDoctrineExtensionsBundle(以及Gedmo DoctrineExtensions)。 我有一个简单的实体

/**
 * @ORM\Entity
 * @Gedmo\Loggable
 * @ORM\Table(name="person")
 */
class Person {
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

[...]

    /**
     * @ORM\Column(type="datetime", nullable=true)
     * @Assert\NotBlank()
     * @Assert\Date()
     * @Gedmo\Versioned
     */
    protected $birthdate;
}

更改现有对象的属性时,会在表ext_log_entries中完成日志条目。此日志表中的条目仅包含已更改的列。我可以通过以下方式阅读日志:

$em = $this->getManager();
$repo = $em->getRepository('Gedmo\Loggable\Entity\LogEntry');
$person_repo = $em->getRepository('Acme\MainBundle\Entity\Person');

$person = $person_repo->find(1);
$log = $repo->findBy(array('objectId' => $person->getId()));
foreach ($log as $log_entry) { var_dump($log_entry->getData()); }

但我不明白的是,为什么字段birthdate始终包含在日志条目中,即使它没有被更改。这里有一些三个日志条目的例子:

array(9) {
  ["salutation"]=>
  string(4) "Herr"
  ["firstname"]=>
  string(3) "Max"
  ["lastname"]=>
  string(6) "Muster"
  ["street"]=>
  string(14) "Musterstraße 1"
  ["zipcode"]=>
  string(5) "00000"
  ["city"]=>
  string(12) "Musterhausen"
  ["birthdate"]=>
  object(DateTime)#655 (3) {
    ["date"]=>
    string(19) "1893-01-01 00:00:00"
    ["timezone_type"]=>
    int(3)
    ["timezone"]=>
    string(13) "Europe/Berlin"
  }
  ["email"]=>
  string(17) "email@example.com"
  ["phone"]=>
  NULL
}

array(2) {
  ["birthdate"]=>
  object(DateTime)#659 (3) {
    ["date"]=>
    string(19) "1893-01-01 00:00:00"
    ["timezone_type"]=>
    int(3)
    ["timezone"]=>
    string(13) "Europe/Berlin"
  }
  ["phone"]=>
  string(9) "123456789"
}

array(2) {
  ["birthdate"]=>
  object(DateTime)#662 (3) {
    ["date"]=>
    string(19) "1893-01-01 00:00:00"
    ["timezone_type"]=>
    int(3)
    ["timezone"]=>
    string(13) "Europe/Berlin"
  }
  ["phone"]=>
  NULL
}

我只想记录真正改变的数据。有没有我没见过的选择?这似乎与birthdateDateTime对象的事实有关,不是吗?

修改 它与DateTime对象无关。这甚至在其他实体中也会发生。我有另一个包含简单值的实体:

/**
 * @ORM\Entity
 * @Gedmo\Loggable
 * @ORM\Entity(repositoryClass="Acme\MainBundle\Repository\ApplicationRepository")
 * @ORM\Table(name="application")
 */
class Application {

[...]

    /**
     * @ORM\Column(type="integer")
     * @Assert\NotBlank(groups={"FormStepOne", "UserEditApplication"})
     * @Gedmo\Versioned
     */
    protected $insurance_number;
}

在浏览器中打开编辑表单时保存而不进行修改,日志表包含:

update  2013-04-26 11:32:42     Acme\MainBundle\Entity\Application  a:1:{s:16:"insurance_number";s:7:"1234567";}
update  2013-04-26 11:33:17     Acme\MainBundle\Entity\Application  a:1:{s:16:"insurance_number";s:7:"1234567";}

为什么?

3 个答案:

答案 0 :(得分:7)

这可能与我在使用其他扩展(timestampable)时遇到的问题类似,即:在doctrine中使用的默认更改跟踪策略(它尝试自动检测更改)有时会将实体标记为脏,当它们不是(对我而言,当我的实体包含一个日期时间对象时,这是可以理解的,因为这是一个在从数据库中提取时需要构造的对象)。这不是一个错误或任何东西 - 它是预期的行为,并且有一些方法围绕它。

可能值得尝试对要记录的实体实施替代更改跟踪策略,并查看是否修复了这些问题 - 我猜这种行为(日志记录)不会启动,除非实体状态是脏的,您可以通过手动实施更改跟踪来避免:

http://docs.doctrine-project.org/en/latest/cookbook/implementing-the-notify-changetracking-policy.html

不要忘记更新您的实体:

YourBundle\Entity\YourThing:
    type: entity
    table: some_table
    changeTrackingPolicy: NOTIFY

见这个帖子:

https://github.com/Atlantic18/DoctrineExtensions/issues/333#issuecomment-16738878

答案 1 :(得分:1)

我今天也遇到了这个问题并解决了它。 这是完整的解决方案,适用于所有string,float,int和DateTime值。

  1. 创建自己的LoggableListener并使用它而不是Gedmo Listener。

    <?php
    
    namespace MyBundle\Loggable\Listener;
    
    use Gedmo\Loggable\LoggableListener;
    use Gedmo\Tool\Wrapper\AbstractWrapper;
    
    class MyLoggableListener extends LoggableListener
    {
        protected function getObjectChangeSetData($ea, $object, $logEntry)
        {
            $om = $ea->getObjectManager();
            $wrapped = AbstractWrapper::wrap($object, $om);
            $meta = $wrapped->getMetadata();
            $config = $this->getConfiguration($om, $meta->name);
            $uow = $om->getUnitOfWork();
            $values = [];
    
            foreach ($ea->getObjectChangeSet($uow, $object) as $field => $changes) {
                if (empty($config['versioned']) || !in_array($field, $config['versioned'])) {
                    continue;
                }
    
                $oldValue = $changes[0];
                if ($meta->isSingleValuedAssociation($field) && $oldValue) {
                    if ($wrapped->isEmbeddedAssociation($field)) {
                        $value = $this->getObjectChangeSetData($ea, $oldValue, $logEntry);
                    } else {
                        $oid = spl_object_hash($oldValue);
                        $wrappedAssoc = AbstractWrapper::wrap($oldValue, $om);
                        $oldValue = $wrappedAssoc->getIdentifier(false);
                        if (!is_array($oldValue) && !$oldValue) {
                            $this->pendingRelatedObjects[$oid][] = [
                                'log' => $logEntry,
                                'field' => $field,
                            ];
                        }
                    }
                }
    
                $value = $changes[1];
                if ($meta->isSingleValuedAssociation($field) && $value) {
                    if ($wrapped->isEmbeddedAssociation($field)) {
                        $value = $this->getObjectChangeSetData($ea, $value, $logEntry);
                    } else {
                        $oid = spl_object_hash($value);
                        $wrappedAssoc = AbstractWrapper::wrap($value, $om);
                        $value = $wrappedAssoc->getIdentifier(false);
                        if (!is_array($value) && !$value) {
                            $this->pendingRelatedObjects[$oid][] = [
                                'log' => $logEntry,
                                'field' => $field,
                            ];
                        }
                    }
                }
    
                //fix for DateTime, integer and float entries
                if ($value == $oldValue) {
                    continue;
                }
    
                $values[$field] = $value;
            }
    
            return $values;
        }
    }
    
  2. 对于Symfony应用程序,请在config.yml文件中注册您的侦听器。

    stof_doctrine_extensions:
        orm:
            default:
                loggable: true
        class:
            loggable: MyBundle\Loggable\Listener\MyLoggableListener
    
  3. 如果您在实体中使用DateTime字段,但在数据库中只存储日期,那么您还需要在所有设置器中重置时间部分。

    public function setDateValue(DateTime $dateValue = null)
    {
        $dateValue->setTime(0, 0, 0);
        $this->dateValue = $dateValue;
        return $this;
    }
    
  4. 那应该做的。

答案 2 :(得分:0)

对于\DateTime我还在努力,但是对于问题的第二部分,有一种方法可以解决我的Numeric属性问题:

/**
 * @ORM\Entity
 * @Gedmo\Loggable
 * @ORM\Entity(repositoryClass="Acme\MainBundle\Repository\ApplicationRepository")
 * @ORM\Table(name="application")
 */
class Application {

[...]

    /**
     * @ORM\Column(type="integer")
     * @Assert\NotBlank(groups={"FormStepOne", "UserEditApplication"})
     * @Gedmo\Versioned
     */
    protected $insurance_number;
}

在这里,您将insurance_number声明为整数属性,但我们知道PHP没有类型,并且进行动态转换,这与Gedmo Loggable存在冲突。

要解决,只需确保您自己在Setter MethodBusiness Logic中进行明确投射。

例如,

替换此(业务逻辑):

$application->setInsuranceNumber($valueComeFromHtmlForm)

这一个:

$application->setInsuranceNumber( (int)$valueComeFromHtmlForm)

然后,当您持久保存对象时,您将无法在日志中看到任何记录。

我认为这是因为LoggableDoctrine Change Tracker期望Integer并收到String (which is a 'not casted Integer'),因此它会将该属性标记为脏。我们可以在Log Record中看到它(S表示新值是String。)