Skip to content

Commit 8b1baff

Browse files
KondukterCROKondukterCRO
committed
fix: phpstan errors
1 parent e41092f commit 8b1baff

11 files changed

+50
-41
lines changed

‎src/Definition/Encoding/DocumentDataToPhpArrayEncoderInterface.php

+1
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@
88

99
interface DocumentDataToPhpArrayEncoderInterface
1010
{
11+
/** @return null|array<mixed,mixed> */
1112
public function encode(DocumentDataInterface $documentData): ?array;
1213
}

‎src/Definition/Encoding/PhpArrayToAttributeCollectionEncoderInterface.php

+1
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@
88

99
interface PhpArrayToAttributeCollectionEncoderInterface
1010
{
11+
/** @param array<string,mixed> $attributes */
1112
public function encode(array $attributes): AttributeCollectionInterface;
1213
}

‎src/Definition/Encoding/PhpArrayToLinkCollectionEncoderInterface.php

+1
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@
88

99
interface PhpArrayToLinkCollectionEncoderInterface
1010
{
11+
/** @param array<string,string> $links */
1112
public function encode(array $links): LinkCollectionInterface;
1213
}

‎src/Definition/Encoding/ResourceIdentifierCollectionToPhpArrayEncoderInterface.php

+2-1
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@
88

99
interface ResourceIdentifierCollectionToPhpArrayEncoderInterface
1010
{
11-
public function encode(ResourceIdentifierCollectionInterface $resourceIdentifierCollection);
11+
/** @return array<int,array<string,mixed>> */
12+
public function encode(ResourceIdentifierCollectionInterface $resourceIdentifierCollection): array;
1213
}

‎src/Implementation/Encoding/DocumentDataToPhpArrayEncoder.php

-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ public function __construct(
3737
$this->resourceIdentifierCollectionEncoder = $resourceIdentifierCollectionEncoder;
3838
}
3939

40-
/** @return array<mixed,mixed> */
4140
public function encode(DocumentDataInterface $documentData): ?array
4241
{
4342
if ($documentData->isResource()) {

‎src/Implementation/Encoding/PhpArrayToRelationshipCollectionEncoder.php

+7-12
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,10 @@
2323

2424
class PhpArrayToRelationshipCollectionEncoder implements PhpArrayToRelationshipCollectionEncoderInterface
2525
{
26-
/** @var PhpArrayToMetaEncoderInterface */
27-
private $phpArrayToMetaEncoder;
28-
29-
/** @var PhpArrayToLinkCollectionEncoderInterface */
30-
private $phpArrayToLinkCollectionEncoder;
31-
3226
public function __construct(
33-
PhpArrayToMetaEncoderInterface $phpArrayToMetaEncoder,
34-
PhpArrayToLinkCollectionEncoderInterface $phpArrayToLinkCollectionEncoder
27+
private PhpArrayToMetaEncoderInterface $phpArrayToMetaEncoder,
28+
private PhpArrayToLinkCollectionEncoderInterface $phpArrayToLinkCollectionEncoder
3529
) {
36-
$this->phpArrayToMetaEncoder = $phpArrayToMetaEncoder;
37-
$this->phpArrayToLinkCollectionEncoder = $phpArrayToLinkCollectionEncoder;
3830
}
3931

4032
/**
@@ -86,7 +78,7 @@ private function decodeRelationship(string $relationshipName, array $relationshi
8678
}
8779

8880
/**
89-
* @param null|array<int,array<string,string>> $resourceLinkage
81+
* @param null|array<int|string,array<string,string>|string> $resourceLinkage
9082
*
9183
* @throws JsonApiEncodingException
9284
*/
@@ -112,11 +104,13 @@ private function parseRelationshipData(?array $resourceLinkage): RelationshipDat
112104

113105
$isAssociativeArray = ArrayUtil::isMap($resourceLinkage);
114106
if (false === $isAssociativeArray) {
107+
/** @var array<int,array<string,string>> $resourceLinkage */
115108
$identifiersCollection = $this->parseResourceIdentifierCollection($resourceLinkage);
116109

117110
return ToManyRelationshipData::make($identifiersCollection);
118111
}
119-
112+
// at this point we have not null to one relationship
113+
/** @var array<string,string> $resourceLinkage */
120114
$resourceIdentifier = new ResourceIdentifier(
121115
$resourceLinkage['id'],
122116
$resourceLinkage['type'],
@@ -126,6 +120,7 @@ private function parseRelationshipData(?array $resourceLinkage): RelationshipDat
126120
return ToOneRelationshipData::make($resourceIdentifier);
127121
}
128122

123+
/** @param array<int, array<string,string>> $data */
129124
private function parseResourceIdentifierCollection(array $data): ResourceIdentifierCollection
130125
{
131126
$resourceIdentifiers = [];

‎src/Implementation/Encoding/ResourceIdentifierCollectionToPhpArrayEncoder.php

+1-3
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,7 @@ public function __construct(ResourceIdentifierToPhpArrayEncoderInterface $resour
1818
$this->resourceIdentifierToPhpArrayEncoder = $resourceIdentifierToPhpArrayEncoder;
1919
}
2020

21-
/**
22-
* @return array<int,array<string,mixed>>
23-
*/
21+
/** @return array<int,array<string,mixed>> */
2422
public function encode(ResourceIdentifierCollectionInterface $resourceIdentifierCollection): array
2523
{
2624
$resourceIdentifiers = [];

‎src/Implementation/Model/Document/DocumentData.php

+28-19
Original file line numberDiff line numberDiff line change
@@ -53,25 +53,46 @@ public function isEmpty(): bool
5353

5454
public function getResource(): ResourceInterface
5555
{
56-
return $this->returnDataIfTrue($this->isResource(), 'Data is not Resource');
56+
$data = $this->data;
57+
if (true !== $this->isResource()) {
58+
throw new DomainException('Data is not Resource');
59+
}
60+
/** @var ResourceInterface $data */
61+
62+
return $data;
5763
}
5864

5965
public function getResourceCollection(): ResourceCollectionInterface
6066
{
61-
return $this->returnDataIfTrue($this->isResourceCollection(), 'Data is not Resource Collection');
67+
$data = $this->data;
68+
if (true !== $this->isResourceCollection()) {
69+
throw new DomainException('Data is not Resource Collection');
70+
}
71+
/** @var ResourceCollectionInterface $data */
72+
73+
return $data;
6274
}
6375

6476
public function getResourceIdentifier(): ResourceIdentifierInterface
6577
{
66-
return $this->returnDataIfTrue($this->isResourceIdentifier(), 'Data is not Resource Identifier');
78+
$data = $this->data;
79+
if (true !== $this->isResourceIdentifier()) {
80+
throw new DomainException('Data is not Resource Identifier');
81+
}
82+
/** @var ResourceIdentifierInterface $data */
83+
84+
return $data;
6785
}
6886

6987
public function getResourceIdentifierCollection(): ResourceIdentifierCollectionInterface
7088
{
71-
return $this->returnDataIfTrue(
72-
$this->isResourceIdentifierCollection(),
73-
'Data is not Resource Identifier Collection'
74-
);
89+
$data = $this->data;
90+
if (true !== $this->isResourceIdentifierCollection()) {
91+
throw new DomainException('Data is not Resource Identifier Collection');
92+
}
93+
/** @var ResourceIdentifierCollectionInterface $data */
94+
95+
return $data;
7596
}
7697

7798
/**
@@ -115,16 +136,4 @@ private function makeSureDataIsValid($data): void
115136

116137
throw new InvalidArgumentException('Invalid data provided');
117138
}
118-
119-
/**
120-
* @return null|ResourceCollection|ResourceIdentifierCollection|ResourceIdentifierInterface|ResourceInterface
121-
*/
122-
private function returnDataIfTrue(bool $condition, string $errorMessage)
123-
{
124-
if (true !== $condition) {
125-
throw new DomainException($errorMessage);
126-
}
127-
128-
return $this->data;
129-
}
130139
}

‎src/Util/ArrayUtil.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ abstract class ArrayUtil
1111
{
1212
/**
1313
* @param array<string,mixed> $array
14-
* @param string[] $requiredKeys
14+
* @param array<int,string> $requiredKeys
1515
*/
1616
public static function hasRequiredKeys(array $array, array $requiredKeys): bool
1717
{
@@ -21,7 +21,7 @@ public static function hasRequiredKeys(array $array, array $requiredKeys): bool
2121
}
2222

2323
/**
24-
* @param array<string,mixed> $array
24+
* @param array<int|string,array<string,string>|string> $array
2525
*/
2626
public static function isMap(array $array): bool
2727
{

‎src/Util/Exception/ValidationException.php

+4-2
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,14 @@ class ValidationException extends Exception
1515
*/
1616
private $value;
1717

18+
/** @var array<int,mixed> */
1819
private array $constraints;
1920

2021
/**
2122
* ValidationException constructor.
2223
*
23-
* @param mixed $value
24+
* @param mixed $value
25+
* @param array<int,mixed> $constraints
2426
*/
2527
public function __construct(
2628
string $message,
@@ -29,7 +31,7 @@ public function __construct(
2931
$value = null,
3032
array $constraints = []
3133
) {
32-
parent::__construct($message, $code);
34+
parent::__construct($message, $code ?? 0);
3335

3436
$this->propertyPath = $propertyPath;
3537
$this->value = $value;

‎src/Util/ValidResourceLinkageAssertion.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ class ValidResourceLinkageAssertion
1515
* - a single resource identifier object for non-empty to-one relationships.
1616
* - an array of resource identifier objects for non-empty to-many relationships.
1717
*
18-
* @param null|array<string,string> $resourceLinkage
18+
* @param null|array<int|string,array<string,string>|string> $resourceLinkage
1919
*
2020
* @throws ValidationException
2121
*/
@@ -30,13 +30,15 @@ public static function assert(?array $resourceLinkage): void
3030
}
3131

3232
if (false === ArrayUtil::isMap($resourceLinkage)) {
33+
/** @var array<int,array<string,string>> $resourceLinkage */
3334
foreach ($resourceLinkage as $linkItem) {
3435
ValidResourceIdentifierAssertion::assert($linkItem);
3536
}
3637

3738
return;
3839
}
3940

41+
/** @var array<string,mixed> $resourceLinkage */
4042
ValidResourceIdentifierAssertion::assert($resourceLinkage);
4143
}
4244
}

0 commit comments

Comments
 (0)