Classes List

Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
<?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;

/** * 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> * @author Kévin Dunglas <dunglas@gmail.com> */
class GetSetMethodNormalizer extends AbstractObjectNormalizer
{
    private static $setterAccessibleCache = array();
    private $cache = array();

    /** * {@inheritdoc} */
    public function supportsNormalization($data$format = null)
    {
        return parent::supportsNormalization($data$format&& (isset($this->cache[$type = \get_class($data)]) ? $this->cache[$type] : $this->cache[$type] = $this->supports($type));
    }

    /** * {@inheritdoc} */
    public function supportsDenormalization($data$type$format = null)
    {
        return parent::supportsDenormalization($data$type$format&& (isset($this->cache[$type]) ? $this->cache[$type] : $this->cache[$type] = $this->supports($type));
    }

    /** * Checks if the given class has any get{Property} method. * * @param string $class * * @return bool */
    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.* or is.*, and can be called without parameters. * * @return bool whether the method is a getter or boolean getter */
    private function isGetMethod(\ReflectionMethod $method)
    {
        $methodLength = \strlen($method->name);

        return
            !$method->isStatic() &&
            (
                ((0 === strpos($method->name'get'&& 3 < $methodLength||
                (0 === strpos($method->name'is'&& 2 < $methodLength||
                (0 === strpos($method->name'has'&& 3 < $methodLength)) &&
                0 === $method->getNumberOfRequiredParameters()
            )
        ;
    }

    /** * {@inheritdoc} */
    protected function extractAttributes($object$format = nullarray $context = array())
    {
        $reflectionObject = new \ReflectionObject($object);
        $reflectionMethods = $reflectionObject->getMethods(\ReflectionMethod::IS_PUBLIC);

        $attributes = array();
        foreach ($reflectionMethods as $method) {
            if (!$this->isGetMethod($method)) {
                continue;
            }

            $attributeName = lcfirst(substr($method->name0 === strpos($method->name'is') ? 2 : 3));

            if ($this->isAllowedAttribute($object$attributeName)) {
                $attributes[] = $attributeName;
            }
        }

        return $attributes;
    }

    /** * {@inheritdoc} */
    protected function getAttributeValue($object$attribute$format = nullarray $context = array())
    {
        $ucfirsted = ucfirst($attribute);

        $getter = 'get'.$ucfirsted;
        if (\is_callable(array($object$getter))) {
            return $object->$getter();
        }

        $isser = 'is'.$ucfirsted;
        if (\is_callable(array($object$isser))) {
            return $object->$isser();
        }

        $haser = 'has'.$ucfirsted;
        if (\is_callable(array($object$haser))) {
            return $object->$haser();
        }
    }

    /** * {@inheritdoc} */
    protected function setAttributeValue($object$attribute$value$format = nullarray $context = array())
    {
        $setter = 'set'.ucfirst($attribute);
        $key = \get_class($object).':'.$setter;

        if (!isset(self::$setterAccessibleCache[$key])) {
            self::$setterAccessibleCache[$key] = \is_callable(array($object$setter)) && !(new \ReflectionMethod($object$setter))->isStatic();
        }

        if (self::$setterAccessibleCache[$key]) {
            $object->$setter($value);
        }
    }
}