diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Serializer] Fixed docblocks and parameter names.

Browse Source
This commit is contained in:
Alexander M. Turek 2019-08-15 13:16:03 +02:00
parent 628271db2f
commit 50701fed9f
13 changed files with 34 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/Symfony/Component/Serializer/Mapping/Factory/ClassResolverTrait.php
View File

@ -25,7 +25,7 @@ trait ClassResolverTrait
/**
* Gets a class name for a given class or instance.
*
* @param mixed $value
* @param object|string $value
*
* @return string
*

12
src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php
View File

@ -168,25 +168,25 @@ abstract class AbstractObjectNormalizer extends AbstractNormalizer
/**
* {@inheritdoc}
*/
public function denormalize($data, $class, $format = null, array $context = [])
public function denormalize($data, $type, $format = null, array $context = [])
{
if (!isset($context['cache_key'])) {
$context['cache_key'] = $this->getCacheKey($format, $context);
}
$allowedAttributes = $this->getAllowedAttributes($class, $context, true);
$allowedAttributes = $this->getAllowedAttributes($type, $context, true);
$normalizedData = $this->prepareForDenormalization($data);
$extraAttributes = [];
$reflectionClass = new \ReflectionClass($class);
$object = $this->instantiateObject($normalizedData, $class, $context, $reflectionClass, $allowedAttributes, $format);
$reflectionClass = new \ReflectionClass($type);
$object = $this->instantiateObject($normalizedData, $type, $context, $reflectionClass, $allowedAttributes, $format);
foreach ($normalizedData as $attribute => $value) {
if ($this->nameConverter) {
$attribute = $this->nameConverter->denormalize($attribute);
}
if ((false !== $allowedAttributes && !\in_array($attribute, $allowedAttributes)) || !$this->isAllowedAttribute($class, $attribute, $format, $context)) {
if ((false !== $allowedAttributes && !\in_array($attribute, $allowedAttributes)) || !$this->isAllowedAttribute($type, $attribute, $format, $context)) {
if (isset($context[self::ALLOW_EXTRA_ATTRIBUTES]) && !$context[self::ALLOW_EXTRA_ATTRIBUTES]) {
$extraAttributes[] = $attribute;
}
@ -194,7 +194,7 @@ abstract class AbstractObjectNormalizer extends AbstractNormalizer
continue;
}
$value = $this->validateAndDenormalize($class, $attribute, $value, $format, $context);
$value = $this->validateAndDenormalize($type, $attribute, $value, $format, $context);
try {
$this->setAttributeValue($object, $attribute, $value, $format, $context);
} catch (InvalidArgumentException $e) {

10
src/Symfony/Component/Serializer/Normalizer/ArrayDenormalizer.php
View File

@ -36,7 +36,7 @@ class ArrayDenormalizer implements DenormalizerInterface, SerializerAwareInterfa
*
* @throws NotNormalizableValueException
*/
public function denormalize($data, $class, $format = null, array $context = [])
public function denormalize($data, $type, $format = null, array $context = [])
{
if (null === $this->serializer) {
throw new BadMethodCallException('Please set a serializer before calling denormalize()!');
@ -44,12 +44,12 @@ class ArrayDenormalizer implements DenormalizerInterface, SerializerAwareInterfa
if (!\is_array($data)) {
throw new InvalidArgumentException('Data expected to be an array, '.\gettype($data).' given.');
}
if ('[]' !== substr($class, -2)) {
throw new InvalidArgumentException('Unsupported class: '.$class);
if ('[]' !== substr($type, -2)) {
throw new InvalidArgumentException('Unsupported class: '.$type);
}
$serializer = $this->serializer;
$class = substr($class, 0, -2);
$type = substr($type, 0, -2);
$builtinType = isset($context['key_type']) ? $context['key_type']->getBuiltinType() : null;
foreach ($data as $key => $value) {
@ -57,7 +57,7 @@ class ArrayDenormalizer implements DenormalizerInterface, SerializerAwareInterfa
throw new NotNormalizableValueException(sprintf('The type of the key "%s" must be "%s" ("%s" given).', $key, $builtinType, \gettype($key)));
}
$data[$key] = $serializer->denormalize($value, $class, $format, $context);
$data[$key] = $serializer->denormalize($value, $type, $format, $context);
}
return $data;

4
src/Symfony/Component/Serializer/Normalizer/CustomNormalizer.php
View File

@ -35,9 +35,9 @@ class CustomNormalizer implements NormalizerInterface, DenormalizerInterface, Se
/**
* {@inheritdoc}
*/
public function denormalize($data, $class, $format = null, array $context = [])
public function denormalize($data, $type, $format = null, array $context = [])
{
$object = $this->extractObjectToPopulate($class, $context) ?: new $class();
$object = $this->extractObjectToPopulate($type, $context) ?: new $type();
$object->denormalize($this->serializer, $data, $format, $context);
return $object;

6
src/Symfony/Component/Serializer/Normalizer/DataUriNormalizer.php
View File

@ -89,14 +89,14 @@ class DataUriNormalizer implements NormalizerInterface, DenormalizerInterface
* @throws InvalidArgumentException
* @throws NotNormalizableValueException
*/
public function denormalize($data, $class, $format = null, array $context = [])
public function denormalize($data, $type, $format = null, array $context = [])
{
if (!preg_match('/^data:([a-z0-9][a-z0-9\!\#\$\&\-\^\_\+\.]{0,126}\/[a-z0-9][a-z0-9\!\#\$\&\-\^\_\+\.]{0,126}(;[a-z0-9\-]+\=[a-z0-9\-]+)?)?(;base64)?,[a-z0-9\!\$\&\\\'\,\(\)\*\+\,\;\=\-\.\_\~\:\@\/\?\%\s]*\s*$/i', $data)) {
throw new NotNormalizableValueException('The provided "data:" URI is not valid.');
}
try {
switch ($class) {
switch ($type) {
case 'Symfony\Component\HttpFoundation\File\File':
return new File($data, false);
@ -108,7 +108,7 @@ class DataUriNormalizer implements NormalizerInterface, DenormalizerInterface
throw new NotNormalizableValueException($exception->getMessage(), $exception->getCode(), $exception);
}
throw new InvalidArgumentException(sprintf('The class parameter "%s" is not supported. It must be one of "SplFileInfo", "SplFileObject" or "Symfony\Component\HttpFoundation\File\File".', $class));
throw new InvalidArgumentException(sprintf('The class parameter "%s" is not supported. It must be one of "SplFileInfo", "SplFileObject" or "Symfony\Component\HttpFoundation\File\File".', $type));
}
/**

2
src/Symfony/Component/Serializer/Normalizer/DateIntervalNormalizer.php
View File

@ -64,7 +64,7 @@ class DateIntervalNormalizer implements NormalizerInterface, DenormalizerInterfa
* @throws InvalidArgumentException
* @throws UnexpectedValueException
*/
public function denormalize($data, $class, $format = null, array $context = [])
public function denormalize($data, $type, $format = null, array $context = [])
{
if (!\is_string($data)) {
throw new InvalidArgumentException(sprintf('Data expected to be a string, %s given.', \gettype($data)));

10
src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php
View File

@ -78,7 +78,7 @@ class DateTimeNormalizer implements NormalizerInterface, DenormalizerInterface
*
* @throws NotNormalizableValueException
*/
public function denormalize($data, $class, $format = null, array $context = [])
public function denormalize($data, $type, $format = null, array $context = [])
{
$dateTimeFormat = isset($context[self::FORMAT_KEY]) ? $context[self::FORMAT_KEY] : null;
$timezone = $this->getTimezone($context);
@ -90,16 +90,16 @@ class DateTimeNormalizer implements NormalizerInterface, DenormalizerInterface
if (null !== $dateTimeFormat) {
if (null === $timezone && \PHP_VERSION_ID < 70000) {
// https://bugs.php.net/68669
$object = \DateTime::class === $class ? \DateTime::createFromFormat($dateTimeFormat, $data) : \DateTimeImmutable::createFromFormat($dateTimeFormat, $data);
$object = \DateTime::class === $type ? \DateTime::createFromFormat($dateTimeFormat, $data) : \DateTimeImmutable::createFromFormat($dateTimeFormat, $data);
} else {
$object = \DateTime::class === $class ? \DateTime::createFromFormat($dateTimeFormat, $data, $timezone) : \DateTimeImmutable::createFromFormat($dateTimeFormat, $data, $timezone);
$object = \DateTime::class === $type ? \DateTime::createFromFormat($dateTimeFormat, $data, $timezone) : \DateTimeImmutable::createFromFormat($dateTimeFormat, $data, $timezone);
}
if (false !== $object) {
return $object;
}
$dateTimeErrors = \DateTime::class === $class ? \DateTime::getLastErrors() : \DateTimeImmutable::getLastErrors();
$dateTimeErrors = \DateTime::class === $type ? \DateTime::getLastErrors() : \DateTimeImmutable::getLastErrors();
throw new NotNormalizableValueException(sprintf(
'Parsing datetime string "%s" using format "%s" resulted in %d errors:'."\n".'%s',
@ -111,7 +111,7 @@ class DateTimeNormalizer implements NormalizerInterface, DenormalizerInterface
}
try {
return \DateTime::class === $class ? new \DateTime($data, $timezone) : new \DateTimeImmutable($data, $timezone);
return \DateTime::class === $type ? new \DateTime($data, $timezone) : new \DateTimeImmutable($data, $timezone);
} catch (\Exception $e) {
throw new NotNormalizableValueException($e->getMessage(), $e->getCode(), $e);
}

4
src/Symfony/Component/Serializer/Normalizer/DenormalizerInterface.php
View File

@ -30,7 +30,7 @@ interface DenormalizerInterface
* Denormalizes data back into an object of the given class.
*
* @param mixed $data Data to restore
* @param string $class The expected class to instantiate
* @param string $type The expected class to instantiate
* @param string $format Format the given data was extracted from
* @param array $context Options available to the denormalizer
*
@ -44,7 +44,7 @@ interface DenormalizerInterface
* @throws RuntimeException Occurs if the class cannot be instantiated
* @throws ExceptionInterface Occurs for all the other cases of errors
*/
public function denormalize($data, $class, $format = null, array $context = []);
public function denormalize($data, $type, $format = null, array $context = []);
/**
* Checks whether the given class is supported for denormalization by this normalizer.

2
src/Symfony/Component/Serializer/Normalizer/JsonSerializableNormalizer.php
View File

@ -60,7 +60,7 @@ class JsonSerializableNormalizer extends AbstractNormalizer
/**
* {@inheritdoc}
*/
public function denormalize($data, $class, $format = null, array $context = [])
public function denormalize($data, $type, $format = null, array $context = [])
{
throw new LogicException(sprintf('Cannot denormalize with "%s".', \JsonSerializable::class));
}

7
src/Symfony/Component/Serializer/Normalizer/ObjectToPopulateTrait.php
View File

@ -17,10 +17,9 @@ trait ObjectToPopulateTrait
* Extract the `object_to_populate` field from the context if it exists
* and is an instance of the provided $class.
*
* @param string $class The class the object should be
* @param $context The denormalization context
* @param string $key They in which to look for the object to populate.
* Keeps backwards compatibility with `AbstractNormalizer`.
* @param string $class The class the object should be
* @param string|null $key They in which to look for the object to populate.
* Keeps backwards compatibility with `AbstractNormalizer`.
*
* @return object|null an object if things check out, null otherwise
*/

2
src/Symfony/Component/Serializer/Tests/Fixtures/AbstractNormalizerDummy.php
View File

@ -46,7 +46,7 @@ class AbstractNormalizerDummy extends AbstractNormalizer
/**
* {@inheritdoc}
*/
public function denormalize($data, $class, $format = null, array $context = [])
public function denormalize($data, $type, $format = null, array $context = [])
{
}

6
src/Symfony/Component/Serializer/Tests/Normalizer/AbstractObjectNormalizerTest.php
View File

@ -304,13 +304,13 @@ class ArrayDenormalizerDummy implements DenormalizerInterface, SerializerAwareIn
*
* @throws NotNormalizableValueException
*/
public function denormalize($data, $class, $format = null, array $context = [])
public function denormalize($data, $type, $format = null, array $context = [])
{
$serializer = $this->serializer;
$class = substr($class, 0, -2);
$type = substr($type, 0, -2);
foreach ($data as $key => $value) {
$data[$key] = $serializer->denormalize($value, $class, $format, $context);
$data[$key] = $serializer->denormalize($value, $type, $format, $context);
}
return $data;

2
src/Symfony/Component/Serializer/Tests/Normalizer/TestDenormalizer.php
View File

@ -23,7 +23,7 @@ class TestDenormalizer implements DenormalizerInterface
/**
* {@inheritdoc}
*/
public function denormalize($data, $class, $format = null, array $context = [])
public function denormalize($data, $type, $format = null, array $context = [])
{
}