API Documentation

CodeGenerator/Php/Docblock/Tag/Param.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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_CodeGenerator  
subpackage
PHP  
version
$Id: Param.php 24390 2011-08-21 11:51:41Z padraic $  

\Zend_CodeGenerator_Php_Docblock_Tag_Param

Extends from
\Zend_CodeGenerator_Php_Docblock_Tag
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_CodeGenerator  

Properties

Propertyprotectedstring  $_datatype= 'null'

Default valuenullDetails
Type
string
Propertyprotectedstring  $_description= 'null'

Default valuenullDetails
Type
string
Propertyprotectedstring  $_paramName= 'null'

Default valuenullDetails
Type
string

Methods

methodpublic__construct( array $options = array ) : void

__construct()

Inherited from: \Zend_CodeGenerator_Abstract::__construct()
Parameters
Name Type Description
$options array
methodpublic__toString( ) : string
final

__toString() - casting to a string will in turn call generate()

Inherited from: \Zend_CodeGenerator_Abstract::__toString()
Returns
Type Description
string
methodprotected_init( ) : void

_init() - this is called before the constuctor

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

_prepare() - this is called at construction completion

Inherited from: \Zend_CodeGenerator_Abstract::_prepare()
methodpublicfactory(  $tagName ) : void
Parameters
Name Type Description
$tagName
methodpublicfromReflection( \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
methodpublicgenerate( ) : string

generate()

Returns
Type Description
string
methodpublicgetDatatype( ) : string

getDatatype

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

getIndentation()

Inherited from: \Zend_CodeGenerator_Php_Abstract::getIndentation()
Returns
Type Description
stringint
methodpublicgetName( ) : string
Returns
Type Description
string
methodpublicgetParamName( ) : string

getParamName()

Returns
Type Description
string
methodpublicgetPluginLoader( ) : \Zend_Loader_PluginLoader
static

getPluginLoader()

Inherited from: \Zend_CodeGenerator_Php_Docblock_Tag::getPluginLoader()
Returns
Type Description
\Zend_Loader_PluginLoader
methodpublicgetSourceContent( ) : string

getSourceContent()

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

isSourceDirty()

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

setConfig()

Inherited from: \Zend_CodeGenerator_Abstract::setConfig()
Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_CodeGenerator_Abstract
methodpublicsetDatatype( string $datatype ) : \Zend_CodeGenerator_Php_Docblock_Tag_Param

setDatatype()

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

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
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_CodeGenerator_Php_Docblock_Tag
methodpublicsetOptions( array $options ) : \Zend_CodeGenerator_Abstract

setOptions()

Inherited from: \Zend_CodeGenerator_Abstract::setOptions()
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_CodeGenerator_Abstract
methodpublicsetParamName( string $paramName ) : \Zend_CodeGenerator_Php_Docblock_Tag_Param

setParamName()

Parameters
Name Type Description
$paramName string
Returns
Type Description
\Zend_CodeGenerator_Php_Docblock_Tag_Param
methodpublicsetPluginLoader( \Zend_Loader_PluginLoader $pluginLoader ) : void
static

setPluginLoader()

Inherited from: \Zend_CodeGenerator_Php_Docblock_Tag::setPluginLoader()
Parameters
Name Type Description
$pluginLoader \Zend_Loader_PluginLoader
methodpublicsetSourceContent( string $sourceContent ) : void

setSourceContent()

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

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 DocBlox 0.13.3.