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

Posted

技术标签:

【中文标题】扩展 EntityType,仅将选项设置为选定的实体【英文标题】:extend EntityType, set choices to selected Entity only 【发布时间】:2017-03-10 17:01:42 【问题描述】:

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

User 实体与我的应用程序中的许多不同实体相关。但是,如果我希望 UserChooserType 加载 a current 选定的用户,我必须为使用它的每个表单添加一个侦听器。例如:

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;

我愿意:

UserChooserTypechoices选项设置为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;
    

【问题讨论】:

快速问:您希望将选择限制为登录用户?还是让它们成为默认选择? @CameronHurd:我想将选择限制为只有已经附加到实体的用户(如果有的话)。登录的用户很可能完全是其他人。例如$site1:siteAdmin = $user1。所以UserChooserType 选择 opt 应该只包含$user1,并且它应该被标记为“已选择”。但是$office2:coordinator = null,所以它的UserChooserType 选项应该是空的。当有人键入搜索字符串时,其他选项通过 Ajax 填充。 【参考方案1】:

这帮助了我: 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 + '" ></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)
    )
  (),

【讨论】:

【参考方案2】:

先说几点:

字段名UserChooserType有点详细。 UserType 更短更清晰,更符合 Symfony 命名约定 我不会从EntityType 扩展UserChooserType。 Doc 说EntityType 专门用于来自 Doctrine 的实体。它增加了魔力,因此可以轻松地围绕 Doctrine 配置该字段:转换器、从数据库中自动获取选择等。如果您的用户在 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-&gt;getToken()-&gt;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);
    
);

类似的东西。不知道这会如何工作。

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

【讨论】:

感谢您的努力。但我不需要安全令牌。附加到某个实体的用户可能不是当前用户。 2、我的表单类是服务。 Symfony3 已弃用短命名。 3、UserManager与Ldap通信,是一个服务。 4、User对象是一个Doctrine实体并且它与一个ldap对象相关。它类似于混合的 ORM 和 ODM 系统,不同之处在于使用 ldap 而不是 ODM。最后,您的建议没有解决核心问题,即填充 choices 的查询需要在执行查询之前知道所选值是什么。 好的,感谢您强调折旧,我显然不是最新的。另外...我记得,如果您选择的选项不在选项列表中,EntityType 将在验证时失败。在目前的情况下,验证步骤是否有效?最后,您是否尝试过将 choices 保留为默认值,而不是强制为空数组? 当提交的选项不在列表中时,choicetypeentitytype 都会失败。 $builder-&gt;resetViewTransformers(); 解决了这个问题。如果我默认保留choices,它会用数据库中的每个用户填充列表。我目前在数据库中有大约 100 个用户,还有更多用户。由于 User 实体的每个实例化都需要一个 ldap 查询,所以我不想在实际需要用户之前加载它们。

以上是关于扩展 EntityType,仅将选项设置为选定的实体的主要内容,如果未能解决你的问题,请参考以下文章

如何仅将输入文件的选定列复制到jcl排序中的输出文件

仅将样式应用于可编辑内容中的选定文本 <p>

Symfony 表单 - EntityType 通过实体 ID 选择选项

如何仅将应用程序片段设置为纵向模式?

如何在Javascript中将选定选项设置为默认选择

如何仅将选定的行从handsontable导出到csv