Classes List

Symfony\Component\Form\ChoiceList\Factory\ChoiceListFactoryInterface

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
<?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;

use Symfony\Component\Form\ChoiceList\ChoiceListInterface;
use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
use Symfony\Component\Form\ChoiceList\View\ChoiceListView;

/** * Creates {@link ChoiceListInterface} instances. * * @author Bernhard Schussek <bschussek@gmail.com> */
interface ChoiceListFactoryInterface
{
    /** * Creates a choice list for the given choices. * * The choices should be passed in the values of the choices array. * * Optionally, a callable can be passed for generating the choice values. * The callable receives the choice as first and the array key as the second * argument. * * @param iterable $choices The choices * @param null|callable $value The callable generating the choice * values * * @return ChoiceListInterface The choice list */
    public function createListFromChoices($choices$value = null);

    /** * Creates a choice list that is loaded with the given loader. * * Optionally, a callable can be passed for generating the choice values. * The callable receives the choice as first and the array key as the second * argument. * * @param ChoiceLoaderInterface $loader The choice loader * @param null|callable $value The callable generating the choice * values * * @return ChoiceListInterface The choice list */
    public function createListFromLoader(ChoiceLoaderInterface $loader$value = null);

    /** * Creates a view for the given choice list. * * Callables may be passed for all optional arguments. The callables receive * the choice as first and the array key as the second argument. * * * The callable for the label and the name should return the generated * label/choice name. * * The callable for the preferred choices should return true or false, * depending on whether the choice should be preferred or not. * * The callable for the grouping should return the group name or null if * a choice should not be grouped. * * The callable for the attributes should return an array of HTML * attributes that will be inserted in the tag of the choice. * * If no callable is passed, the labels will be generated from the choice * keys. The view indices will be generated using an incrementing integer * by default. * * The preferred choices can also be passed as array. Each choice that is * contained in that array will be marked as preferred. * * The attributes can be passed as multi-dimensional array. The keys should * match the keys of the choices. The values should be arrays of HTML * attributes that should be added to the respective choice. * * @param ChoiceListInterface $list The choice list * @param null|array|callable $preferredChoices The preferred choices * @param null|callable $label The callable generating the * choice labels * @param null|callable $index The callable generating the * view indices * @param null|callable $groupBy The callable generating the * group names * @param null|array|callable $attr The callable generating the * HTML attributes * * @return ChoiceListView The choice list view */
    public function createView(ChoiceListInterface $list$preferredChoices = null$label = null$index = null$groupBy = null$attr = null);
}