GitHub Actions: Add PHPStan

.github/workflows/php.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: ['7.2', '7.3', '7.4', '8.0', '8.1']
+        php: ['7.2', '7.3', '7.4', '8.0', '8.1', '8.2']
         os: ['ubuntu-latest']
 
     steps:
@@ -31,16 +31,27 @@ jobs:
           tools: phpcs
 
       - name: Setup dependencies
-        run: composer require -n --no-progress overtrue/phplint
+        run: |
+          composer require -n --no-progress overtrue/phplint
+          git clone --depth 1 https://github.com/Icinga/icingaweb2.git vendor/icingaweb2
+          git clone --depth 1 https://github.com/Icinga/icingaweb2-module-reporting.git vendor/reporting
+          git clone --depth 1 https://github.com/Icinga/icingaweb2-module-x509.git vendor/x509
+          git clone --depth 1 https://github.com/Icinga/icingaweb2-module-pdfexport.git vendor/pdfexport
+          git clone --depth 1 -b snapshot/nightly https://github.com/Icinga/icinga-php-library.git vendor/icinga-php-library
+          git clone --depth 1 -b snapshot/nightly https://github.com/Icinga/icinga-php-thirdparty.git vendor/icinga-php-thirdparty
 
       - name: PHP Lint
-        if: success() || matrix.allow_failure
+        if: ${{ ! cancelled() }}
         run: ./vendor/bin/phplint -n --exclude={^vendor/.*} -- .
 
       - name: PHP CodeSniffer
-        if: success() || matrix.allow_failure
+        if: ${{ ! cancelled() }}
         run: phpcs -wps --colors
 
+      - name: PHPStan
+        if: ${{ ! cancelled() }}
+        uses: php-actions/phpstan@v3
+
   test:
     name: Unit tests with php ${{ matrix.php }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}

application/controllers/HostsController.php

@@ -85,7 +85,7 @@ public function indexAction()
         $hosts->peekAhead($compact);
 
         $this->filter($hosts, $filter);
-        if (isset($summary)) {
+        if (! $compact) {
             $this->filter($summary, $filter);
             yield $this->export($hosts, $summary);
         } else {

application/forms/RedisConfigForm.php

@@ -355,6 +355,7 @@ public function onSuccess()
         ));
 
         $useTls = $this->getElement('redis_tls')->isChecked();
+        $pem = null;
         foreach (['ca', 'cert', 'key'] as $name) {
             $textarea = $this->getElement('redis_' . $name . '_pem');
             if ($useTls && $textarea !== null && ($pem = $textarea->getValue())) {

library/Icingadb/Common/CommandActions.php

@@ -239,6 +239,7 @@ public function sendCustomNotificationAction()
     public function toggleFeaturesAction()
     {
         $commandObjects = $this->getCommandTargets();
+        $form = null;
         if (count($commandObjects) > 1) {
             $this->isGrantedOnCommandTargets('i/am-only-used/to-establish/the-object-auth-cache');
             $form = new ToggleObjectFeaturesForm($this->getFeatureStatus());

library/Icingadb/Common/IcingaRedis.php

@@ -183,7 +183,7 @@ protected static function fetchState(string $key, array $ids, array $columns): G
      *
      * @param Redis|null $redis
      *
-     * @return ?float|int
+     * @return float|int|null
      */
     public static function getLastIcingaHeartbeat(Redis $redis = null)
     {
@@ -241,7 +241,7 @@ public static function getPrimaryRedis(Config $moduleConfig = null, Config $redi
             'port'      => $section->get('port', 6380),
             'password'  => $section->get('password', ''),
             'timeout'   => 0.5
-        ] + static::getTlsParams($moduleConfig));
+        ] + self::getTlsParams($moduleConfig));
 
         $redis->ping();
 
@@ -278,7 +278,7 @@ public static function getSecondaryRedis(Config $moduleConfig = null, Config $re
             'port'      => $section->get('port', 6380),
             'password'  => $section->get('password', ''),
             'timeout'   => 0.5
-        ] + static::getTlsParams($moduleConfig));
+        ] + self::getTlsParams($moduleConfig));
 
         $redis->ping();
 

library/Icingadb/Compat/CompatObject.php

@@ -132,7 +132,7 @@ public function fetchCustomvars(): self
             return $this;
         }
 
-        $this->customvars = (new CustomvarFlat())->unflattenVars($this->object->customvar_flat);
+        $this->customvars = (new CustomvarFlat())->unFlattenVars($this->object->customvar_flat);
 
         return $this;
     }

library/Icingadb/Compat/UrlMigrator.php

@@ -114,6 +114,8 @@ protected function rewrite(Filter\Rule $filter, array $legacyColumns, Filter\Cha
         if ($filter instanceof Filter\Condition) {
             $column = $filter->getColumn();
 
+            $modelPath = null;
+            $exprRule = null;
             if (isset($legacyColumns[$column])) {
                 if ($legacyColumns[$column] === self::DROP) {
                     return false;
@@ -288,10 +290,6 @@ protected static function hostsColumns(): array
                     }
                 }
 
-                if (empty($columns)) {
-                    return false;
-                }
-
                 return Filter::equal('columns', implode(',', $columns));
             },
 
@@ -519,10 +517,6 @@ protected static function servicesColumns(): array
                     }
                 }
 
-                if (empty($columns)) {
-                    return false;
-                }
-
                 return Filter::equal('columns', implode(',', $columns));
             },
 

library/Icingadb/Data/CsvResultSet.php

@@ -14,7 +14,10 @@ class CsvResultSet extends ResultSet
 {
     protected $isCacheDisabled = true;
 
-    public function current()
+    /**
+     * @return array<string, ?string>
+     */
+    public function current(): array
     {
         return $this->extractKeysAndValues(parent::current());
     }

library/Icingadb/Data/JsonResultSet.php

@@ -15,7 +15,10 @@ class JsonResultSet extends ResultSet
 {
     protected $isCacheDisabled = true;
 
-    public function current()
+    /**
+     * @return array<string, ?string>
+     */
+    public function current(): array
     {
         return $this->createObject(parent::current());
     }

library/Icingadb/Data/PivotTable.php

@@ -5,6 +5,7 @@
 namespace Icinga\Module\Icingadb\Data;
 
 use Icinga\Application\Icinga;
+use Icinga\Application\Web;
 use ipl\Orm\Query;
 use ipl\Stdlib\Contract\Paginatable;
 use ipl\Stdlib\Filter;
@@ -209,9 +210,10 @@ public function setYAxisHeader(string $yAxisHeader): self
      */
     protected function getPaginationParameter(string $axis, string $param, int $default = null): int
     {
-        $request = Icinga::app()->getRequest();
+        /** @var Web $app */
+        $app = Icinga::app();
 
-        $value = $request->getParam($param, '');
+        $value = $app->getRequest()->getParam($param, '');
         if (strpos($value, ',') > 0) {
             $parts = explode(',', $value, 2);
             return intval($parts[$axis === 'x' ? 0 : 1]);

library/Icingadb/Hook/ActionsHook/ObjectActionsHook.php

@@ -40,11 +40,9 @@ final public static function loadActions(Model $object): HtmlElement
     {
         switch (true) {
             case $object instanceof Host:
-                /** @var HostActionsHook $hook */
                 $hookName = 'Icingadb\\HostActions';
                 break;
             case $object instanceof Service:
-                /** @var ServiceActionsHook $hook */
                 $hookName = 'Icingadb\\ServiceActions';
                 break;
             default:
@@ -54,6 +52,8 @@ final public static function loadActions(Model $object): HtmlElement
         }
 
         $list = new HtmlElement('ul', Attributes::create(['class' => 'object-detail-actions']));
+
+        /** @var HostActionsHook|ServiceActionsHook $hook */
         foreach (Hook::all($hookName) as $hook) {
             try {
                 foreach ($hook->getActionsForObject($object) as $link) {

library/Icingadb/Hook/CustomVarRendererHook.php

@@ -73,7 +73,7 @@ final public static function prepareForObject(Model $object): Closure
             }
         }
 
-        return function (string $key, $value) use ($hooks, $object) {
+        return function (string $key, $value) use ($hooks) {
             $newKey = $key;
             $newValue = $value;
             $group = null;

library/Icingadb/Hook/ExtensionHook/ObjectDetailExtensionHook.php

@@ -43,23 +43,18 @@ final public static function loadExtensions(Model $object): array
     {
         switch (true) {
             case $object instanceof Host:
-                /** @var HostDetailExtensionHook $hook */
                 $hookName = 'Icingadb\\HostDetailExtension';
                 break;
             case $object instanceof Service:
-                /** @var ServiceDetailExtensionHook $hook */
                 $hookName = 'Icingadb\\ServiceDetailExtension';
                 break;
             case $object instanceof User:
-                /** @var UserDetailExtensionHook $hook */
                 $hookName = 'Icingadb\\UserDetailExtension';
                 break;
             case $object instanceof Usergroup:
-                /** @var UsergroupDetailExtensionHook $hook */
                 $hookName = 'Icingadb\\UsergroupDetailExtension';
                 break;
             case $object instanceof History:
-                /** @var EventDetailExtensionHook $hook */
                 $hookName = 'Icingadb\\EventDetailExtension';
                 break;
             default:
@@ -70,6 +65,14 @@ final public static function loadExtensions(Model $object): array
 
         $extensions = [];
         $lastUsedLocations = [];
+
+        /**
+         * @var $hook HostDetailExtensionHook
+         * @var $hook ServiceDetailExtensionHook
+         * @var $hook UserDetailExtensionHook
+         * @var $hook UsergroupDetailExtensionHook
+         * @var $hook EventDetailExtensionHook
+         */
         foreach (Hook::all($hookName) as $hook) {
             $location = $hook->getLocation();
             if ($location < 0) {

library/Icingadb/Hook/ExtensionHook/ObjectsDetailExtensionHook.php

@@ -39,11 +39,9 @@ final public static function loadExtensions(string $objectType, Query $query, Fi
     {
         switch ($objectType) {
             case 'host':
-                /** @var HostsDetailExtensionHook $hook */
                 $hookName = 'Icingadb\\HostsDetailExtension';
                 break;
             case 'service':
-                /** @var ServicesDetailExtensionHook $hook */
                 $hookName = 'Icingadb\\ServicesDetailExtension';
                 break;
             default:
@@ -54,6 +52,7 @@ final public static function loadExtensions(string $objectType, Query $query, Fi
 
         $extensions = [];
         $lastUsedLocations = [];
+        /** @var HostsDetailExtensionHook|ServicesDetailExtensionHook $hook */
         foreach (Hook::all($hookName) as $hook) {
             $location = $hook->getLocation();
             if ($location < 0) {

library/Icingadb/Model/CheckcommandArgument.php

@@ -70,6 +70,6 @@ public function createBehaviors(Behaviors $behaviors)
     public function createRelations(Relations $relations)
     {
         $relations->belongsTo('environment', Environment::class);
-        $relations->belongsTo('checkcommand', CheckCommand::class);
+        $relations->belongsTo('checkcommand', Checkcommand::class);
     }
 }

library/Icingadb/Model/CheckcommandCustomvar.php

@@ -43,7 +43,7 @@ public function createBehaviors(Behaviors $behaviors)
     public function createRelations(Relations $relations)
     {
         $relations->belongsTo('environment', Environment::class);
-        $relations->belongsTo('checkcommand', CheckCommand::class);
+        $relations->belongsTo('checkcommand', Checkcommand::class);
         $relations->belongsTo('customvar', Customvar::class);
         $relations->belongsTo('customvar_flat', CustomvarFlat::class)
             ->setCandidateKey('customvar_id')

library/Icingadb/Model/CheckcommandEnvvar.php

@@ -56,6 +56,6 @@ public function createBehaviors(Behaviors $behaviors)
     public function createRelations(Relations $relations)
     {
         $relations->belongsTo('environment', Environment::class);
-        $relations->belongsTo('checkcommand', CheckCommand::class);
+        $relations->belongsTo('checkcommand', Checkcommand::class);
     }
 }

library/Icingadb/Model/HostState.php

@@ -67,21 +67,13 @@ public function createRelations(Relations $relations)
             ->setJoinType('LEFT');
     }
 
-    /**
-     * Get the host state as the textual representation
-     *
-     * @return string
-     */
+
     public function getStateText(): string
     {
         return HostStates::text($this->soft_state);
     }
 
-    /**
-     * Get the host state as the translated textual representation
-     *
-     * @return string
-     */
+
     public function getStateTextTranslated(): string
     {
         return HostStates::text($this->soft_state);

library/Icingadb/Model/ServiceState.php

@@ -64,21 +64,11 @@ public function createRelations(Relations $relations)
             ->setJoinType('LEFT');
     }
 
-    /**
-     * Get the host state as the textual representation
-     *
-     * @return string
-     */
     public function getStateText(): string
     {
         return ServiceStates::text($this->soft_state);
     }
 
-    /**
-     * Get the host state as the translated textual representation
-     *
-     * @return string
-     */
     public function getStateTextTranslated(): string
     {
         return ServiceStates::text($this->soft_state);