PHPFUI/InstaDoc
 
Copied!
CloneableInstantiable
Methods
public __construct(PHPFUI\InstaDoc\Controller $controller, string $fullClassPath = '')
public PHPFUI\InstaDoc\Section::generate(PHPFUI\InstaDoc\PageInterface $page, string $object) : 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 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 getValueString(?mixed $value) : string
Properties
protected PHPFUI\InstaDoc\Controller PHPFUI\InstaDoc\Section::$controller
protected phpDocumentor\Reflection\DocBlockFactory $factory
protected PHPFUI\InstaDoc\MarkDownParser $parsedown
protected $reflection = NULL
 
  • var \ReflectionClass<object>|\ReflectionEnum|\ReflectionFunction
Methods
protected formatAttribute(ReflectionAttribute $attribute) : string
 
  • param \ReflectionAttribute<object> $attribute
protected 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 getAttributes(?object $reflection) : array
 
  • return array<int,\ReflectionAttribute<object>>
protected getClassName(object|string $class, bool $asLink = true) : string
protected getColor(string $class, string $name) : string
 

Add a color to a thing by class

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

Get comments indented

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

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

protected 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 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 getMethodParametersBlock(ReflectionFunction|ReflectionMethod $method) : string
protected getParameterComments(?phpDocumentor\Reflection\DocBlock $docBlock) : array
 
  • return array<string,string>
protected section(string $name) : string
Methods
private getAttributeName(string $name, bool $asValue = false) : string
© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration