package Default
inherited_from \Zend\Code\Generator\AbstractGenerator

 Methods

__construct()

__construct(string $shortDescription = null, string $longDescription = null, array $tags = array()
inherited_from \Zend\Code\Generator\AbstractGenerator::__construct()

Parameters

$shortDescription

string

$longDescription

string

$tags

array

__construct()

__construct(array $options = array()
Inherited

Parameters

$options

array

Generate from array

fromArray(array $array) : \Zend\Code\Generator\DocBlockGenerator
Static
configkey shortdescription string The short description for this doc block
configkey longdescription string The long description for this doc block
configkey tags array

Parameters

$array

array

Exceptions

\Zend\Code\Generator\Exception\InvalidArgumentException

Returns

\Zend\Code\Generator\DocBlockGenerator

Build a DocBlock generator object from a reflection object

fromReflection(\Zend\Code\Reflection\DocBlockReflection $reflectionDocBlock) : \Zend\Code\Generator\DocBlockGenerator
Static

Parameters

$reflectionDocBlock

\Zend\Code\Reflection\DocBlockReflection

Returns

\Zend\Code\Generator\DocBlockGenerator

generate()

generate() : string

Returns

string

getIndentation()

getIndentation() : string
Inherited

Returns

string

getLongDescription()

getLongDescription() : string

Returns

string

getShortDescription()

getShortDescription() : string

Returns

string

getSourceContent()

getSourceContent() : string
Inherited

Returns

string

getTags()

getTags() : array<mixed,\Zend\Code\Generator\DocBlock\Tag\TagInterface>

Returns

array<mixed,\Zend\Code\Generator\DocBlock\Tag\TagInterface>

getWordWrap()

getWordWrap() : boolean

Returns

boolean

isSourceDirty()

isSourceDirty() : boolean
Inherited

Returns

boolean

setIndentation()

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

Parameters

$indentation

string

Returns

\Zend\Code\Generator\AbstractGenerator

setLongDescription()

setLongDescription(string $longDescription) : \Zend\Code\Generator\DocBlockGenerator

Parameters

$longDescription

string

Returns

\Zend\Code\Generator\DocBlockGenerator

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

setShortDescription()

setShortDescription(string $shortDescription) : \Zend\Code\Generator\DocBlockGenerator

Parameters

$shortDescription

string

Returns

\Zend\Code\Generator\DocBlockGenerator

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

setTag()

setTag(array|\Zend\Code\Generator\DocBlock\Tag\TagInterface $tag) : \Zend\Code\Generator\DocBlockGenerator

Parameters

$tag

array\Zend\Code\Generator\DocBlock\Tag\TagInterface

Exceptions

\Zend\Code\Generator\Exception\InvalidArgumentException

Returns

\Zend\Code\Generator\DocBlockGenerator

setTags()

setTags(array $tags) : \Zend\Code\Generator\DocBlockGenerator

Parameters

$tags

array

Returns

\Zend\Code\Generator\DocBlockGenerator

setWordWrap()

setWordWrap(boolean $value) : \Zend\Code\Generator\DocBlockGenerator

Parameters

$value

boolean

Returns

\Zend\Code\Generator\DocBlockGenerator

docCommentize()

docCommentize(string $content) : string

Parameters

$content

string

Returns

string

getTagManager()

getTagManager() 
Static

 Properties

 

$indentation

$indentation : string

Default

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

4 spaces by default

$indentation : integer | string

Default

' '
 

$isSourceDirty

$isSourceDirty : boolean

Default

true
 

$longDescription

$longDescription : string

Default

null
 

$shortDescription

$shortDescription : string

Default

null
 

$sourceContent

$sourceContent : string

Default

null
 

$tagManager

$tagManager 

Default

Static
 

$tags

$tags : array

Default

array()
 

$wordwrap

$wordwrap : boolean

Default

true

 Constants

 

Line feed to use in place of EOL

LINE_FEED = "\n"