Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Serializer] Introduce ObjectNormalizer
- Loading branch information
Showing
4 changed files
with
664 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
162 changes: 162 additions & 0 deletions
162
src/Symfony/Component/Serializer/Normalizer/ObjectNormalizer.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,162 @@ | ||
<?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\Serializer\Normalizer; | ||
|
||
use Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException; | ||
use Symfony\Component\PropertyAccess\PropertyAccess; | ||
use Symfony\Component\PropertyAccess\PropertyAccessorInterface; | ||
use Symfony\Component\Serializer\Exception\CircularReferenceException; | ||
use Symfony\Component\Serializer\Exception\LogicException; | ||
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface; | ||
use Symfony\Component\Serializer\NameConverter\NameConverterInterface; | ||
|
||
/** | ||
* Converts between objects and arrays using the PropertyAccess component. | ||
* | ||
* @author Kévin Dunglas <dunglas@gmail.com> | ||
*/ | ||
class ObjectNormalizer extends AbstractNormalizer | ||
{ | ||
/** | ||
* @var PropertyAccessorInterface | ||
*/ | ||
protected $propertyAccessor; | ||
|
||
public function __construct(ClassMetadataFactoryInterface $classMetadataFactory = null, NameConverterInterface $nameConverter = null, PropertyAccessorInterface $propertyAccessor = null) | ||
{ | ||
parent::__construct($classMetadataFactory, $nameConverter); | ||
|
||
$this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor(); | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function supportsNormalization($data, $format = null) | ||
{ | ||
return is_object($data); | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
* | ||
* @throws CircularReferenceException | ||
*/ | ||
public function normalize($object, $format = null, array $context = array()) | ||
{ | ||
if ($this->isCircularReference($object, $context)) { | ||
return $this->handleCircularReference($object); | ||
} | ||
|
||
$data = array(); | ||
$attributes = $this->getAllowedAttributes($object, $context, true); | ||
|
||
// If not using groups, detect manually | ||
if (false === $attributes) { | ||
$attributes = array(); | ||
|
||
// methods | ||
$reflClass = new \ReflectionClass($object); | ||
foreach ($reflClass->getMethods(\ReflectionMethod::IS_PUBLIC) as $reflMethod) { | ||
if ( | ||
!$reflMethod->isConstructor() && | ||
!$reflMethod->isDestructor() && | ||
0 === $reflMethod->getNumberOfRequiredParameters() | ||
) { | ||
$name = $reflMethod->getName(); | ||
|
||
if (strpos($name, 'get') === 0 || strpos($name, 'has') === 0) { | ||
// getters and hassers | ||
$attributes[lcfirst(substr($name, 3))] = true; | ||
} elseif (strpos($name, 'is') === 0) { | ||
// issers | ||
$attributes[lcfirst(substr($name, 2))] = true; | ||
} | ||
} | ||
} | ||
|
||
// properties | ||
foreach ($reflClass->getProperties(\ReflectionProperty::IS_PUBLIC) as $reflProperty) { | ||
$attributes[$reflProperty->getName()] = true; | ||
} | ||
|
||
$attributes = array_keys($attributes); | ||
} | ||
|
||
foreach ($attributes as $attribute) { | ||
if (in_array($attribute, $this->ignoredAttributes)) { | ||
continue; | ||
} | ||
|
||
$attributeValue = $this->propertyAccessor->getValue($object, $attribute); | ||
|
||
if (isset($this->callbacks[$attribute])) { | ||
$attributeValue = call_user_func($this->callbacks[$attribute], $attributeValue); | ||
} | ||
|
||
if (null !== $attributeValue && !is_scalar($attributeValue)) { | ||
if (!$this->serializer instanceof NormalizerInterface) { | ||
throw new LogicException(sprintf('Cannot normalize attribute "%s" because injected serializer is not a normalizer', $attribute)); | ||
} | ||
|
||
$attributeValue = $this->serializer->normalize($attributeValue, $format, $context); | ||
} | ||
|
||
if ($this->nameConverter) { | ||
$attribute = $this->nameConverter->normalize($attribute); | ||
} | ||
|
||
$data[$attribute] = $attributeValue; | ||
} | ||
|
||
return $data; | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function supportsDenormalization($data, $type, $format = null) | ||
{ | ||
return class_exists($type); | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function denormalize($data, $class, $format = null, array $context = array()) | ||
{ | ||
$allowedAttributes = $this->getAllowedAttributes($class, $context, true); | ||
$normalizedData = $this->prepareForDenormalization($data); | ||
|
||
$reflectionClass = new \ReflectionClass($class); | ||
$object = $this->instantiateObject($normalizedData, $class, $context, $reflectionClass, $allowedAttributes); | ||
|
||
foreach ($normalizedData as $attribute => $value) { | ||
$allowed = $allowedAttributes === false || in_array($attribute, $allowedAttributes); | ||
$ignored = in_array($attribute, $this->ignoredAttributes); | ||
|
||
if ($allowed && !$ignored) { | ||
if ($this->nameConverter) { | ||
$attribute = $this->nameConverter->normalize($attribute); | ||
} | ||
|
||
try { | ||
$this->propertyAccessor->setValue($object, $attribute, $value); | ||
} catch (NoSuchPropertyException $exception) { | ||
// Properties not found are ignored | ||
} | ||
} | ||
} | ||
|
||
return $object; | ||
} | ||
} |
Oops, something went wrong.