[minor] add native return types (#269)

liip · Dec 23, 2021 · 67fdfd8 · 67fdfd8
1 parent 906c9e0
commit 67fdfd8
Show file tree

Hide file tree

Showing 61 changed files with 260 additions and 215 deletions.
diff --git a/Check/CustomErrorPages.php b/Check/CustomErrorPages.php
@@ -4,6 +4,7 @@
 
 use Laminas\Diagnostics\Check\CheckInterface;
 use Laminas\Diagnostics\Result\Failure;
+use Laminas\Diagnostics\Result\ResultInterface;
 use Laminas\Diagnostics\Result\Success;
 
 /**
@@ -35,6 +36,9 @@ public function __construct(array $errorCodes, $path, $projectDir)
         $this->projectDir = $projectDir;
     }
 
+    /**
+     * @return ResultInterface
+     */
     public function check()
     {
         $dir = $this->getCustomTemplateDirectory();
@@ -55,15 +59,15 @@ public function check()
         return new Success();
     }
 
+    /**
+     * @return string
+     */
     public function getLabel()
     {
         return 'Custom error pages';
     }
 
-    /**
-     * @return string
-     */
-    private function getCustomTemplateDirectory()
+    private function getCustomTemplateDirectory(): string
     {
         if ($this->projectDir !== $this->path) {
             return $this->path; // using custom directory

diff --git a/Check/DoctrineDbal.php b/Check/DoctrineDbal.php
@@ -4,6 +4,7 @@
 
 use Doctrine\Persistence\ConnectionRegistry;
 use Laminas\Diagnostics\Check\AbstractCheck;
+use Laminas\Diagnostics\Result\ResultInterface;
 use Laminas\Diagnostics\Result\Success;
 
 class DoctrineDbal extends AbstractCheck
@@ -17,6 +18,9 @@ public function __construct(ConnectionRegistry $registry, $connectionName = null
         $this->connectionName = $connectionName;
     }
 
+    /**
+     * @return ResultInterface
+     */
     public function check()
     {
         $connection = $this->manager->getConnection($this->connectionName);

diff --git a/Check/DoctrineDbalCollection.php b/Check/DoctrineDbalCollection.php
@@ -26,6 +26,9 @@ public function __construct(ConnectionRegistry $manager, $connections)
         }
     }
 
+    /**
+     * @return array|\Traversable
+     */
     public function getChecks()
     {
         return $this->checks;

diff --git a/Check/DoctrineMigrationsCollection.php b/Check/DoctrineMigrationsCollection.php
@@ -48,6 +48,9 @@ public function __construct(
         $this->migrations = $migrations;
     }
 
+    /**
+     * @return array|\Traversable
+     */
     public function getChecks()
     {
         if (null === $this->checks) {

diff --git a/Check/DoctrineMongoDb.php b/Check/DoctrineMongoDb.php
@@ -5,6 +5,7 @@
 use Doctrine\Bundle\MongoDBBundle\ManagerRegistry;
 use Laminas\Diagnostics\Check\AbstractCheck;
 use Laminas\Diagnostics\Result\Failure;
+use Laminas\Diagnostics\Result\ResultInterface;
 use Laminas\Diagnostics\Result\Success;
 use MongoDB\Driver\Command;
 use MongoDB\Driver\Exception\ConnectionException;
@@ -20,6 +21,9 @@ public function __construct(ManagerRegistry $registry, $connectionName = null)
         $this->connectionName = $connectionName;
     }
 
+    /**
+     * @return ResultInterface
+     */
     public function check()
     {
         $connection = $this->manager->getConnection($this->connectionName);

diff --git a/Check/DoctrineMongoDbCollection.php b/Check/DoctrineMongoDbCollection.php
@@ -26,6 +26,9 @@ public function __construct(ConnectionRegistry $manager, $connections)
         }
     }
 
+    /**
+     * @return array|\Traversable
+     */
     public function getChecks()
     {
         return $this->checks;

diff --git a/Check/Expression.php b/Check/Expression.php
@@ -4,6 +4,7 @@
 
 use Laminas\Diagnostics\Check\CheckInterface;
 use Laminas\Diagnostics\Result\Failure;
+use Laminas\Diagnostics\Result\ResultInterface;
 use Laminas\Diagnostics\Result\Success;
 use Laminas\Diagnostics\Result\Warning;
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
@@ -36,6 +37,9 @@ public function __construct($label, $warningCheck = null, $criticalCheck = null,
         $this->criticalMessage = $criticalMessage;
     }
 
+    /**
+     * @return ResultInterface
+     */
     public function check()
     {
         $language = $this->getExpressionLanguage();
@@ -51,12 +55,15 @@ public function check()
         return new Success();
     }
 
+    /**
+     * @return string
+     */
     public function getLabel()
     {
         return $this->label;
     }
 
-    protected function getExpressionLanguage()
+    protected function getExpressionLanguage(): ExpressionLanguage
     {
         $language = new ExpressionLanguage();
         $language->register(

diff --git a/Check/ExpressionCollection.php b/Check/ExpressionCollection.php
@@ -24,6 +24,9 @@ public function __construct(array $configs)
         }
     }
 
+    /**
+     * @return array|\Traversable
+     */
     public function getChecks()
     {
         return $this->checks;

diff --git a/Check/GuzzleHttpServiceCollection.php b/Check/GuzzleHttpServiceCollection.php
@@ -31,6 +31,9 @@ public function __construct(array $configs)
         }
     }
 
+    /**
+     * @return array|\Traversable
+     */
     public function getChecks()
     {
         return $this->checks;

diff --git a/Check/HttpServiceCollection.php b/Check/HttpServiceCollection.php
@@ -22,6 +22,9 @@ public function __construct(array $configs)
         }
     }
 
+    /**
+     * @return array|\Traversable
+     */
     public function getChecks()
     {
         return $this->checks;

diff --git a/Check/MemcacheCollection.php b/Check/MemcacheCollection.php
@@ -22,6 +22,9 @@ public function __construct(array $configs)
         }
     }
 
+    /**
+     * @return array|\Traversable
+     */
     public function getChecks()
     {
         return $this->checks;

diff --git a/Check/MemcachedCollection.php b/Check/MemcachedCollection.php
@@ -22,6 +22,9 @@ public function __construct(array $configs)
         }
     }
 
+    /**
+     * @return array|\Traversable
+     */
     public function getChecks()
     {
         return $this->checks;

diff --git a/Check/PdoConnectionCollection.php b/Check/PdoConnectionCollection.php
@@ -17,6 +17,9 @@ public function __construct(array $connections)
         }
     }
 
+    /**
+     * @return array|\Traversable
+     */
     public function getChecks()
     {
         return $this->checks;

diff --git a/Check/PhpFlagsCollection.php b/Check/PhpFlagsCollection.php
@@ -22,6 +22,9 @@ public function __construct(array $configs)
         }
     }
 
+    /**
+     * @return array|\Traversable
+     */
     public function getChecks()
     {
         return $this->checks;

diff --git a/Check/PhpVersionCollection.php b/Check/PhpVersionCollection.php
@@ -22,6 +22,9 @@ public function __construct(array $configs)
         }
     }
 
+    /**
+     * @return array|\Traversable
+     */
     public function getChecks()
     {
         return $this->checks;

diff --git a/Check/ProcessRunningCollection.php b/Check/ProcessRunningCollection.php
@@ -26,6 +26,9 @@ public function __construct($processes)
         }
     }
 
+    /**
+     * @return array|\Traversable
+     */
     public function getChecks()
     {
         return $this->checks;

diff --git a/Check/RabbitMQCollection.php b/Check/RabbitMQCollection.php
@@ -36,6 +36,9 @@ public function __construct(array $configs)
         }
     }
 
+    /**
+     * @return array|\Traversable
+     */
     public function getChecks()
     {
         return $this->checks;

diff --git a/Check/RedisCollection.php b/Check/RedisCollection.php
@@ -26,7 +26,7 @@ public function __construct(array $configs)
         }
     }
 
-    private function parseDsn(array &$config)
+    private function parseDsn(array &$config): void
     {
         $config = \array_merge($config, \parse_url($config['dsn']));
 
@@ -45,6 +45,9 @@ private function parseDsn(array &$config)
         }
     }
 
+    /**
+     * @return array|\Traversable
+     */
     public function getChecks()
     {
         return $this->checks;

diff --git a/Check/SymfonyRequirements.php b/Check/SymfonyRequirements.php
@@ -4,6 +4,7 @@
 
 use Laminas\Diagnostics\Check\CheckInterface;
 use Laminas\Diagnostics\Result\Failure;
+use Laminas\Diagnostics\Result\ResultInterface;
 use Laminas\Diagnostics\Result\Success;
 use Laminas\Diagnostics\Result\Warning;
 
@@ -21,6 +22,9 @@ public function __construct($file)
         require $file;
     }
 
+    /**
+     * @return ResultInterface
+     */
     public function check()
     {
         $symfonyRequirements = new \SymfonyRequirements();
@@ -36,6 +40,9 @@ public function check()
         return new Success();
     }
 
+    /**
+     * @return string
+     */
     public function getLabel()
     {
         return 'Symfony2 Requirements';

diff --git a/Check/SymfonyVersion.php b/Check/SymfonyVersion.php
@@ -4,6 +4,7 @@
 
 use Laminas\Diagnostics\Check\CheckInterface;
 use Laminas\Diagnostics\Result\Failure;
+use Laminas\Diagnostics\Result\ResultInterface;
 use Laminas\Diagnostics\Result\Success;
 use Laminas\Diagnostics\Result\Warning;
 use Symfony\Component\HttpClient\HttpClient;
@@ -20,6 +21,9 @@ class SymfonyVersion implements CheckInterface
     const PACKAGIST_URL = 'https://packagist.org/packages/symfony/symfony.json';
     const VERSION_CHECK_URL = 'https://symfony.com/releases/%s.json';
 
+    /**
+     * @return ResultInterface
+     */
     public function check()
     {
         $currentBranch = Kernel::MAJOR_VERSION.'.'.Kernel::MINOR_VERSION;
@@ -47,6 +51,9 @@ public function check()
         return new Success(sprintf('Your current Symfony branch reaches it\'s end of life in %s.', $endOfLife));
     }
 
+    /**
+     * @return string
+     */
     public function getLabel()
     {
         return 'Symfony version';
@@ -55,11 +62,9 @@ public function getLabel()
     /**
      * @param string $branch
      *
-     * @return string
-     *
      * @throws \Exception
      */
-    private function getLatestVersion($branch)
+    private function getLatestVersion($branch): string
     {
         $response = $this->getResponseAndDecode(self::PACKAGIST_URL);
 
@@ -96,13 +101,11 @@ function ($value) use ($branch) {
     }
 
     /**
-     * @param $url
-     *
-     * @return array
+     * @param string $url
      *
      * @throws \Exception
      */
-    private function getResponseAndDecode($url)
+    private function getResponseAndDecode($url): array
     {
         if (class_exists(HttpClient::class)) {
             return HttpClient::create()->request('GET', $url)->toArray();

diff --git a/Command/HealthCheckCommand.php b/Command/HealthCheckCommand.php
@@ -26,7 +26,7 @@ public function __construct(ConsoleReporter $reporter, RawConsoleReporter $rawRe
         parent::__construct($name);
     }
 
-    protected function configure()
+    protected function configure(): void
     {
         $this
             ->setName('monitor:health')
@@ -53,10 +53,7 @@ protected function configure()
         ;
     }
 
-    /**
-     * @return int
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $failureCount = 0;
-Original file line number
+Diff line change
@@ Expand Up @@
             }
         }
+        /**
+         * @return array|\Traversable
+         */
         public function getChecks()
         {
             return $this->checks;
@@ Expand Down @@