ExampleDescriptor
extends TagDescriptor
in package
Descriptor representing the example tag.
Table of Contents
- $description : DescriptionDescriptor
- $errors : Collection<string|int, Error>
- $name : string
- $example : string
- $filePath : string
- $lineCount : int|null
- $startingLine : int|null
- __construct() : mixed
- Initializes the tag by setting the name and errors,
- __toString() : string
- getDescription() : DescriptionDescriptor
- Returns the description for this tag,
- getErrors() : Collection<string|int, Error>
- Returns all errors associated with this tag.
- getExample() : string
- Returns the content of the example.
- getFilePath() : string
- Returns the location where this example points to.
- getLineCount() : int|null
- Returns the location where this example points to.
- getName() : string
- Returns the name for this tag.
- getStartingLine() : int|null
- Returns the location where this example points to.
- setDescription() : void
- Sets a description for this tab instance.
- setErrors() : void
- Sets a list of errors found on the usage of this tag.
- setExample() : void
- Returns the content of the example.
- setFilePath() : void
- Sets the location where the example points to.
- setLineCount() : void
- Returns the location where this example points to.
- setStartingLine() : void
- Returns the location where this example points to.
- setName() : void
- Sets the name for this tag.
Properties
$description
protected
DescriptionDescriptor
$description
A description line for this tag
$errors
protected
Collection<string|int, Error>
$errors
A collection of errors found during filtering.
$name
protected
string
$name
Name of the tag.
$example
private
string
$example
= ''
the content of the example.
$filePath
private
string
$filePath
= ''
the content of the example.
$lineCount
private
int|null
$lineCount
the content of the example.
$startingLine
private
int|null
$startingLine
the content of the example.
Methods
__construct()
Initializes the tag by setting the name and errors,
public
__construct(string $name[, DescriptionDescriptor|null $description = null ]) : mixed
Parameters
- $name : string
- $description : DescriptionDescriptor|null = null
Return values
mixed —__toString()
public
__toString() : string
Return values
string —getDescription()
Returns the description for this tag,
public
getDescription() : DescriptionDescriptor
Return values
DescriptionDescriptor —getErrors()
Returns all errors associated with this tag.
public
getErrors() : Collection<string|int, Error>
Return values
Collection<string|int, Error> —getExample()
Returns the content of the example.
public
getExample() : string
Return values
string —getFilePath()
Returns the location where this example points to.
public
getFilePath() : string
Return values
string —getLineCount()
Returns the location where this example points to.
public
getLineCount() : int|null
Return values
int|null —getName()
Returns the name for this tag.
public
getName() : string
Return values
string —getStartingLine()
Returns the location where this example points to.
public
getStartingLine() : int|null
Return values
int|null —setDescription()
Sets a description for this tab instance.
public
setDescription(DescriptionDescriptor|null $description) : void
Parameters
- $description : DescriptionDescriptor|null
Return values
void —setErrors()
Sets a list of errors found on the usage of this tag.
public
setErrors(Collection<string|int, Error> $errors) : void
Parameters
- $errors : Collection<string|int, Error>
Return values
void —setExample()
Returns the content of the example.
public
setExample(string $example) : void
Parameters
- $example : string
Return values
void —setFilePath()
Sets the location where the example points to.
public
setFilePath(string $filePath) : void
Parameters
- $filePath : string
Return values
void —setLineCount()
Returns the location where this example points to.
public
setLineCount(int $lineCount) : void
Parameters
- $lineCount : int
Return values
void —setStartingLine()
Returns the location where this example points to.
public
setStartingLine(int $startingLine) : void
Parameters
- $startingLine : int
Return values
void —setName()
Sets the name for this tag.
protected
setName(string $name) : void
Parameters
- $name : string