IBX-10507: Allowed nullable type declarations for method parameters across the codebase

phpstan-baseline.neon

@@ -588,18 +588,6 @@ parameters:
 			count: 1
 			path: src/lib/Gateway/EndpointResolver/NativeEndpointResolver.php
 
-		-
-			message: '#^Method Ibexa\\Solr\\Gateway\\HttpClient\\Stream\:\:getResponseMessage\(\) has parameter \$method with no type specified\.$#'
-			identifier: missingType.parameter
-			count: 1
-			path: src/lib/Gateway/HttpClient/Stream.php
-
-		-
-			message: '#^Method Ibexa\\Solr\\Gateway\\HttpClient\\Stream\:\:getResponseMessage\(\) has parameter \$path with no type specified\.$#'
-			identifier: missingType.parameter
-			count: 1
-			path: src/lib/Gateway/HttpClient/Stream.php
-
 		-
 			message: '#^Method Ibexa\\Solr\\Gateway\\Message\:\:__construct\(\) has parameter \$headers with no value type specified in iterable type array\.$#'
 			identifier: missingType.iterableValue
@@ -1014,36 +1002,6 @@ parameters:
 			count: 1
 			path: src/lib/Query/Common/CriterionVisitor/LanguageCodeIn.php
 
-		-
-			message: '#^Cannot call method visit\(\) on Ibexa\\Contracts\\Solr\\Query\\CriterionVisitor\|null\.$#'
-			identifier: method.nonObject
-			count: 1
-			path: src/lib/Query/Common/CriterionVisitor/LogicalAnd.php
-
-		-
-			message: '#^Method Ibexa\\Solr\\Query\\Common\\CriterionVisitor\\LogicalAnd\:\:visit\(\) should return string but returns false\.$#'
-			identifier: return.type
-			count: 1
-			path: src/lib/Query/Common/CriterionVisitor/LogicalAnd.php
-
-		-
-			message: '#^Cannot call method visit\(\) on Ibexa\\Contracts\\Solr\\Query\\CriterionVisitor\|null\.$#'
-			identifier: method.nonObject
-			count: 1
-			path: src/lib/Query/Common/CriterionVisitor/LogicalNot.php
-
-		-
-			message: '#^Cannot call method visit\(\) on Ibexa\\Contracts\\Solr\\Query\\CriterionVisitor\|null\.$#'
-			identifier: method.nonObject
-			count: 1
-			path: src/lib/Query/Common/CriterionVisitor/LogicalOr.php
-
-		-
-			message: '#^Method Ibexa\\Solr\\Query\\Common\\CriterionVisitor\\LogicalOr\:\:visit\(\) should return string but returns false\.$#'
-			identifier: return.type
-			count: 1
-			path: src/lib/Query/Common/CriterionVisitor/LogicalOr.php
-
 		-
 			message: '#^Method Ibexa\\Solr\\Query\\Common\\CriterionVisitor\\MapLocation\:\:getSearchFields\(\) return type has no value type specified in iterable type array\.$#'
 			identifier: missingType.iterableValue

src/contracts/Query/CriterionVisitor.php

@@ -22,13 +22,9 @@ abstract class CriterionVisitor
     abstract public function canVisit(Criterion $criterion);
 
     /**
-     * Map field value to a proper Solr representation.
-     *
-     * @param CriterionVisitor $subVisitor
-     *
      * @return string
      */
-    abstract public function visit(Criterion $criterion, self $subVisitor = null);
+    abstract public function visit(Criterion $criterion, ?self $subVisitor = null);
 
     /**
      * Get Solr range.

src/lib/Gateway/HttpClient.php

@@ -11,19 +11,7 @@
  */
 interface HttpClient
 {
-    /**
-     * Execute a HTTP request to the remote server.
-     *
-     * Returns the result from the remote server.
-     *
-     * @param string $method
-     * @param \Ibexa\Solr\Gateway\Endpoint $endpoint
-     * @param string $path
-     * @param \Ibexa\Solr\Gateway\Message $message
-     *
-     * @return \Ibexa\Solr\Gateway\Message
-     */
-    public function request($method, Endpoint $endpoint, $path, Message $message = null);
+    public function request(string $method, Endpoint $endpoint, string $path, ?Message $message = null): Message;
 }
 
 class_alias(HttpClient::class, 'EzSystems\EzPlatformSolrSearchEngine\Gateway\HttpClient');

src/lib/Gateway/HttpClient/Stream.php

@@ -40,17 +40,7 @@ public function __construct(HttpClientInterface $client, int $timeout = 10)
         $this->setLogger(new NullLogger());
     }
 
-    /**
-     * Execute an HTTP request to the remote server.
-     *
-     * Returns the result from the remote server.
-     *
-     * @param string $method
-     * @param string $path
-     *
-     * @return \Ibexa\Solr\Gateway\Message
-     */
-    public function request($method, Endpoint $endpoint, $path, Message $message = null): Message
+    public function request(string $method, Endpoint $endpoint, string $path, ?Message $message = null): Message
     {
         $message = $message ?? new Message();
 
@@ -73,9 +63,9 @@ public function request($method, Endpoint $endpoint, $path, Message $message = n
      * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
      */
     private function getResponseMessage(
-        $method,
+        string $method,
         Endpoint $endpoint,
-        $path,
+        string $path,
         Message $message
     ): Message {
         if ($endpoint->user !== null) {

src/lib/Handler.php

@@ -232,14 +232,11 @@ public function findLocations(LocationQuery $query, array $languageFilter = [])
     }
 
     /**
-     * Suggests a list of values for the given prefix.
-     *
      * @param string $prefix
      * @param string[] $fieldPaths
      * @param int $limit
-     * @param \Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion $filter
      */
-    public function suggest($prefix, $fieldPaths = [], $limit = 10, Criterion $filter = null)
+    public function suggest($prefix, $fieldPaths = [], $limit = 10, ?Criterion $filter = null)
     {
         throw new \Exception('@todo: Not implemented yet.');
     }

src/lib/Query/Common/CriterionVisitor/Aggregate.php

@@ -53,15 +53,9 @@ public function canVisit(Criterion $criterion)
     }
 
     /**
-     * Map field value to a proper Solr representation.
-     *
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotImplementedException
-     *
-     * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
-     *
-     * @return string
      */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(Criterion $criterion, ?CriterionVisitor $subVisitor = null): string
     {
         foreach ($this->visitors as $visitor) {
             if ($visitor->canVisit($criterion)) {

src/lib/Query/Common/CriterionVisitor/BaseIsContainer.php

@@ -24,7 +24,7 @@ public function canVisit(Criterion $criterion): bool
         return $criterion instanceof Criterion\IsContainer && $criterion->operator === Operator::EQ;
     }
 
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null): string
+    public function visit(Criterion $criterion, ?CriterionVisitor $subVisitor = null): string
     {
         $value = $criterion->value;
 

src/lib/Query/Common/CriterionVisitor/ContentIdIn.php

@@ -30,14 +30,7 @@ public function canVisit(Criterion $criterion)
             );
     }
 
-    /**
-     * Map field value to a proper Solr representation.
-     *
-     * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
-     *
-     * @return string
-     */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(Criterion $criterion, ?CriterionVisitor $subVisitor = null): string
     {
         return '(' .
             implode(

src/lib/Query/Common/CriterionVisitor/ContentTypeGroupIdIn.php

@@ -30,14 +30,7 @@ public function canVisit(Criterion $criterion)
             );
     }
 
-    /**
-     * Map field value to a proper Solr representation.
-     *
-     * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
-     *
-     * @return string
-     */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(Criterion $criterion, ?CriterionVisitor $subVisitor = null): string
     {
         return '(' .
             implode(

src/lib/Query/Common/CriterionVisitor/ContentTypeIdIn.php

@@ -30,14 +30,7 @@ public function canVisit(Criterion $criterion)
             );
     }
 
-    /**
-     * Map field value to a proper Solr representation.
-     *
-     * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
-     *
-     * @return string
-     */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(Criterion $criterion, ?CriterionVisitor $subVisitor = null): string
     {
         return '(' .
             implode(

src/lib/Query/Common/CriterionVisitor/ContentTypeIdentifierIn.php

@@ -34,7 +34,7 @@ class ContentTypeIdentifierIn extends CriterionVisitor
     /**
      * Create from content type handler and field registry.
      */
-    public function __construct(Handler $contentTypeHandler, LoggerInterface $logger = null)
+    public function __construct(Handler $contentTypeHandler, ?LoggerInterface $logger = null)
     {
         $this->contentTypeHandler = $contentTypeHandler;
         $this->logger = $logger ?? new NullLogger();
@@ -55,14 +55,7 @@ public function canVisit(Criterion $criterion)
             );
     }
 
-    /**
-     * Map field value to a proper Solr representation.
-     *
-     * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
-     *
-     * @return string
-     */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(Criterion $criterion, ?CriterionVisitor $subVisitor = null): string
     {
         $validIds = [];
         $invalidIdentifiers = [];

src/lib/Query/Common/CriterionVisitor/CustomField/CustomFieldIn.php

@@ -31,14 +31,7 @@ public function canVisit(Criterion $criterion)
             );
     }
 
-    /**
-     * Map field value to a proper Solr representation.
-     *
-     * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
-     *
-     * @return string
-     */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(Criterion $criterion, ?CriterionVisitor $subVisitor = null): string
     {
         $queries = [];
         $values = (array)$criterion->value;

src/lib/Query/Common/CriterionVisitor/CustomField/CustomFieldRange.php

@@ -33,14 +33,7 @@ public function canVisit(Criterion $criterion)
             );
     }
 
-    /**
-     * Map field value to a proper Solr representation.
-     *
-     * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
-     *
-     * @return string
-     */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(Criterion $criterion, ?CriterionVisitor $subVisitor = null): string
     {
         $values = (array)$criterion->value;
         $start = $values[0];

src/lib/Query/Common/CriterionVisitor/DateMetadata/ModifiedBetween.php

@@ -33,14 +33,7 @@ public function canVisit(Criterion $criterion)
               $criterion->operator === Operator::BETWEEN);
     }
 
-    /**
-     * Map field value to a proper Solr representation.
-     *
-     * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
-     *
-     * @return string
-     */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(Criterion $criterion, ?CriterionVisitor $subVisitor = null): string
     {
         $start = $this->getSolrTime($criterion->value[0]);
         $end = isset($criterion->value[1]) ? $this->getSolrTime($criterion->value[1]) : null;

src/lib/Query/Common/CriterionVisitor/DateMetadata/ModifiedIn.php

@@ -32,14 +32,7 @@ public function canVisit(Criterion $criterion)
             );
     }
 
-    /**
-     * Map field value to a proper Solr representation.
-     *
-     * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
-     *
-     * @return string
-     */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(Criterion $criterion, ?CriterionVisitor $subVisitor = null): string
     {
         $values = [];
         foreach ($criterion->value as $value) {

src/lib/Query/Common/CriterionVisitor/DateMetadata/PublishedBetween.php

@@ -40,14 +40,7 @@ public function canVisit(Criterion $criterion)
         ], true);
     }
 
-    /**
-     * Map field value to a proper Solr representation.
-     *
-     * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
-     *
-     * @return string
-     */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(Criterion $criterion, ?CriterionVisitor $subVisitor = null): string
     {
         $start = $this->getSolrTime($criterion->value[0]);
         $end = isset($criterion->value[1]) ? $this->getSolrTime($criterion->value[1]) : null;

src/lib/Query/Common/CriterionVisitor/DateMetadata/PublishedIn.php

@@ -36,14 +36,7 @@ public function canVisit(Criterion $criterion)
         return in_array($operator, [Operator::IN, Operator::EQ], true);
     }
 
-    /**
-     * Map field value to a proper Solr representation.
-     *
-     * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
-     *
-     * @return string
-     */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(Criterion $criterion, ?CriterionVisitor $subVisitor = null): string
     {
         return implode(
             ' OR ',

src/lib/Query/Common/CriterionVisitor/Field.php

@@ -52,14 +52,11 @@ protected function getSearchFields(Criterion $criterion)
     }
 
     /**
-     * Map search field value to solr value using FieldValueMapper.
-     *
      * @param mixed $value
-     * @param \Ibexa\Contracts\Core\Search\FieldType $searchFieldType
      *
      * @return mixed
      */
-    protected function mapSearchFieldValue($value, FieldType $searchFieldType = null)
+    protected function mapSearchFieldValue($value, ?FieldType $searchFieldType = null)
     {
         if (null === $searchFieldType) {
             return $value;

src/lib/Query/Common/CriterionVisitor/Field/FieldEmpty.php

@@ -47,13 +47,9 @@ public function canVisit(Criterion $criterion): bool
     }
 
     /**
-     * Map field value to a proper Solr representation.
-     *
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException If no searchable fields are found for the given criterion target.
-     *
-     * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
      */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null): string
+    public function visit(Criterion $criterion, ?CriterionVisitor $subVisitor = null): string
     {
         $searchFields = $this->getSearchFields($criterion);
 

src/lib/Query/Common/CriterionVisitor/Field/FieldIn.php

@@ -34,16 +34,9 @@ public function canVisit(Criterion $criterion)
     }
 
     /**
-     * Map field value to a proper Solr representation.
-     *
      * @throws \Ibexa\Core\Base\Exceptions\InvalidArgumentException If no searchable fields are found for the given criterion target.
-     *
-     * @param \Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion $criterion
-     * @param \Ibexa\Contracts\Solr\Query\CriterionVisitor $subVisitor
-     *
-     * @return string
      */
-    public function visit(Criterion $criterion, CriterionVisitor $subVisitor = null)
+    public function visit(Criterion $criterion, ?CriterionVisitor $subVisitor = null): string
     {
         $searchFields = $this->getSearchFields($criterion);