phpstan level 6

Author: phpfui

README.md

@@ -1,4 +1,4 @@
-# PHPFUI\InstaDoc Library [![Tests](https://github.com/phpfui/InstaDoc/actions/workflows/tests.yml/badge.svg)](https://github.com/phpfui/InstaDoc/actions?query=workflow%3Atests) [![Latest Packagist release](https://img.shields.io/packagist/v/phpfui/InstaDoc.svg)](https://packagist.org/packages/phpfui/InstaDoc) ![](https://img.shields.io/badge/PHPStan-level%205-brightgreen.svg?style=flat)
+# PHPFUI\InstaDoc Library [![Tests](https://github.com/phpfui/InstaDoc/actions/workflows/tests.yml/badge.svg)](https://github.com/phpfui/InstaDoc/actions?query=workflow%3Atests) [![Latest Packagist release](https://img.shields.io/packagist/v/phpfui/InstaDoc.svg)](https://packagist.org/packages/phpfui/InstaDoc) ![](https://img.shields.io/badge/PHPStan-level%206-brightgreen.svg?style=flat)
 
 ## A quick and easy way to add documentation to your PHP project
 

phpstan.neon.dist

@@ -1,5 +1,5 @@
 parameters:
-	level: 5
+	level: 6
 	errorFormat: raw
 	editorUrl: '%%file%% %%line%% %%column%%: %%error%%'
 	paths:

src/PHPFUI/InstaDoc/ChildClasses.php

@@ -8,7 +8,7 @@
 class ChildClasses
 	{
 	/**
-	 * @var array indexed by fqn of class containing array of fqn of children
+	 * @var array<string, array<string>> indexed by fqn of class containing array of fqn of children
 	 */
 	private static array $children = [];
 
@@ -47,7 +47,7 @@ public static function generate() : void
 		}
 
 	/**
-	 * Return the child classes for the passed fully qualified name
+	 * @return array<string> the child classes for the passed fully qualified name
 	 */
 	public static function getChildClasses(string $fqn) : array
 		{

src/PHPFUI/InstaDoc/Controller.php

@@ -61,6 +61,9 @@ class Controller
 		Controller::PAGE,
 	];
 
+	/**
+	 * @var array<string> $accessTabs tabs to show access in UI
+	 */
 	private array $accessTabs = ['Public', 'Protected', 'Private', 'Static'];
 
 	private \PHPFUI\InstaDoc\FileManager $fileManager;
@@ -71,6 +74,9 @@ class Controller
 
 	private string $gitRoot = '';
 
+	/**
+	 * @var array<string, bool> markdown file names
+	 */
 	private array $homePageMarkdown = [];
 
 	private string $homeUrl = '#';
@@ -79,6 +85,9 @@ class Controller
 
 	private \PHPFUI\InstaDoc\PageInterface $page;
 
+	/**
+	 * @var array<string, string>
+	 */
 	private array $parameters = [];
 
 	private string $siteTitle = 'PHPFUI/InstaDoc';
@@ -111,7 +120,7 @@ public function clearMenu() : Controller
 	/**
 	 * Display a page according to the parameters passed on the url.
 	 *
-	 * @param array $classPagesToShow limits the allowed pages to display, used for static file generation
+	 * @param array<string> $classPagesToShow limits the allowed pages to display, used for static file generation
 	 * @param ?PageInterface $page to use, default to current controller page, but pass in a new page for multiple page generations on the same controller instance
 	 */
 	public function display(array $classPagesToShow = Controller::VALID_CLASS_PAGES, ?PageInterface $page = null) : string
@@ -205,7 +214,9 @@ public function display(array $classPagesToShow = Controller::VALID_CLASS_PAGES,
 	/**
 	 * Generate static files for high volume sites.  Pass the path to the directory where you want the files to be placed, it must exist.
 	 *
-	 * @return array with generation file count and time
+	 * @param array<string> $pagesToInclude
+	 *
+	 * @return array<string, float|int<1, max>> array with generation file count and time
 	 */
 	public function generate(string $directoryPath, array $pagesToInclude = [Controller::DOC_PAGE], string $extension = '.html') : array
 		{
@@ -270,13 +281,17 @@ public function generate(string $directoryPath, array $pagesToInclude = [Control
 		return ['count' => $count, 'seconds' => $milliseconds];
 		}
 
+	/**
+	 * @return array<string> tabs to show access in UI
+	 */
 	public function getAccessTabs() : array
 		{
 		return $this->accessTabs;
 		}
 
 	/**
 	 * break up a namespaced class into parts
+	 * @return array<string, string>
 	 */
 	public function getClassParts(string $namespacedClass) : array
 		{
@@ -340,6 +355,8 @@ public function getGitRoot() : string
 
 	/**
 	 * Get unique home page markdown files
+	 *
+	 * @return array<string> markdown file names
 	 */
 	public function getHomePageMarkdown() : array
 		{
@@ -447,6 +464,8 @@ public function getParameter(string $parameter, ?string $default = null) : strin
 
 	/**
 	 * Get all parameters
+	 *
+	 * @return array<string, string>
 	 */
 	public function getParameters() : array
 		{
@@ -482,9 +501,9 @@ public function getConstructorParameters(string $className) : string
 		return $html2Text->getText();
 		}
 
-/**
- * Get a section for display. Override to change layout
- */
+	/**
+	 * Get a section for display. Override to change layout
+	 */
 	public function getSection(string $sectionName) : Section
 		{
 		if (! \in_array($sectionName, Controller::SECTIONS))
@@ -499,6 +518,8 @@ public function getSection(string $sectionName) : Section
 
 	/**
 	 * Get a url given parameters.  Remove invalid parameters.
+	 *
+	 * @param array<string, string> $parameters
 	 */
 	public function getUrl(array $parameters) : string
 		{
@@ -538,6 +559,9 @@ public function getUrl(array $parameters) : string
 		return $url;
 		}
 
+	/**
+	 * @param array<string> $tabs tabs to show access in UI
+	 */
 	public function setAccessTabs(array $tabs) : Controller
 		{
 		$this->accessTabs = $tabs;
@@ -607,6 +631,8 @@ public function setParameter(string $parameter, string $value) : Controller
 
 	/**
 	 * Set the valid parameters from an array
+	 *
+	 * @param array<string, string> $parameters key value pairs
 	 */
 	public function setParameters(array $parameters) : Controller
 		{

src/PHPFUI/InstaDoc/FileManager.php

@@ -12,8 +12,14 @@ class FileManager
 
 	private string $fileName = '';
 
+	/**
+	 * @var array<string>
+	 */
 	private array $excludedNamespaces = [];
 
+	/**
+	 * @var array<array<string>>
+	 */
 	private array $includedNamespaces = [];
 
 	/**
@@ -110,6 +116,8 @@ public function excludeNamespace(string $namespace) : FileManager
 	/**
 	 * Sometimes you don't feel like a nut. Pass namespaces in an
 	 * array to remove them from your documentation.
+	 *
+	 * @param array<string> $namespaces
 	 */
 	public function excludeNamespaces(array $namespaces) : FileManager
 		{
@@ -150,7 +158,7 @@ public function rescan() : FileManager
 
 		foreach ($this->includedNamespaces as $parameters)
 			{
-			NamespaceTree::addNameSpace($parameters[0], $parameters[1], $parameters[2]);
+			NamespaceTree::addNameSpace($parameters[0], $parameters[1], (bool)$parameters[2]);
 			}
 
 		foreach ($this->excludedNamespaces as $namespace)

src/PHPFUI/InstaDoc/NamespaceTree.php

@@ -9,24 +9,24 @@ class NamespaceTree
 	private static string $activeNamespace;
 
 	/**
-	 * @var array indexed by namespace part containing a NamespaceTree
+	 * @var array<string, NamespaceTree> indexed by namespace part containing a NamespaceTree
 	 */
 	private array $children = [];
 
 	/**
-	 * @var array indexed by fully qualified class name containing the file name
+	 * @var array<string, string> indexed by fully qualified class name containing the file name
 	 */
 	private array $classes = [];
 
-	private static $controller;
+	private static \PHPFUI\InstaDoc\Controller $controller;
 
 	/**
 	 * @var bool true if this namespace is in the local git repo
 	 */
 	private bool $localGit = false;
 
 	/**
-	 * @var array of unique markdown files indexed by file name
+	 * @var array<string, bool> of unique markdown files indexed by file name
 	 */
 	private array $md = [];
 
@@ -38,9 +38,9 @@ class NamespaceTree
 	/**
 	 * @var NamespaceTree our parent
 	 */
-	private ?NamespaceTree $parent = null;
+	private ?\PHPFUI\InstaDoc\NamespaceTree $parent = null;
 
-	private static ?NamespaceTree $root = null;
+	private static ?\PHPFUI\InstaDoc\NamespaceTree $root = null;
 
 	// only we can make us to ensure the tree is good
 	private function __construct()
@@ -133,7 +133,7 @@ public static function findNamespace(string $namespace) : NamespaceTree
 		}
 
 	/**
-	 * Returns array of all classes
+	 * @return array<string, string> all classes
 	 */
   public static function getAllClasses(?NamespaceTree $tree = null) : array
 		{
@@ -159,6 +159,9 @@ public static function getAllClasses(?NamespaceTree $tree = null) : array
 		return $classes;
 		}
 
+	/**
+	 * @return array<string>
+	 */
 	public static function getAllMDFiles(?NamespaceTree $tree = null) : array
 		{
 		if (! $tree)
@@ -175,13 +178,16 @@ public static function getAllMDFiles(?NamespaceTree $tree = null) : array
 		return $files;
 		}
 
+	/**
+	 * @return array<string, NamespaceTree> indexed by namespace part containing a NamespaceTree
+	 */
 	public function getChildren() : array
 		{
 		return $this->children;
 		}
 
 	/**
-	 * Return an array with full paths of all the classes in the
+	 * @return array<string, string> an array with full paths of all the classes in the
 	 * namespace, indexed by class name
 	 */
   public function getClassFilenames() : array
@@ -194,6 +200,9 @@ public function getGit() : bool
 		return $this->localGit;
 		}
 
+	/**
+	 * @return array<string> md file names
+	 */
 	public function getMDFiles() : array
 		{
 		return \array_keys($this->md);
@@ -346,7 +355,6 @@ public static function sort(?NamespaceTree $tree = null) : void
 			}
 		}
 
-	/** @phpstan-ignore-next-line */
 	private function getMenuTree(NamespaceTree $tree, \PHPFUI\Menu $menu) : \PHPFUI\Menu
 		{
 		$currentMenu = new \PHPFUI\Menu();

src/PHPFUI/InstaDoc/Page.php

@@ -22,7 +22,7 @@ public function __construct(\PHPFUI\InstaDoc\Controller $controller)
 		$this->addStyleSheet('highlighter/styles/PHPFUI.css');
 		}
 
-	public function addBody($item) : PageInterface
+	public function addBody(mixed $item) : PageInterface
 		{
 		$this->mainColumn->add($item);
 

src/PHPFUI/InstaDoc/PageInterface.php

@@ -8,7 +8,7 @@ public function __construct(Controller $controller);
 
 	public function __toString() : string;
 
-	public function addBody($item) : PageInterface;
+	public function addBody(mixed $item) : PageInterface;
 
 	public function create(\PHPFUI\Menu $menu) : void;
 

src/PHPFUI/InstaDoc/Section.php

@@ -43,6 +43,9 @@ public function getClassBase(string $fullClassName) : string
 		return \array_pop($parts);
 		}
 
+	/**
+	 * @param array<string> $allowedMenus
+	 */
 	public function getMenu(string $className, array $allowedMenus) : ?\PHPFUI\Menu
 		{
 		$menu = new \PHPFUI\Menu();