123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288 |
- <?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;
- use Symfony\Component\PropertyInfo\PropertyReadInfoExtractorInterface;
- use Symfony\Component\PropertyInfo\PropertyWriteInfoExtractorInterface;
- /**
- * A configurable builder to create a PropertyAccessor.
- *
- * @author Jérémie Augustin <jeremie.augustin@pixel-cookers.com>
- */
- class PropertyAccessorBuilder
- {
- /** @var int */
- private $magicMethods = PropertyAccessor::MAGIC_GET | PropertyAccessor::MAGIC_SET;
- private $throwExceptionOnInvalidIndex = false;
- private $throwExceptionOnInvalidPropertyPath = true;
- /**
- * @var CacheItemPoolInterface|null
- */
- private $cacheItemPool;
- /**
- * @var PropertyReadInfoExtractorInterface|null
- */
- private $readInfoExtractor;
- /**
- * @var PropertyWriteInfoExtractorInterface|null
- */
- private $writeInfoExtractor;
- /**
- * Enables the use of all magic methods by the PropertyAccessor.
- */
- public function enableMagicMethods(): self
- {
- $this->magicMethods = PropertyAccessor::MAGIC_GET | PropertyAccessor::MAGIC_SET | PropertyAccessor::MAGIC_CALL;
- return $this;
- }
- /**
- * Disable the use of all magic methods by the PropertyAccessor.
- */
- public function disableMagicMethods(): self
- {
- $this->magicMethods = PropertyAccessor::DISALLOW_MAGIC_METHODS;
- return $this;
- }
- /**
- * Enables the use of "__call" by the PropertyAccessor.
- *
- * @return $this
- */
- public function enableMagicCall()
- {
- $this->magicMethods |= PropertyAccessor::MAGIC_CALL;
- return $this;
- }
- /**
- * Enables the use of "__get" by the PropertyAccessor.
- */
- public function enableMagicGet(): self
- {
- $this->magicMethods |= PropertyAccessor::MAGIC_GET;
- return $this;
- }
- /**
- * Enables the use of "__set" by the PropertyAccessor.
- */
- public function enableMagicSet(): self
- {
- $this->magicMethods |= PropertyAccessor::MAGIC_SET;
- return $this;
- }
- /**
- * Disables the use of "__call" by the PropertyAccessor.
- *
- * @return $this
- */
- public function disableMagicCall()
- {
- $this->magicMethods &= ~PropertyAccessor::MAGIC_CALL;
- return $this;
- }
- /**
- * Disables the use of "__get" by the PropertyAccessor.
- */
- public function disableMagicGet(): self
- {
- $this->magicMethods &= ~PropertyAccessor::MAGIC_GET;
- return $this;
- }
- /**
- * Disables the use of "__set" by the PropertyAccessor.
- */
- public function disableMagicSet(): self
- {
- $this->magicMethods &= ~PropertyAccessor::MAGIC_SET;
- return $this;
- }
- /**
- * @return bool whether the use of "__call" by the PropertyAccessor is enabled
- */
- public function isMagicCallEnabled()
- {
- return (bool) ($this->magicMethods & PropertyAccessor::MAGIC_CALL);
- }
- /**
- * @return bool whether the use of "__get" by the PropertyAccessor is enabled
- */
- public function isMagicGetEnabled(): bool
- {
- return $this->magicMethods & PropertyAccessor::MAGIC_GET;
- }
- /**
- * @return bool whether the use of "__set" by the PropertyAccessor is enabled
- */
- public function isMagicSetEnabled(): bool
- {
- return $this->magicMethods & PropertyAccessor::MAGIC_SET;
- }
- /**
- * 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;
- }
- /**
- * Enables exceptions when reading a non-existing property.
- *
- * This has no influence on writing non-existing indices with PropertyAccessorInterface::setValue()
- * which are always created on-the-fly.
- *
- * @return $this
- */
- public function enableExceptionOnInvalidPropertyPath()
- {
- $this->throwExceptionOnInvalidPropertyPath = 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 disableExceptionOnInvalidPropertyPath()
- {
- $this->throwExceptionOnInvalidPropertyPath = false;
- return $this;
- }
- /**
- * @return bool whether an exception is thrown or null is returned when reading a non-existing property
- */
- public function isExceptionOnInvalidPropertyPath()
- {
- return $this->throwExceptionOnInvalidPropertyPath;
- }
- /**
- * Sets a cache system.
- *
- * @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;
- }
- /**
- * @return $this
- */
- public function setReadInfoExtractor(?PropertyReadInfoExtractorInterface $readInfoExtractor)
- {
- $this->readInfoExtractor = $readInfoExtractor;
- return $this;
- }
- public function getReadInfoExtractor(): ?PropertyReadInfoExtractorInterface
- {
- return $this->readInfoExtractor;
- }
- /**
- * @return $this
- */
- public function setWriteInfoExtractor(?PropertyWriteInfoExtractorInterface $writeInfoExtractor)
- {
- $this->writeInfoExtractor = $writeInfoExtractor;
- return $this;
- }
- public function getWriteInfoExtractor(): ?PropertyWriteInfoExtractorInterface
- {
- return $this->writeInfoExtractor;
- }
- /**
- * Builds and returns a new PropertyAccessor object.
- *
- * @return PropertyAccessorInterface The built PropertyAccessor
- */
- public function getPropertyAccessor()
- {
- return new PropertyAccessor($this->magicMethods, $this->throwExceptionOnInvalidIndex, $this->cacheItemPool, $this->throwExceptionOnInvalidPropertyPath, $this->readInfoExtractor, $this->writeInfoExtractor);
- }
- }
|