Docblock
in package
Docblock class
Table of Contents
Properties
- $description : string|null
- Docblock description
- $lines : array<string|int, mixed>
- Lines of docblock
- $summary : string|null
- Docblock summary
- $tagDictionary : array<string, DocblockTag>
- Dictionary of tags
Methods
- __toString() : string
- Returns raw docblock
- fromClass() : Docblock|null
- Returns new docblock object from class
- fromMethod() : Docblock|null
- Returns new docblock object from class method
- fromProperty() : Docblock|null
- Returns new docblock object from class property
- fromReflection() : Docblock|null
- Returns new docblock object from reflection
- getDescription() : string|null
- Returns description of docblock
- getLine() : DocblockLine|null
- Returns line at index
- getLines() : array<string|int, DocblockLine>
- Returns array of docblock lines
- getSummary() : string|null
- Returns summary of docblock
- getTag() : DocblockTag|null
- Returns docblock tag by name
- __construct() : mixed
- appendStrings() : void
- Assigns line as summary or adds to description
- populateTags() : void
- Populates tags dictionary Assigns reference to tag as value and tag name as key
Properties
$description
Docblock description
private
string|null
$description
= null
$lines
Lines of docblock
private
array<string|int, mixed>
$lines
= []
$summary
Docblock summary
private
string|null
$summary
= null
$tagDictionary
Dictionary of tags
private
array<string, DocblockTag>
$tagDictionary
= []
Methods
__toString()
Returns raw docblock
public
__toString() : string
Return values
stringfromClass()
Returns new docblock object from class
public
static fromClass(string $className) : Docblock|null
Parameters
- $className : string
Return values
Docblock|nullfromMethod()
Returns new docblock object from class method
public
static fromMethod(string $className, string $methodName) : Docblock|null
Parameters
- $className : string
- $methodName : string
Return values
Docblock|nullfromProperty()
Returns new docblock object from class property
public
static fromProperty(string $className, string $propertyName) : Docblock|null
Parameters
- $className : string
- $propertyName : string
Return values
Docblock|nullfromReflection()
Returns new docblock object from reflection
public
static fromReflection(mixed $reflection) : Docblock|null
Parameters
- $reflection : mixed
Tags
Return values
Docblock|nullgetDescription()
Returns description of docblock
public
getDescription() : string|null
Return values
string|nullgetLine()
Returns line at index
public
getLine(int $idx) : DocblockLine|null
Parameters
- $idx : int
Return values
DocblockLine|nullgetLines()
Returns array of docblock lines
public
getLines() : array<string|int, DocblockLine>
Return values
array<string|int, DocblockLine>getSummary()
Returns summary of docblock
public
getSummary() : string|null
Return values
string|nullgetTag()
Returns docblock tag by name
public
getTag(string $name) : DocblockTag|null
Parameters
- $name : string
Return values
DocblockTag|null__construct()
private
__construct(string $content) : mixed
Parameters
- $content : string
appendStrings()
Assigns line as summary or adds to description
private
appendStrings(DocblockLine $line) : void
Parameters
- $line : DocblockLine
populateTags()
Populates tags dictionary Assigns reference to tag as value and tag name as key
private
populateTags() : void