扩展EntityType,仅将选项设置为选定的实体

时间:2016-10-27 21:14:09

标签: forms symfony select2

我已将Symfony的EntityType扩展为UserChooserType,以便与我的User实体和Select2一起使用。 UserChooserType的选择列表来自ldap查询(通过ajax调用),而不是Doctrine查询。所以该领域开始空白。

User实体与我的应用程序中的许多不同实体相关。但是如果我希望UserChooserType加载当前所选用户,我必须为每个使用它的表单添加一个监听器。 e.g:

class SiteType extends AbstractType
{
    /**
     * @param FormBuilderInterface $builder
     * @param array $options
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $siteAdminOpts = array('label' => 'entity.site.admin', 'required'=>false);
       //opts for the UserChooserType

        $builder
            ->add('siteName', FT\TextType::class, array('label' => 'entity.site.name'))
            ->add('siteAdmin', UserChooserType::class, $siteAdminOpts )

           //must be added to every form type that uses UserChooserType with mod for the datatype that $event->getData() returns
            ->addEventListener(FormEvents::PRE_SET_DATA, function(FormEvent $event){
                $site = $event->getData();
                $form = $event->getForm(); //SiteType

                if($user = $site->getSiteAdmin()) $siteAdminOpts['choices'] = array($user);
                $form->add('siteAdmin', UserChooserType::class, $siteAdminOpts);
            });
    }
//etc.

tldr;

我想要:

  • UserChooserType中的所选用户设置choices&n; UserChooserType::configureOptions()选项,或
  • ->addEventListener(...)移至UserChooserType::buildForm()

知道怎么做吗?

这是UserChooserType:

class UserChooserType extends AbstractType
{
    /**
     * @var UserManager
     */
    protected $um;

    /**
     * UserChooserType constructor.
     * @param UserManager $um
     */
    public function __construct(UserManager $um){
        $this->um = $um; //used to find and decorate User entities. It is not a Doctrine entity manager, but it uses one.
    }

    /**
     * @inheritDoc
     */
    public function buildForm(FormBuilderInterface $builder, array $options) {

        $builder->addEventListener(FormEvents::PRE_SUBMIT, function (FormEvent $event) {
            $data = $event->getData();

            if (!$data) return;

            $user = $this->um->getUserByUserName($data);
            if(!$user->getId()) $this->um->saveUser($user); //create User in db, if it's not there yet.
        });

        $builder->resetViewTransformers(); //so new choices aren't discarded

        $builder->addModelTransformer(new CallbackTransformer(
          function ($user) { //internal storage format to display format
            return ($user instanceof User) ? $user->getUserName() : '';
          },
          function ($username) { //display format to storage format
              return ($username) ? $this->um->getUserByUserName($username) : null;
          }
        ));
    }


    /**
     * {@inheritdoc}
     */
    public function configureOptions(OptionsResolver $resolver)
    {
        $resolver->setDefaults(array(
            'class' => 'ACRDUserBundle:User',
            'label' => 'ldap.user.name',
            'choice_label' => function($user, $key, $index){
                $this->um->decorateUser($user);
                $label = $user->getDetail('displayName');
                return $label ? $label : $user->getUserName();
            },
            'choice_value' => 'userName',
            'choices' => [],
            'attr' => array(
                'class' => 'userchooser',
                'placeholder' => 'form.placeholder.userchooser'
            )

        ));
    }

    /**
     * {@inheritdoc}
     */
    public function getBlockPrefix()
    {
        return 'my_userchooser';
    }

    /**
     * @inheritDoc
     */
    public function getParent() {
        return EntityType::class;
    }
}

2 个答案:

答案 0 :(得分:0)

首先发表一些评论:

  • 字段名称UserChooserType有点详细说明。 UserType更短,更清晰,更符合Symfony命名惯例
  • 我不会从UserChooserType延长EntityType。 Doc说EntityType专门用于来自Doctrine的实体。它添加了魔法,以便在Doctrine:变换器,从DB自动获取选项等方面轻松配置字段。如果您的用户在LDAP中完全定义,我建议扩展ChoiceType并填充您的选择直接使用LDAP。

回到你的问题,你想要的是通过声明你的field type as a service来利用依赖注入的全能力量。完成后,而不是:

$builder->add('siteAdmin', UserChooserType::class, $siteAdminOpts)

您将这样做(假设您选择了表单名称user_chooser_type):

$builder->add('siteAdmin', 'user_chooser_type', $siteAdminOpts)

您需要将security.token_storage服务注入您的字段类型。这是保存当前用户信息的服务,您可以这样访问:

$user = $securityTokenStorage->getToken()->getUser();

这样,默认值的填充可以发生在字段类型级别而不是其父级。

使用此功能,您还可以通过注入能够与LDAP通信的服务,在字段类型级别添加LDAP选项。

最后应该注意到所有默认的symfony字段类型也被声明为服务。

修改

以前的答案不是重点。

在Symfony中,我不知道在创建选项/实体字段的选项列表之后修改选项/实体字段的任何可能的简单方法。我不认为有,实际上我可能会像你一样解决你所描述的问题。

我的意见是,你已经做了在这种情况下需要做的事情。

如果您真的有动力,我认为可能只需要在表单类型中移动事件监听器:

->addEventListener(FormEvents::PRE_SET_DATA, function(FormEvent $event) use ($options) {
    if ($form->hasParent()) {
        $data = $event->getData();
        $form = $event->getForm();

        $method = 'get' . ucfirst($form['action_name']);
        if($user = $data->$method()) $siteAdminOpts['choices'] = array($user);
        $form->getParent()->add($options['form_name'], UserChooserType::class, $siteAdminOpts);
    }
});

这样的事情。不知道那会怎么样。

我仍然有兴趣看看是否有人想出一个干净的解决方案。

答案 1 :(得分:0)

这帮了我: https://symfony.com/doc/current/reference/forms/types/entity.html#using-choices

这是我的使用方法(再次选择 2):

public function buildForm(FormBuilderInterface $builder, array $options)
{
    /** @var ProductCollection $productCollection */
    $productCollection = $builder->getData();

    $builder
        ->add('products', EntityType::class,
            [
                'class' => Product::class,
                'required' => FALSE,
                'expanded' => FALSE,
                'multiple' => TRUE,
                'choices' => $productCollection->getProducts(), // We only preload the selected products. The rest come from api.
                'attr' => [
                    'data-toggle' => 'select',
                    'data-options' => json_encode([
                        'ajax' => [
                            'url' => '/admin/product/autocomplete',
                            'dataType' => 'json'
                        ]
                    ])
                ],
                'choice_label' => function (Product $product) {
                    return $product->getName();
                },
                'choice_attr' => function (Product $product) {
                    return [
                        'data-avatarsrc' => $product->getImage()->getUrl(),
                        'data-caption' => $product->getSkus()->first()->getSku(),
                    ];
                },
            ]
        )
    ;
}

这是我用于 select2 初始化的 JS(复制/粘贴):

function() {
    var elements = document.querySelectorAll('[data-toggle="select"]');

    function templateResult(element) {
      let avatarsrc, caption;

      if (element.id && element.avatarsrc) {
        avatarsrc = element.avatarsrc
        caption = element.caption ? ' ' + element.caption : ''
      }
      else if (element.element) {
        avatarsrc = element.element.dataset.avatarsrc ? element.element.dataset.avatarsrc : ''
        caption = element.element.dataset.caption ? ' ' + element.element.dataset.caption : ''
      }

      if (!avatarsrc) {
        return element.text + caption
      }

      let wrapper = document.createElement("div");
      return wrapper.innerHTML = '<span class="avatar avatar-xs mr-3 my-2"><img class="avatar-img rounded-circle" src="' + avatarsrc + '" alt="' + element.text + '"></span><span>' + element.text + '</span><span class="badge badge-soft-success ml-2">' + caption + '</span>', wrapper
    }
    
    jQuery().select2 && elements && [].forEach.call(elements, function(element) {
      var select, additionalOptions, select2options;

      additionalOptions = (select = element).dataset.options ? JSON.parse(select.dataset.options) : {};

      select2options = {
        containerCssClass: select.getAttribute("class"),
        dropdownCssClass: "dropdown-menu show",
        dropdownParent: select.closest(".modal") ? select.closest(".modal") : document.body,
        templateResult: templateResult,
        templateSelection: templateResult
      }

      $(select).select2({...select2options, ...additionalOptions})
    })
  }(),