Skip to content

Commit c1b06f9

Browse files
BacLucBacLuc
committed
api: rename parameter $object to $data for Normalizer
This fixes the psalm error - Argument 1 of App\Serializer\Normalizer\CircularReferenceDetectingHalItemNormalizer::normalize has wrong name $object, expecting $data as defined by Symfony\Component\Serializer\Normalizer\NormalizerInterface::normalize (see https://psalm.dev/230) public function normalize($object, $format = null, array $context = []): null|array|\ArrayObject|bool|float|int|string { } After 6bdbd2e.
1 parent 2ac4773 commit c1b06f9

File tree

7 files changed

+38
-38
lines changed

7 files changed

+38
-38
lines changed

‎api/src/Serializer/Normalizer/CircularReferenceDetectingHalItemNormalizer.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@ public function supportsNormalization($data, $format = null, array $context = []
4141
/**
4242
* {@inheritdoc}
4343
*/
44-
public function normalize($object, $format = null, array $context = []): null|array|\ArrayObject|bool|float|int|string {
45-
if ($this->isHalCircularReference($object, $context)) {
46-
return $this->handleHalCircularReference($object, $format, $context);
44+
public function normalize($data, $format = null, array $context = []): null|array|\ArrayObject|bool|float|int|string {
45+
if ($this->isHalCircularReference($data, $context)) {
46+
return $this->handleHalCircularReference($data, $format, $context);
4747
}
4848

49-
return $this->decorated->normalize($object, $format, $context);
49+
return $this->decorated->normalize($data, $format, $context);
5050
}
5151

5252
public function setSerializer(SerializerInterface $serializer): void {

‎api/src/Serializer/Normalizer/CollectionItemsNormalizer.php‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,20 @@ public function supportsNormalization($data, $format = null, array $context = []
2020
return $this->decorated->supportsNormalization($data, $format, $context);
2121
}
2222

23-
public function normalize($object, $format = null, array $context = []): null|array|\ArrayObject|bool|float|int|string {
24-
$data = $this->decorated->normalize($object, $format, $context);
23+
public function normalize($data, $format = null, array $context = []): null|array|\ArrayObject|bool|float|int|string {
24+
$normalized_data = $this->decorated->normalize($data, $format, $context);
2525

26-
if (isset($data['_embedded'], $data['_embedded']['item'])) {
27-
$data['_embedded']['items'] = $data['_embedded']['item'];
28-
unset($data['_embedded']['item']);
26+
if (isset($normalized_data['_embedded'], $normalized_data['_embedded']['item'])) {
27+
$normalized_data['_embedded']['items'] = $normalized_data['_embedded']['item'];
28+
unset($normalized_data['_embedded']['item']);
2929

30-
$data['_links']['items'] = $data['_links']['item'];
31-
unset($data['_links']['item']);
32-
} elseif (isset($data['totalItems']) && 0 === $data['totalItems']) {
33-
$data['_embedded']['items'] = [];
30+
$normalized_data['_links']['items'] = $normalized_data['_links']['item'];
31+
unset($normalized_data['_links']['item']);
32+
} elseif (isset($normalized_data['totalItems']) && 0 === $normalized_data['totalItems']) {
33+
$normalized_data['_embedded']['items'] = [];
3434
}
3535

36-
return $data;
36+
return $normalized_data;
3737
}
3838

3939
public function getSupportedTypes(?string $format): array {

‎api/src/Serializer/Normalizer/ContentTypeNormalizer.php‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,22 +25,22 @@ public function supportsNormalization($data, $format = null, array $context = []
2525
return $this->decorated->supportsNormalization($data, $format, $context);
2626
}
2727

28-
public function normalize($object, $format = null, array $context = []): null|array|\ArrayObject|bool|float|int|string {
29-
$data = $this->decorated->normalize($object, $format, $context);
28+
public function normalize($data, $format = null, array $context = []): null|array|\ArrayObject|bool|float|int|string {
29+
$normalized_data = $this->decorated->normalize($data, $format, $context);
3030

31-
if ($object instanceof ContentType && isset($object->entityClass)) {
31+
if ($data instanceof ContentType && isset($data->entityClass)) {
3232
// get uri for the respective ContentNode entity and add ContentType as query parameter
33-
[$uriTemplate, $templated] = $this->uriTemplateFactory->createFromResourceClass($object->entityClass);
34-
$uri = $this->uriTemplate->expand($uriTemplate, ['contentType' => $this->iriConverter->getIriFromResource($object)]);
33+
[$uriTemplate, $templated] = $this->uriTemplateFactory->createFromResourceClass($data->entityClass);
34+
$uri = $this->uriTemplate->expand($uriTemplate, ['contentType' => $this->iriConverter->getIriFromResource($data)]);
3535

3636
// add uri as HAL link
37-
$data['_links']['contentNodes']['href'] = $uri;
37+
$normalized_data['_links']['contentNodes']['href'] = $uri;
3838

3939
// unset the property itself (property definition was only needed to ensure proper API documentation)
40-
unset($data['contentNodes']);
40+
unset($normalized_data['contentNodes']);
4141
}
4242

43-
return $data;
43+
return $normalized_data;
4444
}
4545

4646
public function getSupportedTypes(?string $format): array {

‎api/src/Serializer/Normalizer/RelatedCollectionLinkNormalizer.php‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -98,28 +98,28 @@ public function supportsNormalization($data, $format = null, array $context = []
9898
return $this->decorated->supportsNormalization($data, $format, $context);
9999
}
100100

101-
public function normalize($object, $format = null, array $context = []): null|array|\ArrayObject|bool|float|int|string {
102-
$data = $this->decorated->normalize($object, $format, $context);
101+
public function normalize($data, $format = null, array $context = []): null|array|\ArrayObject|bool|float|int|string {
102+
$normalized_data = $this->decorated->normalize($data, $format, $context);
103103

104-
if (!isset($data['_links'])) {
105-
return $data;
104+
if (!isset($normalized_data['_links'])) {
105+
return $normalized_data;
106106
}
107107

108-
foreach ($data['_links'] as $rel => $link) {
108+
foreach ($normalized_data['_links'] as $rel => $link) {
109109
// Only consider array rels (i.e. OneToMany and ManyToMany)
110110
if (isset($link['href'])) {
111111
continue;
112112
}
113113

114114
try {
115-
$data['_links'][$rel] = ['href' => $this->getRelatedCollectionHref($object, $rel, $context)];
115+
$normalized_data['_links'][$rel] = ['href' => $this->getRelatedCollectionHref($data, $rel, $context)];
116116
} catch (UnsupportedRelationException $e) {
117117
// The relation is not supported, or there is no matching filter defined on the related entity
118118
continue;
119119
}
120120
}
121121

122-
return $data;
122+
return $normalized_data;
123123
}
124124

125125
public function getSupportedTypes(?string $format): array {

‎api/src/Serializer/Normalizer/TranslationConstraintViolationListNormalizer.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ public function supportsNormalization(mixed $data, ?string $format = null, array
2424
return $this->getNormalizerCollection()->exists(fn ($_, $elem) => $elem->supportsNormalization($data, $format, $context));
2525
}
2626

27-
public function normalize(mixed $object, ?string $format = null, array $context = []): null|array|\ArrayObject|bool|float|int|string {
28-
$normalizer = $this->getNormalizerCollection()->filter(fn ($elem) => $elem->supportsNormalization($object, $format, $context))->first();
27+
public function normalize(mixed $data, ?string $format = null, array $context = []): null|array|\ArrayObject|bool|float|int|string {
28+
$normalizer = $this->getNormalizerCollection()->filter(fn ($elem) => $elem->supportsNormalization($data, $format, $context))->first();
2929
if (false === $normalizer) {
3030
throw new \RuntimeException("Did not find a normalizer to normalize response to format {$format}");
3131
}
32-
$result = $normalizer->normalize($object, $format, $context);
32+
$result = $normalizer->normalize($data, $format, $context);
3333

34-
/** @var ConstraintViolationList $object */
35-
foreach ($object as $violation) {
34+
/** @var ConstraintViolationList $data */
35+
foreach ($data as $violation) {
3636
foreach ($result['violations'] as &$resultItem) {
3737
$code = $resultItem['code'] ?? null;
3838
$propertyPath = $resultItem['propertyPath'];

‎api/src/Serializer/Normalizer/UriTemplateNormalizer.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ public function supportsNormalization($data, $format = null, array $context = []
2323
return $this->decorated->supportsNormalization($data, $format, $context);
2424
}
2525

26-
public function normalize($object, $format = null, array $context = []): null|array|\ArrayObject|bool|float|int|string {
27-
$result = $this->decorated->normalize($object, $format, $context);
26+
public function normalize($data, $format = null, array $context = []): null|array|\ArrayObject|bool|float|int|string {
27+
$result = $this->decorated->normalize($data, $format, $context);
2828

2929
foreach ($result['_links'] as $rel => $link) {
3030
if ('self' === $rel) {

‎api/tests/Serializer/Normalizer/RelatedCollectionLinkNormalizerTest.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
namespace App\Tests\Serializer\Normalizer;
44

5-
use ApiPlatform\Api\FilterInterface;
5+
use ApiPlatform\Doctrine\Common\Filter\SearchFilterInterface;
66
use ApiPlatform\Doctrine\Orm\Filter\DateFilter;
77
use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
88
use ApiPlatform\Metadata\ApiResource;
@@ -48,7 +48,7 @@ class RelatedCollectionLinkNormalizerTest extends TestCase {
4848
private MockObject|PropertyAccessorInterface $propertyAccessor;
4949
private EntityManagerInterface|MockObject $entityManager;
5050

51-
private ?FilterInterface $filterInstance;
51+
private null|DateFilter|SearchFilterInterface $filterInstance;
5252

5353
protected function setUp(): void {
5454
$this->filterLocatorMock = $this->createMock(ServiceLocator::class);

0 commit comments

Comments
 (0)