chore: introduce phpstan level 6 #7269

VincentLanglet · 2025-07-01T13:30:08Z

Q	A
Branch?	main for features
Tickets	Closes #..., closes #...
License	MIT
Doc PR	api-platform/docs#...

VincentLanglet · 2025-07-01T13:31:07Z

phpstan.neon.dist

+			identifier: missingType.iterableValue
+		-
+			identifier: missingType.generics


iterableValue and generics are creating a lot of error, so I prefer to fix missing param/property/return type first

VincentLanglet · 2025-07-01T13:31:17Z

phpstan.neon.dist

+		-
+			identifier: missingType.property
+			paths:
+				- src/Doctrine/Common/Tests


I ignored all the tests folder.

VincentLanglet · 2025-07-01T13:31:36Z

phpstan.neon.dist

+				- src/Symfony/Bundle/Test
+				- src/Symfony/Tests
+				- tests
+				- src # TODO


Parameter is ~150 error, I'll do it in the next PR.

VincentLanglet · 2025-07-01T13:31:55Z

phpstan.neon.dist

+			paths:
+				- src/Symfony/Bundle/Test
+				- tests
+				- src # TODO


It's around 50 error, I'll try in another PR.

VincentLanglet · 2025-07-01T13:32:08Z

src/Metadata/Extractor/XmlPropertyExtractor.php

    }

-    private function buildArrayValue(?\SimpleXMLElement $resource, string $key, mixed $default = null)
+    private function buildArrayValue(?\SimpleXMLElement $resource, string $key): ?array


default is never used

VincentLanglet · 2025-07-01T13:59:10Z

@soyuka The PHPStan error seems legit to me

 ------ ----------------------------------------------------------------------- 
  Line   Exception/ErrorHandler.php                                             
 ------ ----------------------------------------------------------------------- 
  80     Argument of an invalid type array<int|string,                          
         array<string>|string>|string supplied for foreach, only iterables are  
         supported.                                                             
         🪪 foreach.nonIterable

HttpOperation accepts the following param

     * @param array<int|string, string|string[]>|string|null $formats       {@see https://api-platform.com/docs/core/content-negotiation/#configuring-formats-for-a-specific-resource-or-operation}
     * @param array<int|string, string|string[]>|string|null $inputFormats  {@see https://api-platform.com/docs/core/content-negotiation/#configuring-formats-for-a-specific-resource-or-operation}
     * @param array<int|string, string|string[]>|string|null $outputFormats

but then we're doing foreach on it.

If someone pass a string instead of string[] you'll get a weird behavior.
Not sure what solution you prefer:

Casting the format into an array (in the constructor ? in the getter ?)
Casting the format when iterating on it (but it's not the only place)
Updating the param to only accept array|null and not string

soyuka · 2025-07-01T14:05:22Z

Indeed, to me we should cast the string into an array, the foreach should be changed to op->getOutputFormats() ?? null and the getter should only return:

list<string>, array<string, list[string]>|null

soyuka · 2025-07-02T09:10:44Z

src/Laravel/Controller/ApiPlatformController.php

        $uriVariables = [];
        foreach ($operation->getUriVariables() ?? [] as $parameterName => $_) {
-            $parameter = $request->route($parameterName);
+            $parameter = $request->route((string) $parameterName);


mhh actually this is weird, it's a hard problem though maybe we'll leave that for later ^^

There is an error saying that route is called with int|string instead of string, so I casted the value.
This value is also casted on the following line.

You prefer a phpstan-ignore-line ?

soyuka · 2025-07-02T09:11:16Z

src/Metadata/ApiProperty.php

+     *
+     * @return string[]
     */
    public function getIris()


can we change the return type to ?array as well?

Indeed, done with c29eb43

soyuka · 2025-07-02T09:11:28Z

src/Metadata/ApiProperty.php

+     *
+     * @return bool
     */
    public function getGenId()


same we can return ?bool here

Indeed, done with c29eb43

VincentLanglet commented Jul 1, 2025

View reviewed changes

chore: introduce phpstan level 6

bfd1fa9

VincentLanglet force-pushed the phpstan6 branch from f1c5dab to bfd1fa9 Compare July 1, 2025 13:34

chore: fix cs

734f4d8

VincentLanglet force-pushed the phpstan6 branch from f4b1803 to 734f4d8 Compare July 1, 2025 13:50

fix: phpstan error

fb31437

VincentLanglet marked this pull request as ready for review July 1, 2025 15:51

soyuka requested changes Jul 2, 2025

View reviewed changes

VincentLanglet added 2 commits July 2, 2025 11:46

fix: feedback

c29eb43

fix: native typehint

45916ed

soyuka merged commit cb60937 into api-platform:main Jul 3, 2025
113 of 114 checks passed

Uh oh!

chore: introduce phpstan level 6 #7269

chore: introduce phpstan level 6 #7269

Uh oh!

Conversation

VincentLanglet commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

VincentLanglet commented Jul 1, 2025

Uh oh!

soyuka commented Jul 1, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

VincentLanglet commented Jul 1, 2025 •

edited

Loading