SDK Form demonstrator

lib/symfony/form/ChoiceList/Loader/AbstractChoiceLoader.php

@@ -0,0 +1,66 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\ChoiceList\Loader;
+
+use Symfony\Component\Form\ChoiceList\ArrayChoiceList;
+use Symfony\Component\Form\ChoiceList\ChoiceListInterface;
+
+/**
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+abstract class AbstractChoiceLoader implements ChoiceLoaderInterface
+{
+    private ?iterable $choices;
+
+    /**
+     * @final
+     */
+    public function loadChoiceList(?callable $value = null): ChoiceListInterface
+    {
+        return new ArrayChoiceList($this->choices ??= $this->loadChoices(), $value);
+    }
+
+    public function loadChoicesForValues(array $values, ?callable $value = null): array
+    {
+        if (!$values) {
+            return [];
+        }
+
+        return $this->doLoadChoicesForValues($values, $value);
+    }
+
+    public function loadValuesForChoices(array $choices, ?callable $value = null): array
+    {
+        if (!$choices) {
+            return [];
+        }
+
+        if ($value) {
+            // if a value callback exists, use it
+            return array_map(fn ($item) => (string) $value($item), $choices);
+        }
+
+        return $this->doLoadValuesForChoices($choices);
+    }
+
+    abstract protected function loadChoices(): iterable;
+
+    protected function doLoadChoicesForValues(array $values, ?callable $value): array
+    {
+        return $this->loadChoiceList($value)->getChoicesForValues($values);
+    }
+
+    protected function doLoadValuesForChoices(array $choices): array
+    {
+        return $this->loadChoiceList()->getValuesForChoices($choices);
+    }
+}

lib/symfony/form/ChoiceList/Loader/CallbackChoiceLoader.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\ChoiceList\Loader;
+
+/**
+ * Loads an {@link ArrayChoiceList} instance from a callable returning iterable choices.
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+class CallbackChoiceLoader extends AbstractChoiceLoader
+{
+    private \Closure $callback;
+
+    /**
+     * @param callable $callback The callable returning iterable choices
+     */
+    public function __construct(callable $callback)
+    {
+        $this->callback = $callback(...);
+    }
+
+    protected function loadChoices(): iterable
+    {
+        return ($this->callback)();
+    }
+}

lib/symfony/form/ChoiceList/Loader/ChoiceLoaderInterface.php

@@ -0,0 +1,72 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\ChoiceList\Loader;
+
+use Symfony\Component\Form\ChoiceList\ChoiceListInterface;
+
+/**
+ * Loads a choice list.
+ *
+ * The methods {@link loadChoicesForValues()} and {@link loadValuesForChoices()}
+ * can be used to load the list only partially in cases where a fully-loaded
+ * list is not necessary.
+ *
+ * @author Bernhard Schussek <bschussek@gmail.com>
+ */
+interface ChoiceLoaderInterface
+{
+    /**
+     * Loads a list of choices.
+     *
+     * Optionally, a callable can be passed for generating the choice values.
+     * The callable receives the choice as only argument.
+     * Null may be passed when the choice list contains the empty value.
+     *
+     * @param callable|null $value The callable which generates the values
+     *                             from choices
+     */
+    public function loadChoiceList(?callable $value = null): ChoiceListInterface;
+
+    /**
+     * Loads the choices corresponding to the given values.
+     *
+     * The choices are returned with the same keys and in the same order as the
+     * corresponding values in the given array.
+     *
+     * Optionally, a callable can be passed for generating the choice values.
+     * The callable receives the choice as only argument.
+     * Null may be passed when the choice list contains the empty value.
+     *
+     * @param string[]      $values An array of choice values. Non-existing
+     *                              values in this array are ignored
+     * @param callable|null $value  The callable generating the choice values
+     */
+    public function loadChoicesForValues(array $values, ?callable $value = null): array;
+
+    /**
+     * Loads the values corresponding to the given choices.
+     *
+     * The values are returned with the same keys and in the same order as the
+     * corresponding choices in the given array.
+     *
+     * Optionally, a callable can be passed for generating the choice values.
+     * The callable receives the choice as only argument.
+     * Null may be passed when the choice list contains the empty value.
+     *
+     * @param array         $choices An array of choices. Non-existing choices in
+     *                               this array are ignored
+     * @param callable|null $value   The callable generating the choice values
+     *
+     * @return string[]
+     */
+    public function loadValuesForChoices(array $choices, ?callable $value = null): array;
+}

lib/symfony/form/ChoiceList/Loader/FilterChoiceLoaderDecorator.php

@@ -0,0 +1,64 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\ChoiceList\Loader;
+
+/**
+ * A decorator to filter choices only when they are loaded or partially loaded.
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+class FilterChoiceLoaderDecorator extends AbstractChoiceLoader
+{
+    private ChoiceLoaderInterface $decoratedLoader;
+    private \Closure $filter;
+
+    public function __construct(ChoiceLoaderInterface $loader, callable $filter)
+    {
+        $this->decoratedLoader = $loader;
+        $this->filter = $filter(...);
+    }
+
+    protected function loadChoices(): iterable
+    {
+        $list = $this->decoratedLoader->loadChoiceList();
+
+        if (array_values($list->getValues()) === array_values($structuredValues = $list->getStructuredValues())) {
+            return array_filter(array_combine($list->getOriginalKeys(), $list->getChoices()), $this->filter);
+        }
+
+        foreach ($structuredValues as $group => $values) {
+            if (\is_array($values)) {
+                if ($values && $filtered = array_filter($list->getChoicesForValues($values), $this->filter)) {
+                    $choices[$group] = $filtered;
+                }
+                continue;
+                // filter empty groups
+            }
+
+            if ($filtered = array_filter($list->getChoicesForValues([$values]), $this->filter)) {
+                $choices[$group] = $filtered[0];
+            }
+        }
+
+        return $choices ?? [];
+    }
+
+    public function loadChoicesForValues(array $values, ?callable $value = null): array
+    {
+        return array_filter($this->decoratedLoader->loadChoicesForValues($values, $value), $this->filter);
+    }
+
+    public function loadValuesForChoices(array $choices, ?callable $value = null): array
+    {
+        return $this->decoratedLoader->loadValuesForChoices(array_filter($choices, $this->filter), $value);
+    }
+}

lib/symfony/form/ChoiceList/Loader/IntlCallbackChoiceLoader.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\ChoiceList\Loader;
+
+/**
+ * Callback choice loader optimized for Intl choice types.
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ * @author Yonel Ceruto <yonelceruto@gmail.com>
+ */
+class IntlCallbackChoiceLoader extends CallbackChoiceLoader
+{
+    public function loadChoicesForValues(array $values, ?callable $value = null): array
+    {
+        return parent::loadChoicesForValues(array_filter($values), $value);
+    }
+
+    public function loadValuesForChoices(array $choices, ?callable $value = null): array
+    {
+        $choices = array_filter($choices);
+
+        // If no callable is set, choices are the same as values
+        if (null === $value) {
+            return $choices;
+        }
+
+        return parent::loadValuesForChoices($choices, $value);
+    }
+}