CodeGenerator/Php/Docblock/Tag.php
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_CodeGenerator
- Subpackage
- PHP
- Version
- $Id: Tag.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_CodeGenerator_Php_Docblock_Tag
Package: Zend\CodeGenerator


















- Parent(s)
- \Zend_CodeGenerator_Php_Abstract < \Zend_CodeGenerator_Abstract
- Children
- \Zend_CodeGenerator_Php_Docblock_Tag_License
- \Zend_CodeGenerator_Php_Docblock_Tag_Return
- \Zend_CodeGenerator_Php_Docblock_Tag_Param
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants

LINE_FEED
= "\n"
inherited
Line feed to use in place of EOL
Inherited from:
\Zend_CodeGenerator_Php_Abstract::LINE_FEED- Inherited_from
- \Zend_CodeGenerator_Php_Abstract::LINE_FEED
Properties


int|string $_indentation = ' '
inheritedInherited from:
\Zend_CodeGenerator_Php_Abstract::$$_indentation
Default value
' '
Details- Type
- int | string
- Inherited_from
- \Zend_CodeGenerator_Php_Abstract::$$_indentation


bool $_isSourceDirty = true
inheritedInherited from:
\Zend_CodeGenerator_Php_Abstract::$$_isSourceDirty
Default value
true
Details- Type
- bool
- Inherited_from
- \Zend_CodeGenerator_Php_Abstract::$$_isSourceDirty


string $_sourceContent = null
inheritedInherited from:
\Zend_CodeGenerator_Abstract::$$_sourceContent\Zend_CodeGenerator_Php_Abstract::$$_sourceContent
Default value
null
Details- Type
- string
- Inherited_from
- \Zend_CodeGenerator_Abstract::$$_sourceContent
- Inherited_from
- \Zend_CodeGenerator_Php_Abstract::$$_sourceContent
Methods


__construct(array $options = array()) : void
inherited
__construct()
Inherited from: \Zend_CodeGenerator_Abstract::__construct()\Zend_CodeGenerator_Php_Abstract::__construct()Parameters
Name | Type | Description |
---|---|---|
$options | array |


__toString() : string
finalinherited
__toString() - casting to a string will in turn call generate()
Inherited from: \Zend_CodeGenerator_Abstract::__toString()\Zend_CodeGenerator_Php_Abstract::__toString()Returns
Type | Description |
---|---|
string |


_init() : void
inherited
_init() - this is called before the constuctor
Inherited from: \Zend_CodeGenerator_Abstract::_init()\Zend_CodeGenerator_Php_Abstract::_init()

_prepare() : void
inherited
_prepare() - this is called at construction completion
Inherited from: \Zend_CodeGenerator_Abstract::_prepare()\Zend_CodeGenerator_Php_Abstract::_prepare()

fromReflection(\Zend_Reflection_Docblock_Tag $reflectionTag) : \Zend_CodeGenerator_Php_Docblock_Tag
static
fromReflection()
Parameters
Returns
Name | Type | Description |
---|---|---|
$reflectionTag | \Zend_Reflection_Docblock_Tag |
Type | Description |
---|---|
\Zend_CodeGenerator_Php_Docblock_Tag |


getPluginLoader() : \Zend_Loader_PluginLoader
static
getPluginLoader()
Returns
Type | Description |
---|---|
\Zend_Loader_PluginLoader |


getSourceContent() : string
inherited
getSourceContent()
Inherited from: \Zend_CodeGenerator_Abstract::getSourceContent()\Zend_CodeGenerator_Php_Abstract::getSourceContent()Returns
Type | Description |
---|---|
string |


setConfig(\Zend_Config $config) : \Zend_CodeGenerator_Abstract
inherited
setConfig()
Inherited from: \Zend_CodeGenerator_Abstract::setConfig()\Zend_CodeGenerator_Php_Abstract::setConfig()Parameters
Returns
Name | Type | Description |
---|---|---|
$config | \Zend_Config |
Type | Description |
---|---|
\Zend_CodeGenerator_Abstract |


setDescription(string $description) : \Zend_CodeGenerator_Php_Docblock_Tag
setDescription()
Parameters
Returns
Name | Type | Description |
---|---|---|
$description | string |
Type | Description |
---|---|
\Zend_CodeGenerator_Php_Docblock_Tag |


setIndentation(string | int $indentation) : \Zend_CodeGenerator_Php_Abstract
Parameters
Returns
Name | Type | Description |
---|---|---|
$indentation | string | int |
Type | Description |
---|---|
\Zend_CodeGenerator_Php_Abstract |


setName(string $name) : \Zend_CodeGenerator_Php_Docblock_Tag
setName()
Parameters
Returns
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
\Zend_CodeGenerator_Php_Docblock_Tag |


setOptions(array $options) : \Zend_CodeGenerator_Abstract
inherited
setOptions()
Inherited from: \Zend_CodeGenerator_Abstract::setOptions()\Zend_CodeGenerator_Php_Abstract::setOptions()Parameters
Returns
Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_CodeGenerator_Abstract |


setPluginLoader(\Zend_Loader_PluginLoader $pluginLoader) : void
static
setPluginLoader()
Parameters
Name | Type | Description |
---|---|---|
$pluginLoader | \Zend_Loader_PluginLoader |


setSourceContent(string $sourceContent) : void
inherited
setSourceContent()
Inherited from: \Zend_CodeGenerator_Abstract::setSourceContent()\Zend_CodeGenerator_Php_Abstract::setSourceContent()Parameters
Name | Type | Description |
---|---|---|
$sourceContent | string |


setSourceDirty(bool $isSourceDirty = true) : \Zend_CodeGenerator_Php_Abstract
Parameters
Returns
Name | Type | Description |
---|---|---|
$isSourceDirty | bool |
Type | Description |
---|---|
\Zend_CodeGenerator_Php_Abstract |