2011-01-18 19:17:24 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/*
|
2012-03-31 22:00:32 +01:00
|
|
|
* This file is part of the Symfony package.
|
2011-01-18 19:17:24 +00:00
|
|
|
*
|
2011-03-06 11:40:06 +00:00
|
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
2011-01-18 19:17:24 +00:00
|
|
|
*
|
2012-03-31 22:00:32 +01:00
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
2011-01-18 19:17:24 +00:00
|
|
|
*/
|
|
|
|
|
2012-04-02 04:52:14 +01:00
|
|
|
namespace Symfony\Component\Serializer\Normalizer;
|
|
|
|
|
2012-08-30 20:37:05 +01:00
|
|
|
use Symfony\Component\Serializer\Exception\InvalidArgumentException;
|
2012-04-02 04:52:14 +01:00
|
|
|
use Symfony\Component\Serializer\Exception\RuntimeException;
|
|
|
|
|
2011-01-18 19:17:24 +00:00
|
|
|
/**
|
|
|
|
* Converts between objects with getter and setter methods and arrays.
|
|
|
|
*
|
|
|
|
* The normalization process looks at all public methods and calls the ones
|
|
|
|
* which have a name starting with get and take no parameters. The result is a
|
|
|
|
* map from property names (method name stripped of the get prefix and converted
|
|
|
|
* to lower case) to property values. Property values are normalized through the
|
|
|
|
* serializer.
|
|
|
|
*
|
|
|
|
* The denormalization first looks at the constructor of the given class to see
|
|
|
|
* if any of the parameters have the same name as one of the properties. The
|
|
|
|
* constructor is then called with all parameters or an exception is thrown if
|
|
|
|
* any required parameters were not present as properties. Then the denormalizer
|
|
|
|
* walks through the given map of property names to property values to see if a
|
|
|
|
* setter method exists for any of the properties. If a setter exists it is
|
|
|
|
* called with the property value. No automatic denormalization of the value
|
|
|
|
* takes place.
|
|
|
|
*
|
|
|
|
* @author Nils Adermann <naderman@naderman.de>
|
|
|
|
*/
|
2011-12-11 20:18:03 +00:00
|
|
|
class GetSetMethodNormalizer extends SerializerAwareNormalizer implements NormalizerInterface, DenormalizerInterface
|
2011-01-18 19:17:24 +00:00
|
|
|
{
|
2012-03-12 18:46:28 +00:00
|
|
|
protected $callbacks = array();
|
|
|
|
protected $ignoredAttributes = array();
|
2013-02-02 16:53:42 +00:00
|
|
|
protected $camelizedAttributes = array();
|
2012-03-12 18:46:28 +00:00
|
|
|
|
|
|
|
/**
|
2013-11-20 02:35:05 +00:00
|
|
|
* Set normalization callbacks.
|
2012-03-12 18:46:28 +00:00
|
|
|
*
|
2013-11-20 02:35:05 +00:00
|
|
|
* @param callable[] $callbacks help normalize the result
|
2012-08-30 20:37:05 +01:00
|
|
|
*
|
|
|
|
* @throws InvalidArgumentException if a non-callable callback is set
|
2014-03-04 14:24:09 +00:00
|
|
|
*
|
|
|
|
* @return GetSetMethodNormalizer
|
2012-03-12 18:46:28 +00:00
|
|
|
*/
|
|
|
|
public function setCallbacks(array $callbacks)
|
|
|
|
{
|
|
|
|
foreach ($callbacks as $attribute => $callback) {
|
|
|
|
if (!is_callable($callback)) {
|
2012-08-30 20:37:05 +01:00
|
|
|
throw new InvalidArgumentException(sprintf('The given callback for attribute "%s" is not callable.', $attribute));
|
2012-03-12 18:46:28 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
$this->callbacks = $callbacks;
|
2014-03-04 14:24:09 +00:00
|
|
|
|
|
|
|
return $this;
|
2012-03-12 18:46:28 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set ignored attributes for normalization
|
|
|
|
*
|
|
|
|
* @param array $ignoredAttributes
|
2014-03-04 14:24:09 +00:00
|
|
|
*
|
|
|
|
* @return GetSetMethodNormalizer
|
2012-03-12 18:46:28 +00:00
|
|
|
*/
|
|
|
|
public function setIgnoredAttributes(array $ignoredAttributes)
|
|
|
|
{
|
|
|
|
$this->ignoredAttributes = $ignoredAttributes;
|
2014-03-04 14:24:09 +00:00
|
|
|
|
|
|
|
return $this;
|
2012-03-12 18:46:28 +00:00
|
|
|
}
|
|
|
|
|
2013-02-02 16:53:42 +00:00
|
|
|
/**
|
|
|
|
* Set attributes to be camelized on denormalize
|
|
|
|
*
|
|
|
|
* @param array $camelizedAttributes
|
2014-03-04 14:24:09 +00:00
|
|
|
*
|
|
|
|
* @return GetSetMethodNormalizer
|
2013-02-02 16:53:42 +00:00
|
|
|
*/
|
|
|
|
public function setCamelizedAttributes(array $camelizedAttributes)
|
|
|
|
{
|
|
|
|
$this->camelizedAttributes = $camelizedAttributes;
|
2014-03-04 14:24:09 +00:00
|
|
|
|
|
|
|
return $this;
|
2013-02-02 16:53:42 +00:00
|
|
|
}
|
|
|
|
|
2011-01-18 19:17:24 +00:00
|
|
|
/**
|
|
|
|
* {@inheritdoc}
|
|
|
|
*/
|
2013-01-18 13:08:59 +00:00
|
|
|
public function normalize($object, $format = null, array $context = array())
|
2011-01-18 19:17:24 +00:00
|
|
|
{
|
|
|
|
$reflectionObject = new \ReflectionObject($object);
|
|
|
|
$reflectionMethods = $reflectionObject->getMethods(\ReflectionMethod::IS_PUBLIC);
|
|
|
|
|
|
|
|
$attributes = array();
|
|
|
|
foreach ($reflectionMethods as $method) {
|
|
|
|
if ($this->isGetMethod($method)) {
|
2014-02-22 23:56:53 +00:00
|
|
|
$attributeName = lcfirst(substr($method->name, 0 === strpos($method->name, 'is') ? 2 : 3));
|
2011-01-18 19:17:24 +00:00
|
|
|
|
2012-03-12 18:46:28 +00:00
|
|
|
if (in_array($attributeName, $this->ignoredAttributes)) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
2011-05-08 17:32:22 +01:00
|
|
|
$attributeValue = $method->invoke($object);
|
2012-03-12 18:46:28 +00:00
|
|
|
if (array_key_exists($attributeName, $this->callbacks)) {
|
|
|
|
$attributeValue = call_user_func($this->callbacks[$attributeName], $attributeValue);
|
|
|
|
}
|
2011-05-08 17:32:22 +01:00
|
|
|
if (null !== $attributeValue && !is_scalar($attributeValue)) {
|
2014-02-21 09:42:31 +00:00
|
|
|
if (!$this->serializer instanceof NormalizerInterface) {
|
|
|
|
throw new \LogicException(sprintf('Cannot normalize attribute "%s" because injected serializer is not a normalizer', $attributeName));
|
|
|
|
}
|
2011-05-08 17:32:22 +01:00
|
|
|
$attributeValue = $this->serializer->normalize($attributeValue, $format);
|
2011-01-18 19:17:24 +00:00
|
|
|
}
|
2011-05-08 17:32:22 +01:00
|
|
|
|
|
|
|
$attributes[$attributeName] = $attributeValue;
|
2011-01-18 19:17:24 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $attributes;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* {@inheritdoc}
|
|
|
|
*/
|
2013-01-18 13:08:59 +00:00
|
|
|
public function denormalize($data, $class, $format = null, array $context = array())
|
2011-01-18 19:17:24 +00:00
|
|
|
{
|
|
|
|
$reflectionClass = new \ReflectionClass($class);
|
|
|
|
$constructor = $reflectionClass->getConstructor();
|
|
|
|
|
|
|
|
if ($constructor) {
|
|
|
|
$constructorParameters = $constructor->getParameters();
|
|
|
|
|
|
|
|
$params = array();
|
|
|
|
foreach ($constructorParameters as $constructorParameter) {
|
2013-02-02 16:53:42 +00:00
|
|
|
$paramName = lcfirst($this->formatAttribute($constructorParameter->name));
|
2011-01-18 19:17:24 +00:00
|
|
|
|
|
|
|
if (isset($data[$paramName])) {
|
|
|
|
$params[] = $data[$paramName];
|
|
|
|
// don't run set for a parameter passed to the constructor
|
|
|
|
unset($data[$paramName]);
|
2011-12-18 13:42:59 +00:00
|
|
|
} elseif (!$constructorParameter->isOptional()) {
|
2011-05-29 09:55:08 +01:00
|
|
|
throw new RuntimeException(
|
2011-06-23 13:07:53 +01:00
|
|
|
'Cannot create an instance of '.$class.
|
|
|
|
' from serialized data because its constructor requires '.
|
2012-06-12 13:23:19 +01:00
|
|
|
'parameter "'.$constructorParameter->name.
|
2011-01-18 19:17:24 +00:00
|
|
|
'" to be present.');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$object = $reflectionClass->newInstanceArgs($params);
|
|
|
|
} else {
|
|
|
|
$object = new $class;
|
|
|
|
}
|
|
|
|
|
|
|
|
foreach ($data as $attribute => $value) {
|
2013-02-02 16:53:42 +00:00
|
|
|
$setter = 'set'.$this->formatAttribute($attribute);
|
|
|
|
|
2011-01-18 19:17:24 +00:00
|
|
|
if (method_exists($object, $setter)) {
|
|
|
|
$object->$setter($value);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $object;
|
|
|
|
}
|
|
|
|
|
2013-02-02 16:53:42 +00:00
|
|
|
/**
|
|
|
|
* Format attribute name to access parameters or methods
|
|
|
|
* As option, if attribute name is found on camelizedAttributes array
|
|
|
|
* returns attribute name in camelcase format
|
|
|
|
*
|
2013-04-21 13:26:17 +01:00
|
|
|
* @param string $attributeName
|
2013-02-02 16:53:42 +00:00
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
protected function formatAttribute($attributeName)
|
|
|
|
{
|
|
|
|
if (in_array($attributeName, $this->camelizedAttributes)) {
|
|
|
|
return preg_replace_callback(
|
2013-07-01 13:24:43 +01:00
|
|
|
'/(^|_|\.)+(.)/', function ($match) {
|
|
|
|
return ('.' === $match[1] ? '_' : '').strtoupper($match[2]);
|
2013-02-02 16:53:42 +00:00
|
|
|
}, $attributeName
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $attributeName;
|
|
|
|
}
|
|
|
|
|
2011-05-06 18:36:56 +01:00
|
|
|
/**
|
2014-04-15 06:57:34 +01:00
|
|
|
* {@inheritdoc}
|
2011-05-06 18:36:56 +01:00
|
|
|
*/
|
|
|
|
public function supportsNormalization($data, $format = null)
|
|
|
|
{
|
2011-06-06 21:33:43 +01:00
|
|
|
return is_object($data) && $this->supports(get_class($data));
|
2011-05-06 18:36:56 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-04-15 06:57:34 +01:00
|
|
|
* {@inheritdoc}
|
2011-05-06 18:36:56 +01:00
|
|
|
*/
|
|
|
|
public function supportsDenormalization($data, $type, $format = null)
|
|
|
|
{
|
|
|
|
return $this->supports($type);
|
|
|
|
}
|
|
|
|
|
2011-01-18 19:17:24 +00:00
|
|
|
/**
|
|
|
|
* Checks if the given class has any get{Property} method.
|
|
|
|
*
|
2011-05-06 18:36:56 +01:00
|
|
|
* @param string $class
|
2012-11-16 16:06:12 +00:00
|
|
|
*
|
2011-05-06 18:36:56 +01:00
|
|
|
* @return Boolean
|
2011-01-18 19:17:24 +00:00
|
|
|
*/
|
2011-05-06 18:36:56 +01:00
|
|
|
private function supports($class)
|
2011-01-18 19:17:24 +00:00
|
|
|
{
|
2011-05-07 16:02:06 +01:00
|
|
|
$class = new \ReflectionClass($class);
|
2011-01-18 19:17:24 +00:00
|
|
|
$methods = $class->getMethods(\ReflectionMethod::IS_PUBLIC);
|
|
|
|
foreach ($methods as $method) {
|
|
|
|
if ($this->isGetMethod($method)) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
}
|
2011-06-08 11:12:55 +01:00
|
|
|
|
2011-01-18 19:17:24 +00:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-02-22 23:56:53 +00:00
|
|
|
* Checks if a method's name is get.* or is.*, and can be called without parameters.
|
2011-01-18 19:17:24 +00:00
|
|
|
*
|
2012-10-19 17:43:59 +01:00
|
|
|
* @param \ReflectionMethod $method the method to check
|
|
|
|
*
|
2014-02-22 23:56:53 +00:00
|
|
|
* @return Boolean whether the method is a getter or boolean getter.
|
2011-01-18 19:17:24 +00:00
|
|
|
*/
|
2011-04-03 14:13:21 +01:00
|
|
|
private function isGetMethod(\ReflectionMethod $method)
|
2011-01-18 19:17:24 +00:00
|
|
|
{
|
2014-02-22 23:56:53 +00:00
|
|
|
$methodLength = strlen($method->name);
|
|
|
|
|
2011-01-18 19:17:24 +00:00
|
|
|
return (
|
2014-02-22 23:56:53 +00:00
|
|
|
((0 === strpos($method->name, 'get') && 3 < $methodLength) ||
|
|
|
|
(0 === strpos($method->name, 'is') && 2 < $methodLength)) &&
|
2011-01-18 19:17:24 +00:00
|
|
|
0 === $method->getNumberOfRequiredParameters()
|
|
|
|
);
|
|
|
|
}
|
2011-01-30 09:10:27 +00:00
|
|
|
}
|