PHPStan: raise to level 6 (#4223)

* PHPStan: cleanup setup

* PHPStan: raise to level 6

Author: staabm

contrib/cpanel.php

@@ -179,7 +179,7 @@ function getCpanel()
     return $cpanel;
 }
 
-function getDomainInfo()
+function getDomainInfo(): array
 {
     $domain = vsprintf(get('cpanel')['create_domain_format'], get('cpanel')['create_domain_values']);
     $cleanDomain = str_replace(['.', ',', ' ', '/', '-'], '', $domain);

contrib/ispmanager.php

@@ -694,7 +694,7 @@
     }
 });
 
-function ispmanagerRequest($method, $requestData)
+function ispmanagerRequest(string $method, array $requestData): mixed
 {
     $config = get('ispmanager');
     $dsnData = parse_url($config['api']['dsn']);
@@ -722,7 +722,7 @@ function ispmanagerRequest($method, $requestData)
     }
 }
 
-function ispmanagerAuthRequest($url, $login, $pass)
+function ispmanagerAuthRequest(string $url, string $login, string $pass): void
 {
     $authRequestData = [
         'func' => 'auth',
@@ -743,7 +743,7 @@ function ispmanagerAuthRequest($url, $login, $pass)
     }
 }
 
-function prepareRequest($requestData)
+function prepareRequest(array $requestData): array
 {
     $config = get('ispmanager');
     $dsnData = parse_url($config['api']['dsn']);
@@ -763,9 +763,9 @@ function prepareRequest($requestData)
     return $requestData;
 }
 
-function generatePassword($lenght)
+function generatePassword(int $length): string
 {
-    return substr(md5(uniqid()), 0, $lenght);
+    return substr(md5(uniqid()), 0, $length);
 }
 
 // Callbacks before actions under domains

contrib/sentry.php

@@ -184,7 +184,7 @@ static function (&$value) use ($config) {
     },
 );
 
-function getPreviousReleaseRevision()
+function getPreviousReleaseRevision(): ?string
 {
     switch (get('update_code_strategy')) {
         case 'local_archive':
@@ -206,7 +206,7 @@ function getPreviousReleaseRevision()
     }
 }
 
-function getCurrentReleaseRevision()
+function getCurrentReleaseRevision(): string
 {
     switch (get('update_code_strategy')) {
         case 'local_archive':

contrib/slack.php

@@ -87,7 +87,7 @@
 set('slack_failure_color', '#ff0909');
 set('slack_rollback_color', '#eba211');
 
-function checkSlackAnswer($result)
+function checkSlackAnswer(mixed $result): bool
 {
     if ('invalid_token' === $result) {
         warning('Invalid Slack token');

contrib/supervisord-monitor.php

@@ -91,7 +91,7 @@
 
 use Deployer\Utility\Httpie;
 
-function supervisordCheckConfig()
+function supervisordCheckConfig(): void
 {
     $config = get('supervisord', []);
     foreach ($config as $key => $value) {
@@ -108,12 +108,12 @@ function supervisordCheckConfig()
     }
 }
 
-function supervisordGetBasicAuthToken()
+function supervisordGetBasicAuthToken(): string
 {
     return 'Basic ' . base64_encode(get('supervisord_basic_auth_user') . ':' . get('supervisord_basic_auth_password'));
 }
 
-function supervisordIsAuthenticated()
+function supervisordIsAuthenticated(): bool
 {
     supervisordCheckConfig();
 
@@ -123,7 +123,7 @@ function supervisordIsAuthenticated()
     return $authResponseInfo['http_code'] === 200;
 }
 
-function supervisordControlAction($name, $action = 'stop')
+function supervisordControlAction(string $name, string $action = 'stop'): bool
 {
     $stopResponseInfo = [];
     Httpie::post(get('supervisord_uri') . '/control/' . $action . '/localhost/' . $name)->header('Authorization', supervisordGetBasicAuthToken())->send($stopResponseInfo);

phpstan.neon

@@ -2,7 +2,7 @@ includes:
     - tests/phpstan-baseline.neon
 
 parameters:
-    level: 5
+    level: 6
     paths:
         - bin
         - src
@@ -23,3 +23,7 @@ parameters:
         - "#^Constant MASTER_TOKEN not found\\.$#"
         - "#CpanelPhp#"
         - "#AMQPMessage#"
+        - identifier: missingType.iterableValue
+        -
+            identifier: missingType.generics
+            path: src/Component/Pimple/Container.php

recipe/codeigniter4.php

@@ -80,7 +80,7 @@ function spark($command, $options = [])
     };
 }
 
-function codeigniter4_version_compare($version, $comparator)
+function codeigniter4_version_compare(string $version, string $comparator): bool
 {
     return version_compare(get('codeigniter4_version'), $version, $comparator);
 }

recipe/laravel.php

@@ -74,7 +74,7 @@ function artisan($command, $options = [])
     };
 }
 
-function laravel_version_compare($version, $comparator)
+function laravel_version_compare(string $version, string $comparator): bool
 {
     return version_compare(get('laravel_version'), $version, $comparator);
 }

recipe/magento2.php

@@ -253,7 +253,7 @@
  *
  * @throws ConfigurationException
  */
-function magentoDeployAssetsSplit(string $area)
+function magentoDeployAssetsSplit(string $area): void
 {
     if (!in_array($area, ['frontend', 'backend'], true)) {
         throw new ConfigurationException("\$area must be either 'frontend' or 'backend', '$area' given");

src/Collection/Collection.php

@@ -13,6 +13,9 @@
 use Countable;
 use IteratorAggregate;
 
+/**
+ * @implements IteratorAggregate<string, mixed>
+ */
 class Collection implements Countable, IteratorAggregate
 {
     protected array $values = [];
@@ -35,7 +38,7 @@ public function has(string $name): bool
         return array_key_exists($name, $this->values);
     }
 
-    public function set(string $name, mixed $object)
+    public function set(string $name, mixed $object): void
     {
         $this->values[$name] = $object;
     }