Merge pull request #48 from tlueder/Fix-ObjectStorage-int

Allow index for ObjectStorage to be int

Author: sascha-egerer

stubs/ObjectStorage.stub

@@ -2,10 +2,61 @@
 namespace TYPO3\CMS\Extbase\Persistence;
 
 /**
- * @template T
- * @implements \ArrayAccess<string, T>
- * @implements \Iterator<string, T>
+ * @template TEntity
+ * @implements \ArrayAccess<int, TEntity>
+ * @implements \Iterator<int, TEntity>
+ * @phpstan-type ObjectStorageInternal array{obj: TEntity, inf: mixed}
  */
-class ObjectStorage implements \ArrayAccess, \Iterator
+class ObjectStorage implements \Iterator, \ArrayAccess
 {
+    /**
+     * @var array<string, ObjectStorageInternal>
+     */
+    protected $storage;
+
+    /**
+     * @param TEntity $value
+     * @param mixed $information
+     */
+    public function offsetSet($value, $information);
+
+    /**
+     * @param TEntity|int $value
+     * @return bool
+     */
+    public function offsetExists($value);
+
+    /**
+     * @param TEntity|int $value
+     */
+    public function offsetUnset($value);
+
+    /**
+     * @param TEntity|int $value
+     * @return ($value is int ? TEntity|null : mixed)
+     */
+    public function offsetGet($value);
+
+    /**
+     * This is different from the SplObjectStorage as the key in this implementation is the object hash (string).
+     * @phpstan-ignore-next-line See https://forge.typo3.org/issues/98146
+     * @return string|null
+     */
+    public function key();
+
+    /**
+     * @return array<TEntity>
+     */
+    public function toArray();
+
+    /**
+     * @return array<TEntity>
+     */
+    public function getArray();
+
+    /**
+     * @param TEntity $object
+     * @return bool
+     */
+    public function isRelationDirty($object);
 }

tests/Unit/Type/ObjectStorageStubFileTest.php

@@ -0,0 +1,38 @@
+<?php declare(strict_types = 1);
+
+namespace SaschaEgerer\PhpstanTypo3\Tests\Unit\Type;
+
+use PHPStan\Testing\TypeInferenceTestCase;
+
+class ObjectStorageStubFileTest extends TypeInferenceTestCase
+{
+
+	/**
+	 * @return iterable<mixed>
+	 */
+	public function dataFileAsserts(): iterable
+	{
+		yield from $this->gatherAssertTypes(__DIR__ . '/data/object-storage-stub-files.php');
+	}
+
+	/**
+	 * @dataProvider dataFileAsserts
+	 * @param string $assertType
+	 * @param string $file
+	 * @param mixed ...$args
+	 */
+	public function testFileAsserts(
+		string $assertType,
+		string $file,
+		...$args
+	): void
+	{
+		$this->assertFileAsserts($assertType, $file, ...$args);
+	}
+
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [__DIR__ . '/../../../extension.neon'];
+	}
+
+}

tests/Unit/Type/data/object-storage-stub-files.php

@@ -0,0 +1,43 @@
+<?php declare(strict_types = 1);
+
+// phpcs:disable SlevomatCodingStandard.Namespaces.RequireOneNamespaceInFile.MoreNamespacesInFile
+// phpcs:disable Squiz.Classes.ClassFileName.NoMatch
+// phpcs:disable PSR1.Classes.ClassDeclaration.MultipleClasses
+
+namespace ObjectStorage\My\Test\Extension\Domain\Model;
+
+use TYPO3\CMS\Extbase\DomainObject\AbstractEntity;
+use TYPO3\CMS\Extbase\Persistence\ObjectStorage;
+use function PHPStan\Testing\assertType;
+
+class MyModel extends AbstractEntity
+{
+
+	/** @var ObjectStorage<MyModel> */
+	protected ObjectStorage $objectStorage;
+
+	public function foo(): void
+	{
+		$myModel = new MyModel();
+		$this->objectStorage = new ObjectStorage();
+		$this->objectStorage->attach($myModel);
+
+		assertType('TYPO3\CMS\Extbase\Persistence\ObjectStorage<' . self::class . '>', $this->objectStorage);
+
+		foreach ($this->objectStorage as $key => $value) {
+			assertType('int', $key);
+			assertType(self::class, $value);
+		}
+
+		assertType(self::class . '|null', $this->objectStorage->offsetGet(0));
+
+		// We ignore errors in the next line as this will produce an
+		// "Offset 0 does not exist on TYPO3\CMS\Extbase\Persistence\ObjectStorage<ObjectStorage\My\Test\Extension\Domain\Model\MyModel>
+		// due to the weird implementation of ArrayAccess in ObjectStorage::offsetGet()
+		// @phpstan-ignore-next-line
+		assertType(self::class . '|null', $this->objectStorage[0]);
+
+		assertType('mixed', $this->objectStorage->offsetGet($myModel));
+	}
+
+}