PHPStan level 2 (#1179)

* PHPStan level 2

* Don't rely on phpdoc_to_comment

* Enforce use of comments with @phpstan-ignore

Author: thomascorthals

CHANGELOG.md

@@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added union type declarations to method signatures
 - Solarium\Core\Query\Helper::formatDate() throws a `TypeError` instead of returning `false` if called with an incompatibly typed parameter
 - Managed resources queries no longer work around SOLR-6853 by default. Set the 'useDoubleEncoding' option to `true` if this bug affects you.
+- Solarium codebase is now analysed at PHPStan level 2
 
 ### Removed
 - Solarium\Component\Result\Stats\FacetValue::getFacets(), always returned `null`

composer.json

@@ -31,7 +31,7 @@
         "nyholm/psr7": "^1.8",
         "php-http/guzzle7-adapter": "^1.0",
         "phpstan/extension-installer": "^1.4",
-        "phpstan/phpstan": "^2.1",
+        "phpstan/phpstan": "^2.1.41",
         "phpstan/phpstan-deprecation-rules": "^2.0",
         "phpstan/phpstan-phpunit": "^2.0",
         "phpunit/phpunit": "^10.5",

phpstan.dist.neon

@@ -1,5 +1,9 @@
 parameters:
-    level: 1
+    level: 2
+    reportIgnoresWithoutComments: true
     paths:
         - src
         - tests
+    universalObjectCratesClasses:
+        - Solarium\Core\Query\DocumentInterface
+        - Solarium\Core\Query\Result\QueryType

src/Builder/Analytics/AnalyticsExpressionVisitor.php

@@ -42,6 +42,10 @@ public function dispatch(ExpressionInterface $expr)
 
     /**
      * {@inheritdoc}
+     *
+     * @param ExpressionInterface&FunctionInterface $expression
+     *
+     * @return mixed
      */
     public function walkExpression(ExpressionInterface $expression)
     {

src/Builder/Analytics/FunctionBuilder.php

@@ -12,6 +12,7 @@
 namespace Solarium\Builder\Analytics;
 
 use Solarium\Builder\ExpressionInterface;
+use Solarium\Builder\FunctionInterface;
 
 /**
  * FunctionBuilder.
@@ -20,7 +21,7 @@
  */
 class FunctionBuilder
 {
-    private ExpressionInterface $function;
+    private ExpressionInterface&FunctionInterface $function;
 
     private static ?ExpressionBuilder $expressionBuilder = null;
 
@@ -45,21 +46,21 @@ public static function expr(): ExpressionBuilder
     }
 
     /**
-     * @param ExpressionInterface $function
+     * @param ExpressionInterface&FunctionInterface $function
      *
      * @return self Provides fluent interface
      */
-    public function where(ExpressionInterface $function): self
+    public function where(ExpressionInterface&FunctionInterface $function): self
     {
         $this->function = $function;
 
         return $this;
     }
 
     /**
-     * @return ExpressionInterface
+     * @return ExpressionInterface&FunctionInterface
      */
-    public function getFunction(): ExpressionInterface
+    public function getFunction(): ExpressionInterface&FunctionInterface
     {
         return $this->function;
     }

src/Component/ComponentAwareQueryInterface.php

@@ -104,7 +104,7 @@ interface ComponentAwareQueryInterface
     /**
      * Get all registered component types.
      *
-     * @return array
+     * @return array<self::COMPONENT_*|string> An array of self::COMPONENT_* and/or self-registered keys
      */
     public function getComponentTypes(): array;
 
@@ -131,9 +131,9 @@ public function getComponents(): array;
      * You can optionally supply an autoload class to create a new component
      * instance if there is no registered component for the given key yet.
      *
-     * @param string     $key      Use one of the constants
-     * @param bool       $autoload Autoload if component needs to be created
-     * @param array|null $config   Configuration to use for autoload
+     * @param self::COMPONENT_*|string $key      A self::COMPONENT_* or self-registered key
+     * @param bool                     $autoload Autoload if component needs to be created
+     * @param array|null               $config   Configuration to use for autoload
      *
      * @throws OutOfBoundsException
      *
@@ -146,8 +146,8 @@ public function getComponent(string $key, ?bool $autoload = false, ?array $confi
      *
      * This overwrites any existing component registered with the same key.
      *
-     * @param string            $key
-     * @param AbstractComponent $component
+     * @param self::COMPONENT_*|string $key       A self::COMPONENT_* or self-registered key
+     * @param AbstractComponent        $component
      *
      * @return self Provides fluent interface
      */
@@ -158,7 +158,7 @@ public function setComponent(string $key, AbstractComponent $component): self;
      *
      * You can remove a component by passing its key or the component instance.
      *
-     * @param string|AbstractComponent $component
+     * @param self::COMPONENT_*|string|AbstractComponent $component
      *
      * @return self Provides fluent interface
      */

src/Component/ComponentAwareQueryTrait.php

@@ -31,7 +31,7 @@ trait ComponentAwareQueryTrait
     /**
      * Get all registered component types.
      *
-     * @return array
+     * @return array<self::COMPONENT_*|string> An array of self::COMPONENT_* and/or self-registered keys
      */
     public function getComponentTypes(): array
     {
@@ -69,9 +69,9 @@ public function getComponents(): array
      * You can optionally supply an autoload class to create a new component
      * instance if there is no registered component for the given key yet.
      *
-     * @param string     $key      Use one of the constants
-     * @param bool       $autoload Autoload if component needs to be created
-     * @param array|null $config   Configuration to use for autoload
+     * @param self::COMPONENT_*|string $key      A self::COMPONENT_* or self-registered key
+     * @param bool                     $autoload Autoload if component needs to be created
+     * @param array|null               $config   Configuration to use for autoload
      *
      * @throws OutOfBoundsException
      *
@@ -104,8 +104,8 @@ public function getComponent(string $key, ?bool $autoload = false, ?array $confi
      *
      * This overwrites any existing component registered with the same key.
      *
-     * @param string            $key
-     * @param AbstractComponent $component
+     * @param self::COMPONENT_*|string $key       A self::COMPONENT_* or self-registered key
+     * @param AbstractComponent        $component
      *
      * @return self Provides fluent interface
      */
@@ -122,7 +122,7 @@ public function setComponent(string $key, AbstractComponent $component): self
      *
      * You can remove a component by passing its key or the component instance.
      *
-     * @param string|AbstractComponent $component
+     * @param self::COMPONENT_*|string|AbstractComponent $component
      *
      * @return self Provides fluent interface
      */

src/Component/Facet/FieldValueParametersInterface.php

@@ -105,9 +105,7 @@ public function getMatches(): ?string;
     /**
      * Set the facet sort type.
      *
-     * Use one of the SORT_* constants as the value.
-     *
-     * @param string $sort
+     * @param self::SORT_* $sort
      */
     public function setSort(string $sort): static;
 
@@ -177,9 +175,7 @@ public function getMissing(): ?bool;
     /**
      * Set the facet method.
      *
-     * Use one of the METHOD_* constants as value.
-     *
-     * @param string $method
+     * @param self::METHOD_* $method
      */
     public function setMethod(string $method): static;
 

src/Component/Facet/FieldValueParametersTrait.php

@@ -105,9 +105,7 @@ public function getMatches(): ?string
     /**
      * Set the facet sort type.
      *
-     * Use one of the SORT_* constants as the value.
-     *
-     * @param string $sort
+     * @param self::SORT_* $sort
      */
     public function setSort(string $sort): static
     {
@@ -217,9 +215,7 @@ public function getMissing(): ?bool
     /**
      * Set the facet method.
      *
-     * Use one of the METHOD_* constants as value.
-     *
-     * @param string $method
+     * @param self::METHOD_* $method
      */
     public function setMethod(string $method): static
     {

src/Component/Facet/JsonFacetInterface.php

@@ -14,7 +14,7 @@
  *
  * @see https://solr.apache.org/guide/json-facet-api.html
  */
-interface JsonFacetInterface
+interface JsonFacetInterface extends FacetInterface
 {
     /**
      * Serializes nested facets as option "facet" and returns that array structure.