Line
in package
This represents a line of a docblock.
Tags
Table of Contents
- $content : string
- The content of this line.
- __construct() : mixed
- Create a new line instance.
- __toString() : string
- Get the string representation of object.
- addBlank() : mixed
- Append a blank docblock line to this line's contents.
- containsATag() : bool
- Does the line contain a tag?
- containsUsefulContent() : bool
- Does this line contain useful content?
- getContent() : string
- Get the content of this line.
- isTheEnd() : bool
- Is the line the end of a docblock?
- isTheStart() : bool
- Is the line the start of a docblock?
- remove() : mixed
- Remove this line by clearing its contents.
- setContent() : mixed
- Set the content of this line.
Properties
$content
The content of this line.
private
string
$content
Methods
__construct()
Create a new line instance.
public
__construct(string $content) : mixed
Parameters
- $content : string
Return values
mixed —__toString()
Get the string representation of object.
public
__toString() : string
Return values
string —addBlank()
Append a blank docblock line to this line's contents.
public
addBlank() : mixed
Note that this method technically brakes the internal state of the docblock, but is useful when we need to retain the indexes of lines during the execution of an algorithm.
Return values
mixed —containsATag()
Does the line contain a tag?
public
containsATag() : bool
If this is true, then it must be the first line of an annotation.
Return values
bool —containsUsefulContent()
Does this line contain useful content?
public
containsUsefulContent() : bool
If the line contains text or tags, then this is true.
Return values
bool —getContent()
Get the content of this line.
public
getContent() : string
Return values
string —isTheEnd()
Is the line the end of a docblock?
public
isTheEnd() : bool
Return values
bool —isTheStart()
Is the line the start of a docblock?
public
isTheStart() : bool
Return values
bool —remove()
Remove this line by clearing its contents.
public
remove() : mixed
Note that this method technically brakes the internal state of the docblock, but is useful when we need to retain the indexes of lines during the execution of an algorithm.
Return values
mixed —setContent()
Set the content of this line.
public
setContent(string $content) : mixed
Parameters
- $content : string