Merge pull request #1653 from deguif/type-hint-client-signatures

Add type-hints on signatures of client and logger methods

Author: XWB

CHANGELOG-6.0.md

@@ -17,6 +17,8 @@ in 6.0 versions.
 * [BC break] Signature of methods `getPager`, `getOptions` and `getObjectPersister` from interface `FOS\ElasticaBundle\Persister\Event\PersistEvent` were changed.
 * [BC break] Signature of methods `getNbResults`, `getNbPages`, `getCurrentPage`, `setCurrentPage`, `getMaxPerPage` and `setMaxPerPage` from interface `FOS\ElasticaBundle\Provider\PagerInterface` were changed.
 * [BC break] Signature of methods `findPaginated`, `createPaginatorAdapter` and `createRawPaginatorAdapter` from interface `FOS\ElasticaBundle\Finder\PaginatedFinderInterface` were changed.
+* [BC break] Signature of methods `request`, `getIndex`, `getIndexTemplate` and `setStopwatch` from class `FOS\ElasticaBundle\Elastica\Client` were changed.
+* [BC break] Signature of methods `logQuery`, `getNbQueries` and `getQueries` from class `FOS\ElasticaBundle\Logger\ElasticaLogger` were changed.
 * [BC break] Removed `Elastica\Type`.
 * [BC break] Removed `_parent`.
 * [BC Break] Removed `FOS\ElasticaBundle\Persister\Event\Events` class, use class events instead.

src/Elastica/Client.php

@@ -51,7 +51,7 @@ class Client extends BaseClient
     /**
      * {@inheritdoc}
      */
-    public function request($path, $method = Request::GET, $data = [], array $query = [], $contentType = Request::DEFAULT_CONTENT_TYPE): Response
+    public function request(string $path, string $method = Request::GET, $data = [], array $query = [], string $contentType = Request::DEFAULT_CONTENT_TYPE): Response
     {
         if ($this->stopwatch) {
             $this->stopwatch->start('es_request', 'fos_elastica');
@@ -92,7 +92,7 @@ public function getIndex(string $name): BaseIndex
         return $this->indexCache[$name] = new Index($this, $name);
     }
 
-    public function getIndexTemplate($name)
+    public function getIndexTemplate($name): IndexTemplate
     {
         if (isset($this->indexTemplateCache[$name])) {
             return $this->indexTemplateCache[$name];
@@ -103,27 +103,22 @@ public function getIndexTemplate($name)
 
     /**
      * Sets a stopwatch instance for debugging purposes.
-     *
-     * @param Stopwatch $stopwatch
      */
-    public function setStopwatch(Stopwatch $stopwatch = null)
+    public function setStopwatch(?Stopwatch $stopwatch = null)
     {
         $this->stopwatch = $stopwatch;
     }
 
     /**
      * Log the query if we have an instance of ElasticaLogger.
      *
-     * @param string       $path
-     * @param string       $method
      * @param array|string $data
      * @param int          $queryTime
      * @param int          $engineMS
-     * @param int          $itemCount
      */
-    private function logQuery($path, $method, $data, array $query, $queryTime, $engineMS = 0, $itemCount = 0): void
+    private function logQuery(string $path, string $method, $data, array $query, $queryTime, $engineMS = 0, int $itemCount = 0): void
     {
-        if (!$this->_logger or !$this->_logger instanceof ElasticaLogger) {
+        if (!$this->_logger instanceof ElasticaLogger) {
             return;
         }
 
@@ -136,8 +131,6 @@ private function logQuery($path, $method, $data, array $query, $queryTime, $engi
             'headers' => $connection->hasConfig('headers') ? $connection->getConfig('headers') : [],
         ];
 
-        /** @var ElasticaLogger $logger */
-        $logger = $this->_logger;
-        $logger->logQuery($path, $method, $data, $queryTime, $connectionArray, $query, $engineMS, $itemCount);
+        $this->_logger->logQuery($path, $method, $data, $queryTime, $connectionArray, $query, $engineMS, $itemCount);
     }
 }

src/Logger/ElasticaLogger.php

@@ -39,13 +39,7 @@ class ElasticaLogger extends AbstractLogger
      */
     protected $debug;
 
-    /**
-     * Constructor.
-     *
-     * @param LoggerInterface|null $logger The Symfony logger
-     * @param bool                 $debug
-     */
-    public function __construct(LoggerInterface $logger = null, $debug = false)
+    public function __construct(?LoggerInterface $logger = null, bool $debug = false)
     {
         $this->logger = $logger;
         $this->debug = $debug;
@@ -61,9 +55,8 @@ public function __construct(LoggerInterface $logger = null, $debug = false)
      * @param array        $connection Host, port, transport, and headers of the query
      * @param array        $query      Arguments
      * @param int          $engineTime
-     * @param int          $itemCount
      */
-    public function logQuery($path, $method, $data, $queryTime, $connection = [], $query = [], $engineTime = 0, $itemCount = 0)
+    public function logQuery(string $path, string $method, $data, $queryTime, $connection = [], $query = [], $engineTime = 0, int $itemCount = 0)
     {
         $executionMS = $queryTime * 1000;
 
@@ -102,20 +95,16 @@ public function logQuery($path, $method, $data, $queryTime, $connection = [], $q
 
     /**
      * Returns the number of queries that have been logged.
-     *
-     * @return int The number of queries logged
      */
-    public function getNbQueries()
+    public function getNbQueries(): int
     {
         return count($this->queries);
     }
 
     /**
      * Returns a human-readable array of queries logged.
-     *
-     * @return array An array of queries
      */
-    public function getQueries()
+    public function getQueries(): array
     {
         return $this->queries;
     }
@@ -125,7 +114,7 @@ public function getQueries()
      */
     public function log($level, $message, array $context = [])
     {
-        return $this->logger->log($level, $message, $context);
+        $this->logger->log($level, $message, $context);
     }
 
     public function reset()