Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 82f6e0d

Browse files
lyrixxlyrixx
committed
[Serializer] Added a ConstraintViolationListNormalizer
1 parent b0facfe commit 82f6e0d

File tree

5 files changed

+140
-7
lines changed

5 files changed

+140
-7
lines changed

‎src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@
7272
use Symfony\Component\Serializer\Mapping\ClassDiscriminatorFromClassMetadata;
7373
use Symfony\Component\Serializer\Mapping\Factory\CacheClassMetadataFactory;
7474
use Symfony\Component\Serializer\Normalizer\DateIntervalNormalizer;
75+
use Symfony\Component\Serializer\Normalizer\ConstraintViolationListNormalizer;
7576
use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
7677
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
7778
use Symfony\Component\Stopwatch\Stopwatch;
@@ -1186,6 +1187,10 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder
11861187
$container->removeDefinition('serializer.normalizer.dateinterval');
11871188
}
11881189

1190+
if (!class_exists(ConstraintViolationListNormalizer::class)) {
1191+
$container->removeDefinition('serializer.normalizer.constraint_violation_list');
1192+
}
1193+
11891194
if (!class_exists(ClassDiscriminatorFromClassMetadata::class)) {
11901195
$container->removeAlias('Symfony\Component\Serializer\Mapping\ClassDiscriminatorResolverInterface');
11911196
$container->removeDefinition('serializer.mapping.class_discriminator_resolver');

‎src/Symfony/Bundle/FrameworkBundle/Resources/config/serializer.xml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@
3131
<service id="Symfony\Component\Serializer\Mapping\ClassDiscriminatorResolverInterface" alias="serializer.mapping.class_discriminator_resolver" />
3232

3333
<!-- Normalizer -->
34+
<service id="serializer.normalizer.constraint_violation_list" class="Symfony\Component\Serializer\Normalizer\ConstraintViolationListNormalizer">
35+
<!-- Run before serializer.normalizer.object -->
36+
<tag name="serializer.normalizer" priority="-915" />
37+
</service>
38+
3439
<service id="serializer.normalizer.dateinterval" class="Symfony\Component\Serializer\Normalizer\DateIntervalNormalizer">
3540
<!-- Run before serializer.normalizer.object -->
3641
<tag name="serializer.normalizer" priority="-915" />

‎src/Symfony/Component/Serializer/CHANGELOG.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ CHANGELOG
44
4.1.0
55
-----
66

7-
* added `MissingConstructorArgumentsException` new exception for deserialization failure
8-
of objects that needs data insertion in constructor
9-
* added an optional `default_constructor_arguments` option of context to specify a default data in
10-
case the object is not initializable by its constructor because of data missing
11-
* added optional `bool $escapeFormulas = false` argument to `CsvEncoder::__construct`
7+
* added `MissingConstructorArgumentsException` new exception for deserialization failure
8+
of objects that needs data insertion in constructor
9+
* added an optional `default_constructor_arguments` option of context to specify a default data in
10+
case the object is not initializable by its constructor because of data missing
11+
* added optional `bool $escapeFormulas = false` argument to `CsvEncoder::__construct`
1212

1313
4.0.0
1414
-----
@@ -29,8 +29,8 @@ CHANGELOG
2929
* added support for serializing `DateInterval` objects
3030
* added getter for extra attributes in `ExtraAttributesException`
3131
* improved `CsvEncoder` to handle variable nested structures
32-
* CSV headers can be passed to the `CsvEncoder` via the `csv_headers` serialization context variable
33-
* added `$context` when checking for encoding, decoding and normalizing in `Serializer`
32+
* CSV headers can be passed to the `CsvEncoder` via the `csv_headers` serialization context variable
33+
added `$context` when checking for encoding, decoding and normalizing in `Serializer`
3434

3535
3.3.0
3636
-----

‎src/Symfony/Component/Serializer/Normalizer/ConstraintViolationListNormalizer.php

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Serializer\Normalizer;
13+
14+
use Symfony\Component\Validator\ConstraintViolationListInterface;
15+
16+
/**
17+
* A normalizer that normalize a ConstraintViolationListInterface instance.
18+
*
19+
* This Normalizer implements RFC7807 {@link https://tools.ietf.org/html/rfc7807}.
20+
*
21+
* @author Grégoire Pineau <[email protected]>
22+
* @author Kévin Dunglas <[email protected]>
23+
*/
24+
class ConstraintViolationListNormalizer implements NormalizerInterface
25+
{
26+
/**
27+
* {@inheritdoc}
28+
*/
29+
public function normalize($object, $format = null, array $context = array())
30+
{
31+
$violations = array();
32+
$messages = array();
33+
foreach ($object as $violation) {
34+
$violations[] = array(
35+
'propertyPath' => $violation->getPropertyPath(),
36+
'message' => $violation->getMessage(),
37+
'code' => $violation->getCode(),
38+
);
39+
$propertyPath = $violation->getPropertyPath();
40+
$prefix = $propertyPath ? sprintf('%s: ', $propertyPath) : '';
41+
$messages[] = $prefix.$violation->getMessage();
42+
}
43+
44+
return array(
45+
'title' => isset($context['title']) ? $context['title'] : 'An error occurred',
46+
'detail' => $messages ? implode("\n", $messages) : '',
47+
'violations' => $violations,
48+
);
49+
}
50+
51+
/**
52+
* {@inheritdoc}
53+
*/
54+
public function supportsNormalization($data, $format = null)
55+
{
56+
return $data instanceof ConstraintViolationListInterface;
57+
}
58+
}

‎src/Symfony/Component/Serializer/Tests/Normalizer/ConstraintViolationListNormalizerTest.php

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Serializer\Tests\Normalizer;
13+
14+
use PHPUnit\Framework\TestCase;
15+
use Symfony\Component\Serializer\Normalizer\ConstraintViolationListNormalizer;
16+
use Symfony\Component\Validator\ConstraintViolation;
17+
use Symfony\Component\Validator\ConstraintViolationList;
18+
19+
/**
20+
* @author Grégoire Pineau <[email protected]>
21+
* @author Kévin Dunglas <[email protected]>
22+
*/
23+
class ConstraintViolationListNormalizerTest extends TestCase
24+
{
25+
private $normalizer;
26+
27+
protected function setUp()
28+
{
29+
$this->normalizer = new ConstraintViolationListNormalizer();
30+
}
31+
32+
public function testSupportsNormalization()
33+
{
34+
$this->assertTrue($this->normalizer->supportsNormalization(new ConstraintViolationList()));
35+
$this->assertFalse($this->normalizer->supportsNormalization(new \stdClass()));
36+
}
37+
38+
public function testNormalize()
39+
{
40+
$list = new ConstraintViolationList(array(
41+
new ConstraintViolation('a', 'b', array(), 'c', 'd', 'e', null, 'f'),
42+
new ConstraintViolation('1', '2', array(), '3', '4', '5', null, '6'),
43+
));
44+
45+
$expected = array(
46+
'title' => 'An error occurred',
47+
'detail' => 'd: a
48+
4: 1',
49+
'violations' => array(
50+
array(
51+
'propertyPath' => 'd',
52+
'message' => 'a',
53+
'code' => 'f',
54+
),
55+
array(
56+
'propertyPath' => '4',
57+
'message' => '1',
58+
'code' => '6',
59+
),
60+
),
61+
);
62+
63+
$this->assertEquals($expected, $this->normalizer->normalize($list));
64+
}
65+
}

0 commit comments

Comments
 (0)