Source
extends BaseTag
in package
implements
StaticMethod
Reflection class for a {@}source tag in a Docblock.
Interfaces, Classes and Traits
Table of Contents
- $description : Description|null
- $name : string
- $lineCount : int|null
- $startingLine : int
- __construct() : mixed
- __toString() : string
- create() : mixed
- getDescription() : Description|null
- getLineCount() : int|null
- Returns the number of lines.
- getName() : string
- Gets the name of this tag.
- getStartingLine() : int
- Gets the starting line.
- render() : string
Properties
$description
protected
Description|null
$description
= null
Description of the tag.
$name
protected
string
$name
= 'source'
Name of the tag
$lineCount
private
int|null
$lineCount
= null
The number of lines, relative to the starting line. NULL means "to the end".
$startingLine
private
int
$startingLine
The starting line, relative to the structural element's location.
Methods
__construct()
public
__construct(int|string $startingLine[, int|string|null $lineCount = null ][, Description|null $description = null ]) : mixed
Parameters
- $startingLine : int|string
-
should be a to int convertible value
- $lineCount : int|string|null = null
-
should be a to int convertible value
- $description : Description|null = null
Return values
mixed —__toString()
public
__toString() : string
Return values
string —create()
public
static create(string $body[, DescriptionFactory|null $descriptionFactory = null ][, Context|null $context = null ]) : mixed
Parameters
- $body : string
- $descriptionFactory : DescriptionFactory|null = null
- $context : Context|null = null
Return values
mixed —getDescription()
public
getDescription() : Description|null
Return values
Description|null —getLineCount()
Returns the number of lines.
public
getLineCount() : int|null
Return values
int|null —The number of lines, relative to the starting line. NULL means "to the end".
getName()
Gets the name of this tag.
public
getName() : string
Return values
string —The name of this tag.
getStartingLine()
Gets the starting line.
public
getStartingLine() : int
Return values
int —The starting line, relative to the structural element's location.
render()
public
render([Formatter|null $formatter = null ]) : string
Parameters
- $formatter : Formatter|null = null