Allow to limit the DCA pickers per context (contao#924)

aschempp · Jul 13, 2017 · c06329a · c06329a
1 parent d16b6fe
commit c06329a
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 8 deletions.
diff --git a/src/Picker/PickerBuilder.php b/src/Picker/PickerBuilder.php
@@ -62,16 +62,22 @@ public function __construct(FactoryInterface $menuFactory, RouterInterface $rout
      */
     public function addProvider(PickerProviderInterface $provider)
     {
-        $this->providers[] = $provider;
+        $this->providers[$provider->getName()] = $provider;
     }
 
     /**
      * {@inheritdoc}
      */
     public function create(PickerConfig $config)
     {
+        $providers = $this->providers;
+
+        if (is_array($allowed = $config->getExtra('providers'))) {
+            $providers = array_intersect_key($providers, array_flip($allowed));
+        }
+
         $providers = array_filter(
-            $this->providers,
+            $providers,
             function (PickerProviderInterface $provider) use ($config) {
                 return $provider->supportsContext($config->getContext());
             }
@@ -105,9 +111,15 @@ public function createFromData($data)
     /**
      * {@inheritdoc}
      */
-    public function supportsContext($context)
+    public function supportsContext($context, array $allowed = null)
     {
-        foreach ($this->providers as $provider) {
+        $providers = $this->providers;
+
+        if (null !== $allowed) {
+            $providers = array_intersect_key($providers, array_flip($allowed));
+        }
+
+        foreach ($providers as $provider) {
             if ($provider->supportsContext($context)) {
                 return true;
             }
@@ -121,7 +133,9 @@ public function supportsContext($context)
      */
     public function getUrl($context, array $extras = [], $value = '')
     {
-        if (!$this->supportsContext($context)) {
+        $providers = (isset($extras['providers']) && is_array($extras['providers'])) ? $extras['providers'] : null;
+
+        if (!$this->supportsContext($context, $providers)) {
             return '';
         }
 

diff --git a/src/Picker/PickerBuilderInterface.php b/src/Picker/PickerBuilderInterface.php
@@ -38,11 +38,12 @@ public function createFromData($data);
     /**
      * Returns whether the given context is supported.
      *
-     * @param string $context
+     * @param string     $context
+     * @param array|null $allowed
      *
      * @return bool
      */
-    public function supportsContext($context);
+    public function supportsContext($context, array $allowed = null);
 
     /**
      * Gets picker URL for given context and configuration.

diff --git a/src/Resources/contao/classes/Backend.php b/src/Resources/contao/classes/Backend.php
@@ -1088,6 +1088,7 @@ public static function getDcaPickerWizard($extras, $table, $field, $inputName)
 	{
 		$context = 'link';
 		$extras = is_array($extras) ? $extras : [];
+		$providers = (isset($extras['providers']) && is_array($extras['providers'])) ? $extras['providers'] : null;
 
 		if (isset($extras['context']))
 		{
@@ -1097,7 +1098,7 @@ public static function getDcaPickerWizard($extras, $table, $field, $inputName)
 
 		$factory = \System::getContainer()->get('contao.picker.builder');
 
-		if (!$factory->supportsContext($context))
+		if (!$factory->supportsContext($context, $providers))
 		{
 			return '';
 		}