Support for classes in global namespace

Author: phpfui

README.md

@@ -69,9 +69,20 @@ That is it. You are done!
 ### Adding New Classes
 PHPFUI\InstaDoc saves the classes to display in PHP serialized files.  Delete those files (.serial extension) when you want to display new classes. PHPFUI\InstaDoc will regenerate automatically if the files are missing.
 
+### Add Child Classes to the Docs
+```php
+\PHPFUI\InstaDoc\ChildClasses::load('../ChildClasses.serial');
+```
+
+### Add a Global Namespace Class
+The git repo path defaults to the composer directory, but you can change the path by calling:
+```php
+$fileManager->addGlobalNameSpaceClass(__DIR__ . '/global/FPDF.php');
+```
+
 ### Removing a Namespace
 ```php
-\PHPFUI\InstaDoc\NamespaceTree::deleteNameSpace('cebe\markdown\tests');
+$fileManager->excludeNamespace('Carbon');
 ```
 
 ### Add git Repository Page

src/PHPFUI/InstaDoc/Controller.php

@@ -130,9 +130,15 @@ public function display(array $classPagesToShow = Controller::VALID_CLASS_PAGES,
 			{
 			$mainColumn->add($this->getSection('Landing')->generate($page, $this->getParameter(Controller::NAMESPACE)));
 			}
-		elseif ($this->getParameter(Controller::CLASS_NAME) && $this->getParameter(Controller::NAMESPACE))
+		elseif ($this->getParameter(Controller::CLASS_NAME))
 			{
-			$fullClassName = $this->getParameter(Controller::NAMESPACE) . '\\' . $this->getParameter(Controller::CLASS_NAME);
+			$nameSpace = $this->getParameter(Controller::NAMESPACE);
+			if ($nameSpace)
+				{
+				$nameSpace .= '\\';
+				}
+
+			$fullClassName = $nameSpace . $this->getParameter(Controller::CLASS_NAME);
 			$tree = NamespaceTree::findNamespace($this->getParameter(Controller::NAMESPACE));
 			$files = $tree->getClassFilenames();
 			$fullClassPath = $files[$fullClassName] ?? '';

src/PHPFUI/InstaDoc/FileManager.php

@@ -32,11 +32,11 @@ public function __construct(string $composerJsonPath = '')
 
 	/**
 	 * You can add a Namespace directly.  Specify the namespace (no
-	 * leading \) and the directory containing the class files.
-	 * This is realitive to the current script directory.  You can
-	 * also pass an option localGit flag indicating this directory
-	 * is in the project git repo.  This will allow you to see the
-	 * git history on the file.
+	 * leading backslash) and the directory containing the class
+	 * files. This is realitive to the current script directory.
+	 * You can also pass an option localGit flag indicating this
+	 * directory is in the project git repo.  This will allow you to
+	 * see the git history on the file.
 	 */
 	public function addNamespace(string $namespace, string $directory, bool $localGit = false) : FileManager
 		{
@@ -45,6 +45,21 @@ public function addNamespace(string $namespace, string $directory, bool $localGi
 		return $this;
 		}
 
+	/**
+	 * The classes in the global namespace are handled slightly
+	 * differently, as this should be the exception rather than the
+	 * rule.
+	 *
+	 * @param string $filename Pass in the full file path
+	 * @param bool $localGit the git flag is attached to the global
+	 *  					 namespace, not the individual file and will use
+	 *  					 the setting of the last file added.
+	 */
+	public function addGlobalNameSpaceClass(string $filename, bool $localGit = false) : void
+		{
+		NamespaceTree::addGlobalNameSpaceClass($filename, $localGit);
+		}
+
 	/**
 	 * Set file extension for saving index file
 	 */
@@ -66,7 +81,8 @@ public function setBaseFile(string $fileName) : self
 		}
 
 	/**
-	 * Delete config files
+	 * Delete config files.  This should be done when new classes
+	 * have been added to the project.
 	 *
 	 * @return int number of files deleted
 	 */

src/PHPFUI/InstaDoc/NamespaceTree.php

@@ -47,12 +47,22 @@ private function __construct()
 		{
 		}
 
-	public static function addNamespace(string $namespace, string $directory, bool $localGit = false) : void
+	public static function addGlobalNameSpaceClass(string $filename, bool $localGit = false) : void
 		{
-		if (! $namespace)
+		$filenameLength = \strlen($filename);
+		if (\strpos($filename, '.php') == $filenameLength - 4)
 			{
-			return;
+			$root = self::getRoot();
+			$file = \str_replace('/', '\\', \str_replace('.php', '', $filename));
+			$parts = \explode('\\', $file);
+			$class = \array_pop($parts);
+			$root->classes[$class] = $filename;
+			$root->localGit = $localGit;
 			}
+		}
+
+	public static function addNamespace(string $namespace, string $directory, bool $localGit = false) : void
+		{
 		$namespaceLength = \strlen($namespace);
 
 		if ($namespaceLength && '\\' == $namespace[$namespaceLength - 1])
@@ -63,17 +73,17 @@ public static function addNamespace(string $namespace, string $directory, bool $
 		$node = self::findNamespace($namespace);
 		$node->localGit = $localGit;
 
-	$iterator = new \DirectoryIterator($directory);
+		$iterator = new \DirectoryIterator($directory);
 
-	foreach ($iterator as $fileinfo)
+		foreach ($iterator as $fileinfo)
 			{
 			$filename = $fileinfo->getFilename();
 			$filenameLength = \strlen($filename);
 
-	  if ($fileinfo->isDir() && false === \strpos($filename, '.'))
+			if ($fileinfo->isDir() && false === \strpos($filename, '.'))
 				{
 				self::addNamespace($namespace . '\\' . $filename, $directory . '/' . $filename, $localGit);
-		}
+				}
 			elseif (\strpos($filename, '.php') == $filenameLength - 4)
 				{
 				$class = \substr($filename, 0, $filenameLength - 4);
@@ -253,6 +263,27 @@ public static function populateMenu(\PHPFUI\Menu $menu) : void
 		{
 		self::sort(self::getRoot());
 
+		// add no namespace stuff first
+		if (self::$root->classes)
+			{
+			$namespace = '\\';
+			$rootMenu = new \PHPFUI\Menu();
+			foreach (self::$root->classes as $class => $path)
+				{
+				$activeClass = self::$activeClass;
+				$activeNamespace = self::$activeNamespace;
+
+				$menuItem = new \PHPFUI\MenuItem($class, self::$controller->getClassUrl($class));
+				if ($class == self::$activeClass)
+					{
+					$menuItem->setActive();
+					}
+				$rootMenu->addMenuItem($menuItem);
+				}
+			$menuItem = new \PHPFUI\MenuItem($namespace);
+			$menu->addSubMenu($menuItem, $rootMenu);
+			}
+
 		foreach (self::$root->children as $child)
 			{
 			$child->getMenuTree($child, $menu);