[CI] Added phpstan (#32)

.github/workflows/ci.yaml

@@ -70,3 +70,6 @@ jobs:
 
             - name: Run unit test suite
               run: composer test
+
+            - name: Run PHPStan analysis
+              run: composer run-script phpstan

composer.json

@@ -41,26 +41,30 @@
         "ibexa/doctrine-schema": "~4.6.0@dev",
         "ibexa/design-engine": "~4.6.0@dev",
         "ibexa/fieldtype-richtext": "~4.6.0@dev",
+        "ibexa/phpstan": "~4.6.0@dev",
         "ibexa/search": "~4.6.0@dev",
         "ibexa/user": "~4.6.0@dev",
         "ibexa/http-cache": "~4.6.0@dev",
         "phpspec/phpspec": "^7.1",
         "ibexa/code-style": "^1.0",
-        "friendsofphp/php-cs-fixer": "^3.0"
+        "friendsofphp/php-cs-fixer": "^3.0",
+        "phpstan/phpstan": "^2.0",
+        "phpstan/phpstan-phpunit": "^2.0",
+        "phpstan/phpstan-symfony": "^2.0"
     },
     "scripts": {
         "fix-cs": "php-cs-fixer fix --config=.php-cs-fixer.php -v --show-progress=dots",
         "check-cs": "@fix-cs --dry-run",
-        "test": "phpspec run --format=pretty"
+        "test": "phpspec run --format=pretty",
+        "phpstan": "phpstan analyse"
     },
     "extra": {
         "branch-alias": {
             "dev-main": "4.6.x-dev"
         }
     },
     "config": {
-        "allow-plugins": {
-            "composer/package-versions-deprecated": true
-        }
+        "sort-packages": true,
+        "allow-plugins": false
     }
 }

phpstan-baseline.neon

@@ -0,0 +1,139 @@
+parameters:
+	ignoreErrors:
+		-
+			message: '#^Parameter \#1 \$href of method Ibexa\\Rest\\RequestParser\:\:parseHref\(\) expects string, string\|null given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/bundle/Controller/QueryFieldRestController.php
+
+		-
+			message: '#^Parameter \#1 \$locationId of method Ibexa\\Contracts\\Core\\Repository\\LocationService\:\:loadLocation\(\) expects int, int\|null given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/bundle/Controller/QueryFieldRestController.php
+
+		-
+			message: '#^Argument of an invalid type array\|bool\|float\|int\|string\|null supplied for foreach, only iterables are supported\.$#'
+			identifier: foreach.nonIterable
+			count: 1
+			path: src/bundle/DependencyInjection/Compiler/FieldDefinitionIdentifierViewMatcherPass.php
+
+		-
+			message: '#^Cannot access offset \(int\|string\) on non\-empty\-array\|bool\|float\|int\|string\|null\.$#'
+			identifier: offsetAccess.nonOffsetAccessible
+			count: 1
+			path: src/bundle/DependencyInjection/Compiler/FieldDefinitionIdentifierViewMatcherPass.php
+
+		-
+			message: '#^Parameter \#2 \$callback of function array_filter expects \(callable\(int\|string\)\: bool\)\|null, Closure\(mixed\)\: \(0\|1\|false\) given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/bundle/DependencyInjection/Compiler/FieldDefinitionIdentifierViewMatcherPass.php
+
+		-
+			message: '#^Parameter \#1 \$queryTypeIdentifier of method Ibexa\\Bundle\\FieldTypeQuery\\DependencyInjection\\Compiler\\QueryTypesListPass\:\:buildQueryTypeName\(\) expects string, int\|string given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/bundle/DependencyInjection/Compiler/QueryTypesListPass.php
+
+		-
+			message: '#^Parameter \#1 \$input of static method Symfony\\Component\\Yaml\\Yaml\:\:parse\(\) expects string, string\|false given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/bundle/DependencyInjection/IbexaFieldTypeQueryExtension.php
+
+		-
+			message: '#^Method Ibexa\\FieldTypeQuery\\ContentView\\QueryResultsInjector\:\:__construct\(\) has parameter \$views with no value type specified in iterable type array\.$#'
+			identifier: missingType.iterableValue
+			count: 1
+			path: src/lib/ContentView/QueryResultsInjector.php
+
+		-
+			message: '#^Property Ibexa\\FieldTypeQuery\\ContentView\\QueryResultsInjector\:\:\$queryFieldService \(Ibexa\\Contracts\\FieldTypeQuery\\QueryFieldLocationService&Ibexa\\Contracts\\FieldTypeQuery\\QueryFieldServiceInterface\) does not accept Ibexa\\Contracts\\FieldTypeQuery\\QueryFieldServiceInterface\.$#'
+			identifier: assign.propertyType
+			count: 1
+			path: src/lib/ContentView/QueryResultsInjector.php
+
+		-
+			message: '#^Property Ibexa\\FieldTypeQuery\\ContentView\\QueryResultsInjector\:\:\$views type has no value type specified in iterable type array\.$#'
+			identifier: missingType.iterableValue
+			count: 1
+			path: src/lib/ContentView/QueryResultsInjector.php
+
+		-
+			message: '#^Property Ibexa\\FieldTypeQuery\\ExceptionSafeQueryFieldService\:\:\$inner \(Ibexa\\Contracts\\FieldTypeQuery\\QueryFieldLocationService&Ibexa\\Contracts\\FieldTypeQuery\\QueryFieldServiceInterface\) does not accept Ibexa\\Contracts\\FieldTypeQuery\\QueryFieldServiceInterface\.$#'
+			identifier: assign.propertyType
+			count: 1
+			path: src/lib/ExceptionSafeQueryFieldService.php
+
+		-
+			message: '#^Class Ibexa\\FieldTypeQuery\\FieldType\\Form\\QueryFieldFormType extends generic class Symfony\\Component\\Form\\AbstractType but does not specify its types\: TData$#'
+			identifier: missingType.generics
+			count: 1
+			path: src/lib/FieldType/Form/QueryFieldFormType.php
+
+		-
+			message: '#^Generator expects key type string, string\|null given\.$#'
+			identifier: generator.keyType
+			count: 1
+			path: src/lib/FieldType/Mapper/QueryFormMapper.php
+
+		-
+			message: '#^Method Ibexa\\FieldTypeQuery\\FieldType\\Mapper\\QueryFormMapper\:\:mapFieldDefinitionForm\(\) has parameter \$fieldDefinitionForm with generic interface Symfony\\Component\\Form\\FormInterface but does not specify its types\: TData$#'
+			identifier: missingType.generics
+			count: 1
+			path: src/lib/FieldType/Mapper/QueryFormMapper.php
+
+		-
+			message: '#^Property Ibexa\\Core\\Persistence\\Legacy\\Content\\StorageFieldValue\:\:\$dataText \(string\) does not accept array\|bool\|float\|int\|string\|null\.$#'
+			identifier: assign.propertyType
+			count: 1
+			path: src/lib/Persistence/Legacy/Content/FieldValue/Converter/QueryConverter.php
+
+		-
+			message: '#^Anonymous function should return Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Content but returns Ibexa\\Contracts\\Core\\Repository\\Values\\ValueObject\.$#'
+			identifier: return.type
+			count: 1
+			path: src/lib/QueryFieldService.php
+
+		-
+			message: '#^Method Ibexa\\FieldTypeQuery\\QueryFieldService\:\:isExpression\(\) has parameter \$expression with no type specified\.$#'
+			identifier: missingType.parameter
+			count: 1
+			path: src/lib/QueryFieldService.php
+
+		-
+			message: '#^Method Ibexa\\FieldTypeQuery\\QueryFieldService\:\:prepareQuery\(\) has parameter \$extraParameters with no value type specified in iterable type array\.$#'
+			identifier: missingType.iterableValue
+			count: 1
+			path: src/lib/QueryFieldService.php
+
+		-
+			message: '#^Method Ibexa\\FieldTypeQuery\\QueryFieldService\:\:resolveExpression\(\) has no return type specified\.$#'
+			identifier: missingType.return
+			count: 1
+			path: src/lib/QueryFieldService.php
+
+		-
+			message: '#^Method Ibexa\\FieldTypeQuery\\QueryFieldService\:\:resolveExpression\(\) has parameter \$variables with no value type specified in iterable type array\.$#'
+			identifier: missingType.iterableValue
+			count: 1
+			path: src/lib/QueryFieldService.php
+
+		-
+			message: '#^Method Ibexa\\FieldTypeQuery\\QueryFieldService\:\:resolveParameters\(\) has parameter \$expressions with no value type specified in iterable type array\.$#'
+			identifier: missingType.iterableValue
+			count: 1
+			path: src/lib/QueryFieldService.php
+
+		-
+			message: '#^Method Ibexa\\FieldTypeQuery\\QueryFieldService\:\:resolveParameters\(\) has parameter \$variables with no value type specified in iterable type array\.$#'
+			identifier: missingType.iterableValue
+			count: 1
+			path: src/lib/QueryFieldService.php
+
+		-
+			message: '#^Method Ibexa\\FieldTypeQuery\\QueryFieldService\:\:resolveParameters\(\) return type has no value type specified in iterable type array\.$#'
+			identifier: missingType.iterableValue
+			count: 1
+			path: src/lib/QueryFieldService.php

phpstan.neon

@@ -0,0 +1,14 @@
+includes:
+    - phpstan-baseline.neon
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+    - vendor/phpstan/phpstan-symfony/extension.neon
+    - vendor/ibexa/phpstan/extension.neon
+
+parameters:
+    ignoreErrors:
+        -
+            message: "#^Cannot call method (log|debug|info|notice|warning|error|critical|alert|emergency)\\(\\) on Psr\\\\Log\\\\LoggerInterface\\|null\\.$#"
+    level: 8
+    paths:
+        - src
+    treatPhpDocTypesAsCertain: false

spec/ContentView/FieldDefinitionIdentifierMatcherSpec.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+
 namespace spec\Ibexa\FieldTypeQuery\ContentView;
 
 use Ibexa\Contracts\Core\Repository\ContentTypeService;

spec/ContentView/QueryResultsInjectorSpec.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+
 namespace spec\Ibexa\FieldTypeQuery\ContentView;
 
 use Ibexa\Contracts\FieldTypeQuery\QueryFieldServiceInterface;

spec/ExceptionSafeQueryFieldServiceSpec.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+
 namespace spec\Ibexa\FieldTypeQuery;
 
 use Ibexa\Contracts\FieldTypeQuery\QueryFieldServiceInterface;

spec/GraphQL/ContentQueryFieldDefinitionMapperSpec.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+
 namespace spec\Ibexa\FieldTypeQuery\GraphQL;
 
 use Ibexa\Contracts\Core\Repository\ContentTypeService;

spec/GraphQL/QueryFieldResolverSpec.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+
 namespace spec\Ibexa\FieldTypeQuery\GraphQL;
 
 use Ibexa\Contracts\FieldTypeQuery\QueryFieldServiceInterface;

spec/Persistence/Legacy/Content/FieldValue/Converter/QueryConverterSpec.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+
 namespace spec\Ibexa\FieldTypeQuery\Persistence\Legacy\Content\FieldValue\Converter;
 
 use Ibexa\Contracts\Core\Persistence\Content\Type\FieldDefinition;

spec/QueryFieldServiceSpec.php

@@ -4,10 +4,10 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+
 namespace spec\Ibexa\FieldTypeQuery;
 
 use Ibexa\Contracts\Core\Repository\ContentTypeService;
-use Ibexa\Contracts\Core\Repository\LocationService;
 use Ibexa\Contracts\Core\Repository\SearchService;
 use Ibexa\Contracts\Core\Repository\Values\Content\ContentInfo;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query as ApiContentQuery;
@@ -38,7 +38,6 @@ class QueryFieldServiceSpec extends ObjectBehavior
     public function let(
         SearchService $searchService,
         ContentTypeService $contentTypeService,
-        LocationService $locationService,
         QueryTypeRegistry $queryTypeRegistry,
         QueryType $queryType
     ) {
@@ -60,12 +59,11 @@ public function let(
         $contentTypeWithoutPagination = $this->getContentType($parameters, false, 10);
         $contentTypeService->loadContentType(self::CONTENT_TYPE_ID_WITHOUT_PAGINATION)->willReturn($contentTypeWithoutPagination);
 
-        $locationService->loadLocation(self::LOCATION_ID)->willReturn($location);
         $queryTypeRegistry->getQueryType(self::QUERY_TYPE_IDENTIFIER)->willReturn($queryType);
         $queryType->getQuery(Argument::any())->willReturn(new ApiQuery());
         // @todo this should fail. It does not.
         $searchService->findContent(Argument::any())->willReturn($this->searchResult);
-        $this->beConstructedWith($searchService, $contentTypeService, $locationService, $queryTypeRegistry);
+        $this->beConstructedWith($searchService, $contentTypeService, $queryTypeRegistry);
     }
 
     public function it_is_initializable()

src/bundle/Controller/QueryFieldRestController.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+
 namespace Ibexa\Bundle\FieldTypeQuery\Controller;
 
 use Ibexa\Contracts\Core\Repository\ContentService;
@@ -15,6 +16,7 @@
 use Ibexa\Contracts\Core\Repository\Values\ContentType\ContentType;
 use Ibexa\Contracts\Rest\Exceptions\NotFoundException;
 use Ibexa\FieldTypeQuery\QueryFieldService;
+use function Ibexa\PolyfillPhp82\iterator_to_array;
 use Ibexa\Rest\RequestParser;
 use Ibexa\Rest\Server\Values as RestValues;
 use Symfony\Component\HttpFoundation\Request;
@@ -50,10 +52,14 @@ public function __construct(
         $this->requestParser = $requestParser;
     }
 
-    public function getResults(Request $request, $contentId, $versionNumber, $fieldDefinitionIdentifier): RestValues\ContentList
-    {
-        $offset = (int)$request->query->get('offset', 0);
-        $limit = (int)$request->query->get('limit', -1);
+    public function getResults(
+        Request $request,
+        int $contentId,
+        int $versionNumber,
+        string $fieldDefinitionIdentifier
+    ): RestValues\ContentList {
+        $offset = (int)$request->query->get('offset', '0');
+        $limit = (int)$request->query->get('limit', '-1');
 
         if ($request->query->has('location')) {
             $location = $this->loadLocationByPath($request);
@@ -89,10 +95,10 @@ function (Content $content) {
                         $this->locationService->loadLocation($content->contentInfo->mainLocationId),
                         $content,
                         $this->getContentType($content->contentInfo),
-                        $this->contentService->loadRelations($content->getVersionInfo())
+                        iterator_to_array($this->contentService->loadRelations($content->getVersionInfo()))
                     );
                 },
-                $items
+                iterator_to_array($items)
             ),
             $this->queryFieldService->countContentItems($content, $fieldDefinitionIdentifier)
         );

src/bundle/DependencyInjection/Compiler/ConfigurableFieldDefinitionMapperPass.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+
 namespace Ibexa\Bundle\FieldTypeQuery\DependencyInjection\Compiler;
 
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
@@ -17,13 +18,16 @@ class ConfigurableFieldDefinitionMapperPass implements CompilerPassInterface
 {
     public const PARAMETER = 'ibexa.graphql.schema.content.mapping.field_definition_type';
 
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasParameter(self::PARAMETER)) {
             return;
         }
 
         $parameter = $container->getParameter(self::PARAMETER);
+        if (!is_array($parameter)) {
+            return;
+        }
         $parameter['ezcontentquery'] = [
             'definition_type' => 'QueryFieldDefinition',
             'value_resolver' => 'resolver("QueryFieldValue", [field, content])',

src/bundle/DependencyInjection/Compiler/FieldDefinitionIdentifierViewMatcherPass.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+
 namespace Ibexa\Bundle\FieldTypeQuery\DependencyInjection\Compiler;
 
 use Ibexa\FieldTypeQuery\ContentView\FieldDefinitionIdentifierMatcher;
@@ -18,7 +19,7 @@ class FieldDefinitionIdentifierViewMatcherPass implements CompilerPassInterface
     private const LONG_IDENTIFIER = '@' . FieldDefinitionIdentifierMatcher::class;
     private const SHORT_IDENTIFIER = 'Identifier\FieldDefinition';
 
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         $configKeys = array_filter(
             array_keys($container->getParameterBag()->all()),