Store Provider (#128)

* implementation for issue #127
- implement ToolboxStoreProviderInterface and adapt BrickConfigBuilder
- updated UPGRADE.md
* fix annotation
Co-authored-by: Stefan Hagspiel <info@solverat.com>

Author: pixel81k

README.md

@@ -99,7 +99,8 @@ The Toolbox provides a lot of [ready-to-use Bricks](docs/11_ElementsOverview.md)
 - [Conditional Logic in Configuration](docs/12_ConditionalLogic.md)
 - [CK-Editor Configuration](docs/13_CkEditor.md)
 - [Image Thumbnails Strategy](docs/14_ImageThumbnails.md)
-- [Configuration Context](docs/15_Context.md) (New!)
+- [Configuration Context](docs/15_Context.md)
+- [Editable Store Provider](docs/16_EditableStoreProvider.md)
 - [Create a Custom Brick](docs/10_CustomBricks.md)
 - [Theme / Layout](docs/30_ToolboxTheme.md)
 - [Overriding Views](docs/31_OverridingViews.md)
@@ -109,7 +110,7 @@ The Toolbox provides a lot of [ready-to-use Bricks](docs/11_ElementsOverview.md)
 - [Javascript Plugins](docs/80_Javascript.md)
 
 ## Pimcore Fixes / Overrides
-- fix the pimcore iframe [maskFrames](src/ToolboxBundle/Resources/public/js/document/edit.js#L8) bug (in some cases the iframe overlay field does not apply to the right position)
+- Fix the pimcore iframe [maskFrames](src/ToolboxBundle/Resources/public/js/document/edit.js#L8) bug (in some cases the iframe overlay field does not apply to the right position)
 - Transforms all the brick config buttons (`pimcore_area_edit_button_*`) to more grateful ones.
 
 ## Copyright and license

UPGRADE.md

@@ -8,6 +8,7 @@ Just click the "update" button or execute the migration command to finish the bu
 
 #### Update from Version 3.1.x to Version 3.2.0
 - **[NEW FEATURE]**: Pimcore 6.4.0 and Pimcore 6.5.0 ready
+- **[NEW FEATURE]**: Store Provider added (https://github.com/dachcom-digital/pimcore-toolbox/pull/128)
 - **[BUG FIX]**: Video Autoplay Fix (https://github.com/dachcom-digital/pimcore-toolbox/issues/129)
 
 #### Update from Version 3.x to Version 3.1.0

docs/11_ElementsOverview.md

@@ -497,7 +497,6 @@ toolbox:
 There is also a jquery plugin for the video element. Read more about it [here](80_Javascript.md#video-extension)
 
 # Element Config Field Overview
-
 In short, you're able to use all the [pimcore editables](https://www.pimcore.org/docs/5.0.0/Documents/Editables/index.html).
 
 **Example** 
@@ -513,8 +512,10 @@ toolbox:
                         # https://www.pimcore.org/docs/5.0.0/Documents/Editables/Input.html#page_Configuration
 ```
 
-# Additional Classes
+## Editable Store Provider
+In addition, you could use the toolbox editable store provider to generate dynamic store data. Read more about it [here](./16_EditableStoreProvider.md).
 
+# Additional Classes
 Almost every toolbox element supports the `additionalClasses` field type.
 This Element will help you to generate some additional classes for every toolbox element.
 This is great since you don't need to override the element view, just add one or more additional classes via config.

docs/16_EditableStoreProvider.md

@@ -0,0 +1,69 @@
+# Store Provider for (Multi-) Select Editables
+
+This Bundle allows you to generate dynamic data for your dropdown elements. 
+If you're in pimcore context, a typical store looks like this:
+
+```yml
+toolbox:
+    areas:
+        video:
+            config_elements:
+                a_classical_store:
+                    type: multiselect
+                    title: 'Test 2'
+                    config:
+                        store:
+                            my_value: 'My Value'
+                            foo: 'Bar'
+```
+
+### Configure Dynamic Store Provider
+But you're also able to provide your data from a symfony service: 
+
+```yml
+toolbox:
+    areas:
+        video:
+            config_elements:
+                my_dynamic_store_provider:
+                    type: select
+                    title: 'Test'
+                    config:
+                        store_provider: 'my_awesome_store_provider'
+```
+
+### Register Custom Store Provider
+Now we need to register our new service:
+
+```yml
+# app/config.yml
+services:
+    AppBundle\Toolbox\MyStoreProvider:
+        tags:
+            - { name: toolbox.editable.store_provider, identifier: 'my_awesome_store_provider' }
+
+```
+
+### Create Store Provider
+
+```php
+<?php
+
+namespace AppBundle\Toolbox;
+
+use ToolboxBundle\Provider\StoreProviderInterface;
+
+class MyStoreProvider implements StoreProviderInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function getValues()
+    {
+        return [
+            'my_value' => 'My Value',
+            'foo'      => 'Bar'
+        ];
+    }
+}
+```

src/ToolboxBundle/Builder/BrickConfigBuilder.php

@@ -4,9 +4,10 @@
 
 use Pimcore\Model\Document\Tag\Area\Info;
 use Pimcore\Model\Document\Tag\Checkbox;
-use Pimcore\Translation\Translator;
 use Pimcore\Templating\Renderer\TagRenderer;
+use Pimcore\Translation\Translator;
 use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
+use ToolboxBundle\Registry\StoreProviderRegistryInterface;
 
 class BrickConfigBuilder
 {
@@ -66,20 +67,26 @@ class BrickConfigBuilder
     protected $configWindowSize = null;
 
     /**
-     * ElementBuilder constructor.
-     *
+     * @var StoreProviderRegistryInterface
+     */
+    protected $storeProvider = null;
+
+    /**
      * @param Translator      $translator
      * @param TagRenderer     $tagRenderer
      * @param EngineInterface $templating
+     * @param StoreProviderRegistryInterface $storeProvider
      */
     public function __construct(
         Translator $translator,
         TagRenderer $tagRenderer,
-        EngineInterface $templating
+        EngineInterface $templating,
+        StoreProviderRegistryInterface $storeProvider
     ) {
         $this->translator = $translator;
         $this->tagRenderer = $tagRenderer;
         $this->templating = $templating;
+        $this->storeProvider = $storeProvider;
     }
 
     /**
@@ -181,7 +188,53 @@ private function needStore($type)
      */
     private function hasValidStore($parsedConfig)
     {
-        return isset($parsedConfig['store']) && is_array($parsedConfig['store']) && count($parsedConfig['store']) > 0;
+        if (isset($parsedConfig['store']) && is_array($parsedConfig['store']) && count($parsedConfig['store']) > 0) {
+            return true;
+        }
+
+        if (isset($parsedConfig['store_provider']) && $this->storeProvider->has($parsedConfig['store_provider'])) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * @param string $type
+     * @param array  $config
+     *
+     * @return array
+     * @throws \Exception
+     */
+    private function buildStore($type, $config)
+    {
+        $dataConfig = $config;
+
+        unset($dataConfig['store'], $dataConfig['store_provider']);
+
+        $storeValues = [];
+        if (isset($config['store']) && !is_null($config['store'])) {
+            $storeValues = $config['store'];
+        } elseif (isset($config['store_provider']) && !is_null($config['store_provider'])) {
+            $storeProvider = $this->storeProvider->get($config['store_provider']);
+            $storeValues = $storeProvider->getValues();
+        }
+
+        if (count($storeValues) === 0) {
+            throw new \Exception($type . ' (' . $this->documentEditableId . ') has no valid configured store');
+        }
+
+        $store = [];
+        foreach ($storeValues as $k => $v) {
+            if (is_array($v)) {
+                $v = $v['name'];
+            }
+            $store[] = [$k, $this->translator->trans($v, [], 'admin')];
+        }
+
+        $dataConfig['store'] = $store;
+
+        return $dataConfig;
     }
 
     /**
@@ -293,23 +346,8 @@ private function getTagConfig($type, $config, $additionalConfig)
         }
 
         //check store
-        if ($this->needStore($type) && isset($parsedConfig['store']) && !is_null($parsedConfig['store'])) {
-            if (empty($parsedConfig['store'])) {
-                throw new \Exception($type . ' (' . $this->documentEditableId . ') has no valid configured store');
-            }
-
-            $store = [];
-            foreach ($parsedConfig['store'] as $k => $v) {
-                if (is_array($v)) {
-                    $v = $v['name'];
-                }
-
-                $store[] = [$k, $this->translator->trans($v, [], 'admin')];
-            }
-
-            $parsedConfig['store'] = $store;
-        } else {
-            unset($parsedConfig['store']);
+        if ($this->needStore($type) && $this->hasValidStore($parsedConfig)) {
+            $parsedConfig = $this->buildStore($type, $parsedConfig);
         }
 
         return $parsedConfig;

src/ToolboxBundle/DependencyInjection/Compiler/StoreProviderPass.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace ToolboxBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+use ToolboxBundle\Registry\StoreProviderRegistry;
+
+final class StoreProviderPass implements CompilerPassInterface
+{
+    /**
+     * @param ContainerBuilder $container
+     */
+    public function process(ContainerBuilder $container)
+    {
+        $definition = $container->getDefinition(StoreProviderRegistry::class);
+        foreach ($container->findTaggedServiceIds('toolbox.editable.store_provider') as $id => $tags) {
+            foreach ($tags as $attributes) {
+                $definition->addMethodCall('register', [$attributes['identifier'], new Reference($id)]);
+            }
+        }
+    }
+}

src/ToolboxBundle/Provider/StoreProviderInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace ToolboxBundle\Provider;
+
+interface StoreProviderInterface
+{
+    /**
+     * @return mixed
+     */
+    public function getValues();
+}

src/ToolboxBundle/Registry/StoreProviderRegistry.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace ToolboxBundle\Registry;
+
+use ToolboxBundle\Provider\StoreProviderInterface;
+
+class StoreProviderRegistry implements StoreProviderRegistryInterface
+{
+    /**
+     * @var array
+     */
+    protected $services = [];
+
+    /**
+     * {@inheritDoc}
+     */
+    public function register($identifier, $service)
+    {
+        if (!in_array(StoreProviderInterface::class, class_implements($service), true)) {
+            throw new \InvalidArgumentException(
+                sprintf('%s needs to implement "%s", "%s" given.', get_class($service), StoreProviderInterface::class, implode(', ', class_implements($service)))
+            );
+        }
+
+        $this->services[$identifier] = $service;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function has($identifier)
+    {
+        return isset($this->services[$identifier]);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function get($identifier)
+    {
+        if (!$this->has($identifier)) {
+            throw new \Exception('"' . $identifier . '" Store provider does not exist.');
+        }
+
+        return $this->services[$identifier];
+    }
+}

src/ToolboxBundle/Registry/StoreProviderRegistryInterface.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace ToolboxBundle\Registry;
+
+use ToolboxBundle\Provider\StoreProviderInterface;
+
+interface StoreProviderRegistryInterface
+{
+    /**
+     * @param string                 $identifier
+     * @param StoreProviderInterface $service
+     */
+    public function register($identifier, $service);
+
+    /**
+     * @param string $identifier
+     *
+     * @return bool
+     */
+    public function has($identifier);
+
+    /**
+     * @param string $identifier
+     *
+     * @return StoreProviderInterface
+     *
+     * @throws \Exception
+     */
+    public function get($identifier);
+}

src/ToolboxBundle/Resources/config/pimcore/registry.yml

@@ -10,4 +10,8 @@ services:
     ToolboxBundle\Registry\CalculatorRegistry:
         arguments:
             $columnInterface: 'ToolboxBundle\Calculator\ColumnCalculatorInterface'
-            $slideColumnInterface: 'ToolboxBundle\Calculator\SlideColumnCalculatorInterface'
+            $slideColumnInterface: 'ToolboxBundle\Calculator\SlideColumnCalculatorInterface'
+
+    # registry: store provider
+    ToolboxBundle\Registry\StoreProviderRegistryInterface: '@ToolboxBundle\Registry\StoreProviderRegistry'
+    ToolboxBundle\Registry\StoreProviderRegistry: ~