CodeGenerator/Php/Docblock.php

Show: PublicProtectedPrivateinherited
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 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
jump to top

Package: Zend\CodeGenerator
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

>VConstant  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

>VPropertyprotectedstring $_indentation = ''
Default value''Details
Type
string
>VPropertyprotectedbool $_isSourceDirty = true
inherited
Inherited from: \Zend_CodeGenerator_Php_Abstract::$$_isSourceDirty
Default valuetrueDetails
Type
bool
Inherited_from
\Zend_CodeGenerator_Php_Abstract::$$_isSourceDirty  
>VPropertyprotectedstring $_longDescription = null
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_shortDescription = null
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_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  
>VPropertyprotectedarray $_tags = array()
Default valuearray()Details
Type
array

Methods

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

__construct()

Inherited from: \Zend_CodeGenerator_Abstract::__construct()\Zend_CodeGenerator_Php_Abstract::__construct()
Parameters
NameTypeDescription
$optionsarray
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
TypeDescription
string
methodprotected_docCommentize(string $content) : string

_docCommentize()

Parameters
NameTypeDescription
$contentstring
Returns
TypeDescription
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()
methodpublicfromReflection(\Zend_Reflection_Docblock $reflectionDocblock) : \Zend_CodeGenerator_Php_Docblock
static

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

Parameters
NameTypeDescription
$reflectionDocblock\Zend_Reflection_Docblock
Returns
TypeDescription
\Zend_CodeGenerator_Php_Docblock
methodpublicgenerate() : string

generate()

Returns
TypeDescription
string
methodpublicgetIndentation() : string | int
inherited

getIndentation()

Inherited from: \Zend_CodeGenerator_Php_Abstract::getIndentation()
Returns
TypeDescription
string | int
methodpublicgetLongDescription() : string

getLongDescription()

Returns
TypeDescription
string
methodpublicgetShortDescription() : string

getShortDescription()

Returns
TypeDescription
string
methodpublicgetSourceContent() : string
inherited

getSourceContent()

Inherited from: \Zend_CodeGenerator_Abstract::getSourceContent()\Zend_CodeGenerator_Php_Abstract::getSourceContent()
Returns
TypeDescription
string
methodpublicgetTags() : array

getTags

Returns
TypeDescription
arrayArray of Zend_CodeGenerator_Php_Docblock_Tag
methodpublicisSourceDirty() : bool
inherited

isSourceDirty()

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

setConfig()

Inherited from: \Zend_CodeGenerator_Abstract::setConfig()\Zend_CodeGenerator_Php_Abstract::setConfig()
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_CodeGenerator_Abstract
methodpublicsetIndentation(string | int $indentation) : \Zend_CodeGenerator_Php_Abstract
inherited

setIndentation()

Inherited from: \Zend_CodeGenerator_Php_Abstract::setIndentation()
Parameters
NameTypeDescription
$indentationstring | int
Returns
TypeDescription
\Zend_CodeGenerator_Php_Abstract
methodpublicsetLongDescription(string $longDescription) : \Zend_CodeGenerator_Php_Docblock

setLongDescription()

Parameters
NameTypeDescription
$longDescriptionstring
Returns
TypeDescription
\Zend_CodeGenerator_Php_Docblock
methodpublicsetOptions(array $options) : \Zend_CodeGenerator_Abstract
inherited

setOptions()

Inherited from: \Zend_CodeGenerator_Abstract::setOptions()\Zend_CodeGenerator_Php_Abstract::setOptions()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_CodeGenerator_Abstract
methodpublicsetShortDescription(string $shortDescription) : \Zend_CodeGenerator_Php_Docblock

setShortDescription()

Parameters
NameTypeDescription
$shortDescriptionstring
Returns
TypeDescription
\Zend_CodeGenerator_Php_Docblock
methodpublicsetSourceContent(string $sourceContent) : void
inherited

setSourceContent()

Inherited from: \Zend_CodeGenerator_Abstract::setSourceContent()\Zend_CodeGenerator_Php_Abstract::setSourceContent()
Parameters
NameTypeDescription
$sourceContentstring
methodpublicsetSourceDirty(bool $isSourceDirty = true) : \Zend_CodeGenerator_Php_Abstract
inherited

setSourceDirty()

Inherited from: \Zend_CodeGenerator_Php_Abstract::setSourceDirty()
Parameters
NameTypeDescription
$isSourceDirtybool
Returns
TypeDescription
\Zend_CodeGenerator_Php_Abstract
methodpublicsetTag(array | \Zend_CodeGenerator_Php_Docblock_Tag $tag) : \Zend_CodeGenerator_Php_Docblock

setTag()

Parameters
NameTypeDescription
$tagarray | \Zend_CodeGenerator_Php_Docblock_Tag
Returns
TypeDescription
\Zend_CodeGenerator_Php_Docblock
methodpublicsetTags(array $tags) : \Zend_CodeGenerator_Php_Docblock

setTags()

Parameters
NameTypeDescription
$tagsarray
Returns
TypeDescription
\Zend_CodeGenerator_Php_Docblock
Documentation was generated by phpDocumentor 2.0.0a12.