PHPFUI/InstaDoc
 
Copied!
CloneableFinalInstantiable
Methods
public __construct(phpDocumentor\Reflection\DocBlock\DescriptionFactory $descriptionFactory, phpDocumentor\Reflection\DocBlock\TagFactory $tagFactory)
 

Initializes this factory with the required subcontractors.

public create( $docblock, ?phpDocumentor\Reflection\Types\Context $context = NULL, ?phpDocumentor\Reflection\Location $location = NULL) : phpDocumentor\Reflection\DocBlock
 
  • param object|string $docblock A string containing the DocBlock to parse or an object supporting the getDocComment method (such as a ReflectionClass object).
public static createInstance(array $additionalTags = []) : phpDocumentor\Reflection\DocBlockFactoryInterface
 

Factory method for easy instantiation.

  • param array<string,class-string<\Tag>|\Factory> $additionalTags
public registerTagHandler(string $tagName, $handler) : void
 
  • param class-string<\Tag>|\Factory $handler
Properties
private phpDocumentor\Reflection\DocBlock\DescriptionFactory $descriptionFactory
private phpDocumentor\Reflection\DocBlock\TagFactory $tagFactory
Methods
private filterTagBlock(string $tags) : ?string
private parseTagBlock(string $tags, phpDocumentor\Reflection\Types\Context $context) : array
 

Creates the tag objects.

  • param string $tags Tag block to parse.
  • param \Types\Context $context Context of the parsed Tag
  • return \DocBlock\Tag[]
private splitDocBlock(string $comment) : array
 

Splits the DocBlock into a template marker, summary, description and block of tags.

private splitTagBlockIntoTagLines(string $tags) : array
 
  • return string[]
private stripDocComment(string $comment) : string
 

Strips the asterisks from the DocBlock comment.

  • param string $comment String containing the comment text.
Methods
public static createInstance(array $additionalTags = []) : phpDocumentor\Reflection\DocBlockFactoryInterface
 

Factory method for easy instantiation.

  • param array<string,class-string<\Tag>|\Factory> $additionalTags
© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration