package Default
inherited_from \Zend\Code\Generator\AbstractGenerator

 Methods

__construct()

__construct(string $authorName = null, string $authorEmail = null
inherited_from \Zend\Code\Generator\AbstractGenerator::__construct()

Parameters

$authorName

string

$authorEmail

string

__construct()

__construct(array $options = array()
Inherited

Parameters

$options

array

fromReflection()

fromReflection(\Zend\Code\Reflection\DocBlock\Tag\TagInterface $reflectionTag) : \Zend\Code\Generator\DocBlock\Tag\ReturnTag
Static
deprecated Deprecated in 2.3. Use TagManager::createTagFromReflection() instead

Parameters

$reflectionTag

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

Returns

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

generate()

generate() : string

Returns

string

getAuthorEmail()

getAuthorEmail() : string

Returns

string

getAuthorName()

getAuthorName() : string

Returns

string

getIndentation()

getIndentation() : string
Inherited

Returns

string

getName()

getName() : string

Returns

string

getSourceContent()

getSourceContent() : string
Inherited

Returns

string

isSourceDirty()

isSourceDirty() : boolean
Inherited

Returns

boolean

setAuthorEmail()

setAuthorEmail(string $authorEmail) : \Zend\Code\Generator\DocBlock\Tag\AuthorTag

Parameters

$authorEmail

string

Returns

\Zend\Code\Generator\DocBlock\Tag\AuthorTag

setAuthorName()

setAuthorName(string $authorName) : \Zend\Code\Generator\DocBlock\Tag\AuthorTag

Parameters

$authorName

string

Returns

\Zend\Code\Generator\DocBlock\Tag\AuthorTag

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

 Properties

 

$authorEmail

$authorEmail : string

Default

null
 

$authorName

$authorName : string

Default

null
 

4 spaces by default

$indentation : integer | string

Default

' '
 

$isSourceDirty

$isSourceDirty : boolean

Default

true
 

$sourceContent

$sourceContent : string

Default

null

 Constants

 

Line feed to use in place of EOL

LINE_FEED = "\n"