CodeGenerator/Php/Docblock/Tag/Param.php

Show:

inherited

Classes
- \Zend_CodeGenerator_Php_Docblock_Tag_Param

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: Param.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_CodeGenerator_Php_Docblock_Tag_Param
jump to top

Package: Zend\CodeGenerator

Parent(s): \Zend_CodeGenerator_Php_Docblock_Tag < \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

Line feed to use in place of EOL

Inherited from: \Zend_CodeGenerator_Php_Abstract::LINE_FEED \Zend_CodeGenerator_Php_Docblock_Tag::LINE_FEED

Inherited_from: \Zend_CodeGenerator_Php_Abstract::LINE_FEED
Inherited_from: \Zend_CodeGenerator_Php_Docblock_Tag::LINE_FEED

Properties

string $_datatype = null

Default valuenullDetails

Type: string

string $_description = null

Default valuenullDetails

Type: string

int|string $_indentation = ' '

inherited

Inherited from: \Zend_CodeGenerator_Php_Abstract::$$_indentation \Zend_CodeGenerator_Php_Docblock_Tag::$$_indentation

Default value' 'Details

Type: int | string
Inherited_from: \Zend_CodeGenerator_Php_Abstract::$$_indentation
Inherited_from: \Zend_CodeGenerator_Php_Docblock_Tag::$$_indentation

bool $_isSourceDirty = true

inherited

Inherited from: \Zend_CodeGenerator_Php_Abstract::$$_isSourceDirty \Zend_CodeGenerator_Php_Docblock_Tag::$$_isSourceDirty

Default valuetrueDetails

Type: bool
Inherited_from: \Zend_CodeGenerator_Php_Abstract::$$_isSourceDirty
Inherited_from: \Zend_CodeGenerator_Php_Docblock_Tag::$$_isSourceDirty

string $_name = null

inherited

Inherited from: \Zend_CodeGenerator_Php_Docblock_Tag::$$_name

Default valuenullDetails

Type: string
Inherited_from: \Zend_CodeGenerator_Php_Docblock_Tag::$$_name

string $_paramName = null

Default valuenullDetails

Type: string

\Zend_Loader_PluginLoader $_pluginLoader = null

staticinherited

Inherited from: \Zend_CodeGenerator_Php_Docblock_Tag::$$_pluginLoader

Default valuenullDetails

Type: \Zend_Loader_PluginLoader
Inherited_from: \Zend_CodeGenerator_Php_Docblock_Tag::$$_pluginLoader

string $_sourceContent = null

inherited

Inherited from: \Zend_CodeGenerator_Abstract::$$_sourceContent \Zend_CodeGenerator_Php_Abstract::$$_sourceContent \Zend_CodeGenerator_Php_Docblock_Tag::$$_sourceContent

Default valuenullDetails

Type: string
Inherited_from: \Zend_CodeGenerator_Abstract::$$_sourceContent
Inherited_from: \Zend_CodeGenerator_Php_Abstract::$$_sourceContent
Inherited_from: \Zend_CodeGenerator_Php_Docblock_Tag::$$_sourceContent

Methods

__construct(array $options = array()) : void

inherited

__construct()

Inherited from: \Zend_CodeGenerator_Abstract::__construct()\Zend_CodeGenerator_Php_Abstract::__construct()\Zend_CodeGenerator_Php_Docblock_Tag::__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()\Zend_CodeGenerator_Php_Docblock_Tag::__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()\Zend_CodeGenerator_Php_Docblock_Tag::_init()

_prepare() : void

inherited

_prepare() - this is called at construction completion

Inherited from: \Zend_CodeGenerator_Abstract::_prepare()\Zend_CodeGenerator_Php_Abstract::_prepare()\Zend_CodeGenerator_Php_Docblock_Tag::_prepare()

factory( $tagName) : void

staticinherited

Inherited from: \Zend_CodeGenerator_Php_Docblock_Tag::factory()

Parameters

Name	Type	Description
$tagName

fromReflection(\Zend_Reflection_Docblock_Tag $reflectionTagParam) : \Zend_CodeGenerator_Php_Docblock_Tag

static

fromReflection()

Parameters

Name	Type	Description
$reflectionTagParam	\Zend_Reflection_Docblock_Tag

Returns

Type	Description
\Zend_CodeGenerator_Php_Docblock_Tag

generate() : string

generate()

Returns

Type	Description
string

getDatatype() : string

getDatatype

Returns

Type	Description
string

getDescription() : string

inherited

getDescription()

Inherited from: \Zend_CodeGenerator_Php_Docblock_Tag::getDescription()

Returns

Type	Description
string

getIndentation() : string | int

inherited

getIndentation()

Inherited from: \Zend_CodeGenerator_Php_Abstract::getIndentation()\Zend_CodeGenerator_Php_Docblock_Tag::getIndentation()

Returns

Type	Description
string \| int

getName() : string

inherited

getName()

Inherited from: \Zend_CodeGenerator_Php_Docblock_Tag::getName()

Returns

Type	Description
string

getParamName() : string

getParamName()

Returns

Type	Description
string

getPluginLoader() : \Zend_Loader_PluginLoader

staticinherited

getPluginLoader()

Inherited from: \Zend_CodeGenerator_Php_Docblock_Tag::getPluginLoader()

Returns

Type	Description
\Zend_Loader_PluginLoader

getSourceContent() : string

inherited

getSourceContent()

Inherited from: \Zend_CodeGenerator_Abstract::getSourceContent()\Zend_CodeGenerator_Php_Abstract::getSourceContent()\Zend_CodeGenerator_Php_Docblock_Tag::getSourceContent()

Returns

Type	Description
string

isSourceDirty() : bool

inherited

isSourceDirty()

Inherited from: \Zend_CodeGenerator_Php_Abstract::isSourceDirty()\Zend_CodeGenerator_Php_Docblock_Tag::isSourceDirty()

Returns

Type	Description
bool

setConfig(\Zend_Config $config) : \Zend_CodeGenerator_Abstract

inherited

setConfig()

Inherited from: \Zend_CodeGenerator_Abstract::setConfig()\Zend_CodeGenerator_Php_Abstract::setConfig()\Zend_CodeGenerator_Php_Docblock_Tag::setConfig()

Parameters

Name	Type	Description
$config	\Zend_Config

Returns

Type	Description
\Zend_CodeGenerator_Abstract

setDatatype(string $datatype) : \Zend_CodeGenerator_Php_Docblock_Tag_Param

setDatatype()

Parameters

Name	Type	Description
$datatype	string

Returns

Type	Description
\Zend_CodeGenerator_Php_Docblock_Tag_Param

setDescription(string $description) : \Zend_CodeGenerator_Php_Docblock_Tag

inherited

setDescription()

Inherited from: \Zend_CodeGenerator_Php_Docblock_Tag::setDescription()

Parameters

Name	Type	Description
$description	string

Returns

Type	Description
\Zend_CodeGenerator_Php_Docblock_Tag

setIndentation(string | int $indentation) : \Zend_CodeGenerator_Php_Abstract

inherited

setIndentation()

Inherited from: \Zend_CodeGenerator_Php_Abstract::setIndentation()\Zend_CodeGenerator_Php_Docblock_Tag::setIndentation()

Parameters

Name	Type	Description
$indentation	string \| int

Returns

Type	Description
\Zend_CodeGenerator_Php_Abstract

setName(string $name) : \Zend_CodeGenerator_Php_Docblock_Tag

inherited

setName()

Inherited from: \Zend_CodeGenerator_Php_Docblock_Tag::setName()

Parameters

Name	Type	Description
$name	string

Returns

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()\Zend_CodeGenerator_Php_Docblock_Tag::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_CodeGenerator_Abstract

setParamName(string $paramName) : \Zend_CodeGenerator_Php_Docblock_Tag_Param

setParamName()

Parameters

Name	Type	Description
$paramName	string

Returns

Type	Description
\Zend_CodeGenerator_Php_Docblock_Tag_Param

setPluginLoader(\Zend_Loader_PluginLoader $pluginLoader) : void

staticinherited

setPluginLoader()

Inherited from: \Zend_CodeGenerator_Php_Docblock_Tag::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()\Zend_CodeGenerator_Php_Docblock_Tag::setSourceContent()

Parameters

Name	Type	Description
$sourceContent	string

setSourceDirty(bool $isSourceDirty = true) : \Zend_CodeGenerator_Php_Abstract

inherited

setSourceDirty()

Inherited from: \Zend_CodeGenerator_Php_Abstract::setSourceDirty()\Zend_CodeGenerator_Php_Docblock_Tag::setSourceDirty()

Parameters

Name	Type	Description
$isSourceDirty	bool

Returns

Type	Description
\Zend_CodeGenerator_Php_Abstract

CodeGenerator/Php/Docblock/Tag/Param.php

\Zend_CodeGenerator_Php_Docblock_Tag_Paramjump to top

Constants

Properties

Methods

\Zend_CodeGenerator_Php_Docblock_Tag_Param
jump to top