Classes List

Symfony\Component\Form\ChoiceList\Factory\PropertyAccessDecorator

 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 
<?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;
use Symfony\Component\PropertyAccess\Exception\UnexpectedTypeException;
use Symfony\Component\PropertyAccess\PropertyAccess;
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
use Symfony\Component\PropertyAccess\PropertyPath;

/** * Adds property path support to a choice list factory. * * Pass the decorated factory to the constructor: * * ```php * $decorator = new PropertyAccessDecorator($factory); * ``` * * You can now pass property paths for generating choice values, labels, view * indices, HTML attributes and for determining the preferred choices and the * choice groups: * * ```php * // extract values from the $value property * $list = $createListFromChoices($objects, 'value'); * ``` * * @author Bernhard Schussek <bschussek@gmail.com> */
class PropertyAccessDecorator implements ChoiceListFactoryInterface
{
    private $decoratedFactory;
    private $propertyAccessor;

    public function __construct(ChoiceListFactoryInterface $decoratedFactoryPropertyAccessorInterface $propertyAccessor = null)
    {
        $this->decoratedFactory = $decoratedFactory;
        $this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();
    }

    /** * Returns the decorated factory. * * @return ChoiceListFactoryInterface The decorated factory */
    public function getDecoratedFactory()
    {
        return $this->decoratedFactory;
    }

    /** * {@inheritdoc} * * @param iterable $choices The choices * @param null|callable|string|PropertyPath $value The callable or path for * generating the choice values * * @return ChoiceListInterface The choice list */
    public function createListFromChoices($choices$value = null)
    {
        if (is_string($value&& !is_callable($value)) {
            $value = new PropertyPath($value);
        } elseif (is_string($value&& is_callable($value)) {
            @trigger_error('Passing callable strings is deprecated since Symfony 3.1 and PropertyAccessDecorator will treat them as property paths in 4.0. You should use a "\Closure" instead.'E_USER_DEPRECATED);
        }

        if ($value instanceof PropertyPath) {
            $accessor = $this->propertyAccessor;
            $value = function ($choiceuse ($accessor$value) {
                // The callable may be invoked with a non-object/array value
                // when such values are passed to
                // ChoiceListInterface::getValuesForChoices(). Handle this case
                // so that the call to getValue() doesn't break.
                if (is_object($choice|| is_array($choice)) {
                    return $accessor->getValue($choice$value);
                }
            };
        }

        return $this->decoratedFactory->createListFromChoices($choices$value);
    }

    /** * {@inheritdoc} * * @param ChoiceLoaderInterface $loader The choice loader * @param null|callable|string|PropertyPath $value The callable or path for * generating the choice values * * @return ChoiceListInterface The choice list */
    public function createListFromLoader(ChoiceLoaderInterface $loader$value = null)
    {
        if (is_string($value&& !is_callable($value)) {
            $value = new PropertyPath($value);
        } elseif (is_string($value&& is_callable($value)) {
            @trigger_error('Passing callable strings is deprecated since Symfony 3.1 and PropertyAccessDecorator will treat them as property paths in 4.0. You should use a "\Closure" instead.'E_USER_DEPRECATED);
        }

        if ($value instanceof PropertyPath) {
            $accessor = $this->propertyAccessor;
            $value = function ($choiceuse ($accessor$value) {
                // The callable may be invoked with a non-object/array value
                // when such values are passed to
                // ChoiceListInterface::getValuesForChoices(). Handle this case
                // so that the call to getValue() doesn't break.
                if (is_object($choice|| is_array($choice)) {
                    return $accessor->getValue($choice$value);
                }
            };
        }

        return $this->decoratedFactory->createListFromLoader($loader$value);
    }

    /** * {@inheritdoc} * * @param ChoiceListInterface $list The choice list * @param null|array|callable|string|PropertyPath $preferredChoices The preferred choices * @param null|callable|string|PropertyPath $label The callable or path generating the choice labels * @param null|callable|string|PropertyPath $index The callable or path generating the view indices * @param null|callable|string|PropertyPath $groupBy The callable or path generating the group names * @param null|array|callable|string|PropertyPath $attr The callable or path 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)
    {
        $accessor = $this->propertyAccessor;

        if (is_string($label&& !is_callable($label)) {
            $label = new PropertyPath($label);
        } elseif (is_string($label&& is_callable($label)) {
            @trigger_error('Passing callable strings is deprecated since Symfony 3.1 and PropertyAccessDecorator will treat them as property paths in 4.0. You should use a "\Closure" instead.'E_USER_DEPRECATED);
        }

        if ($label instanceof PropertyPath) {
            $label = function ($choiceuse ($accessor$label) {
                return $accessor->getValue($choice$label);
            };
        }

        if (is_string($preferredChoices&& !is_callable($preferredChoices)) {
            $preferredChoices = new PropertyPath($preferredChoices);
        } elseif (is_string($preferredChoices&& is_callable($preferredChoices)) {
            @trigger_error('Passing callable strings is deprecated since Symfony 3.1 and PropertyAccessDecorator will treat them as property paths in 4.0. You should use a "\Closure" instead.'E_USER_DEPRECATED);
        }

        if ($preferredChoices instanceof PropertyPath) {
            $preferredChoices = function ($choiceuse ($accessor$preferredChoices) {
                try {
                    return $accessor->getValue($choice$preferredChoices);
                } catch (UnexpectedTypeException $e) {
                    // Assume not preferred if not readable
                    return false;
                }
            };
        }

        if (is_string($index&& !is_callable($index)) {
            $index = new PropertyPath($index);
        } elseif (is_string($index&& is_callable($index)) {
            @trigger_error('Passing callable strings is deprecated since Symfony 3.1 and PropertyAccessDecorator will treat them as property paths in 4.0. You should use a "\Closure" instead.'E_USER_DEPRECATED);
        }

        if ($index instanceof PropertyPath) {
            $index = function ($choiceuse ($accessor$index) {
                return $accessor->getValue($choice$index);
            };
        }

        if (is_string($groupBy&& !is_callable($groupBy)) {
            $groupBy = new PropertyPath($groupBy);
        } elseif (is_string($groupBy&& is_callable($groupBy)) {
            @trigger_error('Passing callable strings is deprecated since Symfony 3.1 and PropertyAccessDecorator will treat them as property paths in 4.0. You should use a "\Closure" instead.'E_USER_DEPRECATED);
        }

        if ($groupBy instanceof PropertyPath) {
            $groupBy = function ($choiceuse ($accessor$groupBy) {
                try {
                    return $accessor->getValue($choice$groupBy);
                } catch (UnexpectedTypeException $e) {
                    // Don't group if path is not readable
                }
            };
        }

        if (is_string($attr&& !is_callable($attr)) {
            $attr = new PropertyPath($attr);
        } elseif (is_string($attr&& is_callable($attr)) {
            @trigger_error('Passing callable strings is deprecated since Symfony 3.1 and PropertyAccessDecorator will treat them as property paths in 4.0. You should use a "\Closure" instead.'E_USER_DEPRECATED);
        }

        if ($attr instanceof PropertyPath) {
            $attr = function ($choiceuse ($accessor$attr) {
                return $accessor->getValue($choice$attr);
            };
        }

        return $this->decoratedFactory->createView($list$preferredChoices$label$index$groupBy$attr);
    }
}