CodeGenerator/Php/Docblock.php
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: Docblock.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_CodeGenerator_Php_Docblock
- Parent(s)
- \Zend_CodeGenerator_Php_Abstract < \Zend_CodeGenerator_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants

LINE_FEED
= "\n"
- Inherited_from
- \Zend_CodeGenerator_Php_Abstract::LINE_FEED
Properties


bool $_isSourceDirty = true
true
Details- Type
- bool
- Inherited_from
- \Zend_CodeGenerator_Php_Abstract::$$_isSourceDirty


string $_sourceContent = null
null
Details- Type
- string
- Inherited_from
- \Zend_CodeGenerator_Abstract::$$_sourceContent
- Inherited_from
- \Zend_CodeGenerator_Php_Abstract::$$_sourceContent
Methods


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


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


_docCommentize(string $content) : string
_docCommentize()
Name | Type | Description |
---|---|---|
$content | string |
Type | Description |
---|---|
string |


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

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

fromReflection(\Zend_Reflection_Docblock $reflectionDocblock) : \Zend_CodeGenerator_Php_Docblock
fromReflection() - Build a docblock generator object from a reflection object
Name | Type | Description |
---|---|---|
$reflectionDocblock | \Zend_Reflection_Docblock |
Type | Description |
---|---|
\Zend_CodeGenerator_Php_Docblock |


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


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


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


setLongDescription(string $longDescription) : \Zend_CodeGenerator_Php_Docblock
setLongDescription()
Name | Type | Description |
---|---|---|
$longDescription | string |
Type | Description |
---|---|
\Zend_CodeGenerator_Php_Docblock |


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


setShortDescription(string $shortDescription) : \Zend_CodeGenerator_Php_Docblock
setShortDescription()
Name | Type | Description |
---|---|---|
$shortDescription | string |
Type | Description |
---|---|
\Zend_CodeGenerator_Php_Docblock |


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


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


setTag(array | \Zend_CodeGenerator_Php_Docblock_Tag $tag) : \Zend_CodeGenerator_Php_Docblock
setTag()
Name | Type | Description |
---|---|---|
$tag | array | \Zend_CodeGenerator_Php_Docblock_Tag |
Type | Description |
---|---|
\Zend_CodeGenerator_Php_Docblock |


setTags(array $tags) : \Zend_CodeGenerator_Php_Docblock
setTags()
Name | Type | Description |
---|---|---|
$tags | array |
Type | Description |
---|---|
\Zend_CodeGenerator_Php_Docblock |