Merge pull request #170 from oliverklee/task/align-stubs-with-core

[TASK] Port some type annotation improvements from the Core

Author: sascha-egerer

stubs/ObjectStorage.stub

@@ -15,32 +15,32 @@ class ObjectStorage implements \Iterator, \ArrayAccess
     protected $storage;
 
     /**
-     * @param TEntity $value
+     * @param TEntity|string|null $value
      * @param mixed $information
      */
     public function offsetSet($value, $information);
 
     /**
-     * @param TEntity|int $value
+     * @param TEntity|int|string $value
      * @return bool
      */
     public function offsetExists($value);
 
     /**
-     * @param TEntity|int $value
+     * @param TEntity|int|string $value
      */
     public function offsetUnset($value);
 
     /**
-     * @param TEntity|int $value
+     * @param TEntity|int|string $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
+     * @return string
      */
     // @phpstan-ignore-next-line See https://forge.typo3.org/issues/98146
     public function key();

stubs/QueryInterface.stub

@@ -6,9 +6,14 @@ namespace TYPO3\CMS\Extbase\Persistence;
  */
 interface QueryInterface
 {
+    // We have to define the constants here to be able to use them in other stubs.
+    // See https://phpstan.org/user-guide/stub-files
+    public const ORDER_ASCENDING = 'ASC';
+    public const ORDER_DESCENDING = 'DESC';
+    
     /**
      * @param bool $returnRawQueryResult
-     * @return \TYPO3\CMS\Extbase\Persistence\QueryResultInterface<ModelType>|array<string, mixed>
+     * @return \TYPO3\CMS\Extbase\Persistence\QueryResultInterface<ModelType>|list<array<string, mixed>>
      */
     public function execute($returnRawQueryResult = false);
 

stubs/QueryResult.stub

@@ -10,7 +10,7 @@ use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
 class QueryResult implements QueryResultInterface
 {
     /**
-     * @return null|ModelType
+     * @return ModelType|null
      */
     public function getFirst();
 }

stubs/QueryResultInterface.stub

@@ -14,7 +14,7 @@ interface QueryResultInterface extends \Countable, \Iterator, \ArrayAccess
     public function getQuery();
 
     /**
-     * @return null|ModelType
+     * @return ModelType|null
      */
     public function getFirst();
 

stubs/Repository.stub

@@ -47,7 +47,7 @@ class Repository
     public function findByIdentifier($identifier);
 
     /**
-     * @phpstan-param array<string,string> $defaultOrderings
+     * @phpstan-param array<non-empty-string, QueryInterface::ORDER_*> $defaultOrderings
      * @phpstan-return void
      */
     public function setDefaultOrderings($defaultOrderings);