IBX-9727: Added type-hints and adapted codebase to PHP8+ within contracts

Author: konradoboza

dependencies.json

@@ -1086,18 +1086,6 @@ parameters:
 			count: 1
 			path: src/bundle/Controller/URLWildcardController.php
 
-		-
-			message: '#^Parameter \#1 \$locationIds of method Ibexa\\Contracts\\AdminUi\\UniversalDiscovery\\Provider\:\:getLocations\(\) expects array\<int\>, list\<string\> given\.$#'
-			identifier: argument.type
-			count: 1
-			path: src/bundle/Controller/UniversalDiscoveryController.php
-
-		-
-			message: '#^Parameter \#1 \$locationList of class Ibexa\\AdminUi\\REST\\Value\\UniversalDiscovery\\LocationListData constructor expects array\<array\{location\: Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location, permissions\: array\{create\: array\{hasAccess\: bool, restrictedContentTypeIds\: array\<int\>, restrictedLanguageCodes\: array\<string\>\}, edit\: array\{hasAccess\: bool, restrictedContentTypeIds\: array\<int\>, restrictedLanguageCodes\: array\<string\>\}\}\}\>, array\<Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location\> given\.$#'
-			identifier: argument.type
-			count: 1
-			path: src/bundle/Controller/UniversalDiscoveryController.php
-
 		-
 			message: '#^Cannot access property \$languageCode on Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Language\|null\.$#'
 			identifier: property.nonObject
@@ -7290,18 +7278,6 @@ parameters:
 			count: 1
 			path: src/lib/QueryType/TrashSearchQueryType.php
 
-		-
-			message: '#^Method Ibexa\\AdminUi\\REST\\Generator\\ProfilePictureFieldConfigRestGenerator\:\:generate\(\) has parameter \$parameter with no type specified\.$#'
-			identifier: missingType.parameter
-			count: 1
-			path: src/lib/REST/Generator/ProfilePictureFieldConfigRestGenerator.php
-
-		-
-			message: '#^Method Ibexa\\AdminUi\\REST\\Generator\\UserConfigRestGenerator\:\:generate\(\) has parameter \$parameter with no type specified\.$#'
-			identifier: missingType.parameter
-			count: 1
-			path: src/lib/REST/Generator/UserConfigRestGenerator.php
-
 		-
 			message: '#^Method Ibexa\\AdminUi\\REST\\Security\\NonAdminRESTRequestMatcher\:\:__construct\(\) has parameter \$siteAccessGroups with no value type specified in iterable type array\.$#'
 			identifier: missingType.iterableValue
@@ -8707,7 +8683,7 @@ parameters:
 			path: src/lib/UniversalDiscovery/UniversalDiscoveryProvider.php
 
 		-
-			message: '#^Method Ibexa\\AdminUi\\UniversalDiscovery\\UniversalDiscoveryProvider\:\:getLocations\(\) should return array\<Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location\> but returns list\<array\<string, array\<string, mixed\>\|Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location\>\>\.$#'
+			message: '#^Method Ibexa\\AdminUi\\UniversalDiscovery\\UniversalDiscoveryProvider\:\:getLocations\(\) should return array\<array\{location\: Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location, permissions\: array\{create\: array\{hasAccess\: bool, restrictedContentTypeIds\: array\<int\>, restrictedLanguageCodes\: array\<string\>\}, edit\: array\{hasAccess\: bool, restrictedContentTypeIds\: array\<int\>, restrictedLanguageCodes\: array\<string\>\}\}\}\> but returns list\<array\{location\: Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location, permissions\: array\<string, mixed\>\}\>\.$#'
 			identifier: return.type
 			count: 1
 			path: src/lib/UniversalDiscovery/UniversalDiscoveryProvider.php
@@ -8760,6 +8736,12 @@ parameters:
 			count: 1
 			path: src/lib/UniversalDiscovery/UniversalDiscoveryProvider.php
 
+		-
+			message: '#^Parameter \#1 \$value of class Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Query\\Criterion\\LocationId constructor expects array\<int\>\|int, list\<string\> given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/lib/UniversalDiscovery/UniversalDiscoveryProvider.php
+
 		-
 			message: '#^Parameter \#2 \$locations of method Ibexa\\AdminUi\\UniversalDiscovery\\UniversalDiscoveryProvider\:\:moveSelectedLocationOnTop\(\) expects array, Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location given\.$#'
 			identifier: argument.type

phpstan-baseline.neon

@@ -16,14 +16,11 @@
 use Ibexa\Rest\Server\Controller;
 use Symfony\Component\HttpFoundation\Request;
 
-class UniversalDiscoveryController extends Controller
+final class UniversalDiscoveryController extends Controller
 {
-    private Provider $provider;
-
     public function __construct(
-        Provider $provider
+        private readonly Provider $provider
     ) {
-        $this->provider = $provider;
     }
 
     public function locationsAction(Request $request): LocationListData

src/bundle/Controller/UniversalDiscoveryController.php

@@ -83,9 +83,23 @@ public function getLocationGridViewData(
     ): array;
 
     /**
-     * @param int[] $locationIds
+     * @param list<string> $locationIds
      *
-     * @return \Ibexa\Contracts\Core\Repository\Values\Content\Location[]
+     * @return array<array{
+     *     location: \Ibexa\Contracts\Core\Repository\Values\Content\Location,
+     *     permissions: array{
+     *       create: array{
+     *         hasAccess: bool,
+     *         restrictedContentTypeIds: array<int>,
+     *         restrictedLanguageCodes: array<string>
+     *       },
+     *       edit: array{
+     *         hasAccess: bool,
+     *         restrictedContentTypeIds: array<int>,
+     *         restrictedLanguageCodes: array<string>
+     *       }
+     *     }
+     * }>
      */
     public function getLocations(array $locationIds): array;
 

src/contracts/UniversalDiscovery/Provider.php

@@ -13,10 +13,10 @@
 use Ibexa\Contracts\Rest\Output\Generator;
 use Ibexa\Contracts\Rest\Output\Visitor;
 
-final class ProfilePictureFieldConfigRestGenerator implements ApplicationConfigRestGeneratorInterface
+final readonly class ProfilePictureFieldConfigRestGenerator implements ApplicationConfigRestGeneratorInterface
 {
-    private const NAMESPACE = 'user';
-    private const PARAMETER = 'profile_picture_field';
+    private const string NAMESPACE = 'user';
+    private const string PARAMETER = 'profile_picture_field';
 
     public function supportsNamespace(string $namespace): bool
     {
@@ -28,7 +28,7 @@ public function supportsParameter(string $parameterName): bool
         return self::PARAMETER === $parameterName;
     }
 
-    public function generate($parameter, Generator $generator, Visitor $visitor): void
+    public function generate(mixed $parameter, Generator $generator, Visitor $visitor): void
     {
         if ($parameter instanceof Field) {
             $generator->startHashElement(self::PARAMETER);

src/lib/REST/Generator/ProfilePictureFieldConfigRestGenerator.php

@@ -13,10 +13,10 @@
 use Ibexa\Contracts\Rest\Output\Generator;
 use Ibexa\Contracts\Rest\Output\Visitor;
 
-final class UserConfigRestGenerator implements ApplicationConfigRestGeneratorInterface
+final readonly class UserConfigRestGenerator implements ApplicationConfigRestGeneratorInterface
 {
-    private const NAMESPACE = 'user';
-    private const PARAMETER = 'user';
+    private const string NAMESPACE = 'user';
+    private const string PARAMETER = 'user';
 
     public function supportsNamespace(string $namespace): bool
     {
@@ -28,7 +28,7 @@ public function supportsParameter(string $parameterName): bool
         return self::PARAMETER === $parameterName;
     }
 
-    public function generate($parameter, Generator $generator, Visitor $visitor): void
+    public function generate(mixed $parameter, Generator $generator, Visitor $visitor): void
     {
         if ($parameter instanceof User) {
             $generator->startHashElement(self::PARAMETER);