Classes List

Symfony\Component\Form\ChoiceList\LazyChoiceList

 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 
<?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\Loader\ChoiceLoaderInterface;

/** * A choice list that loads its choices lazily. * * The choices are fetched using a {@link ChoiceLoaderInterface} instance. * If only {@link getChoicesForValues()} or {@link getValuesForChoices()} is * called, the choice list is only loaded partially for improved performance. * * Once {@link getChoices()} or {@link getValues()} is called, the list is * loaded fully. * * @author Bernhard Schussek <bschussek@gmail.com> */
class LazyChoiceList implements ChoiceListInterface
{
    private $loader;

    /** * The callable creating string values for each choice. * * If null, choices are simply cast to strings. * * @var null|callable */
    private $value;

    /** * @var ChoiceListInterface|null * * @deprecated Since 3.1, to be removed in 4.0. Cache the choice list in the {@link ChoiceLoaderInterface} instead. */
    private $loadedList;

    /** * @var bool * * @deprecated Flag used for BC layer since 3.1. To be removed in 4.0. */
    private $loaded = false;

    /** * Creates a lazily-loaded list using 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 */
    public function __construct(ChoiceLoaderInterface $loadercallable $value = null)
    {
        $this->loader = $loader;
        $this->value = $value;
    }

    /** * {@inheritdoc} */
    public function getChoices()
    {
        if ($this->loaded) {
            // We can safely invoke the {@link ChoiceLoaderInterface} assuming it has the list
            // in cache when the lazy list is already loaded
            if ($this->loadedList !== $this->loader->loadChoiceList($this->value)) {
                @trigger_error(sprintf('Caching the choice list in %s is deprecated since Symfony 3.1 and will not happen in 4.0. Cache the list in the %s instead.'__CLASS__ChoiceLoaderInterface::class), E_USER_DEPRECATED);
            }

            return $this->loadedList->getChoices();
        }

        // BC
        $this->loadedList = $this->loader->loadChoiceList($this->value);
        $this->loaded = true;

        return $this->loadedList->getChoices();
        // In 4.0 keep the following line only:
        // return $this->loader->loadChoiceList($this->value)->getChoices()
    }

    /** * {@inheritdoc} */
    public function getValues()
    {
        if ($this->loaded) {
            // Check whether the loader has the same cache
            if ($this->loadedList !== $this->loader->loadChoiceList($this->value)) {
                @trigger_error(sprintf('Caching the choice list in %s is deprecated since Symfony 3.1 and will not happen in 4.0. Cache the list in the %s instead.'__CLASS__ChoiceLoaderInterface::class), E_USER_DEPRECATED);
            }

            return $this->loadedList->getValues();
        }

        // BC
        $this->loadedList = $this->loader->loadChoiceList($this->value);
        $this->loaded = true;

        return $this->loadedList->getValues();
        // In 4.0 keep the following line only:
        // return $this->loader->loadChoiceList($this->value)->getValues()
    }

    /** * {@inheritdoc} */
    public function getStructuredValues()
    {
        if ($this->loaded) {
            // Check whether the loader has the same cache
            if ($this->loadedList !== $this->loader->loadChoiceList($this->value)) {
                @trigger_error(sprintf('Caching the choice list in %s is deprecated since Symfony 3.1 and will not happen in 4.0. Cache the list in the %s instead.'__CLASS__ChoiceLoaderInterface::class), E_USER_DEPRECATED);
            }

            return $this->loadedList->getStructuredValues();
        }

        // BC
        $this->loadedList = $this->loader->loadChoiceList($this->value);
        $this->loaded = true;

        return $this->loadedList->getStructuredValues();
        // In 4.0 keep the following line only:
        // return $this->loader->loadChoiceList($this->value)->getStructuredValues();
    }

    /** * {@inheritdoc} */
    public function getOriginalKeys()
    {
        if ($this->loaded) {
            // Check whether the loader has the same cache
            if ($this->loadedList !== $this->loader->loadChoiceList($this->value)) {
                @trigger_error(sprintf('Caching the choice list in %s is deprecated since Symfony 3.1 and will not happen in 4.0. Cache the list in the %s instead.'__CLASS__ChoiceLoaderInterface::class), E_USER_DEPRECATED);
            }

            return $this->loadedList->getOriginalKeys();
        }

        // BC
        $this->loadedList = $this->loader->loadChoiceList($this->value);
        $this->loaded = true;

        return $this->loadedList->getOriginalKeys();
        // In 4.0 keep the following line only:
        // return $this->loader->loadChoiceList($this->value)->getOriginalKeys();
    }

    /** * {@inheritdoc} */
    public function getChoicesForValues(array $values)
    {
        if ($this->loaded) {
            // Check whether the loader has the same cache
            if ($this->loadedList !== $this->loader->loadChoiceList($this->value)) {
                @trigger_error(sprintf('Caching the choice list in %s is deprecated since Symfony 3.1 and will not happen in 4.0. Cache the list in the %s instead.'__CLASS__ChoiceLoaderInterface::class), E_USER_DEPRECATED);
            }

            return $this->loadedList->getChoicesForValues($values);
        }

        return $this->loader->loadChoicesForValues($values$this->value);
    }

    /** * {@inheritdoc} */
    public function getValuesForChoices(array $choices)
    {
        if ($this->loaded) {
            // Check whether the loader has the same cache
            if ($this->loadedList !== $this->loader->loadChoiceList($this->value)) {
                @trigger_error(sprintf('Caching the choice list in %s is deprecated since Symfony 3.1 and will not happen in 4.0. Cache the list in the %s instead.'__CLASS__ChoiceLoaderInterface::class), E_USER_DEPRECATED);
            }

            return $this->loadedList->getValuesForChoices($choices);
        }

        return $this->loader->loadValuesForChoices($choices$this->value);
    }
}