PHPFUI/InstaDoc
 
Copied!
Cloneable
Methods
public static addGlobalNameSpaceClass(string $filename, bool $localGit = false) : void
public static addNamespace(string $namespace, string $directory, bool $localGit = false) : void
public static deleteNameSpace(string $namespace) : void
public static findNamespace(string $namespace) : PHPFUI\InstaDoc\NamespaceTree
public static getAllClasses(?PHPFUI\InstaDoc\NamespaceTree $tree = NULL) : array
 
  • return array<string,string> all classes
public static getAllMDFiles(?PHPFUI\InstaDoc\NamespaceTree $tree = NULL) : array
 
  • return string[]
public getChildren() : array
 
  • return array<string,\NamespaceTree> indexed by namespace part containing a NamespaceTree
public getClassFilenames() : array
 
  • return array<string,string> an array with full paths of all the classes in the namespace, indexed by class name
public getGit() : bool
public getMDFiles() : array
 
  • return string[] md file names
public getNamespace() : string
 

Returns the full namespace all the way up to the root.

public static hasClass(string $namespacedClass) : bool
public static load(string $file) : bool
public static populateMenu(PHPFUI\Menu $menu) : void
 

Populates a menu object with namespaces as sub menus and classes as menu items.

public static save(string $file) : bool
public static setActiveClass(string $activeClass) : void
 

Set the currently active class for menu generation.

public static setActiveNamespace(string $activeNamespace) : void
 

Set the currently active namespace for menu generation.

public static setController(PHPFUI\InstaDoc\Controller $controller) : void
 

Set the Controller. Used for creating links so all documentation is at the same url.

public static sort(?PHPFUI\InstaDoc\NamespaceTree $tree = NULL) : void
 

Sorts the child namespaces and classes

Properties
private static string $activeClass
private static string $activeNamespace
private array $children = []
 
  • var array<string,\NamespaceTree> indexed by namespace part containing a NamespaceTree
private array $classes = []
 
  • var array<string,string> indexed by fully qualified class name containing the file name
private static PHPFUI\InstaDoc\Controller $controller
private bool $localGit = false
 
  • var bool true if this namespace is in the local git repo
private array $md = []
 
  • var array<string,bool> of unique markdown files indexed by file name
private string $namespace = ''
 
  • var string of the namespace part
private ?PHPFUI\InstaDoc\NamespaceTree $parent = NULL
 
  • var \NamespaceTree our parent
private static ?PHPFUI\InstaDoc\NamespaceTree $root = PHPFUI\InstaDoc\NamespaceTree
Methods
private __construct()
private getMenuTree(PHPFUI\InstaDoc\NamespaceTree $tree, PHPFUI\Menu $menu) : PHPFUI\Menu
private static getRoot() : PHPFUI\InstaDoc\NamespaceTree
Properties
private static string $activeClass
private static string $activeNamespace
private static PHPFUI\InstaDoc\Controller $controller
private static ?PHPFUI\InstaDoc\NamespaceTree $root = PHPFUI\InstaDoc\NamespaceTree
Methods
public static addGlobalNameSpaceClass(string $filename, bool $localGit = false) : void
public static addNamespace(string $namespace, string $directory, bool $localGit = false) : void
public static deleteNameSpace(string $namespace) : void
public static findNamespace(string $namespace) : PHPFUI\InstaDoc\NamespaceTree
public static getAllClasses(?PHPFUI\InstaDoc\NamespaceTree $tree = NULL) : array
 
  • return array<string,string> all classes
public static getAllMDFiles(?PHPFUI\InstaDoc\NamespaceTree $tree = NULL) : array
 
  • return string[]
private static getRoot() : PHPFUI\InstaDoc\NamespaceTree
public static hasClass(string $namespacedClass) : bool
public static load(string $file) : bool
public static populateMenu(PHPFUI\Menu $menu) : void
 

Populates a menu object with namespaces as sub menus and classes as menu items.

public static save(string $file) : bool
public static setActiveClass(string $activeClass) : void
 

Set the currently active class for menu generation.

public static setActiveNamespace(string $activeNamespace) : void
 

Set the currently active namespace for menu generation.

public static setController(PHPFUI\InstaDoc\Controller $controller) : void
 

Set the Controller. Used for creating links so all documentation is at the same url.

public static sort(?PHPFUI\InstaDoc\NamespaceTree $tree = NULL) : void
 

Sorts the child namespaces and classes

© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration