Zend Framework » \Zend\Code\Generator\DocBlock\Tag

Methods

__construct()

__construct(array $options)

Parameters

$options

array

Build a Tag generator object from a reflection object

fromReflection(\Zend\Code\Reflection\DocBlock\Tag\TagInterface $reflectionTag) : \Zend\Code\Generator\DocBlock\Tag

Parameters

$reflectionTag

\Zend\Code\Reflection\DocBlock\Tag\TagInterface

Returns

\Zend\Code\Generator\DocBlock\Tag

generate()

generate() : string

Returns

string

getDescription()

getDescription() : string

Returns

string

getIndentation()

getIndentation() : string

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::getIndentation()

Returns

string

getName()

getName() : string

Returns

string

getSourceContent()

getSourceContent() : string

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::getSourceContent()

Returns

string

isSourceDirty()

isSourceDirty() : bool

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::isSourceDirty()

Returns

bool

setDescription()

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

Parameters

$description

string

Returns

\Zend\Code\Generator\DocBlock\Tag

setIndentation()

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

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::setIndentation()

Parameters

$indentation

string

Returns

\Zend\Code\Generator\AbstractGenerator

setName()

setName(string $name) : \Zend\Code\Generator\DocBlock\Tag

Parameters

$name

string

Returns

\Zend\Code\Generator\DocBlock\Tag

setOptions()

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

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::setOptions()

Parameters

$options

array\Traversable

Exceptions

`\Zend\Code\Generator\Exception\InvalidArgumentException`

Returns

\Zend\Code\Generator\AbstractGenerator

setSourceContent()

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

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::setSourceContent()

Parameters

$sourceContent

string

Returns

\Zend\Code\Generator\AbstractGenerator

setSourceDirty()

setSourceDirty(bool $isSourceDirty) : \Zend\Code\Generator\AbstractGenerator

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::setSourceDirty()

Parameters

$isSourceDirty

bool

Returns

\Zend\Code\Generator\AbstractGenerator

Properties

$description

$description : string

<p>4 spaces by default</p>

$indentation : int | string

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::$$indentation

$isSourceDirty

$isSourceDirty : bool

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::$$isSourceDirty

$name

$name : string

$sourceContent

$sourceContent : string

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::$$sourceContent

$typeFormats

$typeFormats : array

Constants

Line feed to use in place of EOL

LINE_FEED

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::LINE_FEED