Classes List

Symfony\Component\Form\ChoiceList\Factory\CachingFactoryDecorator

 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 
<?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;

/** * Caches the choice lists created by the decorated factory. * * @author Bernhard Schussek <bschussek@gmail.com> */
class CachingFactoryDecorator implements ChoiceListFactoryInterface
{
    private $decoratedFactory;

    /** * @var ChoiceListInterface[] */
    private $lists = array();

    /** * @var ChoiceListView[] */
    private $views = array();

    /** * Generates a SHA-256 hash for the given value. * * Optionally, a namespace string can be passed. Calling this method will * the same values, but different namespaces, will return different hashes. * * @param mixed $value The value to hash * @param string $namespace Optional. The namespace * * @return string The SHA-256 hash * * @internal */
    public static function generateHash($value$namespace = '')
    {
        if (is_object($value)) {
            $value = spl_object_hash($value);
        } elseif (is_array($value)) {
            array_walk_recursive($valuefunction (&$v) {
                if (is_object($v)) {
                    $v = spl_object_hash($v);
                }
            });
        }

        return hash('sha256'$namespace.':'.serialize($value));
    }

    /** * Flattens an array into the given output variable. * * @param array $array The array to flatten * @param array $output The flattened output * * @internal */
    private static function flatten(array $array, &$output)
    {
        if (null === $output) {
            $output = array();
        }

        foreach ($array as $key => $value) {
            if (is_array($value)) {
                self::flatten($value$output);
                continue;
            }

            $output[$key] = $value;
        }
    }

    public function __construct(ChoiceListFactoryInterface $decoratedFactory)
    {
        $this->decoratedFactory = $decoratedFactory;
    }

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

    /** * {@inheritdoc} */
    public function createListFromChoices($choices$value = null)
    {
        if ($choices instanceof \Traversable) {
            $choices = iterator_to_array($choices);
        }

        // The value is not validated on purpose. The decorated factory may
        // decide which values to accept and which not.

        // We ignore the choice groups for caching. If two choice lists are
        // requested with the same choices, but a different grouping, the same
        // choice list is returned.
        self::flatten($choices$flatChoices);

        $hash = self::generateHash(array($flatChoices$value), 'fromChoices');

        if (!isset($this->lists[$hash])) {
            $this->lists[$hash] = $this->decoratedFactory->createListFromChoices($choices$value);
        }

        return $this->lists[$hash];
    }

    /** * {@inheritdoc} */
    public function createListFromLoader(ChoiceLoaderInterface $loader$value = null)
    {
        $hash = self::generateHash(array($loader$value), 'fromLoader');

        if (!isset($this->lists[$hash])) {
            $this->lists[$hash] = $this->decoratedFactory->createListFromLoader($loader$value);
        }

        return $this->lists[$hash];
    }

    /** * {@inheritdoc} */
    public function createView(ChoiceListInterface $list$preferredChoices = null$label = null$index = null$groupBy = null$attr = null)
    {
        // The input is not validated on purpose. This way, the decorated
        // factory may decide which input to accept and which not.
        $hash = self::generateHash(array($list$preferredChoices$label$index$groupBy$attr));

        if (!isset($this->views[$hash])) {
            $this->views[$hash] = $this->decoratedFactory->createView(
                $list,
                $preferredChoices,
                $label,
                $index,
                $groupBy,
                $attr
            );
        }

        return $this->views[$hash];
    }
}