2013-03-04 22:59:45 +00:00
|
|
|
<?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;
|
|
|
|
|
|
|
|
/**
|
2015-02-21 15:36:02 +00:00
|
|
|
* A configurable builder to create a PropertyAccessor.
|
2013-03-04 22:59:45 +00:00
|
|
|
*
|
|
|
|
* @author Jérémie Augustin <jeremie.augustin@pixel-cookers.com>
|
|
|
|
*/
|
2013-04-25 09:52:48 +01:00
|
|
|
class PropertyAccessorBuilder
|
2013-03-04 22:59:45 +00:00
|
|
|
{
|
|
|
|
/**
|
2014-04-16 11:30:19 +01:00
|
|
|
* @var bool
|
2013-03-04 22:59:45 +00:00
|
|
|
*/
|
|
|
|
private $magicCall = false;
|
|
|
|
|
2013-09-27 15:14:57 +01:00
|
|
|
/**
|
2014-04-16 11:34:42 +01:00
|
|
|
* @var bool
|
2013-09-27 15:14:57 +01:00
|
|
|
*/
|
|
|
|
private $throwExceptionOnInvalidIndex = false;
|
|
|
|
|
2013-03-04 22:59:45 +00:00
|
|
|
/**
|
2013-08-24 07:54:37 +01:00
|
|
|
* Enables the use of "__call" by the PropertyAccessor.
|
2013-04-25 09:52:48 +01:00
|
|
|
*
|
|
|
|
* @return PropertyAccessorBuilder The builder object
|
2013-03-04 22:59:45 +00:00
|
|
|
*/
|
|
|
|
public function enableMagicCall()
|
|
|
|
{
|
|
|
|
$this->magicCall = true;
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2013-08-24 07:54:37 +01:00
|
|
|
* Disables the use of "__call" by the PropertyAccessor.
|
2013-04-25 09:52:48 +01:00
|
|
|
*
|
|
|
|
* @return PropertyAccessorBuilder The builder object
|
2013-03-04 22:59:45 +00:00
|
|
|
*/
|
|
|
|
public function disableMagicCall()
|
|
|
|
{
|
|
|
|
$this->magicCall = false;
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2015-02-21 15:36:02 +00:00
|
|
|
* @return bool whether the use of "__call" by the PropertyAccessor is enabled
|
2013-03-04 22:59:45 +00:00
|
|
|
*/
|
|
|
|
public function isMagicCallEnabled()
|
|
|
|
{
|
|
|
|
return $this->magicCall;
|
|
|
|
}
|
|
|
|
|
2013-09-27 15:14:57 +01:00
|
|
|
/**
|
2015-02-21 15:36:02 +00:00
|
|
|
* 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.
|
2013-09-27 15:14:57 +01:00
|
|
|
*
|
|
|
|
* @return PropertyAccessorBuilder The builder object
|
|
|
|
*/
|
|
|
|
public function enableExceptionOnInvalidIndex()
|
|
|
|
{
|
|
|
|
$this->throwExceptionOnInvalidIndex = true;
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2015-02-21 15:36:02 +00:00
|
|
|
* Disables exceptions when reading a non-existing index.
|
|
|
|
*
|
|
|
|
* Instead, null is returned when calling PropertyAccessorInterface::getValue() on a non-existing index.
|
2013-09-27 15:14:57 +01:00
|
|
|
*
|
|
|
|
* @return PropertyAccessorBuilder The builder object
|
|
|
|
*/
|
|
|
|
public function disableExceptionOnInvalidIndex()
|
|
|
|
{
|
|
|
|
$this->throwExceptionOnInvalidIndex = false;
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2015-02-21 15:36:02 +00:00
|
|
|
* @return bool whether an exception is thrown or null is returned when reading a non-existing index
|
2013-09-27 15:14:57 +01:00
|
|
|
*/
|
|
|
|
public function isExceptionOnInvalidIndexEnabled()
|
|
|
|
{
|
|
|
|
return $this->throwExceptionOnInvalidIndex;
|
|
|
|
}
|
|
|
|
|
2013-03-04 22:59:45 +00:00
|
|
|
/**
|
2015-02-21 15:36:02 +00:00
|
|
|
* Builds and returns a new PropertyAccessor object.
|
2013-04-25 09:52:48 +01:00
|
|
|
*
|
2015-02-21 15:36:02 +00:00
|
|
|
* @return PropertyAccessorInterface The built PropertyAccessor
|
2013-03-04 22:59:45 +00:00
|
|
|
*/
|
|
|
|
public function getPropertyAccessor()
|
|
|
|
{
|
2013-09-27 15:14:57 +01:00
|
|
|
return new PropertyAccessor($this->magicCall, $this->throwExceptionOnInvalidIndex);
|
2013-03-04 22:59:45 +00:00
|
|
|
}
|
|
|
|
}
|