More fixes

doctrine-extensions · Sep 3, 2023 · c764934 · c764934
1 parent 3754da4
commit c764934
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 17 deletions.
diff --git a/src/Mapping/Event/AdapterInterface.php b/src/Mapping/Event/AdapterInterface.php
@@ -125,7 +125,7 @@ public function recomputeSingleObjectChangeSet($uow, $meta, $object);
      *
      * @param ORMUnitOfWork|MongoDBUnitOfWork $uow The UnitOfWork as provided by the object manager
      *
-     * @return array
+     * @return array<int|string, object>
      */
     public function getScheduledObjectUpdates($uow);
 
@@ -134,7 +134,7 @@ public function getScheduledObjectUpdates($uow);
      *
      * @param ORMUnitOfWork|MongoDBUnitOfWork $uow The UnitOfWork as provided by the object manager
      *
-     * @return array
+     * @return array<int|string, object>
      */
     public function getScheduledObjectInsertions($uow);
 
@@ -143,7 +143,7 @@ public function getScheduledObjectInsertions($uow);
      *
      * @param ORMUnitOfWork|MongoDBUnitOfWork $uow The UnitOfWork as provided by the object manager
      *
-     * @return array
+     * @return array<int|string, object>
      */
     public function getScheduledObjectDeletions($uow);
 

diff --git a/src/Mapping/ExtensionMetadataFactory.php b/src/Mapping/ExtensionMetadataFactory.php
@@ -100,7 +100,7 @@ public function __construct(ObjectManager $objectManager, string $extensionNames
      *
      * @param ClassMetadata&(DocumentClassMetadata|EntityClassMetadata) $meta
      *
-     * @return array the metatada configuration
+     * @return array<string, mixed> the metatada configuration
      */
     public function getExtensionMetadata($meta)
     {

diff --git a/src/Tree/Entity/Repository/ClosureTreeRepository.php b/src/Tree/Entity/Repository/ClosureTreeRepository.php
@@ -98,7 +98,7 @@ public function getPathQuery($node)
      *
      * @param object $node
      *
-     * @return array list of Nodes in path
+     * @return array<int, object|null> list of Nodes in path
      */
     public function getPath($node)
     {
@@ -207,7 +207,7 @@ public function childrenQuery($node = null, $direct = false, $sortByField = null
      * @param string|string[]      $direction   Sort order ('asc'|'desc'|'ASC'|'DESC'). If $sortByField is an array, this may also be an array with matching number of elements
      * @param bool                 $includeNode Include the root node in results?
      *
-     * @return array<int, object>|null List of children or null on failure
+     * @return array<int, object|null> List of children or null on failure
      *
      * @phpstan-param 'asc'|'desc'|'ASC'|'DESC'|array<int, 'asc'|'desc'|'ASC'|'DESC'> $direction
      */
@@ -233,6 +233,9 @@ public function getChildrenQuery($node = null, $direct = false, $sortByField = n
         return $this->childrenQuery($node, $direct, $sortByField, $direction, $includeNode);
     }
 
+    /**
+     * @return array<int, object|null>
+     */
     public function getChildren($node = null, $direct = false, $sortByField = null, $direction = 'ASC', $includeNode = false)
     {
         return $this->children($node, $direct, $sortByField, $direction, $includeNode);
@@ -312,14 +315,6 @@ public function removeFromTree($node)
         $node = null;
     }
 
-    /**
-     * Process nodes and produce an array with the
-     * structure of the tree
-     *
-     * @param array $nodes Array of nodes
-     *
-     * @return array Array with tree structure
-     */
     public function buildTreeArray(array $nodes)
     {
         $meta = $this->getClassMetadata();

diff --git a/src/Tree/Entity/Repository/MaterializedPathRepository.php b/src/Tree/Entity/Repository/MaterializedPathRepository.php
@@ -53,7 +53,7 @@ public function getTreeQuery($rootNode = null)
      *
      * @param object $rootNode
      *
-     * @return array
+     * @return array<int, object>
      */
     public function getTree($rootNode = null)
     {

diff --git a/src/Tree/Entity/Repository/NestedTreeRepository.php b/src/Tree/Entity/Repository/NestedTreeRepository.php
@@ -403,7 +403,7 @@ public function childrenQuery($node = null, $direct = false, $sortByField = null
      * @param string|string[]      $direction   Sort order ('asc'|'desc'|'ASC'|'DESC'). If $sortByField is an array, this may also be an array with matching number of elements
      * @param bool                 $includeNode Flag indicating whether the given node should be included in the results
      *
-     * @return array<int, object>|null List of children or null on failure
+     * @return array<int, object> List of children or null on failure
      *
      * @phpstan-param 'asc'|'desc'|'ASC'|'DESC'|array<int, 'asc'|'desc'|'ASC'|'DESC'> $direction
      */
@@ -424,6 +424,9 @@ public function getChildrenQuery($node = null, $direct = false, $sortByField = n
         return $this->childrenQuery($node, $direct, $sortByField, $direction, $includeNode);
     }
 
+    /**
+     * @return array<int, object|null>
+     */
     public function getChildren($node = null, $direct = false, $sortByField = null, $direction = 'ASC', $includeNode = false)
     {
         return $this->children($node, $direct, $sortByField, $direction, $includeNode);

diff --git a/src/Tree/RepositoryUtilsInterface.php b/src/Tree/RepositoryUtilsInterface.php
@@ -63,7 +63,7 @@ public function buildTree(array $nodes, array $options = []);
      *
      * @param object[] $nodes The nodes to build the tree from
      *
-     * @return array
+     * @return array<int, array<string, mixed>>
      */
     public function buildTreeArray(array $nodes);