/protected/extensions/doctrine/vendors/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php
PHP | 155 lines | 82 code | 20 blank | 53 comment | 9 complexity | 1fd7262c7ec96fd348c15b6fe9dc35fe MD5 | raw file
Possible License(s): BSD-2-Clause, LGPL-2.1, BSD-3-Clause
- <?php
- namespace Symfony\Component\Serializer\Normalizer;
- use Symfony\Component\Serializer\Exception\RuntimeException;
- /*
- * This file is part of the Symfony framework.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * This source file is subject to the MIT license that is bundled
- * with this source code in the file LICENSE.
- */
- /**
- * 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>
- */
- class GetSetMethodNormalizer extends SerializerAwareNormalizer
- {
- /**
- * {@inheritdoc}
- */
- public function normalize($object, $format = null)
- {
- $reflectionObject = new \ReflectionObject($object);
- $reflectionMethods = $reflectionObject->getMethods(\ReflectionMethod::IS_PUBLIC);
- $attributes = array();
- foreach ($reflectionMethods as $method) {
- if ($this->isGetMethod($method)) {
- $attributeName = strtolower(substr($method->getName(), 3));
- $attributeValue = $method->invoke($object);
- if (null !== $attributeValue && !is_scalar($attributeValue)) {
- $attributeValue = $this->serializer->normalize($attributeValue, $format);
- }
- $attributes[$attributeName] = $attributeValue;
- }
- }
- return $attributes;
- }
- /**
- * {@inheritdoc}
- */
- public function denormalize($data, $class, $format = null)
- {
- $reflectionClass = new \ReflectionClass($class);
- $constructor = $reflectionClass->getConstructor();
- if ($constructor) {
- $constructorParameters = $constructor->getParameters();
- $params = array();
- foreach ($constructorParameters as $constructorParameter) {
- $paramName = strtolower($constructorParameter->getName());
- if (isset($data[$paramName])) {
- $params[] = $data[$paramName];
- // don't run set for a parameter passed to the constructor
- unset($data[$paramName]);
- } elseif (!$constructorParameter->isOptional()) {
- throw new RuntimeException(
- 'Cannot create an instance of '.$class.
- ' from serialized data because its constructor requires '.
- 'parameter "'.$constructorParameter->getName().
- '" to be present.');
- }
- }
- $object = $reflectionClass->newInstanceArgs($params);
- } else {
- $object = new $class;
- }
- foreach ($data as $attribute => $value) {
- $setter = 'set'.$attribute;
- if (method_exists($object, $setter)) {
- $object->$setter($value);
- }
- }
- return $object;
- }
- /**
- * {@inheritDoc}
- */
- public function supportsNormalization($data, $format = null)
- {
- return is_object($data) && $this->supports(get_class($data));
- }
- /**
- * {@inheritDoc}
- */
- public function supportsDenormalization($data, $type, $format = null)
- {
- return $this->supports($type);
- }
- /**
- * Checks if the given class has any get{Property} method.
- *
- * @param string $class
- * @return Boolean
- */
- private function supports($class)
- {
- $class = new \ReflectionClass($class);
- $methods = $class->getMethods(\ReflectionMethod::IS_PUBLIC);
- foreach ($methods as $method) {
- if ($this->isGetMethod($method)) {
- return true;
- }
- }
- return false;
- }
- /**
- * Checks if a method's name is get.* and can be called without parameters.
- *
- * @param ReflectionMethod $method the method to check
- * @return Boolean whether the method is a getter.
- */
- private function isGetMethod(\ReflectionMethod $method)
- {
- return (
- 0 === strpos($method->getName(), 'get') &&
- 3 < strlen($method->getName()) &&
- 0 === $method->getNumberOfRequiredParameters()
- );
- }
- }