IBX-9727: Add missing type hints to search contracts (#565)

* Added missing type hints to \Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Value\MapLocationValue
* Added missing type hints to \Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Field\FieldAggregationTrait
* Added missing type hints to search contracts (automatic)
* Added generics to aggregation framework contracts
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Image\AbstractImageRangeCriterion
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Image\AbstractImageCompositeCriterion
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Location\Depth
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Location\IsMainLocation
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Location\Priority
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Ancestor
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\ContentId
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\ContentTypeGroupId
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\ContentTypeId
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\ContentTypeIdentifier
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\DateMetadata
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Field
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\FullText
* Removed unsupported \Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\FullText::{$analyzers, $wildcards} properties
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\LanguageCode
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\LocationId
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\LocationRemoteId
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\LogicalOperator
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\MapLocationDistance
* Removed unsupported Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\MapLocationDistance::$boost property
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\ObjectStateId
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\ObjectStateIdentifier
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Operator
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\ParentLocationId
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\RemoteId
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\SectionId
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\SectionIdentifier
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Subtree
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\UserEmail
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\UserId
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\UserLogin
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\UserMetadata
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Visibility
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause\Target\CustomFieldTarget
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause\Target\FieldTarget
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause\Target\MapLocationTarget
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause\Target\RandomTarget
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause\Field
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause\MapLocationDistance
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Search\SearchHit
* Added missing type hints to Ibexa\Contracts\Core\Repository\Values\Content\Search\SearchResult
* [PHPStan] Regenerated baseline
* [Tests] Updated unit tests
* Applied code review suggestions

Author: adamwojs

phpstan-baseline.neon

@@ -10,24 +10,31 @@
 
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation;
 
+/**
+ * @phpstan-template TValue
+ */
 abstract class AbstractRangeAggregation implements Aggregation
 {
     /**
      * The name of the aggregation.
-     *
-     * @var string
      */
-    protected $name;
+    protected string $name;
 
-    /** @var \Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Range[] */
-    protected $ranges;
+    /** @phpstan-var \Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Range<covariant TValue>[] */
+    protected array $ranges;
 
+    /**
+     * @phpstan-param \Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Range<covariant TValue>[] $ranges
+     */
     public function __construct(string $name, array $ranges = [])
     {
         $this->name = $name;
         $this->ranges = $ranges;
     }
 
+    /**
+     * @phpstan-return \Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Range<covariant TValue>[]
+     */
     public function getRanges(): array
     {
         return $this->ranges;

src/contracts/Repository/Values/Content/Query/Aggregation/AbstractRangeAggregation.php

@@ -14,10 +14,8 @@ abstract class AbstractStatsAggregation implements Aggregation
 {
     /**
      * The name of the aggregation.
-     *
-     * @var string
      */
-    protected $name;
+    protected string $name;
 
     public function __construct(string $name)
     {

src/contracts/Repository/Values/Content/Query/Aggregation/AbstractStatsAggregation.php

@@ -12,29 +12,23 @@
 
 abstract class AbstractTermAggregation implements Aggregation
 {
-    public const DEFAULT_LIMIT = 10;
-    public const DEFAULT_MIN_COUNT = 1;
+    public const int DEFAULT_LIMIT = 10;
+    public const int DEFAULT_MIN_COUNT = 1;
 
     /**
      * The name of the aggregation.
-     *
-     * @var string
      */
-    protected $name;
+    protected string $name;
 
     /**
      * Number of facets (terms) returned.
-     *
-     * @var int
      */
-    protected $limit = self::DEFAULT_LIMIT;
+    protected int $limit = self::DEFAULT_LIMIT;
 
     /**
      * Specifies the minimum count. Only facet groups with more or equal results are returned.
-     *
-     * @var int
      */
-    protected $minCount = self::DEFAULT_MIN_COUNT;
+    protected int $minCount = self::DEFAULT_MIN_COUNT;
 
     public function __construct(string $name)
     {

src/contracts/Repository/Values/Content/Query/Aggregation/AbstractTermAggregation.php

@@ -11,15 +11,20 @@
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Ranges\RangesGeneratorInterface;
 use Traversable;
 
+/**
+ * @phpstan-extends \Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\AbstractRangeAggregation<\DateTimeInterface>
+ */
 final class DateMetadataRangeAggregation extends AbstractRangeAggregation
 {
-    public const MODIFIED = 'modified';
-    public const CREATED = 'created';
-    public const PUBLISHED = 'published';
+    public const string MODIFIED = 'modified';
+    public const string CREATED = 'created';
+    public const string PUBLISHED = 'published';
 
-    /** @var string */
-    private $type;
+    private string $type;
 
+    /**
+     * @param \Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Range<covariant \DateTimeInterface>[] $ranges
+     */
     public function __construct(string $name, string $type, array $ranges = [])
     {
         parent::__construct($name, $ranges);
@@ -31,6 +36,9 @@ public function getType(): string
         return $this->type;
     }
 
+    /**
+     * @phpstan-param \Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Ranges\RangesGeneratorInterface<covariant \DateTimeInterface> $generator
+     */
     public static function fromGenerator(
         string $name,
         string $type,

src/contracts/Repository/Values/Content/Query/Aggregation/DateMetadataRangeAggregation.php

@@ -11,10 +11,18 @@
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\AbstractRangeAggregation;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\FieldAggregation;
 
+/**
+ * @phpstan-template TValue
+ *
+ * @phpstan-extends \Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\AbstractRangeAggregation<TValue>
+ */
 abstract class AbstractFieldRangeAggregation extends AbstractRangeAggregation implements FieldAggregation
 {
     use FieldAggregationTrait;
 
+    /**
+     * @param \Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Range<TValue>[] $ranges
+     */
     public function __construct(
         string $name,
         string $contentTypeIdentifier,

src/contracts/Repository/Values/Content/Query/Aggregation/Field/AbstractFieldRangeAggregation.php

@@ -10,13 +10,12 @@
 
 final class CountryTermAggregation extends AbstractFieldTermAggregation
 {
-    public const TYPE_NAME = 1;
-    public const TYPE_IDC = 2;
-    public const TYPE_ALPHA_2 = 4;
-    public const TYPE_ALPHA_3 = 8;
+    public const int TYPE_NAME = 1;
+    public const int TYPE_IDC = 2;
+    public const int TYPE_ALPHA_2 = 4;
+    public const int TYPE_ALPHA_3 = 8;
 
-    /** @var int */
-    private $type;
+    private int $type;
 
     public function __construct(
         string $name,

src/contracts/Repository/Values/Content/Query/Aggregation/Field/CountryTermAggregation.php

@@ -11,8 +11,14 @@
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Ranges\RangesGeneratorInterface;
 use Traversable;
 
+/**
+ * @phpstan-extends \Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Field\AbstractFieldRangeAggregation<\DateTimeInterface>
+ */
 final class DateRangeAggregation extends AbstractFieldRangeAggregation
 {
+    /**
+     * @phpstan-param \Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Ranges\RangesGeneratorInterface<\DateTimeInterface> $generator
+     */
     public static function fromGenerator(
         string $name,
         string $contentTypeIdentifier,

src/contracts/Repository/Values/Content/Query/Aggregation/Field/DateRangeAggregation.php

@@ -11,8 +11,14 @@
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Ranges\RangesGeneratorInterface;
 use Traversable;
 
+/**
+ * @phpstan-extends \Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Field\AbstractFieldRangeAggregation<\DateTimeInterface>
+ */
 final class DateTimeRangeAggregation extends AbstractFieldRangeAggregation
 {
+    /**
+     * @phpstan-param \Ibexa\Contracts\Core\Repository\Values\Content\Query\Aggregation\Ranges\RangesGeneratorInterface<\DateTimeInterface> $generator
+     */
     public static function fromGenerator(
         string $name,
         string $contentTypeIdentifier,

src/contracts/Repository/Values/Content/Query/Aggregation/Field/DateTimeRangeAggregation.php

@@ -10,11 +10,9 @@
 
 trait FieldAggregationTrait
 {
-    /** @var string */
-    public $contentTypeIdentifier;
+    public string $contentTypeIdentifier;
 
-    /** @var string */
-    public $fieldDefinitionIdentifier;
+    public string $fieldDefinitionIdentifier;
 
     public function getContentTypeIdentifier(): string
     {