Zend Framework API Documentation
Back to top  

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_Docblock_Tag

 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

factory() 

factory($tagName) 
InheritedStatic

Parameters

$tagName

fromReflection()

fromReflection(\Zend_Reflection_Docblock_Tag $reflectionTagLicense) : \Zend_CodeGenerator_Php_Docblock_Tag_License
Static
inherited_from \Zend_CodeGenerator_Php_Docblock_Tag::fromReflection()

Parameters

$reflectionTagLicense

Returns

\Zend_CodeGenerator_Php_Docblock_Tag_License

fromReflection()

fromReflection(\Zend_Reflection_Docblock_Tag $reflectionTag) : \Zend_CodeGenerator_Php_Docblock_Tag
InheritedStatic

Parameters

$reflectionTag

\Zend_Reflection_Docblock_Tag

Returns

\Zend_CodeGenerator_Php_Docblock_Tag

generate()

generate() : string
inherited_from \Zend_CodeGenerator_Php_Docblock_Tag::generate()

Returns

string

generate() - must be implemented by the child

generate() 
Inherited

getDescription()

getDescription() : string
Inherited

Returns

string

getIndentation()

getIndentation() : string | integer
Inherited

Returns

stringinteger

getName()

getName() : string
Inherited

Returns

string

getPluginLoader()

getPluginLoader() : \Zend_Loader_PluginLoader
InheritedStatic

Returns

\Zend_Loader_PluginLoader

getSourceContent()

getSourceContent() : string
Inherited

Returns

string

getUrl()

getUrl() : string

Returns

string

isSourceDirty()

isSourceDirty() : boolean
Inherited

Returns

boolean

setConfig()

setConfig(\Zend_Config $config) : \Zend_CodeGenerator_Abstract
Inherited

Parameters

$config

\Zend_Config

Returns

\Zend_CodeGenerator_Abstract

setDescription()

setDescription(string $description) : \Zend_CodeGenerator_Php_Docblock_Tag
Inherited

Parameters

$description

string

Returns

\Zend_CodeGenerator_Php_Docblock_Tag

setIndentation()

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

Parameters

$indentation

stringinteger

Returns

\Zend_CodeGenerator_Php_Abstract

setName()

setName(string $name) : \Zend_CodeGenerator_Php_Docblock_Tag
Inherited

Parameters

$name

string

Returns

\Zend_CodeGenerator_Php_Docblock_Tag

setOptions()

setOptions(array $options) : \Zend_CodeGenerator_Abstract
Inherited

Parameters

$options

array

Returns

\Zend_CodeGenerator_Abstract

setPluginLoader()

setPluginLoader(\Zend_Loader_PluginLoader $pluginLoader) 
InheritedStatic

Parameters

$pluginLoader

\Zend_Loader_PluginLoader

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

setUrl()

setUrl(string $url) : \Zend_CodeGenerator_Php_Docblock_Tag_License

Parameters

$url

string

Returns

\Zend_CodeGenerator_Php_Docblock_Tag_License

_init() - this is called before the constuctor

_init() 
Inherited

_prepare() - this is called at construction completion

_prepare() 
Inherited

 Properties

 

$_description

$_description : string

Default

null
inherited_from \Zend_CodeGenerator_Php_Docblock_Tag::_description
 

$_description

$_description : string

Default

null
 

$_indentation

$_indentation : integer | string

Default

' '
 

$_isSourceDirty

$_isSourceDirty : boolean

Default

true
 

$_name

$_name : string

Default

null
 

$_pluginLoader

$_pluginLoader : \Zend_Loader_PluginLoader

Default

null
Static
 

$_sourceContent

$_sourceContent : string

Default

null
 

$_url

$_url : string

Default

null

 Constants

 

Line feed to use in place of EOL

LINE_FEED = "\n"