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

\Zend_CodeGenerator_Php_Parameter

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

Properties

>VPropertyprotectedstring $_defaultValue = null
Default valuenullDetails
Type
string
>VPropertyprotectedint|string $_indentation = ' '
Default value' 'Details
Type
int | string
Inherited_from
\Zend_CodeGenerator_Php_Abstract::$$_indentation  
>VPropertyprotectedbool $_isSourceDirty = true
Default valuetrueDetails
Type
bool
Inherited_from
\Zend_CodeGenerator_Php_Abstract::$$_isSourceDirty  
>VPropertyprotectedstring $_name = null
Default valuenullDetails
Type
string
>VPropertyprotectedbool $_passedByReference = false
Default valuefalseDetails
Type
bool
>VPropertyprotectedint $_position = null
Default valuenullDetails
Type
int
>VPropertyprotectedstring $_type = null
Default valuenullDetails
Type
string

Methods

methodpublic__construct(array $options = array()) : void
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_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_Parameter $reflectionParameter) : \Zend_CodeGenerator_Php_Parameter
static

fromReflection()

Parameters
NameTypeDescription
$reflectionParameter\Zend_Reflection_Parameter
Returns
TypeDescription
\Zend_CodeGenerator_Php_Parameter
methodpublicgenerate() : string

generate()

Returns
TypeDescription
string
methodpublicgetDefaultValue() : string

getDefaultValue()

Returns
TypeDescription
string
methodpublicgetIndentation() : string | int
inherited

getIndentation()

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

getName()

Returns
TypeDescription
string
methodpublicgetPassedByReference() : bool

Returns
TypeDescription
bool
methodpublicgetPosition() : int

getPosition()

Returns
TypeDescription
int
methodpublicgetSourceContent() : string
Returns
TypeDescription
string
methodpublicgetType() : string

getType()

Returns
TypeDescription
string
methodpublicisSourceDirty() : bool
inherited

isSourceDirty()

Inherited from: \Zend_CodeGenerator_Php_Abstract::isSourceDirty()
Returns
TypeDescription
bool
methodpublicsetConfig(\Zend_Config $config) : \Zend_CodeGenerator_Abstract
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_CodeGenerator_Abstract
methodpublicsetDefaultValue(null | bool | string | int | float | \Zend_CodeGenerator_Php_Parameter_DefaultValue $defaultValue) : \Zend_CodeGenerator_Php_Parameter

Set the default value of the parameter.

Certain variables are difficult to expres

Parameters
NameTypeDescription
$defaultValuenull | bool | string | int | float | \Zend_CodeGenerator_Php_Parameter_DefaultValue
Returns
TypeDescription
\Zend_CodeGenerator_Php_Parameter
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
methodpublicsetName(string $name) : \Zend_CodeGenerator_Php_Parameter

setName()

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_CodeGenerator_Php_Parameter
methodpublicsetOptions(array $options) : \Zend_CodeGenerator_Abstract
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_CodeGenerator_Abstract
methodpublicsetPassedByReference(bool $passedByReference) : \Zend_CodeGenerator_Php_Parameter

Parameters
NameTypeDescription
$passedByReferencebool
Returns
TypeDescription
\Zend_CodeGenerator_Php_Parameter
methodpublicsetPosition(int $position) : \Zend_CodeGenerator_Php_Parameter

setPosition()

Parameters
NameTypeDescription
$positionint
Returns
TypeDescription
\Zend_CodeGenerator_Php_Parameter
methodpublicsetSourceContent(string $sourceContent) : void
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
methodpublicsetType(string $type) : \Zend_CodeGenerator_Php_Parameter

setType()

Parameters
NameTypeDescription
$typestring
Returns
TypeDescription
\Zend_CodeGenerator_Php_Parameter
Documentation was generated by phpDocumentor 2.0.0a12.