This abstract class can be used as parent for all tags that use a type part in their content.

see
package Default
inherited_from \Zend\Code\Generator\AbstractGenerator

 Methods

__construct()

__construct(array $types = array(), string $description = null
inherited_from \Zend\Code\Generator\AbstractGenerator::__construct()

Parameters

$types

array

$description

string

__construct()

__construct(array $options = array()
Inherited

Parameters

$options

array

getDescription()

getDescription() : string

Returns

string

getIndentation()

getIndentation() : string
Inherited

Returns

string

getSourceContent()

getSourceContent() : string
Inherited

Returns

string

getTypes()

getTypes() : array

Returns

array

getTypesAsString()

getTypesAsString(string $delimiter = '|') : string

Parameters

$delimiter

string

Returns

string

isSourceDirty()

isSourceDirty() : boolean
Inherited

Returns

boolean

setDescription()

setDescription(string $description) : \Zend\Code\Generator\DocBlock\Tag\ReturnTag

Parameters

$description

string

Returns

\Zend\Code\Generator\DocBlock\Tag\ReturnTag

setIndentation()

setIndentation(string $indentation) : \Zend\Code\Generator\AbstractGenerator
Inherited

Parameters

$indentation

string

Returns

\Zend\Code\Generator\AbstractGenerator

setOptions()

setOptions(array|\Traversable $options) : \Zend\Code\Generator\AbstractGenerator
Inherited

Parameters

$options

array\Traversable

Exceptions

\Zend\Code\Generator\Exception\InvalidArgumentException

Returns

\Zend\Code\Generator\AbstractGenerator

setSourceContent()

setSourceContent(string $sourceContent) : \Zend\Code\Generator\AbstractGenerator
Inherited

Parameters

$sourceContent

string

Returns

\Zend\Code\Generator\AbstractGenerator

setSourceDirty()

setSourceDirty(boolean $isSourceDirty = true) : \Zend\Code\Generator\AbstractGenerator
Inherited

Parameters

$isSourceDirty

boolean

Returns

\Zend\Code\Generator\AbstractGenerator

Array of types or string with types delimited by pipe (|) e.g. array('int', 'null') or "int|null"

setTypes(array|string $types) : \Zend\Code\Generator\DocBlock\Tag\ReturnTag

Parameters

$types

arraystring

Returns

\Zend\Code\Generator\DocBlock\Tag\ReturnTag

 Properties

 

$description

$description : string

Default

null
 

4 spaces by default

$indentation : integer | string

Default

' '
 

$isSourceDirty

$isSourceDirty : boolean

Default

true
 

$sourceContent

$sourceContent : string

Default

null
 

$types

$types : array

Default

array()

 Constants

 

Line feed to use in place of EOL

LINE_FEED = "\n"