PHPFUI/InstaDoc
 
Copied!
CloneableInstantiable
Methods
public __construct(PHPFUI\InstaDoc\Controller $controller)
public generate(PHPFUI\InstaDoc\PageInterface $page, string $fullClassPath) : PHPFUI\Container
public PHPFUI\InstaDoc\Section::getBreadCrumbs(string $object) : PHPFUI\BreadCrumbs
public PHPFUI\InstaDoc\Section::getClassBase(string $fullClassName) : string
public PHPFUI\InstaDoc\Section::getMenu(string $className, array $allowedMenus) : ?PHPFUI\Menu
 
  • param string[] $allowedMenus
public PHPFUI\InstaDoc\Section\CodeCommon::getMethodParameters(ReflectionFunction|ReflectionMethod $method, array $parameterComments = []) : string
 
  • param array<string,string> $parameterComments comments indexed by parameter name
public PHPFUI\InstaDoc\Section::getNamespaceFromClass(string $class) : string
public PHPFUI\InstaDoc\Section\CodeCommon::getValueString(?mixed $value) : string
Properties
protected PHPFUI\InstaDoc\Controller PHPFUI\InstaDoc\Section::$controller
protected phpDocumentor\Reflection\DocBlockFactory PHPFUI\InstaDoc\Section\CodeCommon::$factory
protected PHPFUI\InstaDoc\MarkDownParser PHPFUI\InstaDoc\Section\CodeCommon::$parsedown
protected PHPFUI\InstaDoc\Section\CodeCommon::$reflection = NULL
 
  • var \ReflectionClass<object>|\ReflectionEnum|\ReflectionFunction
Methods
protected PHPFUI\InstaDoc\Section\CodeCommon::formatAttribute(ReflectionAttribute $attribute) : string
 
  • param \ReflectionAttribute<object> $attribute
protected PHPFUI\InstaDoc\Section\CodeCommon::formatComments(?phpDocumentor\Reflection\DocBlock $docBlock, ReflectionMethod|ReflectionClass|?null $reflection = NULL) : string
 

Format comments without indentation

  • template
  • param \ReflectionMethod|\ReflectionClass<\T>|null $reflection if \ReflectionClass, then grab the comments from the class header
protected PHPFUI\InstaDoc\Section\CodeCommon::getAttributes(?object $reflection) : array
 
  • return array<int,\ReflectionAttribute<object>>
protected PHPFUI\InstaDoc\Section\CodeCommon::getClassName(object|string $class, bool $asLink = true) : string
protected PHPFUI\InstaDoc\Section\CodeCommon::getColor(string $class, string $name) : string
 

Add a color to a thing by class

protected PHPFUI\InstaDoc\Section\CodeCommon::getComments(?phpDocumentor\Reflection\DocBlock $docBlock, ?ReflectionMethod $reflection = NULL) : string
 

Get comments indented

protected PHPFUI\InstaDoc\Section\CodeCommon::getDocBlock(object $method) : ?phpDocumentor\Reflection\DocBlock
protected PHPFUI\InstaDoc\Section\CodeCommon::getHtmlClass(string $class) : string
 

Convert php class name to html class name (\ => -)

protected PHPFUI\InstaDoc\Section\CodeCommon::getInheritedDocBlock(array $tags, ReflectionMethod|ReflectionClass|?null $reflection) : array
 
  • param array<int,\phpDocumentor\Reflection\DocBlock\Tag> $tags
  • template
  • param \ReflectionMethod|\ReflectionClass<\T>|null $reflection if \ReflectionClass, then grab the comments from the class header
  • return array<int,\phpDocumentor\Reflection\DocBlock\Tag>
protected PHPFUI\InstaDoc\Section\CodeCommon::getInheritedText(phpDocumentor\Reflection\DocBlock $docBlock, ReflectionMethod|ReflectionClass|?null $reflection = NULL, string $textType = 'getDescription') : string
 
  • template
  • param \ReflectionMethod|\ReflectionClass<\T>|null $reflection if \ReflectionClass, then grab the comments from the class header
protected PHPFUI\InstaDoc\Section\CodeCommon::getMethodParametersBlock(ReflectionFunction|ReflectionMethod $method) : string
protected PHPFUI\InstaDoc\Section\CodeCommon::getParameterComments(?phpDocumentor\Reflection\DocBlock $docBlock) : array
 
  • return array<string,string>
protected PHPFUI\InstaDoc\Section\CodeCommon::section(string $name) : string
Methods
private documentFunction(string $function) : PHPFUI\Container
© 2025 Bruce Wells