vendor/symfony/form/ChoiceList/Factory/ChoiceListFactoryInterface.php line 47

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Form\ChoiceList\Factory;
  14. use Symfony\Component\Form\ChoiceList\ChoiceListInterface;
  15. use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
  16. use Symfony\Component\Form\ChoiceList\View\ChoiceListView;
  18. /**
  19.  * Creates {@link ChoiceListInterface} instances.
  20.  *
  21.  * @author Bernhard Schussek <bschussek@gmail.com>
  22.  */
  23. interface ChoiceListFactoryInterface
  24. {
  25.     /**
  26.      * Creates a choice list for the given choices.
  27.      *
  28.      * The choices should be passed in the values of the choices array.
  29.      *
  30.      * Optionally, a callable can be passed for generating the choice values.
  31.      * The callable receives the choice as only argument.
  32.      * Null may be passed when the choice list contains the empty value.
  33.      *
  34.      * @param callable|null $filter The callable filtering the choices
  35.      */
  36.     public function createListFromChoices(iterable $choices, callable $value = null, callable $filter = null): ChoiceListInterface;
  38.     /**
  39.      * Creates a choice list that is loaded with the given loader.
  40.      *
  41.      * Optionally, a callable can be passed for generating the choice values.
  42.      * The callable receives the choice as only argument.
  43.      * Null may be passed when the choice list contains the empty value.
  44.      *
  45.      * @param callable|null $filter The callable filtering the choices
  46.      */
  47.     public function createListFromLoader(ChoiceLoaderInterface $loader, callable $value = null, callable $filter = null): ChoiceListInterface;
  49.     /**
  50.      * Creates a view for the given choice list.
  51.      *
  52.      * Callables may be passed for all optional arguments. The callables receive
  53.      * the choice as first and the array key as the second argument.
  54.      *
  55.      *  * The callable for the label and the name should return the generated
  56.      *    label/choice name.
  57.      *  * The callable for the preferred choices should return true or false,
  58.      *    depending on whether the choice should be preferred or not.
  59.      *  * The callable for the grouping should return the group name or null if
  60.      *    a choice should not be grouped.
  61.      *  * The callable for the attributes should return an array of HTML
  62.      *    attributes that will be inserted in the tag of the choice.
  63.      *
  64.      * If no callable is passed, the labels will be generated from the choice
  65.      * keys. The view indices will be generated using an incrementing integer
  66.      * by default.
  67.      *
  68.      * The preferred choices can also be passed as array. Each choice that is
  69.      * contained in that array will be marked as preferred.
  70.      *
  71.      * The attributes can be passed as multi-dimensional array. The keys should
  72.      * match the keys of the choices. The values should be arrays of HTML
  73.      * attributes that should be added to the respective choice.
  74.      *
  75.      * @param array|callable|null $preferredChoices           The preferred choices
  76.      * @param callable|false|null $label                      The callable generating the choice labels;
  77.      *                                                        pass false to discard the label
  78.      * @param array|callable|null $attr                       The callable generating the HTML attributes
  79.      * @param array|callable      $labelTranslationParameters The parameters used to translate the choice labels
  80.      */
  81.     public function createView(ChoiceListInterface $list, array|callable $preferredChoices = null, callable|false $label = null, callable $index = null, callable $groupBy = null, array|callable $attr = null, array|callable $labelTranslationParameters = []): ChoiceListView;
  82. }