CodeGenerator/Php/Docblock/Tag.php

Show: inherited
Table of Contents

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 [email protected] 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
jump to top

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

Constant  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

Propertyprotectedstring $_description = null

Default valuenullDetails
Type
string
Propertyprotectedint|string $_indentation = ' '
inherited

Inherited from: \Zend_CodeGenerator_Php_Abstract::$$_indentation
Default value' 'Details
Type
int | string
Inherited_from
\Zend_CodeGenerator_Php_Abstract::$$_indentation  
Propertyprotectedbool $_isSourceDirty = true
inherited

Inherited from: \Zend_CodeGenerator_Php_Abstract::$$_isSourceDirty
Default valuetrueDetails
Type
bool
Inherited_from
\Zend_CodeGenerator_Php_Abstract::$$_isSourceDirty  
Propertyprotectedstring $_name = null

Default valuenullDetails
Type
string
Propertyprotected\Zend_Loader_PluginLoader $_pluginLoader = null
static

Default valuenullDetails
Type
\Zend_Loader_PluginLoader
Propertyprotectedstring $_sourceContent = null
inherited

Inherited from: \Zend_CodeGenerator_Abstract::$$_sourceContent\Zend_CodeGenerator_Php_Abstract::$$_sourceContent
Default valuenullDetails
Type
string
Inherited_from
\Zend_CodeGenerator_Abstract::$$_sourceContent  
Inherited_from
\Zend_CodeGenerator_Php_Abstract::$$_sourceContent  

Methods

methodpublic__construct(array $options = array()) : void
inherited

__construct()

Inherited from: \Zend_CodeGenerator_Abstract::__construct()\Zend_CodeGenerator_Php_Abstract::__construct()
Parameters
Name Type Description
$options array
methodpublic__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
methodprotected_init() : void
inherited

_init() - this is called before the constuctor

Inherited from: \Zend_CodeGenerator_Abstract::_init()\Zend_CodeGenerator_Php_Abstract::_init()
methodprotected_prepare() : void
inherited

_prepare() - this is called at construction completion

Inherited from: \Zend_CodeGenerator_Abstract::_prepare()\Zend_CodeGenerator_Php_Abstract::_prepare()
methodpublicfactory( $tagName) : void
static

Parameters
Name Type Description
$tagName
methodpublicfromReflection(\Zend_Reflection_Docblock_Tag $reflectionTag) : \Zend_CodeGenerator_Php_Docblock_Tag
static

fromReflection()

Parameters
Name Type Description
$reflectionTag \Zend_Reflection_Docblock_Tag
Returns
Type Description
\Zend_CodeGenerator_Php_Docblock_Tag
methodpublicgenerate() : string

generate()

Returns
Type Description
string
methodpublicgetDescription() : string

getDescription()

Returns
Type Description
string
methodpublicgetIndentation() : string | int
inherited

getIndentation()

Inherited from: \Zend_CodeGenerator_Php_Abstract::getIndentation()
Returns
Type Description
string | int
methodpublicgetName() : string

getName()

Returns
Type Description
string
methodpublicgetPluginLoader() : \Zend_Loader_PluginLoader
static

getPluginLoader()

Returns
Type Description
\Zend_Loader_PluginLoader
methodpublicgetSourceContent() : string
inherited

getSourceContent()

Inherited from: \Zend_CodeGenerator_Abstract::getSourceContent()\Zend_CodeGenerator_Php_Abstract::getSourceContent()
Returns
Type Description
string
methodpublicisSourceDirty() : bool
inherited

isSourceDirty()

Inherited from: \Zend_CodeGenerator_Php_Abstract::isSourceDirty()
Returns
Type Description
bool
methodpublicsetConfig(\Zend_Config $config) : \Zend_CodeGenerator_Abstract
inherited

setConfig()

Inherited from: \Zend_CodeGenerator_Abstract::setConfig()\Zend_CodeGenerator_Php_Abstract::setConfig()
Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_CodeGenerator_Abstract
methodpublicsetDescription(string $description) : \Zend_CodeGenerator_Php_Docblock_Tag

setDescription()

Parameters
Name Type Description
$description string
Returns
Type Description
\Zend_CodeGenerator_Php_Docblock_Tag
methodpublicsetIndentation(string | int $indentation) : \Zend_CodeGenerator_Php_Abstract
inherited

setIndentation()

Inherited from: \Zend_CodeGenerator_Php_Abstract::setIndentation()
Parameters
Name Type Description
$indentation string | int
Returns
Type Description
\Zend_CodeGenerator_Php_Abstract
methodpublicsetName(string $name) : \Zend_CodeGenerator_Php_Docblock_Tag

setName()

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_CodeGenerator_Php_Docblock_Tag
methodpublicsetOptions(array $options) : \Zend_CodeGenerator_Abstract
inherited

setOptions()

Inherited from: \Zend_CodeGenerator_Abstract::setOptions()\Zend_CodeGenerator_Php_Abstract::setOptions()
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_CodeGenerator_Abstract
methodpublicsetPluginLoader(\Zend_Loader_PluginLoader $pluginLoader) : void
static

setPluginLoader()

Parameters
Name Type Description
$pluginLoader \Zend_Loader_PluginLoader
methodpublicsetSourceContent(string $sourceContent) : void
inherited

setSourceContent()

Inherited from: \Zend_CodeGenerator_Abstract::setSourceContent()\Zend_CodeGenerator_Php_Abstract::setSourceContent()
Parameters
Name Type Description
$sourceContent string
methodpublicsetSourceDirty(bool $isSourceDirty = true) : \Zend_CodeGenerator_Php_Abstract
inherited

setSourceDirty()

Inherited from: \Zend_CodeGenerator_Php_Abstract::setSourceDirty()
Parameters
Name Type Description
$isSourceDirty bool
Returns
Type Description
\Zend_CodeGenerator_Php_Abstract
Documentation was generated by phpDocumentor 2.0.0a8.