Merge pull request #92 from jacquesbh/feature/tags

Add tags filtering

README.md

@@ -77,6 +77,33 @@ To display the content of the rich editor field you must call the twig filter:
 
 You can see an example in the [test application](/tests/Application/templates/bundles/SyliusShopBundle/Product/Show/Tabs/Details/_description.html.twig)
 
+### Filter the elements
+
+If you want to filter the elements which are available for your field, you can use the `tags` option when you build your form.  
+As example:
+
+```php
+$builder->add('description', RichEditorType::class, [
+    'required' => false,
+    'label' => 'sylius.form.product.description',
+    'tags' => ['product'],
+]);
+```
+
+In that example, only the Ui Elements with the tag `product` will be available.  
+Don't worry, you can add this filter afterwards, we won't remove the already present Ui Elements of your field. But we
+won't allow to add more if they don't have one of the allowed tags!
+
+#### Example of setting tags to an Ui Element using yaml
+
+```yaml
+monsieurbiz_sylius_richeditor:
+    ui_elements:
+        app.my_element:
+            # … 
+            tags: ['product']
+```
+
 ## Available elements
 
 The plugin already contains some simple elements.
@@ -152,6 +179,7 @@ monsieurbiz_sylius_richeditor:
             templates:
                 admin_render: '/Admin/UiElement/google_maps.html.twig'
                 front_render: '/Shop/UiElement/google_maps.html.twig'
+            tags: []
 ```
 
 You can use your own Ui Element object if needed. Be sure to implement the

assets/js/app.js

@@ -143,6 +143,8 @@ global.MonsieurBizRichEditorManager = class {
 
     let inputValue = this.input.value.trim();
 
+    this.tags = this.input.dataset.tags.length === 0 ? [] : this.input.dataset.tags.split(',');
+
     let initInterfaceCallback = function () {
       this.initInterface();
     }.bind(this);
@@ -325,10 +327,19 @@ global.MonsieurBizRichEditorManager = class {
     let cardsContainer = this.selectionPanel.dialog.querySelector('.js-uie-cards-container');
     cardsContainer.innerHTML = '';
     for (let elementCode in this.config.uielements) {
-      if (this.config.uielements[elementCode].ignored) {
+      if (this.config.uielements[elementCode].ignored) { // duplicates using aliases
         continue;
       }
-      cardsContainer.append(this.getNewUiElementCard(this.config.uielements[elementCode], position));
+      if (this.tags.length > 0) {
+        for (let tagIndex in this.tags) {
+          if (0 <= this.config.uielements[elementCode].tags.indexOf(this.tags[tagIndex])) {
+            cardsContainer.append(this.getNewUiElementCard(this.config.uielements[elementCode], position));
+            break;
+          }
+        }
+      } else {
+        cardsContainer.append(this.getNewUiElementCard(this.config.uielements[elementCode], position));
+      }
     }
     this.newPanel.close();
     this.selectionPanel.open();

src/DependencyInjection/Configuration.php

@@ -73,6 +73,10 @@ private function addUiElements(ArrayNodeDefinition $rootNode): void
                                     ->scalarNode('front_render')->isRequired()->cannotBeEmpty()->end()
                                 ->end()
                             ->end()
+                            ->arrayNode('tags')
+                                ->defaultValue([])
+                                ->scalarPrototype()->end()
+                            ->end()
                         ->end()
                     ->end()
                 ->end()

src/Form/Type/RichEditorType.php

@@ -16,6 +16,7 @@
 use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\Form\FormView;
+use Symfony\Component\OptionsResolver\OptionsResolver;
 
 class RichEditorType extends TextType
 {
@@ -25,6 +26,18 @@ class RichEditorType extends TextType
     public function buildView(FormView $view, FormInterface $form, array $options): void
     {
         $view->vars['attr']['data-component'] = 'rich-editor';
+        $view->vars['attr']['data-tags'] = implode(',', $options['tags'] ?? []);
         parent::buildView($view, $form, $options);
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefaults([
+            'compound' => false,
+            'tags' => [],
+        ]);
+    }
 }

src/UiElement/Metadata.php

@@ -154,4 +154,12 @@ public function getServiceId(string $serviceName): string
 
         return sprintf('%s.%s.%s', $code[0], $serviceName, $code[1]);
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getTags(): array
+    {
+        return $this->parameters['tags'] ?? [];
+    }
 }

src/UiElement/MetadataInterface.php

@@ -91,4 +91,9 @@ public function hasTemplate(string $name): bool;
      * @return string
      */
     public function getServiceId(string $serviceName): string;
+
+    /**
+     * @return array
+     */
+    public function getTags(): array;
 }

src/UiElement/UiElementTrait.php

@@ -136,6 +136,7 @@ public function jsonSerialize()
             'icon' => $this->getIcon(),
             'title' => $this->translator->trans($this->getTitle()),
             'ignored' => $this->ignored,
+            'tags' => $this->metadata->getTags(),
         ];
     }
 }

tests/spec/UiElement/MetadataSpec.php

@@ -129,4 +129,21 @@ public function it_gives_its_service_name(): void
     {
         $this->getServiceId('foo')->shouldReturn('app.foo.amigo');
     }
+
+    public function it_gives_empty_tags(): void
+    {
+        $this->getTags()->shouldReturn([]);
+    }
+
+    public function it_gives_tags(): void
+    {
+        $parameters = self::PARAMETERS;
+        $tags = ['foo', 'bar'];
+        $parameters['tags'] = $tags;
+        $this->beConstructedThrough('fromCodeAndConfiguration', [
+            self::CODE,
+            $parameters,
+        ]);
+        $this->getTags()->shouldReturn($tags);
+    }
 }