数据转换器与约束

Question

我偶然发现了一个关于Symfony's DataTransformers 以及如何正确使用它们的问题。虽然我知道如何实现并将它们添加到我的表单字段中，但我想知道 DataTransformers 应该如何与 Constraints 结合使用。

以下代码显示了我的用例。

形式

<?php

namespace AppBundle\Form;

use AppBundle\Form\DataTransformer\Consent\ConsentTransformer;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
use Symfony\Component\Form\Extension\Core\Type\SubmitType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Validator\Constraints\IsTrue;

class ConsentTestForm extends AbstractType
{
    /** @var ConsentTransformer $consentTransformer */
    private $consentTransformer;

    /**
     * ConsentTestForm constructor.
     * @param ConsentTransformer $consentTransformer
     */
    public function __construct(ConsentTransformer $consentTransformer)
    {
        $this->consentTransformer = $consentTransformer;
    }

    /**
     * @inheritDoc
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder->add('accountConsent', CheckboxType::class, [
            'constraints' => [
                new IsTrue()
            ]
        ]);
        $builder->get('accountConsent')->addModelTransformer($this->consentTransformer);

        $builder->add('submit', SubmitType::class);
    }
}

模型

<?php

class User extends Concrete implements \Pimcore\Model\DataObject\DirtyIndicatorInterface
{
    protected $accountConsent;

    /**
     * ...
     */
    public function getAccountConsent () {
        // ...
    }

    /**
     * ...
     */
    public function setAccountConsent ($accountConsent) {
        // ...
    }
}

为简洁起见，省略了很多代码。型号是Pimcore class。

数据转换器

<?php

namespace Passioneight\Bundle\FormBuilderBundle\Form\DataTransformer\Consent;

use Pimcore\Model\DataObject\Data\Consent;
use Symfony\Component\Form\DataTransformerInterface;

class ConsentTransformer implements DataTransformerInterface
{
    /**
     * @inheritDoc
     * @param Consent|null $consent
     */
    public function transform($consent)
    {
        return $consent instanceof Consent && $consent->getConsent();
    }

    /**
     * @inheritDoc
     * @param bool|null $consented
     */
    public function reverseTransform($consented)
    {
        $consent = new Consent();
        $consent->setConsent($consented ?: false);
        return $consent;
    }
}

如您所见，任何提交的值（即null、true、false）都将转换为Consent，反之亦然。

控制器

<?php

namespace AppBundle\Controller;

use AppBundle\Form\ConsentTestForm;
use AppBundle\Model\DataObject\User;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

/**
 * Class TestController
 * @package AppBundle\Controller
 *
 * @Route("/test")
 */
class TestController extends AbstractFrontendController
{
    /**
     * @Route("/form")
     * @param Request $request
     * @return Response
     */
    public function formAction(Request $request)
    {
        $user = new User();

        $form = $this->createForm(ConsentTestForm::class, $user);
        $form->handleRequest($request);

        if ($form->isSubmitted()) {
            if ($form->isValid()) {
                p_r("VALID");
                p_r($user);
            } else {
                p_r("NOT VALID");
            }
        };

        return $this->renderTemplate(':Test:form.html.twig', [
            "form" => $form->createView()
        ]);
    }
}

请注意 new User() 如何作为实体传递，以便使用提交的值自动填充它。

观点

{{ form(form) }}

问题

表单可以构建得很好，最终显示一个带有我指定标签的复选框。由于转换器，checked 状态甚至可以正确显示，因为transform 方法将Users Consent 转换为boolean。

但是，在提交表单时，会显示一个错误，说需要帐户同意。虽然在未给予同意的情况下提交表单时这很好，但在真正同意时并不是理想的结果。

同意时，提交的值将转换为Consent，然后将保留值true。但是由于转换是在验证提交的值之前完成的，因此会显示前面提到的错误。出现这种情况是因为在表单中添加的accountConsent 字段有一个Constraint 集，即IsTrue。因此，IsTrueValidator 会验证 Consent（而不是实际提交的值）。

显然，IsTrueValidator 无法知道 Pimcore 的 Consent 类。

问题

所有这些都给我留下了一个问题：如何正确地将IsTrue-constraint 与我的ConsentDataTransformer 结合起来？

Answer 1

验证的问题是您试图将对象验证为布尔类型。当您尝试验证并在提交表单时转换时，总是会执行约束。所以您已经转换了数据，这就是为什么IsBool 验证失败的原因，因为该值属于 Consent 对象类型；不是布尔值。

要解决这个问题，您必须创建新的验证约束来覆盖 IsTrue。

<?php

namespace App\Form\Validator;

use Symfony\Component\Validator\Constraints\IsTrue;

class IsConsented extends IsTrue
{
    public $message = 'You need to consent!';
}

和一个验证器在同一个命名空间上；

<?php

namespace App\Form\Validator;

use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Constraints\IsTrueValidator;

class IsConsentedValidator extends IsTrueValidator
{
    public function validate($value, Constraint $constraint)
    {
        return parent::validate($value->getConsent(), $constraint);
    }
}

然后你需要用IsConsented改变你的IsTrue约束，如下所示；

<?php

namespace App\Form;

use App\Entity\User;
use App\Form\DataTransformer\ConsentTransformer;
use App\Form\Validator\IsConsented;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
use Symfony\Component\Form\Extension\Core\Type\SubmitType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

class ConsentTestFormType extends AbstractType
{
    /** @var ConsentTransformer $consentTransformer */
    private $consentTransformer;

    /**
     * ConsentTestForm constructor.
     * @param ConsentTransformer $consentTransformer
     */
    public function __construct(ConsentTransformer $consentTransformer)
    {
        $this->consentTransformer = $consentTransformer;
    }

    /**
     * @inheritDoc
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('accountConsent', CheckboxType::class, [
            'constraints' => [
                new IsConsented()
            ]
        ]);
        $builder->get('accountConsent')->addModelTransformer($this->consentTransformer);

        $builder->add('submit', SubmitType::class);
    }

    public function configureOptions(OptionsResolver $resolver)
    {
        $resolver->setDefaults([
            'data_class' => User::class,
        ]);
    }
}

就是这样。您的表格现在有效。输出应该是这样的；

FormController.php on line 30:
"VALID"