Classes List

Symfony\Component\PropertyAccess\PropertyAccessorBuilder

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

use Psr\Cache\CacheItemPoolInterface;

/** * A configurable builder to create a PropertyAccessor. * * @author Jérémie Augustin <jeremie.augustin@pixel-cookers.com> */
class PropertyAccessorBuilder
{
    private $magicCall = false;
    private $throwExceptionOnInvalidIndex = false;

    /** * @var CacheItemPoolInterface|null */
    private $cacheItemPool;

    /** * Enables the use of "__call" by the PropertyAccessor. * * @return $this */
    public function enableMagicCall()
    {
        $this->magicCall = true;

        return $this;
    }

    /** * Disables the use of "__call" by the PropertyAccessor. * * @return $this */
    public function disableMagicCall()
    {
        $this->magicCall = false;

        return $this;
    }

    /** * @return bool whether the use of "__call" by the PropertyAccessor is enabled */
    public function isMagicCallEnabled()
    {
        return $this->magicCall;
    }

    /** * Enables exceptions when reading a non-existing index. * * This has no influence on writing non-existing indices with PropertyAccessorInterface::setValue() * which are always created on-the-fly. * * @return $this */
    public function enableExceptionOnInvalidIndex()
    {
        $this->throwExceptionOnInvalidIndex = true;

        return $this;
    }

    /** * Disables exceptions when reading a non-existing index. * * Instead, null is returned when calling PropertyAccessorInterface::getValue() on a non-existing index. * * @return $this */
    public function disableExceptionOnInvalidIndex()
    {
        $this->throwExceptionOnInvalidIndex = false;

        return $this;
    }

    /** * @return bool whether an exception is thrown or null is returned when reading a non-existing index */
    public function isExceptionOnInvalidIndexEnabled()
    {
        return $this->throwExceptionOnInvalidIndex;
    }

    /** * Sets a cache system. * * @param CacheItemPoolInterface|null $cacheItemPool * * @return PropertyAccessorBuilder The builder object */
    public function setCacheItemPool(CacheItemPoolInterface $cacheItemPool = null)
    {
        $this->cacheItemPool = $cacheItemPool;

        return $this;
    }

    /** * Gets the used cache system. * * @return CacheItemPoolInterface|null */
    public function getCacheItemPool()
    {
        return $this->cacheItemPool;
    }

    /** * Builds and returns a new PropertyAccessor object. * * @return PropertyAccessorInterface The built PropertyAccessor */
    public function getPropertyAccessor()
    {
        return new PropertyAccessor($this->magicCall$this->throwExceptionOnInvalidIndex$this->cacheItemPool);
    }
}