category Zend
package Zend_CodeGenerator
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_CodeGenerator_Php_Abstract

 Methods

__construct()

__construct(array $options = array()
Inherited

Parameters

$options

array

__toString() - casting to a string will in turn call generate()

__toString() : string
Inherited

Returns

string

fromReflection() - Build a docblock generator object from a reflection object

fromReflection(\Zend_Reflection_Docblock $reflectionDocblock) : \Zend_CodeGenerator_Php_Docblock
Static

Parameters

$reflectionDocblock

\Zend_Reflection_Docblock

Returns

\Zend_CodeGenerator_Php_Docblock

generate()

generate() : string

Returns

string

generate() - must be implemented by the child

generate() 
Inherited

getIndentation()

getIndentation() : string | integer
Inherited

Returns

stringinteger

getLongDescription()

getLongDescription() : string

Returns

string

getShortDescription()

getShortDescription() : string

Returns

string

getSourceContent()

getSourceContent() : string
Inherited

Returns

string

getTags

getTags() : array

Returns

arrayArray of Zend_CodeGenerator_Php_Docblock_Tag

isSourceDirty()

isSourceDirty() : boolean
Inherited

Returns

boolean

setConfig()

setConfig(\Zend_Config $config) : \Zend_CodeGenerator_Abstract
Inherited

Parameters

$config

\Zend_Config

Returns

\Zend_CodeGenerator_Abstract

setIndentation()

setIndentation(string|integer $indentation) : \Zend_CodeGenerator_Php_Abstract
Inherited

Parameters

$indentation

stringinteger

Returns

\Zend_CodeGenerator_Php_Abstract

setLongDescription()

setLongDescription(string $longDescription) : \Zend_CodeGenerator_Php_Docblock

Parameters

$longDescription

string

Returns

\Zend_CodeGenerator_Php_Docblock

setOptions()

setOptions(array $options) : \Zend_CodeGenerator_Abstract
Inherited

Parameters

$options

array

Returns

\Zend_CodeGenerator_Abstract

setShortDescription()

setShortDescription(string $shortDescription) : \Zend_CodeGenerator_Php_Docblock

Parameters

$shortDescription

string

Returns

\Zend_CodeGenerator_Php_Docblock

setSourceContent()

setSourceContent(string $sourceContent) 
Inherited

Parameters

$sourceContent

string

setSourceDirty()

setSourceDirty(boolean $isSourceDirty = true) : \Zend_CodeGenerator_Php_Abstract
Inherited

Parameters

$isSourceDirty

boolean

Returns

\Zend_CodeGenerator_Php_Abstract

setTag()

setTag(array|\Zend_CodeGenerator_Php_Docblock_Tag $tag) : \Zend_CodeGenerator_Php_Docblock

Parameters

$tag

array\Zend_CodeGenerator_Php_Docblock_Tag

Returns

\Zend_CodeGenerator_Php_Docblock

setTags()

setTags(array $tags) : \Zend_CodeGenerator_Php_Docblock

Parameters

$tags

array

Returns

\Zend_CodeGenerator_Php_Docblock

_docCommentize()

_docCommentize(string $content) : string

Parameters

$content

string

Returns

string

_init() - this is called before the constuctor

_init() 
Inherited

_prepare() - this is called at construction completion

_prepare() 
Inherited

 Properties

 

$_indentation

$_indentation : string

Default

''
inherited_from \Zend_CodeGenerator_Php_Abstract::_indentation
 

$_indentation

$_indentation : integer | string

Default

' '
 

$_isSourceDirty

$_isSourceDirty : boolean

Default

true
 

$_longDescription

$_longDescription : string

Default

null
 

$_shortDescription

$_shortDescription : string

Default

null
 

$_sourceContent

$_sourceContent : string

Default

null
 

$_tags

$_tags : array

Default

array()

 Constants

 

Line feed to use in place of EOL

LINE_FEED = "\n"