Typed properties

Author: phpfui

src/PHPFUI/InstaDoc/ChildClasses.php

@@ -10,7 +10,7 @@ class ChildClasses
 	/**
 	 * @var array indexed by fqn of class containing array of fqn of children
 	 */
-	private static $children = [];
+	private static array $children = [];
 
 	/**
 	 * Generate child class information from all classes in NamespaceTree

src/PHPFUI/InstaDoc/Controller.php

@@ -61,29 +61,29 @@ class Controller
 		Controller::PAGE,
 	];
 
-	private $accessTabs = ['Public', 'Protected', 'Private', 'Static'];
+	private array $accessTabs = ['Public', 'Protected', 'Private', 'Static'];
 
-	private $fileManager;
+	private \PHPFUI\InstaDoc\FileManager $fileManager;
 
-	private $generating = '';
+	private string $generating = '';
 
-	private $gitFileOffset = '';
+	private string $gitFileOffset = '';
 
-	private $gitRoot = '';
+	private string $gitRoot = '';
 
-	private $homePageMarkdown = [];
+	private array $homePageMarkdown = [];
 
-	private $homeUrl = '#';
+	private string $homeUrl = '#';
 
-	private $menu = null;
+	private ?\PHPFUI\AccordionMenu $menu = null;
 
-	private $page;
+	private \PHPFUI\InstaDoc\PageInterface $page;
 
-	private $parameters = [];
+	private array $parameters = [];
 
-	private $siteTitle = 'PHPFUI/InstaDoc';
+	private string $siteTitle = 'PHPFUI/InstaDoc';
 
-	public function __construct(FileManager $fileManager)
+	public function __construct(\PHPFUI\InstaDoc\FileManager $fileManager)
 		{
 		$this->fileManager = $fileManager;
 		$this->gitRoot = $fileManager->getComposerPath();
@@ -406,7 +406,7 @@ public function getNamespaceURL(string $namespace) : string
 	/**
 	 * Gets a blank page and sets the page title. Override to change the generated page layout.
 	 */
-	public function getPage() : PageInterface
+	public function getPage() : \PHPFUI\InstaDoc\PageInterface
 		{
 		$page = new Page($this);
 

src/PHPFUI/InstaDoc/FileManager.php

@@ -4,17 +4,17 @@
 
 class FileManager
 	{
-	private $composerJsonPath = '';
+	private string $composerJsonPath = '';
 
-	private $configFile = '..';
+	private string $configFile = '..';
 
-	private $extension = '.serial';
+	private string $extension = '.serial';
 
-	private $fileName = '';
+	private string $fileName = '';
 
-	private $excludedNamespaces = [];
+	private array $excludedNamespaces = [];
 
-	private $includedNamespaces = [];
+	private array $includedNamespaces = [];
 
 	/**
 	 * Make a FileManager.  Pass a composer JSON path to use

src/PHPFUI/InstaDoc/MarkDownParser.php

@@ -4,9 +4,9 @@
 
 class MarkDownParser
 	{
-	private $parser;
+	private \cebe\markdown\GithubMarkdown $parser;
 
-	private $page;
+	private \PHPFUI\Interfaces\Page $page;
 
 	public function __construct(\PHPFUI\Interfaces\Page $page)
 		{

src/PHPFUI/InstaDoc/NamespaceTree.php

@@ -11,29 +11,29 @@ class NamespaceTree
 	/**
 	 * @var array indexed by namespace part containing a NamespaceTree
 	 */
-	private $children = [];
+	private array $children = [];
 
 	/**
 	 * @var array indexed by fully qualified class name containing the file name
 	 */
-	private $classes = [];
+	private array $classes = [];
 
 	private static $controller;
 
 	/**
 	 * @var bool true if this namespace is in the local git repo
 	 */
-	private $localGit = false;
+	private bool $localGit = false;
 
 	/**
 	 * @var array of unique markdown files indexed by file name
 	 */
-	private $md = [];
+	private array $md = [];
 
 	/**
 	 * @var string of the namespace part
 	 */
-	private $namespace = '';
+	private string $namespace = '';
 
 	/**
 	 * @var NamespaceTree our parent

src/PHPFUI/InstaDoc/Page.php

@@ -4,17 +4,17 @@
 
 class Page extends \PHPFUI\Page implements \PHPFUI\InstaDoc\PageInterface
 	{
-	private $controller;
+	private \PHPFUI\InstaDoc\Controller $controller;
 
-	private $generating = '';
+	private string $generating = '';
 
-	private $homeUrl = '#';
+	private string $homeUrl = '#';
 
-	private $mainColumn;
+	private \PHPFUI\Cell $mainColumn;
 
-	private $menu;
+	private \PHPFUI\Menu $menu;
 
-	public function __construct(Controller $controller)
+	public function __construct(\PHPFUI\InstaDoc\Controller $controller)
 		{
 		parent::__construct();
 		$this->controller = $controller;

src/PHPFUI/InstaDoc/Section.php

@@ -9,9 +9,9 @@
  */
 class Section
 	{
-	protected $controller;
+	protected \PHPFUI\InstaDoc\Controller $controller;
 
-	public function __construct(Controller $controller)
+	public function __construct(\PHPFUI\InstaDoc\Controller $controller)
 		{
 		$this->controller = $controller;
 		}

src/PHPFUI/InstaDoc/Section/CodeCommon.php

@@ -4,9 +4,9 @@
 
 class CodeCommon extends \PHPFUI\InstaDoc\Section
 	{
-	protected $factory;
+	protected \phpDocumentor\Reflection\DocBlockFactory $factory;
 
-	protected $parsedown;
+	protected \PHPFUI\InstaDoc\MarkDownParser $parsedown;
 
 	protected $reflection;
 
@@ -54,7 +54,7 @@ protected function formatComments(?\phpDocumentor\Reflection\DocBlock $docBlock,
 			foreach ($tags as $tag)
 				{
 				$name = $tag->getName();
-				$description = \method_exists($tag, 'getDescription') ? \trim($tag->getDescription()) : '';
+				$description = \method_exists($tag, 'getDescription') ? \trim($tag->getDescription() ?? '') : '';
 				$body = '';
 				// punt on useless tags
 				if (\in_array($name, ['method', 'inheritdoc']))
@@ -352,7 +352,7 @@ protected function getParameterComments(?\phpDocumentor\Reflection\DocBlock $doc
 		foreach ($docBlock->getTags() as $tag)
 			{
 			$name = $tag->getName();
-			$description = \method_exists($tag, 'getDescription') ? \trim($tag->getDescription()) : '';
+			$description = \method_exists($tag, 'getDescription') ? \trim($tag->getDescription() ?? '') : '';
 
 			if ('param' == $name && $description)
 				{

src/PHPFUI/InstaDoc/Section/Doc.php

@@ -4,7 +4,7 @@
 
 class Doc extends \PHPFUI\InstaDoc\Section\CodeCommon
 	{
-	private $class;
+	private string $class;
 
 	public function __construct(\PHPFUI\InstaDoc\Controller $controller)
 		{
@@ -456,7 +456,7 @@ protected function objectCompare($lhs, $rhs) : int
 		return \strcasecmp($lhs->name, $rhs->name);
 		}
 
-	protected function objectSort(array &$objects) : void
+	protected function objectSort(array & $objects) : void
 		{
 		\usort($objects, [$this, 'objectCompare']);
 		}