DocstringRepresentation
extends Representation
in package
Table of Contents
- $class : mixed
- $contents : mixed
- $file : mixed
- $hints : mixed
- $implicit_label : mixed
- $label : mixed
- $line : mixed
- $name : mixed
- __construct() : mixed
- getDocstringWithoutComments() : null|string
- Returns the representation's docstring without surrounding comments.
- getLabel() : mixed
- getName() : mixed
- labelIsImplicit() : mixed
- setName() : mixed
Properties
$class
public
mixed
$class
$contents
public
mixed
$contents
= array()
$file
public
mixed
$file
$hints
public
mixed
$hints
= array('docstring')
$implicit_label
public
mixed
$implicit_label
= false
$label
public
mixed
$label
$line
public
mixed
$line
$name
protected
mixed
$name
Methods
__construct()
public
__construct(mixed $docstring, mixed $file, mixed $line[, mixed $class = null ]) : mixed
Parameters
- $docstring : mixed
- $file : mixed
- $line : mixed
- $class : mixed = null
Return values
mixed —getDocstringWithoutComments()
Returns the representation's docstring without surrounding comments.
public
getDocstringWithoutComments() : null|string
Note that this will not work flawlessly.
On comments with whitespace after the stars the lines will begin with whitespace, since we can't accurately guess how much of an indentation is required.
And on lines without stars on the left this may eat bullet points.
Long story short: If you want the docstring read the contents. If you absolutely must have it without comments (ie renderValueShort) this will probably do.
Return values
null|string —Docstring with comments stripped
getLabel()
public
getLabel() : mixed
Return values
mixed —getName()
public
getName() : mixed
Return values
mixed —labelIsImplicit()
public
labelIsImplicit() : mixed
Return values
mixed —setName()
public
setName(mixed $name) : mixed
Parameters
- $name : mixed