IBX-9727: Add missing type hints to content related VO

phpstan-baseline.neon

@@ -5928,18 +5928,6 @@ parameters:
 			count: 1
 			path: src/contracts/Repository/Iterator/BatchIteratorAdapter/ContentFilteringAdapter.php
 
-		-
-			message: '#^Method Ibexa\\Contracts\\Core\\Repository\\Iterator\\BatchIteratorAdapter\\LocationFilteringAdapter\:\:__construct\(\) has parameter \$languages with no value type specified in iterable type array\.$#'
-			identifier: missingType.iterableValue
-			count: 1
-			path: src/contracts/Repository/Iterator/BatchIteratorAdapter/LocationFilteringAdapter.php
-
-		-
-			message: '#^Method Ibexa\\Contracts\\Core\\Repository\\Iterator\\BatchIteratorAdapter\\LocationFilteringAdapter\:\:fetch\(\) should return Iterator but returns iterable\<Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location\>&Traversable\.$#'
-			identifier: return.type
-			count: 1
-			path: src/contracts/Repository/Iterator/BatchIteratorAdapter/LocationFilteringAdapter.php
-
 		-
 			message: '#^Method Ibexa\\Contracts\\Core\\Repository\\LanguageResolver\:\:getPrioritizedLanguages\(\) has parameter \$forcedLanguages with no value type specified in iterable type array\.$#'
 			identifier: missingType.iterableValue
@@ -6054,36 +6042,6 @@ parameters:
 			count: 1
 			path: src/contracts/Repository/Values/Content/ContentDraftList.php
 
-		-
-			message: '#^Method Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\DraftList\\Item\\UnauthorizedContentDraftListItem\:\:__construct\(\) has parameter \$payload with no value type specified in iterable type array\.$#'
-			identifier: missingType.iterableValue
-			count: 1
-			path: src/contracts/Repository/Values/Content/DraftList/Item/UnauthorizedContentDraftListItem.php
-
-		-
-			message: '#^Method Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\DraftList\\Item\\UnauthorizedContentDraftListItem\:\:getPayload\(\) return type has no value type specified in iterable type array\.$#'
-			identifier: missingType.iterableValue
-			count: 1
-			path: src/contracts/Repository/Values/Content/DraftList/Item/UnauthorizedContentDraftListItem.php
-
-		-
-			message: '#^Property Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\DraftList\\Item\\UnauthorizedContentDraftListItem\:\:\$payload type has no value type specified in iterable type array\.$#'
-			identifier: missingType.iterableValue
-			count: 1
-			path: src/contracts/Repository/Values/Content/DraftList/Item/UnauthorizedContentDraftListItem.php
-
-		-
-			message: '#^Class Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location has PHPDoc tag @property\-read for property \$path with no value type specified in iterable type array\.$#'
-			identifier: missingType.iterableValue
-			count: 1
-			path: src/contracts/Repository/Values/Content/Location.php
-
-		-
-			message: '#^Class Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\LocationList implements generic interface IteratorAggregate but does not specify its types\: TKey, TValue$#'
-			identifier: missingType.generics
-			count: 1
-			path: src/contracts/Repository/Values/Content/LocationList.php
-
 		-
 			message: '#^Right side of \|\| is always false\.$#'
 			identifier: booleanOr.rightAlwaysFalse
@@ -9102,12 +9060,6 @@ parameters:
 			count: 1
 			path: src/lib/Limitation/TargetOnlyLimitationType.php
 
-		-
-			message: '#^PHPDoc tag @var does not specify variable name\.$#'
-			identifier: varTag.noVariable
-			count: 1
-			path: src/lib/Limitation/UserGroupLimitationType.php
-
 		-
 			message: '#^Method Ibexa\\Core\\MVC\\Exception\\NoViewTemplateException\:\:getView\(\) has no return type specified\.$#'
 			identifier: missingType.return
@@ -14190,6 +14142,12 @@ parameters:
 			count: 1
 			path: src/lib/Persistence/Legacy/Content/Mapper.php
 
+		-
+			message: '#^Property Ibexa\\Contracts\\Core\\Persistence\\Content\\CreateStruct\:\:\$isHidden \(bool\) on left side of \?\? is not nullable\.$#'
+			identifier: nullCoalesce.property
+			count: 1
+			path: src/lib/Persistence/Legacy/Content/Mapper.php
+
 		-
 			message: '#^Property Ibexa\\Contracts\\Core\\Persistence\\Content\\Field\:\:\$id \(int\) does not accept null\.$#'
 			identifier: assign.propertyType
@@ -17982,12 +17940,6 @@ parameters:
 			count: 1
 			path: src/lib/Repository/ContentService.php
 
-		-
-			message: '#^Property Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\ContentCreateStruct\:\:\$modificationDate \(DateTime\) in isset\(\) is not nullable\.$#'
-			identifier: isset.property
-			count: 1
-			path: src/lib/Repository/ContentService.php
-
 		-
 			message: '#^Property Ibexa\\Core\\Repository\\ContentService\:\:\$repository \(Ibexa\\Core\\Repository\\Repository\) does not accept Ibexa\\Contracts\\Core\\Repository\\Repository\.$#'
 			identifier: assign.propertyType
@@ -19566,18 +19518,6 @@ parameters:
 			count: 1
 			path: src/lib/Repository/Values/Content/Content.php
 
-		-
-			message: '#^Method Ibexa\\Core\\Repository\\Values\\Content\\Location\:\:getProperties\(\) has parameter \$dynamicProperties with no value type specified in iterable type array\.$#'
-			identifier: missingType.iterableValue
-			count: 1
-			path: src/lib/Repository/Values/Content/Location.php
-
-		-
-			message: '#^Method Ibexa\\Core\\Repository\\Values\\Content\\Location\:\:getProperties\(\) return type has no value type specified in iterable type array\.$#'
-			identifier: missingType.iterableValue
-			count: 1
-			path: src/lib/Repository/Values/Content/Location.php
-
 		-
 			message: '#^Method Ibexa\\Core\\Repository\\Values\\Content\\TrashItem\:\:getProperties\(\) has parameter \$dynamicProperties with no value type specified in iterable type array\.$#'
 			identifier: missingType.iterableValue
@@ -20988,12 +20928,6 @@ parameters:
 			count: 1
 			path: src/lib/Search/Legacy/Content/Handler.php
 
-		-
-			message: '#^Property Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Query\:\:\$sortClauses \(array\<Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Query\\SortClause\>\) does not accept null\.$#'
-			identifier: assign.propertyType
-			count: 1
-			path: src/lib/Search/Legacy/Content/Handler.php
-
 		-
 			message: '#^Method Ibexa\\Core\\Search\\Legacy\\Content\\Indexer\:\:purge\(\) has no return type specified\.$#'
 			identifier: missingType.return
@@ -25398,12 +25332,6 @@ parameters:
 			count: 1
 			path: tests/integration/Core/Repository/BaseTestCase.php
 
-		-
-			message: '#^Property Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\ContentCreateStruct\:\:\$remoteId \(string\) does not accept string\|null\.$#'
-			identifier: assign.propertyType
-			count: 1
-			path: tests/integration/Core/Repository/BaseTestCase.php
-
 		-
 			message: '#^Property Ibexa\\Tests\\Integration\\Core\\Repository\\BaseTestCase\:\:\$repository \(Ibexa\\Contracts\\Core\\Repository\\Repository\) does not accept null\.$#'
 			identifier: assign.propertyType
@@ -58518,24 +58446,12 @@ parameters:
 			count: 1
 			path: tests/lib/Repository/Service/Mock/ContentTest.php
 
-		-
-			message: '#^Method Ibexa\\Tests\\Core\\Repository\\Service\\Mock\\ContentTest\:\:testCreateContentThrowsInvalidArgumentExceptionContentTypeNotSet\(\) has no return type specified\.$#'
-			identifier: missingType.return
-			count: 1
-			path: tests/lib/Repository/Service/Mock/ContentTest.php
-
 		-
 			message: '#^Method Ibexa\\Tests\\Core\\Repository\\Service\\Mock\\ContentTest\:\:testCreateContentThrowsInvalidArgumentExceptionDuplicateRemoteId\(\) has no return type specified\.$#'
 			identifier: missingType.return
 			count: 1
 			path: tests/lib/Repository/Service/Mock/ContentTest.php
 
-		-
-			message: '#^Method Ibexa\\Tests\\Core\\Repository\\Service\\Mock\\ContentTest\:\:testCreateContentThrowsInvalidArgumentExceptionMainLanguageCodeNotSet\(\) has no return type specified\.$#'
-			identifier: missingType.return
-			count: 1
-			path: tests/lib/Repository/Service/Mock/ContentTest.php
-
 		-
 			message: '#^Method Ibexa\\Tests\\Core\\Repository\\Service\\Mock\\ContentTest\:\:testCreateContentThrowsUnauthorizedException\(\) has no return type specified\.$#'
 			identifier: missingType.return
@@ -61698,12 +61614,6 @@ parameters:
 			count: 1
 			path: tests/lib/Repository/Values/Content/LanguageTest.php
 
-		-
-			message: '#^Method Ibexa\\Tests\\Core\\Repository\\Values\\Content\\LanguageTest\:\:testNewClass\(\) has no return type specified\.$#'
-			identifier: missingType.return
-			count: 1
-			path: tests/lib/Repository/Values/Content/LanguageTest.php
-
 		-
 			message: '#^Method Ibexa\\Tests\\Core\\Repository\\Values\\Content\\LanguageTest\:\:testReadOnlyProperty\(\) has no return type specified\.$#'
 			identifier: missingType.return
@@ -61758,12 +61668,6 @@ parameters:
 			count: 1
 			path: tests/lib/Repository/Values/Content/SectionTest.php
 
-		-
-			message: '#^Method Ibexa\\Tests\\Core\\Repository\\Values\\Content\\SectionTest\:\:testNewClass\(\) has no return type specified\.$#'
-			identifier: missingType.return
-			count: 1
-			path: tests/lib/Repository/Values/Content/SectionTest.php
-
 		-
 			message: '#^Method Ibexa\\Tests\\Core\\Repository\\Values\\Content\\SectionTest\:\:testReadOnlyProperty\(\) has no return type specified\.$#'
 			identifier: missingType.return
@@ -61800,12 +61704,6 @@ parameters:
 			count: 1
 			path: tests/lib/Repository/Values/Content/TrashItemTest.php
 
-		-
-			message: '#^Method Ibexa\\Tests\\Core\\Repository\\Values\\Content\\TrashItemTest\:\:testNewClass\(\) has no return type specified\.$#'
-			identifier: missingType.return
-			count: 1
-			path: tests/lib/Repository/Values/Content/TrashItemTest.php
-
 		-
 			message: '#^Method Ibexa\\Tests\\Core\\Repository\\Values\\Content\\TrashItemTest\:\:testReadOnlyProperty\(\) has no return type specified\.$#'
 			identifier: missingType.return
@@ -62616,12 +62514,6 @@ parameters:
 			count: 1
 			path: tests/lib/Search/Legacy/Content/HandlerContentTest.php
 
-		-
-			message: '#^Method Ibexa\\Tests\\Core\\Search\\Legacy\\Content\\HandlerContentTest\:\:testFindWithNullLimit\(\) has no return type specified\.$#'
-			identifier: missingType.return
-			count: 1
-			path: tests/lib/Search/Legacy/Content/HandlerContentTest.php
-
 		-
 			message: '#^Method Ibexa\\Tests\\Core\\Search\\Legacy\\Content\\HandlerContentTest\:\:testFindWithOffsetToNonexistent\(\) has no return type specified\.$#'
 			identifier: missingType.return
@@ -63138,12 +63030,6 @@ parameters:
 			count: 1
 			path: tests/lib/Search/Legacy/Content/HandlerLocationTest.php
 
-		-
-			message: '#^Method Ibexa\\Tests\\Core\\Search\\Legacy\\Content\\HandlerLocationTest\:\:testFindWithNullLimit\(\) has no return type specified\.$#'
-			identifier: missingType.return
-			count: 1
-			path: tests/lib/Search/Legacy/Content/HandlerLocationTest.php
-
 		-
 			message: '#^Method Ibexa\\Tests\\Core\\Search\\Legacy\\Content\\HandlerLocationTest\:\:testFindWithOffsetToNonexistent\(\) has no return type specified\.$#'
 			identifier: missingType.return

src/contracts/Repository/Iterator/BatchIteratorAdapter/LocationFilteringAdapter.php

@@ -22,13 +22,20 @@ final class LocationFilteringAdapter implements BatchIteratorAdapter
     /** @var string[]|null */
     private ?array $languages;
 
+    /**
+     * @param string[]|null $languages
+     */
     public function __construct(LocationService $locationService, Filter $filter, ?array $languages = null)
     {
         $this->locationService = $locationService;
         $this->filter = $filter;
         $this->languages = $languages;
     }
 
+    /**
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException
+     * @throws \Exception
+     */
     public function fetch(int $offset, int $limit): Iterator
     {
         $filter = clone $this->filter;

src/contracts/Repository/Iterator/BatchIteratorAdapter/RelationListIteratorAdapter.php

@@ -13,30 +13,29 @@
 use Ibexa\Contracts\Core\Repository\Values\Content\RelationType;
 use Ibexa\Contracts\Core\Repository\Values\Content\VersionInfo;
 use Iterator;
-use IteratorIterator;
 
-final class RelationListIteratorAdapter implements BatchIteratorAdapter
+final readonly class RelationListIteratorAdapter implements BatchIteratorAdapter
 {
     public function __construct(
-        readonly private ContentService $contentService,
-        readonly private VersionInfo $versionInfo,
-        readonly private ?RelationType $relationType = null,
+        private ContentService $contentService,
+        private VersionInfo $versionInfo,
+        private ?RelationType $relationType = null,
     ) {
     }
 
+    /**
+     * @phpstan-return \Iterator<int, \Ibexa\Contracts\Core\Repository\Values\Content\RelationList\RelationListItemInterface>
+     *
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\BadStateException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException
+     */
     public function fetch(int $offset, int $limit): Iterator
     {
-        $iterator = $this->contentService->loadRelationList(
+        return $this->contentService->loadRelationList(
             $this->versionInfo,
             $offset,
             $limit,
             $this->relationType
         )->getIterator();
-
-        if ($iterator instanceof Iterator) {
-            return $iterator;
-        }
-
-        return new IteratorIterator($iterator);
     }
 }

src/contracts/Repository/Values/Content/ContentCreateStruct.php

@@ -8,6 +8,9 @@
 
 namespace Ibexa\Contracts\Core\Repository\Values\Content;
 
+use DateTimeInterface;
+use Ibexa\Contracts\Core\Repository\Values\ContentType\ContentType;
+
 /**
  * This class is used for creating a new content object.
  *
@@ -19,57 +22,43 @@ abstract class ContentCreateStruct extends ContentStruct
      * The content type for which the new content is created.
      *
      * Required.
-     *
-     * @var \Ibexa\Contracts\Core\Repository\Values\ContentType\ContentType
      */
-    public $contentType;
+    public ContentType $contentType;
 
     /**
-     * The section the content is assigned to.
-     * If not set the section of the parent is used or a default section.
+     * The main language code for the content. This language will also
+     * be used as an initial language for the first created version.
+     * It is also used as the default language for added fields.
      *
-     * @var mixed
+     * Required.
      */
-    public $sectionId;
+    public string $mainLanguageCode;
 
     /**
-     * The owner of the content. If not given the current authenticated user is set as owner.
-     *
-     * @var mixed
+     * The section to which the content is assigned.
+     * If not set, either the parent section or a default section is used.
      */
-    public $ownerId;
+    public ?int $sectionId = null;
 
     /**
-     * Indicates if the content object is shown in the mainlanguage if its not present in an other requested language.
-     *
-     * @var bool
+     * The owner of the content. If not given, the current authenticated user is set as owner.
      */
-    public $alwaysAvailable;
+    public ?int $ownerId = null;
 
     /**
-     * Remote identifier used as a custom identifier for the object.
-     *
-     * Needs to be a unique Content->remoteId string value.
-     *
-     * @var string
+     * Indicates if the content object is shown in the main language if it's not present in another requested language.
      */
-    public $remoteId;
+    public ?bool $alwaysAvailable = null;
 
     /**
-     * the main language code for the content. This language will also
-     * be used for as initial language for the first created version.
-     * It is also used as default language for added fields.
-     *
-     * Required.
+     * Remote identifier used as a custom identifier for the object.
      *
-     * @var string
+     * Needs to be a unique Content->remoteId string value.
      */
-    public $mainLanguageCode;
+    public ?string $remoteId = null;
 
     /**
-     * Modification date. If not given the current timestamp is used.
-     *
-     * @var \DateTime
+     * Modification date. If not given, the current timestamp is used.
      */
-    public $modificationDate;
+    public ?DateTimeInterface $modificationDate = null;
 }

src/contracts/Repository/Values/Content/ContentDraftList.php

@@ -18,15 +18,12 @@
  */
 class ContentDraftList extends ValueObject implements IteratorAggregate
 {
-    /**
-     * @var int
-     */
-    public $totalCount = 0;
+    public int $totalCount = 0;
 
     /**
      * @var \Ibexa\Contracts\Core\Repository\Values\Content\DraftList\ContentDraftListItemInterface[]
      */
-    public $items = [];
+    public array $items = [];
 
     /**
      * {@inheritdoc}