workflows: 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,26 @@ 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/icingadb-web.git vendor/icingadb-web
+          git clone --depth 1 https://github.com/Icinga/icingaweb2-module-director.git vendor/icingaweb2-module-director
+          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
 
+      - 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/clicommands/ProcessCommand.php

@@ -110,8 +110,8 @@ public function checkAction()
             exit(1);
         }
 
+        $name = $this->params->get('config');
         try {
-            $name = $this->params->get('config');
             if ($name === null) {
                 $name = $this->getFirstProcessName();
             }
@@ -132,8 +132,8 @@ public function checkAction()
             }
         }
 
-        /** @var BpNode $node */
         try {
+            /** @var BpNode $node */
             $node = $bp->getNode($nodeName);
             if (Module::exists('icingadb')
                 && (! $bp->hasBackendName() && IcingadbSupport::useIcingaDbAsBackend())

application/controllers/HostController.php

@@ -7,6 +7,7 @@
 use Icinga\Module\Businessprocess\ProvidedHook\Icingadb\IcingadbSupport;
 use Icinga\Module\Icingadb\Model\Host;
 use Icinga\Module\Monitoring\Controller;
+use Icinga\Module\Monitoring\DataView\DataView;
 use Icinga\Web\Url;
 use ipl\Stdlib\Filter;
 
@@ -54,7 +55,8 @@ public function showAction()
                 ->from('hoststatus', array('host_name'))
                 ->where('host_name', $hostName);
 
-            if ($this->applyRestriction('monitoring/filter/objects', $query)->fetchRow() !== false) {
+            $this->applyRestriction('monitoring/filter/objects', $query);
+            if ($query->fetchRow() !== false) {
                 $this->redirectNow(Url::fromPath('monitoring/host/show')->setParams($this->params));
             }
         }

application/controllers/ProcessController.php

@@ -35,6 +35,7 @@
 use ipl\Html\TemplateString;
 use ipl\Html\Text;
 use ipl\Web\Control\SortControl;
+use ipl\Web\FormElement\TermInput;
 use ipl\Web\Widget\Link;
 use ipl\Web\Widget\Icon;
 
@@ -199,7 +200,7 @@ protected function prepareControls($bp, $renderer)
         $controls->add(Breadcrumb::create(clone $renderer));
         if (! $this->showFullscreen && ! $this->view->compact) {
             $controls->add(
-                new RenderedProcessActionBar($bp, $renderer, $this->Auth(), $this->url())
+                new RenderedProcessActionBar($bp, $renderer, $this->url())
             );
         }
 
@@ -282,7 +283,9 @@ protected function loadActionForm(BpConfig $bp, Node $node = null)
                 ->handleRequest($this->getServerRequest());
 
             if ($form->hasElement('children')) {
-                foreach ($form->getElement('children')->prepareMultipartUpdate($this->getServerRequest()) as $update) {
+                /** @var TermInput $childrenElement */
+                $childrenElement = $form->getElement('children');
+                foreach ($childrenElement->prepareMultipartUpdate($this->getServerRequest()) as $update) {
                     if (! is_array($update)) {
                         $update = [$update];
                     }

application/controllers/ServiceController.php

@@ -7,6 +7,7 @@
 use Icinga\Module\Businessprocess\ProvidedHook\Icingadb\IcingadbSupport;
 use Icinga\Module\Icingadb\Model\Service;
 use Icinga\Module\Monitoring\Controller;
+use Icinga\Module\Monitoring\DataView\DataView;
 use Icinga\Web\Url;
 use ipl\Stdlib\Filter;
 
@@ -61,7 +62,8 @@ public function showAction()
                 ->where('host_name', $hostName)
                 ->where('service_description', $serviceName);
 
-            if ($this->applyRestriction('monitoring/filter/objects', $query)->fetchRow() !== false) {
+            $this->applyRestriction('monitoring/filter/objects', $query);
+            if ($query->fetchRow() !== false) {
                 $this->redirectNow(Url::fromPath('monitoring/service/show')->setParams($this->params));
             }
         }

application/forms/AddNodeForm.php

@@ -378,9 +378,11 @@ protected function onSuccess()
 
             $changes->createNode(BpConfig::escapeName($this->getValue('name')), $properties);
         } else {
+            /** @var TermInput $term */
+            $term = $this->getElement('children');
             $children = array_unique(array_map(function ($term) {
                 return $term->getSearchValue();
-            }, $this->getElement('children')->getTerms()));
+            }, $term->getTerms()));
 
             if ($nodeType === 'host' || $nodeType === 'service') {
                 $stateOverrides = $this->getValue('stateOverrides');

application/forms/BpUploadForm.php

@@ -155,7 +155,7 @@ protected function getTempDir()
 
     protected function processUploadedSource()
     {
-        /** @var \Zend_Form_Element_File $el */
+        /** @var ?\Zend_Form_Element_File $el */
         $el = $this->getElement('uploaded_file');
 
         if ($el && $this->hasBeenSent()) {

application/forms/DeleteNodeForm.php

@@ -6,19 +6,22 @@
 use Icinga\Module\Businessprocess\Modification\ProcessChanges;
 use Icinga\Module\Businessprocess\Node;
 use Icinga\Module\Businessprocess\Web\Form\BpConfigBaseForm;
+use Icinga\Web\View;
 
 class DeleteNodeForm extends BpConfigBaseForm
 {
     /** @var Node */
     protected $node;
 
-    /** @var BpNode */
+    /** @var ?BpNode */
     protected $parentNode;
 
     public function setup()
     {
         $node = $this->node;
         $nodeName = $node->getAlias() ?? $node->getName();
+
+        /** @var View $view */
         $view = $this->getView();
         $this->addHtml(
             '<h2>' . $view->escape(

application/forms/MoveNodeForm.php

@@ -3,6 +3,7 @@
 namespace Icinga\Module\Businessprocess\Forms;
 
 use Icinga\Application\Icinga;
+use Icinga\Application\Web;
 use Icinga\Exception\Http\HttpException;
 use Icinga\Module\Businessprocess\BpConfig;
 use Icinga\Module\Businessprocess\BpNode;
@@ -136,7 +137,9 @@ public function onSuccess()
             );
         } catch (ModificationError $e) {
             $this->notifyError($e->getMessage());
-            Icinga::app()->getResponse()
+            /** @var Web $app */
+            $app = Icinga::app();
+            $app->getResponse()
                 // Web 2's JS forces a content update for non-200s. Our own JS
                 // can't prevent this, hence we're not making this a 400 :(
                 //->setHttpResponseCode(400)

application/forms/ProcessForm.php

@@ -7,6 +7,7 @@
 use Icinga\Module\Businessprocess\Node;
 use Icinga\Module\Businessprocess\Web\Form\BpConfigBaseForm;
 use Icinga\Web\Notification;
+use Icinga\Web\View;
 
 class ProcessForm extends BpConfigBaseForm
 {
@@ -16,8 +17,11 @@ class ProcessForm extends BpConfigBaseForm
     public function setup()
     {
         if ($this->node !== null) {
+            /** @var View $view */
+            $view = $this->getView();
+
             $this->addHtml(
-                '<h2>' . $this->getView()->escape(
+                '<h2>' . $view->escape(
                     sprintf($this->translate('Modify "%s"'), $this->node->getAlias())
                 ) . '</h2>'
             );

application/forms/SimulationForm.php

@@ -5,13 +5,14 @@
 use Icinga\Module\Businessprocess\MonitoredNode;
 use Icinga\Module\Businessprocess\Simulation;
 use Icinga\Module\Businessprocess\Web\Form\BpConfigBaseForm;
+use Icinga\Web\View;
 
 class SimulationForm extends BpConfigBaseForm
 {
     /** @var MonitoredNode */
     protected $node;
 
-    /** @var MonitoredNode */
+    /** @var ?MonitoredNode */
     protected $simulatedNode;
 
     /** @var Simulation */
@@ -36,6 +37,7 @@ public function setup()
             $node = $this->node;
         }
 
+        /** @var View $view */
         $view = $this->getView();
         if ($hasSimulation) {
             $title = $this->translate('Modify simulation for %s');

library/Businessprocess/BpConfig.php

@@ -226,7 +226,7 @@ public function countChanges()
     /**
      * Whether changes have been applied to this configuration
      *
-     * @return int
+     * @return bool
      */
     public function hasChanges()
     {
@@ -631,7 +631,7 @@ protected function storage()
 
     /**
      * @param   string  $name
-     * @return  Node
+     * @return  MonitoredNode|BpNode
      * @throws  Exception
      */
     public function getNode($name)

library/Businessprocess/BpNode.php

@@ -21,7 +21,7 @@ class BpNode extends Node
 
     protected $display = 0;
 
-    /** @var  Node[] */
+    /** @var  ?Node[] */
     protected $children;
 
     /** @var array */
@@ -623,18 +623,14 @@ public function operatorHtml()
         switch ($this->getOperator()) {
             case self::OP_AND:
                 return 'AND';
-                break;
             case self::OP_OR:
                 return 'OR';
             case self::OP_XOR:
                 return 'XOR';
-                break;
             case self::OP_NOT:
                 return 'NOT';
-                break;
             case self::OP_DEGRADED:
                 return 'DEG';
-                break;
             default:
                 // MIN
                 $this->assertNumericOperator();

library/Businessprocess/Common/Sort.php

@@ -10,10 +10,10 @@
 
 trait Sort
 {
-    /** @var string Current sort specification */
+    /** @var ?string Current sort specification */
     protected $sort;
 
-    /** @var callable Actual sorting function */
+    /** @var ?callable Actual sorting function */
     protected $sortFn;
 
     /**
@@ -29,14 +29,18 @@ public function getSort(): ?string
     /**
      * Set the sort specification
      *
-     * @param string $sort
+     * @param ?string $sort
      *
      * @return $this
      *
      * @throws InvalidArgumentException When sorting according to the specified specification is not possible
      */
-    public function setSort(string $sort): self
+    public function setSort(?string $sort): self
     {
+        if (empty($sort)) {
+            return $this;
+        }
+
         list($sortBy, $direction) = Str::symmetricSplit($sort, ' ', 2, 'asc');
 
         switch ($sortBy) {