DescriptionDescriptor
in package
implements
Stringable
FinalYes
Table of Contents
Interfaces
- Stringable
Properties
- $description : Description
- $inlineTags : array<int, TagDescriptor|null>
Methods
- __construct() : mixed
- __toString() : string
- Renders docblock as string.
- createEmpty() : self
- getBodyTemplate() : string
- getTags() : array<int, TagDescriptor|null>
- Returns the tags for this description
- isEmpty() : bool
- replaceTag() : void
Properties
$description
private
Description
$description
$inlineTags
private
array<int, TagDescriptor|null>
$inlineTags
Methods
__construct()
public
__construct(Description|null $description, array<int, TagDescriptor|null> $tags) : mixed
Parameters
- $description : Description|null
- $tags : array<int, TagDescriptor|null>
__toString()
Renders docblock as string.
public
__toString() : string
will be removed in v4
This method is here for legacy purpose. The new v3 template has improved the way we render descriptons which requires more advanced handling of descriptions and just not some string jugling.
Return values
stringcreateEmpty()
public
static createEmpty() : self
Return values
selfgetBodyTemplate()
public
getBodyTemplate() : string
Return values
stringgetTags()
Returns the tags for this description
public
getTags() : array<int, TagDescriptor|null>
Return values
array<int, TagDescriptor|null>isEmpty()
public
isEmpty() : bool
Return values
boolreplaceTag()
public
replaceTag(int $position, TagDescriptor|null $tagDescriptor) : void
Parameters
- $position : int
- $tagDescriptor : TagDescriptor|null