Classes List

Symfony\Component\Form\ChoiceList\ArrayChoiceList

 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 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
 168 
 169 
 170 
 171 
 172 
 173 
 174 
 175 
 176 
 177 
 178 
 179 
 180 
 181 
 182 
 183 
 184 
 185 
 186 
 187 
 188 
 189 
 190 
 191 
 192 
 193 
 194 
 195 
 196 
 197 
 198 
 199 
 200 
 201 
 202 
 203 
 204 
 205 
 206 
 207 
 208 
 209 
 210 
 211 
 212 
 213 
 214 
 215 
 216 
 217 
 218 
 219 
 220 
 221 
 222 
 223 
 224 
 225 
 226 
 227 
 228 
 229 
 230 
 231 
 232 
 233 
 234 
 235 
 236 
 237 
 238 
 239 
 240 
 241 
 242 
 243 
 244 
 245 
 246 
 247 
<?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 with arbitrary data types. * * The user of this class is responsible for assigning string values to the * choices. Both the choices and their values are passed to the constructor. * Each choice must have a corresponding value (with the same array key) in * the value array. * * @author Bernhard Schussek <bschussek@gmail.com> */
class ArrayChoiceList implements ChoiceListInterface
{
    /** * The choices in the list. * * @var array */
    protected $choices;

    /** * The values indexed by the original keys. * * @var array */
    protected $structuredValues;

    /** * The original keys of the choices array. * * @var int[]|string[] */
    protected $originalKeys;

    /** * The callback for creating the value for a choice. * * @var callable */
    protected $valueCallback;

    /** * Creates a list with the given choices and values. * * The given choice array must have the same array keys as the value array. * * @param iterable $choices The selectable choices * @param callable|null $value The callable for creating the value * for a choice. If `null` is passed, * incrementing integers are used as * values */
    public function __construct($choicescallable $value = null)
    {
        if ($choices instanceof \Traversable) {
            $choices = iterator_to_array($choices);
        }

        if (null === $value && $this->castableToString($choices)) {
            $value = function ($choice) {
                return false === $choice ? '0' : (string) $choice;
            };
        }

        if (null !== $value) {
            // If a deterministic value generator was passed, use it later
            $this->valueCallback = $value;
        } else {
            // Otherwise simply generate incrementing integers as values
            $i = 0;
            $value = function () use (&$i) {
                return $i++;
            };
        }

        // If the choices are given as recursive array (i.e. with explicit
        // choice groups), flatten the array. The grouping information is needed
        // in the view only.
        $this->flatten($choices$value$choicesByValues$keysByValues$structuredValues);

        $this->choices = $choicesByValues;
        $this->originalKeys = $keysByValues;
        $this->structuredValues = $structuredValues;
    }

    /** * {@inheritdoc} */
    public function getChoices()
    {
        return $this->choices;
    }

    /** * {@inheritdoc} */
    public function getValues()
    {
        return array_map('strval'array_keys($this->choices));
    }

    /** * {@inheritdoc} */
    public function getStructuredValues()
    {
        return $this->structuredValues;
    }

    /** * {@inheritdoc} */
    public function getOriginalKeys()
    {
        return $this->originalKeys;
    }

    /** * {@inheritdoc} */
    public function getChoicesForValues(array $values)
    {
        $choices = array();

        foreach ($values as $i => $givenValue) {
            if (array_key_exists($givenValue$this->choices)) {
                $choices[$i] = $this->choices[$givenValue];
            }
        }

        return $choices;
    }

    /** * {@inheritdoc} */
    public function getValuesForChoices(array $choices)
    {
        $values = array();

        // Use the value callback to compare choices by their values, if present
        if ($this->valueCallback) {
            $givenValues = array();

            foreach ($choices as $i => $givenChoice) {
                $givenValues[$i] = (string) call_user_func($this->valueCallback$givenChoice);
            }

            return array_intersect($givenValuesarray_keys($this->choices));
        }

        // Otherwise compare choices by identity
        foreach ($choices as $i => $givenChoice) {
            foreach ($this->choices as $value => $choice) {
                if ($choice === $givenChoice) {
                    $values[$i] = (string) $value;
                    break;
                }
            }
        }

        return $values;
    }

    /** * Flattens an array into the given output variables. * * @param array $choices The array to flatten * @param callable $value The callable for generating choice values * @param array $choicesByValues The flattened choices indexed by the * corresponding values * @param array $keysByValues The original keys indexed by the * corresponding values * @param array $structuredValues The values indexed by the original keys * * @internal */
    protected function flatten(array $choices$value, &$choicesByValues, &$keysByValues, &$structuredValues)
    {
        if (null === $choicesByValues) {
            $choicesByValues = array();
            $keysByValues = array();
            $structuredValues = array();
        }

        foreach ($choices as $key => $choice) {
            if (is_array($choice)) {
                $this->flatten($choice$value$choicesByValues$keysByValues$structuredValues[$key]);

                continue;
            }

            $choiceValue = (string) call_user_func($value$choice);
            $choicesByValues[$choiceValue] = $choice;
            $keysByValues[$choiceValue] = $key;
            $structuredValues[$key] = $choiceValue;
        }
    }

    /** * Checks whether the given choices can be cast to strings without * generating duplicates. * * @param array $choices The choices * @param array|null $cache The cache for previously checked entries. Internal * * @return bool returns true if the choices can be cast to strings and * false otherwise */
    private function castableToString(array $choicesarray &$cache = array())
    {
        foreach ($choices as $choice) {
            if (is_array($choice)) {
                if (!$this->castableToString($choice$cache)) {
                    return false;
                }

                continue;
            } elseif (!is_scalar($choice)) {
                return false;
            }

            $choice = false === $choice ? '0' : (string) $choice;

            if (isset($cache[$choice])) {
                return false;
            }

            $cache[$choice] = true;
        }

        return true;
    }
}