Adding PHPStan

Author: phpfui

composer.json

@@ -29,6 +29,7 @@
 "phpfui/html-unit-tester": "^1.0",
 "roave/security-advisories": "dev-latest",
 "phpfui/phpunit-syntax-coverage": "^1.0",
-"friendsofphp/php-cs-fixer": "^3.0"
+"friendsofphp/php-cs-fixer": "^3.0",
+"phpstan/phpstan": "^1.8"
 }
 }

phpstan.neon.dist

@@ -0,0 +1,8 @@
+parameters:
+level: 4
+errorFormat: raw
+editorUrl: '%%file%% %%line%% %%column%%: %%error%%'
+paths:
+- src
+excludePaths:
+- src/PHPFUI/InstaDoc/Tests/*

src/PHPFUI/InstaDoc/Controller.php

@@ -75,7 +75,7 @@ class Controller
 
 private string $homeUrl = '#';
 
-private ?\PHPFUI\AccordionMenu $menu = null;
+private ?\PHPFUI\Menu $menu = null;
 
 private \PHPFUI\InstaDoc\PageInterface $page;
 
@@ -150,7 +150,7 @@ public function display(array $classPagesToShow = Controller::VALID_CLASS_PAGES,
 }
 $section = new Section($this);
 
-$div = new \PHPFUI\GridX('div');
+$div = new \PHPFUI\GridX();
 $div->add($section->getBreadCrumbs($fullClassName));
 
 $cell = new \PHPFUI\Cell();
@@ -541,6 +541,8 @@ public function getUrl(array $parameters) : string
 public function setAccessTabs(array $tabs) : Controller
 {
 $this->accessTabs = $tabs;
+
+return $this;
 }
 
 /**

src/PHPFUI/InstaDoc/FileManager.php

@@ -126,20 +126,19 @@ public function getComposerPath() : string
 /**
  * Load the namespace index.
  *
- * @return true if file exists, false if generated
+ * @return bool true if file exists, false if generated
  */
 public function load(string $fileName = '') : bool
 {
-$returnValue = true;
-
 if (! \PHPFUI\InstaDoc\NamespaceTree::load($this->getSerializedName($fileName)))
 {
 $this->rescan();
 $this->save();
-$returnValue = false;
+
+return false;
 }
 
-return $returnValue;
+return true;
 }
 
 /**

src/PHPFUI/InstaDoc/MarkDownParser.php

@@ -43,7 +43,7 @@ public function text(string $markdown) : string
 $highlighted = $hl->highlight('php', $child->text());
 $block->setAttribute('class', 'hljs ' . $highlighted->language);
 $block->parentNode()->setAttribute('class', 'hljs ' . $highlighted->language);
-$child->plainText = \htmlspecialchars_decode($highlighted->value);
+$child->plaintext = \htmlspecialchars_decode($highlighted->value);
 }
 $div->add("{$dom}");
 

src/PHPFUI/InstaDoc/Page.php

@@ -12,8 +12,6 @@ class Page extends \PHPFUI\Page implements \PHPFUI\InstaDoc\PageInterface
 
 private \PHPFUI\Cell $mainColumn;
 
-private \PHPFUI\Menu $menu;
-
 public function __construct(\PHPFUI\InstaDoc\Controller $controller)
 {
 parent::__construct();
@@ -33,8 +31,6 @@ public function addBody($item) : PageInterface
 
 public function create(\PHPFUI\Menu $menu) : void
 {
-$this->menu = $menu;
-
 $link = new \PHPFUI\Link($this->homeUrl, $this->getPageName(), false);
 
 $titleBar = new \PHPFUI\TitleBar($link);

src/PHPFUI/InstaDoc/PageInterface.php

@@ -2,7 +2,7 @@
 
 namespace PHPFUI\InstaDoc;
 
-interface PageInterface
+interface PageInterface extends \PHPFUI\Interfaces\Page
 {
 public function __construct(Controller $controller);
 
@@ -15,4 +15,6 @@ public function create(\PHPFUI\Menu $menu) : void;
 public function setGenerating(string $generating) : PageInterface;
 
 public function setHomeUrl(string $url) : PageInterface;
+
+public static function setDebug(int $level = 0) : void;
 }

src/PHPFUI/InstaDoc/Section/Doc.php

@@ -11,7 +11,7 @@ public function __construct(\PHPFUI\InstaDoc\Controller $controller)
 parent::__construct($controller);
 }
 
-public function generate(\PHPFUI\Instadoc\PageInterface $page, string $fullClassPath) : \PHPFUI\Container
+public function generate(\PHPFUI\InstaDoc\PageInterface $page, string $fullClassPath) : \PHPFUI\Container
 {
 $container = new \PHPFUI\Container();
 

src/PHPFUI/InstaDoc/Section/Functions.php

@@ -9,7 +9,7 @@ public function __construct(\PHPFUI\InstaDoc\Controller $controller)
 parent::__construct($controller);
 }
 
-public function generate(\PHPFUI\Instadoc\PageInterface $page, string $fullClassPath) : \PHPFUI\Container
+public function generate(\PHPFUI\InstaDoc\PageInterface $page, string $fullClassPath) : \PHPFUI\Container
 {
 $container = new \PHPFUI\Container();
 

src/PHPFUI/InstaDoc/Section/Git.php

@@ -8,7 +8,7 @@ public function generate(\PHPFUI\InstaDoc\PageInterface $page, string $fullClass
 {
 $container = new \PHPFUI\Container();
 
-$gitPage = $this->controller->getParameter(\PHPFUI\InstaDoc\Controller::GIT_ONPAGE, 0);
+$gitPage = (int)$this->controller->getParameter(\PHPFUI\InstaDoc\Controller::GIT_ONPAGE, 0);
 $limit = $this->controller->getParameter(\PHPFUI\InstaDoc\Controller::GIT_LIMIT, 20);
 
 $offset = $this->controller->getGitFileOffset();
@@ -51,6 +51,8 @@ public function generate(\PHPFUI\InstaDoc\PageInterface $page, string $fullClass
 return $container;
 }
 
+$count = (int)$count;
+$limit = (int)$limit;
 $lastPage = (int)(($count - 1) / $limit) + 1;
 
 $log->setOffset($gitPage * $limit);