[Form] Added support for caching choice lists based on options

Author: HeahDude

CHANGELOG.md

@@ -4,6 +4,7 @@ CHANGELOG
 5.1.0
 -----
 
+ * Added a `ChoiceList` facade to leverage explicit choice list caching based on options
  * Added an `AbstractChoiceLoader` to simplify implementations and handle global optimizations
  * The `view_timezone` option defaults to the `model_timezone` if no `reference_date` is configured.
  * Added default `inputmode` attribute to Search, Email and Tel form types.

ChoiceList/ChoiceList.php

@@ -0,0 +1,135 @@
+<?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;
+
+use Symfony\Component\Form\ChoiceList\Factory\Cache\ChoiceAttr;
+use Symfony\Component\Form\ChoiceList\Factory\Cache\ChoiceFieldName;
+use Symfony\Component\Form\ChoiceList\Factory\Cache\ChoiceLabel;
+use Symfony\Component\Form\ChoiceList\Factory\Cache\ChoiceLoader;
+use Symfony\Component\Form\ChoiceList\Factory\Cache\ChoiceValue;
+use Symfony\Component\Form\ChoiceList\Factory\Cache\GroupBy;
+use Symfony\Component\Form\ChoiceList\Factory\Cache\PreferredChoice;
+use Symfony\Component\Form\ChoiceList\Loader\CallbackChoiceLoader;
+use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
+use Symfony\Component\Form\FormTypeExtensionInterface;
+use Symfony\Component\Form\FormTypeInterface;
+
+/**
+ * A set of convenient static methods to create cacheable choice list options.
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+final class ChoiceList
+{
+    /**
+     * Creates a cacheable loader from any callable providing iterable choices.
+     *
+     * @param FormTypeInterface|FormTypeExtensionInterface $formType A form type or type extension configuring a cacheable choice list
+     * @param callable                                     $choices  A callable that must return iterable choices or grouped choices
+     * @param mixed|null                                   $vary     Dynamic data used to compute a unique hash when caching the loader
+     */
+    public static function lazy($formType, callable $choices, $vary = null): ChoiceLoader
+    {
+        return self::loader($formType, new CallbackChoiceLoader($choices), $vary);
+    }
+
+    /**
+     * Decorates a loader to make it cacheable.
+     *
+     * @param FormTypeInterface|FormTypeExtensionInterface $formType A form type or type extension configuring a cacheable choice list
+     * @param ChoiceLoaderInterface                        $loader   A loader responsible for creating loading choices or grouped choices
+     * @param mixed|null                                   $vary     Dynamic data used to compute a unique hash when caching the loader
+     */
+    public static function loader($formType, ChoiceLoaderInterface $loader, $vary = null): ChoiceLoader
+    {
+        return new ChoiceLoader($formType, $loader, $vary);
+    }
+
+    /**
+     * Decorates a "choice_value" callback to make it cacheable.
+     *
+     * @param FormTypeInterface|FormTypeExtensionInterface $formType A form type or type extension configuring a cacheable choice list
+     * @param callable                                     $value    Any pseudo callable to create a unique string value from a choice
+     * @param mixed|null                                   $vary     Dynamic data used to compute a unique hash when caching the callback
+     */
+    public static function value($formType, $value, $vary = null): ChoiceValue
+    {
+        return new ChoiceValue($formType, $value, $vary);
+    }
+
+    /**
+     * Decorates a "choice_label" option to make it cacheable.
+     *
+     * @param FormTypeInterface|FormTypeExtensionInterface $formType A form type or type extension configuring a cacheable choice list
+     * @param callable|false                               $label    Any pseudo callable to create a label from a choice or false to discard it
+     * @param mixed|null                                   $vary     Dynamic data used to compute a unique hash when caching the option
+     */
+    public static function label($formType, $label, $vary = null): ChoiceLabel
+    {
+        return new ChoiceLabel($formType, $label, $vary);
+    }
+
+    /**
+     * Decorates a "choice_name" callback to make it cacheable.
+     *
+     * @param FormTypeInterface|FormTypeExtensionInterface $formType  A form type or type extension configuring a cacheable choice list
+     * @param callable                                     $fieldName Any pseudo callable to create a field name from a choice
+     * @param mixed|null                                   $vary      Dynamic data used to compute a unique hash when caching the callback
+     */
+    public static function fieldName($formType, $fieldName, $vary = null): ChoiceFieldName
+    {
+        return new ChoiceFieldName($formType, $fieldName, $vary);
+    }
+
+    /**
+     * Decorates a "choice_attr" option to make it cacheable.
+     *
+     * @param FormTypeInterface|FormTypeExtensionInterface $formType A form type or type extension configuring a cacheable choice list
+     * @param callable|array                               $attr     Any pseudo callable or array to create html attributes from a choice
+     * @param mixed|null                                   $vary     Dynamic data used to compute a unique hash when caching the option
+     */
+    public static function attr($formType, $attr, $vary = null): ChoiceAttr
+    {
+        return new ChoiceAttr($formType, $attr, $vary);
+    }
+
+    /**
+     * Decorates a "group_by" callback to make it cacheable.
+     *
+     * @param FormTypeInterface|FormTypeExtensionInterface $formType A form type or type extension configuring a cacheable choice list
+     * @param callable                                     $groupBy  Any pseudo callable to return a group name from a choice
+     * @param mixed|null                                   $vary     Dynamic data used to compute a unique hash when caching the callback
+     */
+    public static function groupBy($formType, $groupBy, $vary = null): GroupBy
+    {
+        return new GroupBy($formType, $groupBy, $vary);
+    }
+
+    /**
+     * Decorates a "preferred_choices" option to make it cacheable.
+     *
+     * @param FormTypeInterface|FormTypeExtensionInterface $formType  A form type or type extension configuring a cacheable choice list
+     * @param callable|array                               $preferred Any pseudo callable or array to return a group name from a choice
+     * @param mixed|null                                   $vary      Dynamic data used to compute a unique hash when caching the option
+     */
+    public static function preferred($formType, $preferred, $vary = null): PreferredChoice
+    {
+        return new PreferredChoice($formType, $preferred, $vary);
+    }
+
+    /**
+     * Should not be instantiated.
+     */
+    private function __construct()
+    {
+    }
+}

ChoiceList/Factory/Cache/AbstractStaticOption.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\Factory\Cache;
+
+use Symfony\Component\Form\ChoiceList\Factory\CachingFactoryDecorator;
+use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
+use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
+use Symfony\Component\Form\FormTypeExtensionInterface;
+use Symfony\Component\Form\FormTypeInterface;
+
+/**
+ * A template decorator for static {@see ChoiceType} options.
+ *
+ * Used as fly weight for {@see CachingFactoryDecorator}.
+ *
+ * @internal
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+abstract class AbstractStaticOption
+{
+    private static $options = [];
+
+    /** @var bool|callable|string|array|\Closure|ChoiceLoaderInterface */
+    private $option;
+
+    /**
+     * @param FormTypeInterface|FormTypeExtensionInterface $formType A form type or type extension configuring a cacheable choice list
+     * @param mixed                                        $option   Any pseudo callable, array, string or bool to define a choice list option
+     * @param mixed|null                                   $vary     Dynamic data used to compute a unique hash when caching the option
+     */
+    final public function __construct($formType, $option, $vary = null)
+    {
+        if (!$formType instanceof FormTypeInterface && !$formType instanceof FormTypeExtensionInterface) {
+            throw new \TypeError(sprintf('Expected an instance of "%s" or "%s", but got "%s".', FormTypeInterface::class, FormTypeExtensionInterface::class, \is_object($formType) ? \get_class($formType) : \gettype($formType)));
+        }
+
+        $hash = CachingFactoryDecorator::generateHash([static::class, $formType, $vary]);
+
+        $this->option = self::$options[$hash] ?? self::$options[$hash] = $option;
+    }
+
+    /**
+     * @return mixed
+     */
+    final public function getOption()
+    {
+        return $this->option;
+    }
+
+    final public static function reset(): void
+    {
+        self::$options = [];
+    }
+}

ChoiceList/Factory/Cache/ChoiceAttr.php

@@ -0,0 +1,27 @@
+<?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\Factory\Cache;
+
+use Symfony\Component\Form\FormTypeExtensionInterface;
+use Symfony\Component\Form\FormTypeInterface;
+
+/**
+ * A cacheable wrapper for any {@see FormTypeInterface} or {@see FormTypeExtensionInterface}
+ * which configures a "choice_attr" option.
+ *
+ * @internal
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+final class ChoiceAttr extends AbstractStaticOption
+{
+}

ChoiceList/Factory/Cache/ChoiceFieldName.php

@@ -0,0 +1,27 @@
+<?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\Factory\Cache;
+
+use Symfony\Component\Form\FormTypeExtensionInterface;
+use Symfony\Component\Form\FormTypeInterface;
+
+/**
+ * A cacheable wrapper for any {@see FormTypeInterface} or {@see FormTypeExtensionInterface}
+ * which configures a "choice_name" callback.
+ *
+ * @internal
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+final class ChoiceFieldName extends AbstractStaticOption
+{
+}

ChoiceList/Factory/Cache/ChoiceLabel.php

@@ -0,0 +1,27 @@
+<?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\Factory\Cache;
+
+use Symfony\Component\Form\FormTypeExtensionInterface;
+use Symfony\Component\Form\FormTypeInterface;
+
+/**
+ * A cacheable wrapper for any {@see FormTypeInterface} or {@see FormTypeExtensionInterface}
+ * which configures a "choice_label" option.
+ *
+ * @internal
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+final class ChoiceLabel extends AbstractStaticOption
+{
+}

ChoiceList/Factory/Cache/ChoiceLoader.php

@@ -0,0 +1,51 @@
+<?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\Factory\Cache;
+
+use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
+use Symfony\Component\Form\FormTypeExtensionInterface;
+use Symfony\Component\Form\FormTypeInterface;
+
+/**
+ * A cacheable wrapper for {@see FormTypeInterface} or {@see FormTypeExtensionInterface}
+ * which configures a "choice_loader" option.
+ *
+ * @internal
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+final class ChoiceLoader extends AbstractStaticOption implements ChoiceLoaderInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function loadChoiceList(callable $value = null)
+    {
+        return $this->getOption()->loadChoiceList($value);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function loadChoicesForValues(array $values, callable $value = null)
+    {
+        return $this->getOption()->loadChoicesForValues($values, $value);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function loadValuesForChoices(array $choices, callable $value = null)
+    {
+        $this->getOption()->loadValuesForChoices($choices, $value);
+    }
+}

ChoiceList/Factory/Cache/ChoiceValue.php

@@ -0,0 +1,27 @@
+<?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\Factory\Cache;
+
+use Symfony\Component\Form\FormTypeExtensionInterface;
+use Symfony\Component\Form\FormTypeInterface;
+
+/**
+ * A cacheable wrapper for any {@see FormTypeInterface} or {@see FormTypeExtensionInterface}
+ * which configures a "choice_value" callback.
+ *
+ * @internal
+ *
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+final class ChoiceValue extends AbstractStaticOption
+{
+}