Classes List

Symfony\Component\Form\ChoiceList\ChoiceListInterface

 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 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
<?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;

/** * A list of choices that can be selected in a choice field. * * A choice list assigns unique string values to each of a list of choices. * These string values are displayed in the "value" attributes in HTML and * submitted back to the server. * * The acceptable data types for the choices depend on the implementation. * Values must always be strings and (within the list) free of duplicates. * * @author Bernhard Schussek <bschussek@gmail.com> */
interface ChoiceListInterface
{
    /** * Returns all selectable choices. * * @return array The selectable choices indexed by the corresponding values */
    public function getChoices();

    /** * Returns the values for the choices. * * The values are strings that do not contain duplicates. * * @return string[] The choice values */
    public function getValues();

    /** * Returns the values in the structure originally passed to the list. * * Contrary to {@link getValues()}, the result is indexed by the original * keys of the choices. If the original array contained nested arrays, these * nested arrays are represented here as well: * * $form->add('field', 'choice', array( * 'choices' => array( * 'Decided' => array('Yes' => true, 'No' => false), * 'Undecided' => array('Maybe' => null), * ), * )); * * In this example, the result of this method is: * * array( * 'Decided' => array('Yes' => '0', 'No' => '1'), * 'Undecided' => array('Maybe' => '2'), * ) * * @return string[] The choice values */
    public function getStructuredValues();

    /** * Returns the original keys of the choices. * * The original keys are the keys of the choice array that was passed in the * "choice" option of the choice type. Note that this array may contain * duplicates if the "choice" option contained choice groups: * * $form->add('field', 'choice', array( * 'choices' => array( * 'Decided' => array(true, false), * 'Undecided' => array(null), * ), * )); * * In this example, the original key 0 appears twice, once for `true` and * once for `null`. * * @return int[]|string[] The original choice keys indexed by the * corresponding choice values */
    public function getOriginalKeys();

    /** * Returns 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. * * @param string[] $values An array of choice values. Non-existing values in * this array are ignored * * @return array An array of choices */
    public function getChoicesForValues(array $values);

    /** * Returns 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. * * @param array $choices An array of choices. Non-existing choices in this * array are ignored * * @return string[] An array of choice values */
    public function getValuesForChoices(array $choices);
}