class
KalimahApps
/
Daleel
/
ProcessApiDocs
ProcessApiDocs
Handle generating API docs from docblocks.
Properties
private
$namespaces_list array
Array of namespaces
Default: []
private
$console Symfony\...\SymfonyStyle
input/output interface
Default: null
private
$errors array
Array of errors
Default: []
private
$view_builder_progress Symfony\...\ProgressBar
Progress bar for building views
Default: null
private
$tree array
Tree of namespaces
Default: null
private
$views_count int
Number of views to build (used for progress bar)
Default: 1
Methods
public
__construct ( Symfony\...\SymfonyStyle $console ) : void
Initiate directory traversal and process elements.
Parameters
-
$console
Symfony\...\SymfonyStyle
input/output interface
public
getSidebarTree ( ) : void
Get the tree of namespaces.
public
start ( ) : void
Start the process.
private
createTree ( Symfony\...\Finder $files ) : array
Loop through files and create a hierarchical tree.
Parameters
-
$files
Symfony\...\Finder
Files to loop through
private
sortAndCountTree ( array $tree ) : array
Sort tree recursively.
Parameters
-
$tree
array
Tree to sort
private
buildSidebarTree ( array $tree , array $path ) : array
Build a tree of namespaces to be used in the sidebar.
Parameters
-
$tree
array
Tree to build sidebar from
-
$path
array
Path to current element
private
buildObjectToc ( $object_data ) : array
Build a table of contents for an object (class, trait, interface, etc.).
Parameters
-
$object_data
array
Object data
private
buildNamespaceData ( $namespace_data , array $path , array $title ) : array
Build a tree of namespaces to be used in namespace index page.
Parameters
-
$namespace_data
array
Namespace data
-
$path
array
Path to current element
-
$title
array
Title of current element
private
buildHtml ( $tree , $path , $breadcrumbs ) : void
Build html files recursively.
Parameters
-
$tree
array
Tree to build html files from
-
$path
array
Path to current element
-
$breadcrumbs
array
Breadcrumbs to current element
public
getErrors ( ) : array
Get list of errors found.