PHPFUI/InstaDoc
 
Copied!
Cloneable
Methods
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
 

Returns array of all classes

public static getAllMDFiles ( ? PHPFUI\InstaDoc\NamespaceTree $tree = NULL ) : array
public getChildren () : array
public getClassFilenames () : array
 

Return an array with full paths of all the classes in the
namespace, indexed by class name

public getGit () : bool
public getMDFiles () : array
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 $activeClass = 'NamespaceTree'
private static $activeNamespace = '\PHPFUI\InstaDoc'
private $children
 
  • var array indexed by namespace part containing a NamespaceTree
private $classes
 
  • var array indexed by fully qualified class name containing the file name
private static $controller = PHPFUI\InstaDoc\Controller
private $localGit
 
  • var bool true if this namespace is in the local git repo
private $md
 
  • var array of unique markdown files indexed by file name
private $namespace
 
  • var string of the namespace part
private $parent
 
private static $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 $activeClass = 'NamespaceTree'
private static $activeNamespace = '\PHPFUI\InstaDoc'
private static $controller = PHPFUI\InstaDoc\Controller
private static $root = PHPFUI\InstaDoc\NamespaceTree
Methods
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
 

Returns array of all classes

public static getAllMDFiles ( ? PHPFUI\InstaDoc\NamespaceTree $tree = NULL ) : array
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
© 2021 Bruce Wells
Search Namespaces \ Classes
Configuration