DocblockLine
in package
Docblock line class
Table of Contents
Properties
- $content : string|null
- Content of docblock line (ignores markup)
- $rawString : string
- Raw (unprocessed) docblock line
- $tag : DocblockTag|null
- Tag on line
Methods
- __toString() : string
- Returns raw line
- fromString() : DocblockLine
- Creates and returns new docblock line object from raw line
- getContent() : string|null
- Returns content of docblock line
- getRaw() : string
- Returns raw line
- getTag() : DocblockTag|null
- Returns tag on line or null if not present
- hasTag() : bool
- Returns if line has a tag
- isClosure() : bool
- Returns if line is a closure (*\ or /**)
- isEmpty() : bool
- Returns if line is empty (has no content)
- isText() : bool
- Returns if line is a text (not a tag and not empty)
- __construct() : mixed
Properties
$content
Content of docblock line (ignores markup)
private
string|null
$content
$rawString
Raw (unprocessed) docblock line
private
string
$rawString
$tag
Tag on line
private
DocblockTag|null
$tag
= null
Methods
__toString()
Returns raw line
public
__toString() : string
Return values
stringfromString()
Creates and returns new docblock line object from raw line
public
static fromString(string $string) : DocblockLine
Parameters
- $string : string
Return values
DocblockLinegetContent()
Returns content of docblock line
public
getContent() : string|null
Return values
string|nullgetRaw()
Returns raw line
public
getRaw() : string
Return values
stringgetTag()
Returns tag on line or null if not present
public
getTag() : DocblockTag|null
Return values
DocblockTag|nullhasTag()
Returns if line has a tag
public
hasTag() : bool
Return values
boolisClosure()
Returns if line is a closure (*\ or /**)
public
isClosure() : bool
Return values
boolisEmpty()
Returns if line is empty (has no content)
public
isEmpty() : bool
Return values
boolisText()
Returns if line is a text (not a tag and not empty)
public
isText() : bool
Return values
bool__construct()
private
__construct(string $rawString) : mixed
Parameters
- $rawString : string