Upgrade phpstan to v1.0 (#1686)

Author: mvorisek

composer.json

@@ -72,7 +72,7 @@
         "instaclick/php-webdriver": "^1.4.7",
         "johnkary/phpunit-speedtrap": "^3.3",
         "phpstan/extension-installer": "^1.1",
-        "phpstan/phpstan": "^0.12.82",
+        "phpstan/phpstan": "^1.0",
         "phpunit/phpunit": "^9.5.5",
         "symfony/console": "^4.4.30 || ^5.3.7",
         "symfony/css-selector": "^4.4.24 || ^5.2.9",

demos/_includes/Counter.php

@@ -9,7 +9,7 @@
  */
 class Counter extends \Atk4\Ui\Form\Control\Line
 {
-    public $content = 20; // default
+    public $content = '20'; // default
 
     protected function init(): void
     {

phpstan.neon.dist

@@ -127,11 +127,6 @@ class App
     /** @var View[] Modal view that need to be rendered using json output. */
     private $portals = [];
 
-    /**
-     * @var bool whether or not semantic-ui vue has been initialised
-     */
-    private $is_sui_init = false;
-
     /**
      * @var string used in method App::url to build the url
      *
@@ -227,7 +222,7 @@ static function (int $severity, string $msg, string $file, int $line): bool {
         }
 
         // Set up UI persistence
-        if (!isset($this->ui_persistence)) {
+        if ($this->ui_persistence === null) {
             $this->ui_persistence = new UiPersistence();
         }
 
@@ -484,7 +479,7 @@ public function initLayout($seed)
         $layout = Layout::fromSeed($seed);
         $layout->setApp($this);
 
-        if (!$this->html) {
+        if ($this->html === null) {
             $this->html = new View(['defaultTemplate' => 'html.html']);
             $this->html->setApp($this);
             $this->html->invokeInit();
@@ -535,9 +530,6 @@ public function initIncludes()
      */
     public function addStyle($style)
     {
-        if (!$this->html) {
-            throw new Exception('App does not know how to add style');
-        }
         $this->html->template->dangerouslyAppendHtml('HEAD', $this->getTag('style', $style));
     }
 
@@ -568,11 +560,6 @@ public function run()
             $this->hook(self::HOOK_BEFORE_RENDER);
             $this->is_rendering = true;
 
-            // if no App layout set
-            if (!isset($this->html)) {
-                throw new Exception('App layout should be set.');
-            }
-
             $this->html->template->set('title', $this->title);
             $this->html->renderAll();
             $this->html->template->dangerouslyAppendHtml('HEAD', $this->html->getJs());

src/App.php

@@ -163,16 +163,9 @@ public function setModel(\Atk4\Data\Model $model, $fields = null)
     /**
      * Return Field decorator associated with
      * the form's field.
-     *
-     * @return \Atk4\Ui\Form\Control
      */
     public function getControl(string $name): Control
     {
-        if (empty($this->form)) {
-            throw (new Exception('Incorrect value for $form'))
-                ->addMoreInfo('form', $this->form);
-        }
-
         return $this->form->getControl($name);
     }
 

src/Form/AbstractLayout.php

@@ -177,7 +177,7 @@ public function getInput()
      */
     public function getValue()
     {
-        return isset($this->field)
+        return $this->field !== null
             ? (is_array($this->field->get()) ? implode(',', $this->field->get()) : $this->field->get())
             : parent::getValue();
     }
@@ -247,7 +247,7 @@ protected function htmlRenderValue(): void
         }
 
         // model set? use this, else values property
-        if (isset($this->model)) {
+        if ($this->model !== null) {
             if ($this->renderRowFunction) {
                 foreach ($this->model as $row) {
                     $this->_addCallBackRow($row);

src/Form/Control/Dropdown.php

@@ -97,7 +97,7 @@ public function setInputAttr($attr, $value = null)
      */
     public function getValue()
     {
-        return isset($this->field)
+        return $this->field !== null
                     ? $this->getApp()->ui_persistence->typecastSaveField($this->field, $this->field->get())
                     : ($this->content ?? '');
     }

src/Form/Control/Input.php

@@ -68,7 +68,7 @@ class Lookup extends Input
      * true = will use "Add new" label
      * string = will use your string
      *
-     * @var bool|string|null
+     * @var bool|string|array|null
      */
     public $plus = false;
 
@@ -249,17 +249,22 @@ protected function initQuickNewRecord()
             return;
         }
 
-        $this->plus = is_bool($this->plus) ? 'Add New' : $this->plus;
+        if ($this->plus === true) {
+            $this->plus = 'Add New';
+        }
 
-        $this->plus = is_string($this->plus) ? ['button' => $this->plus] : $this->plus;
+        if (is_string($this->plus)) {
+            $this->plus = ['button' => $this->plus];
+        }
 
         $buttonSeed = $this->plus['button'] ?? [];
-
-        $buttonSeed = is_string($buttonSeed) ? ['content' => $buttonSeed] : $buttonSeed;
+        if (is_string($buttonSeed)) {
+            $buttonSeed = ['content' => $buttonSeed];
+        }
 
         $defaultSeed = [\Atk4\Ui\Button::class, 'disabled' => ($this->disabled || $this->readonly)];
 
-        $this->action = Factory::factory(array_merge($defaultSeed, (array) $buttonSeed));
+        $this->action = Factory::factory(array_merge($defaultSeed, $buttonSeed));
 
         if ($this->form) {
             $vp = \Atk4\Ui\VirtualPage::addTo($this->form);

src/Form/Control/Lookup.php

@@ -554,7 +554,7 @@ protected function renderView(): void
                     'maxDepth' => $this->maxDepth,
                     'query' => $this->query,
                     'name' => $this->short_name,
-                    'labels' => $this->labels ?? null,
+                    'labels' => $this->labels ?: null,
                     'form' => $this->form->formElement->name,
                     'debug' => $this->options['debug'] ?? false,
                 ],

src/Form/Control/ScopeBuilder.php

@@ -84,9 +84,6 @@ class Upload extends Input
     public const UPLOAD_ACTION = 'upload';
     public const DELETE_ACTION = 'delete';
 
-    /** @var bool check if callback is trigger by one of the action. */
-    private $_isCbRunning = false;
-
     protected function init(): void
     {
         parent::init();

src/Form/Control/Upload.php

@@ -18,9 +18,6 @@ class Grid extends View
 {
     use HookTrait;
 
-    /** @const string not used, make it public if needed or drop it */
-    private const HOOK_ON_USER_ACTION = self::class . '@onUserAction';
-
     /**
      * Will be initialized to Menu object, however you can set this to false to disable menu.
      *

src/Grid.php

@@ -169,7 +169,7 @@ protected function renderView(): void
         // empty message
         if (!$this->_rendered_rows_count) {
             if (!$this->jsPaginator || !$this->jsPaginator->getPage()) {
-                $empty = isset($this->t_empty) ? $this->t_empty->renderToHtml() : '';
+                $empty = $this->t_empty !== null ? $this->t_empty->renderToHtml() : '';
                 if ($this->template->hasTag('rows')) {
                     $this->template->dangerouslyAppendHtml('rows', $empty);
                 } else {

src/Lister.php

@@ -71,7 +71,7 @@ protected function _typecastSaveField(\Atk4\Data\Field $field, $value): string
                     $format = $field->persist_format ?: $formats[$field->type];
 
                     // datetime only - set to persisting timezone
-                    if ($field->type === 'datetime' && isset($field->persist_timezone)) {
+                    if ($field->type === 'datetime') {
                         $value = new \DateTime($value->format('Y-m-d H:i:s.u'), $value->getTimezone());
                         $value->setTimezone(new \DateTimeZone($field->persist_timezone));
                     }
@@ -111,7 +111,7 @@ protected function _typecastLoadField(\Atk4\Data\Field $field, $value)
 
                 // datetime only - set from persisting timezone
                 $valueStr = is_object($value) ? $this->_typecastSaveField($field, $value) : $value;
-                if ($field->type === 'datetime' && isset($field->persist_timezone)) {
+                if ($field->type === 'datetime') {
                     $value = $dt_class::createFromFormat($format, $valueStr, new $tz_class($field->persist_timezone));
                     if ($value === false) {
                         throw (new Exception('Incorrectly formatted datetime'))

src/Persistence/Ui.php

@@ -18,7 +18,7 @@
  */
 class Labels extends Table\Column
 {
-    /** @var array Array of allowed values. This have precedence over->values */
+    /** @var array|null Array of allowed values. This have precedence over->values */
     public $values;
 
     /**

src/Table/Column/Labels.php

@@ -255,7 +255,7 @@ protected function getAddMenuItem(UserAction $action): array
      */
     protected function getAddActionCaption(UserAction $action): string
     {
-        return 'Add ' . $action->getModel()->caption ?? '';
+        return 'Add' . ($action->getModel()->caption ? ' ' . $action->getModel()->caption : '');
     }
 
     // Generate id for a model user action.

src/UserAction/ExecutorFactory.php

@@ -29,7 +29,7 @@ class PanelExecutor extends Right implements JsExecutorInterface
     public $dynamic = [];
     public $hasClickAway = false;
 
-    /** @var string */
+    /** @var string|null */
     public $title;
 
     /** @var Header */

src/UserAction/PanelExecutor.php

@@ -29,7 +29,7 @@ class VpExecutor extends View implements JsExecutorInterface
     /** @var VirtualPage */
     protected $vp;
 
-    /** @var string */
+    /** @var string|null */
     public $title;
 
     /** @var Header */

src/UserAction/VpExecutor.php

@@ -14,8 +14,6 @@
  */
 class View extends AbstractView implements JsExpressionable
 {
-    // {{{ Properties of the class
-
     /**
      * When you call render() this will be populated with JavaScript
      * chains.
@@ -102,7 +100,7 @@ class View extends AbstractView implements JsExpressionable
     /**
      * Set static contents of this view.
      *
-     * @var string|false
+     * @var string|false|null
      */
     public $content;
 
@@ -113,9 +111,8 @@ class View extends AbstractView implements JsExpressionable
      */
     public $element;
 
-    /** @var ExecutorFactory Seed class name */
-    public $executorFactory;
-    // }}}
+    /** @var ExecutorFactory|null Seed class name */
+    protected $executorFactory;
 
     // {{{ Setting Things up
 
@@ -711,7 +708,7 @@ protected function recursiveRender(): void
             }
         }
 
-        if (isset($this->content) && $this->content !== false) {
+        if ($this->content !== null && $this->content !== false) {
             $this->template->append('Content', $this->content);
         }
     }

src/View.php

@@ -8,6 +8,7 @@
 use Atk4\Ui\AbstractView;
 use Atk4\Ui\Callback;
 use Atk4\Ui\VirtualPage;
+use Mvorisek\Atk4\Hintable\Phpstan\PhpstanUtil;
 
 class AppMock extends \Atk4\Ui\App
 {
@@ -17,6 +18,8 @@ class AppMock extends \Atk4\Ui\App
     public function terminate($output = '', array $headers = []): void
     {
         $this->terminated = true;
+
+        PhpstanUtil::fakeNeverReturn();
     }
 
     /**

tests/CallbackTest.php

@@ -9,6 +9,7 @@
 use Atk4\Ui\App;
 use Atk4\Ui\Callback;
 use Atk4\Ui\Form;
+use Mvorisek\Atk4\Hintable\Phpstan\PhpstanUtil;
 
 class FormTest extends TestCase
 {
@@ -183,5 +184,7 @@ class AppFormTestMock extends App
     public function terminate($output = '', array $headers = []): void
     {
         $this->output = $output;
+
+        PhpstanUtil::fakeNeverReturn();
     }
 }