Adding PHPStan

phpfui · phpfui · commit ebbb385c66ed · 2022-08-11T16:23:01.000-04:00
diff --git a/composer.json b/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"
 		}
 }
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -0,0 +1,8 @@
+parameters:
+	level: 4
+	errorFormat: raw
+	editorUrl: '%%file%% %%line%% %%column%%: %%error%%'
+	paths:
+		- src
+	excludePaths:
+		- src/PHPFUI/InstaDoc/Tests/*
diff --git a/src/PHPFUI/InstaDoc/Controller.php b/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;
 		}
 
 	/**
diff --git a/src/PHPFUI/InstaDoc/FileManager.php b/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;
 		}
 
 	/**
diff --git a/src/PHPFUI/InstaDoc/MarkDownParser.php b/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}");
 
diff --git a/src/PHPFUI/InstaDoc/Page.php b/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);
diff --git a/src/PHPFUI/InstaDoc/PageInterface.php b/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;
 	}
diff --git a/src/PHPFUI/InstaDoc/Section/Doc.php b/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();
 
diff --git a/src/PHPFUI/InstaDoc/Section/Functions.php b/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();
 
diff --git a/src/PHPFUI/InstaDoc/Section/Git.php b/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);

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,7 @@`
`29`	`29`	`"phpfui/html-unit-tester": "^1.0",`
`30`	`30`	`"roave/security-advisories": "dev-latest",`
`31`	`31`	`"phpfui/phpunit-syntax-coverage": "^1.0",`
`32`		`- "friendsofphp/php-cs-fixer": "^3.0"`
	`32`	`+ "friendsofphp/php-cs-fixer": "^3.0",`
	`33`	`+ "phpstan/phpstan": "^1.8"`
`33`	`34`	`}`
`34`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ class Controller`
`75`	`75`
`76`	`76`	`private string $homeUrl = '#';`
`77`	`77`
`78`		`- private ?\PHPFUI\AccordionMenu $menu = null;`
	`78`	`+ private ?\PHPFUI\Menu $menu = null;`
`79`	`79`
`80`	`80`	`private \PHPFUI\InstaDoc\PageInterface $page;`
`81`	`81`
`@@ -150,7 +150,7 @@ public function display(array $classPagesToShow = Controller::VALID_CLASS_PAGES,`
`150`	`150`	`}`
`151`	`151`	`$section = new Section($this);`
`152`	`152`
`153`		`- $div = new \PHPFUI\GridX('div');`
	`153`	`+ $div = new \PHPFUI\GridX();`
`154`	`154`	`$div->add($section->getBreadCrumbs($fullClassName));`
`155`	`155`
`156`	`156`	`$cell = new \PHPFUI\Cell();`
`@@ -541,6 +541,8 @@ public function getUrl(array $parameters) : string`
`541`	`541`	`public function setAccessTabs(array $tabs) : Controller`
`542`	`542`	`{`
`543`	`543`	`$this->accessTabs = $tabs;`
	`544`	`+`
	`545`	`+ return $this;`
`544`	`546`	`}`
`545`	`547`
`546`	`548`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -126,20 +126,19 @@ public function getComposerPath() : string`
`126`	`126`	`/**`
`127`	`127`	`* Load the namespace index.`
`128`	`128`	`*`
`129`		`- * @return true if file exists, false if generated`
	`129`	`+ * @return bool true if file exists, false if generated`
`130`	`130`	`*/`
`131`	`131`	`public function load(string $fileName = '') : bool`
`132`	`132`	`{`
`133`		`- $returnValue = true;`
`134`		`-`
`135`	`133`	`if (! \PHPFUI\InstaDoc\NamespaceTree::load($this->getSerializedName($fileName)))`
`136`	`134`	`{`
`137`	`135`	`$this->rescan();`
`138`	`136`	`$this->save();`
`139`		`- $returnValue = false;`
	`137`	`+`
	`138`	`+ return false;`
`140`	`139`	`}`
`141`	`140`
`142`		`- return $returnValue;`
	`141`	`+ return true;`
`143`	`142`	`}`
`144`	`143`
`145`	`144`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public function text(string $markdown) : string`
`43`	`43`	`$highlighted = $hl->highlight('php', $child->text());`
`44`	`44`	`$block->setAttribute('class', 'hljs ' . $highlighted->language);`
`45`	`45`	`$block->parentNode()->setAttribute('class', 'hljs ' . $highlighted->language);`
`46`		`- $child->plainText = \htmlspecialchars_decode($highlighted->value);`
	`46`	`+ $child->plaintext = \htmlspecialchars_decode($highlighted->value);`
`47`	`47`	`}`
`48`	`48`	`$div->add("{$dom}");`
`49`	`49`
Original file line number	Diff line number	Diff line change
`@@ -12,8 +12,6 @@ class Page extends \PHPFUI\Page implements \PHPFUI\InstaDoc\PageInterface`
`12`	`12`
`13`	`13`	`private \PHPFUI\Cell $mainColumn;`
`14`	`14`
`15`		`- private \PHPFUI\Menu $menu;`
`16`		`-`
`17`	`15`	`public function __construct(\PHPFUI\InstaDoc\Controller $controller)`
`18`	`16`	`{`
`19`	`17`	`parent::__construct();`
`@@ -33,8 +31,6 @@ public function addBody($item) : PageInterface`
`33`	`31`
`34`	`32`	`public function create(\PHPFUI\Menu $menu) : void`
`35`	`33`	`{`
`36`		`- $this->menu = $menu;`
`37`		`-`
`38`	`34`	`$link = new \PHPFUI\Link($this->homeUrl, $this->getPageName(), false);`
`39`	`35`
`40`	`36`	`$titleBar = new \PHPFUI\TitleBar($link);`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace PHPFUI\InstaDoc;`
`4`	`4`
`5`		`-interface PageInterface`
	`5`	`+interface PageInterface extends \PHPFUI\Interfaces\Page`
`6`	`6`	`{`
`7`	`7`	`public function __construct(Controller $controller);`
`8`	`8`
`@@ -15,4 +15,6 @@ public function create(\PHPFUI\Menu $menu) : void;`
`15`	`15`	`public function setGenerating(string $generating) : PageInterface;`
`16`	`16`
`17`	`17`	`public function setHomeUrl(string $url) : PageInterface;`
	`18`	`+`
	`19`	`+ public static function setDebug(int $level = 0) : void;`
`18`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ public function __construct(\PHPFUI\InstaDoc\Controller $controller)`
`11`	`11`	`parent::__construct($controller);`
`12`	`12`	`}`
`13`	`13`
`14`		`- public function generate(\PHPFUI\Instadoc\PageInterface $page, string $fullClassPath) : \PHPFUI\Container`
	`14`	`+ public function generate(\PHPFUI\InstaDoc\PageInterface $page, string $fullClassPath) : \PHPFUI\Container`
`15`	`15`	`{`
`16`	`16`	`$container = new \PHPFUI\Container();`
`17`	`17`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ public function __construct(\PHPFUI\InstaDoc\Controller $controller)`
`9`	`9`	`parent::__construct($controller);`
`10`	`10`	`}`
`11`	`11`
`12`		`- public function generate(\PHPFUI\Instadoc\PageInterface $page, string $fullClassPath) : \PHPFUI\Container`
	`12`	`+ public function generate(\PHPFUI\InstaDoc\PageInterface $page, string $fullClassPath) : \PHPFUI\Container`
`13`	`13`	`{`
`14`	`14`	`$container = new \PHPFUI\Container();`
`15`	`15`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ public function generate(\PHPFUI\InstaDoc\PageInterface $page, string $fullClass`
`8`	`8`	`{`
`9`	`9`	`$container = new \PHPFUI\Container();`
`10`	`10`
`11`		`- $gitPage = $this->controller->getParameter(\PHPFUI\InstaDoc\Controller::GIT_ONPAGE, 0);`
	`11`	`+ $gitPage = (int)$this->controller->getParameter(\PHPFUI\InstaDoc\Controller::GIT_ONPAGE, 0);`
`12`	`12`	`$limit = $this->controller->getParameter(\PHPFUI\InstaDoc\Controller::GIT_LIMIT, 20);`
`13`	`13`
`14`	`14`	`$offset = $this->controller->getGitFileOffset();`
`@@ -51,6 +51,8 @@ public function generate(\PHPFUI\InstaDoc\PageInterface $page, string $fullClass`
`51`	`51`	`return $container;`
`52`	`52`	`}`
`53`	`53`
	`54`	`+ $count = (int)$count;`
	`55`	`+ $limit = (int)$limit;`
`54`	`56`	`$lastPage = (int)(($count - 1) / $limit) + 1;`
`55`	`57`
`56`	`58`	`$log->setOffset($gitPage * $limit);`