Add missing phpdoc

Author: alcaeus

lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Search.php

@@ -16,9 +16,11 @@
 use function strtolower;
 
 /**
+ * @psalm-import-type SortDirectionKeywords from Sort
  * @psalm-type CountType = 'lowerBound'|'total'
  * @psalm-type SortMetaKeywords = 'searchScore'
  * @psalm-type SortMeta = array{'$meta': SortMetaKeywords}
+ * @psalm-type SortShape = array<string, int|SortMeta|SortDirectionKeywords>
  * @psalm-type SearchStageExpression = array{
  *     '$search': object{
  *         index?: string,
@@ -143,6 +145,12 @@ public function returnStoredSource(bool $returnStoredSource = true): static
         return $this;
     }
 
+    /**
+     * @param array<string, int|string>|string $fieldName Field name or array of field/order pairs
+     * @param int|string                       $order     Field order (if one field is specified)
+     * @psalm-param SortShape|string $fieldName
+     * @psalm-param int|SortMeta|SortDirectionKeywords|null $order
+     */
     public function sort($fieldName, $order = null): static
     {
         $allowedMetaSort = ['searchScore'];

lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Search/AbstractSearchOperator.php

@@ -6,8 +6,16 @@
 
 use Doctrine\ODM\MongoDB\Aggregation\Stage;
 use Doctrine\ODM\MongoDB\Aggregation\Stage\Search;
+use Doctrine\ODM\MongoDB\Aggregation\Stage\Sort;
 
-/** @internal */
+/**
+ * @internal
+ *
+ * @psalm-import-type SortDirectionKeywords from Sort
+ * @psalm-import-type SortMetaKeywords from Search
+ * @psalm-import-type SortMeta from Search
+ * @psalm-import-type SortShape from Search
+ */
 abstract class AbstractSearchOperator extends Stage implements SearchOperator
 {
     public function __construct(private Search $search)
@@ -35,6 +43,12 @@ public function returnStoredSource(bool $returnStoredSource): Search
         return $this->search->returnStoredSource($returnStoredSource);
     }
 
+    /**
+     * @param array<string, int|string>|string $fieldName Field name or array of field/order pairs
+     * @param int|string                       $order     Field order (if one field is specified)
+     * @psalm-param SortShape|string $fieldName
+     * @psalm-param int|SortMeta|SortDirectionKeywords|null $order
+     */
     public function sort($fieldName, $order = null): Search
     {
         return $this->search->sort($fieldName, $order);

psalm-baseline.xml

@@ -5,6 +5,18 @@
       <code>IteratorAggregate</code>
     </MissingTemplateParam>
   </file>
+  <file src="lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Search.php">
+    <MoreSpecificImplementedParamType>
+      <code>$fieldName</code>
+      <code>$order</code>
+    </MoreSpecificImplementedParamType>
+  </file>
+  <file src="lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Search/AbstractSearchOperator.php">
+    <MoreSpecificImplementedParamType>
+      <code>$fieldName</code>
+      <code>$order</code>
+    </MoreSpecificImplementedParamType>
+  </file>
   <file src="lib/Doctrine/ODM/MongoDB/Configuration.php">
     <TypeDoesNotContainType>
       <code><![CDATA[$reflectionClass->implementsInterface(ClassMetadataFactoryInterface::class)]]></code>