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

\Zend_CodeGenerator_Php_Method
jump to top

Package: Zend\CodeGenerator
Parent(s)
\Zend_CodeGenerator_Php_Member_Abstract < \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  VISIBILITY_PUBLIC = 'public'
inheritedInherited from: \Zend_CodeGenerator_Php_Member_Abstract::VISIBILITY_PUBLIC
Inherited_from
\Zend_CodeGenerator_Php_Member_Abstract::VISIBILITY_PUBLIC  
>VConstant  VISIBILITY_PROTECTED = 'protected'
inheritedInherited from: \Zend_CodeGenerator_Php_Member_Abstract::VISIBILITY_PROTECTED
Inherited_from
\Zend_CodeGenerator_Php_Member_Abstract::VISIBILITY_PROTECTED  
>VConstant  VISIBILITY_PRIVATE = 'private'
inheritedInherited from: \Zend_CodeGenerator_Php_Member_Abstract::VISIBILITY_PRIVATE
Inherited_from
\Zend_CodeGenerator_Php_Member_Abstract::VISIBILITY_PRIVATE  
>VConstant  LINE_FEED = "\n"
inherited
Line feed to use in place of EOL
Inherited from: \Zend_CodeGenerator_Php_Abstract::LINE_FEED\Zend_CodeGenerator_Php_Member_Abstract::LINE_FEED
Inherited_from
\Zend_CodeGenerator_Php_Abstract::LINE_FEED  
Inherited_from
\Zend_CodeGenerator_Php_Member_Abstract::LINE_FEED  

Properties

>VPropertyprotectedstring $_body = null
Default valuenullDetails
Type
string
>VPropertyprotected\Zend_CodeGenerator_Php_Docblock $_docblock = null
Default valuenullDetails
Type
\Zend_CodeGenerator_Php_Docblock
>VPropertyprotectedint|string $_indentation = ' '
inherited
Inherited from: \Zend_CodeGenerator_Php_Abstract::$$_indentation\Zend_CodeGenerator_Php_Member_Abstract::$$_indentation
Default value' 'Details
Type
int | string
Inherited_from
\Zend_CodeGenerator_Php_Abstract::$$_indentation  
Inherited_from
\Zend_CodeGenerator_Php_Member_Abstract::$$_indentation  
>VPropertyprotectedbool $_isAbstract = false
inherited
Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::$$_isAbstract
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_CodeGenerator_Php_Member_Abstract::$$_isAbstract  
>VPropertyprotectedbool $_isFinal = false
Default valuefalseDetails
Type
bool
>VPropertyprotectedbool $_isSourceDirty = true
inherited
Inherited from: \Zend_CodeGenerator_Php_Abstract::$$_isSourceDirty\Zend_CodeGenerator_Php_Member_Abstract::$$_isSourceDirty
Default valuetrueDetails
Type
bool
Inherited_from
\Zend_CodeGenerator_Php_Abstract::$$_isSourceDirty  
Inherited_from
\Zend_CodeGenerator_Php_Member_Abstract::$$_isSourceDirty  
>VPropertyprotectedbool $_isStatic = false
inherited
Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::$$_isStatic
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_CodeGenerator_Php_Member_Abstract::$$_isStatic  
>VPropertyprotectedstring $_name = null
inherited
Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::$$_name
Default valuenullDetails
Type
string
Inherited_from
\Zend_CodeGenerator_Php_Member_Abstract::$$_name  
>VPropertyprotectedarray $_parameters = array()
Default valuearray()Details
Type
array
>VPropertyprotectedstring $_sourceContent = null
inherited
Inherited from: \Zend_CodeGenerator_Abstract::$$_sourceContent\Zend_CodeGenerator_Php_Abstract::$$_sourceContent\Zend_CodeGenerator_Php_Member_Abstract::$$_sourceContent
Default valuenullDetails
Type
string
Inherited_from
\Zend_CodeGenerator_Abstract::$$_sourceContent  
Inherited_from
\Zend_CodeGenerator_Php_Abstract::$$_sourceContent  
Inherited_from
\Zend_CodeGenerator_Php_Member_Abstract::$$_sourceContent  
>VPropertyprotected\const $_visibility = self::VISIBILITY_PUBLIC
inherited
Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::$$_visibility
Default valueself::VISIBILITY_PUBLICDetails
Type
\const
Inherited_from
\Zend_CodeGenerator_Php_Member_Abstract::$$_visibility  

Methods

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

__construct()

Inherited from: \Zend_CodeGenerator_Abstract::__construct()\Zend_CodeGenerator_Php_Abstract::__construct()\Zend_CodeGenerator_Php_Member_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()\Zend_CodeGenerator_Php_Member_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()\Zend_CodeGenerator_Php_Member_Abstract::_init()
methodprotected_prepare() : void
inherited

_prepare() - this is called at construction completion

Inherited from: \Zend_CodeGenerator_Abstract::_prepare()\Zend_CodeGenerator_Php_Abstract::_prepare()\Zend_CodeGenerator_Php_Member_Abstract::_prepare()
methodpublicfromReflection(\Zend_Reflection_Method $reflectionMethod) : \Zend_CodeGenerator_Php_Method
static

fromReflection()

Parameters
NameTypeDescription
$reflectionMethod\Zend_Reflection_Method
Returns
TypeDescription
\Zend_CodeGenerator_Php_Method
methodpublicgenerate() : string

generate()

Returns
TypeDescription
string
methodpublicgetBody() : string

getBody()

Returns
TypeDescription
string
methodpublicgetDocblock() : \Zend_CodeGenerator_Php_Docblock
inherited

getDocblock()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::getDocblock()
Returns
TypeDescription
\Zend_CodeGenerator_Php_Docblock
methodpublicgetIndentation() : string | int
inherited

getIndentation()

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

getName()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::getName()
Returns
TypeDescription
string
methodpublicgetParameters() : array

getParameters()

Returns
TypeDescription
arrayArray of Zend_CodeGenerator_Php_Parameter
methodpublicgetSourceContent() : string
inherited

getSourceContent()

Inherited from: \Zend_CodeGenerator_Abstract::getSourceContent()\Zend_CodeGenerator_Php_Abstract::getSourceContent()\Zend_CodeGenerator_Php_Member_Abstract::getSourceContent()
Returns
TypeDescription
string
methodpublicgetVisibility() : \const
inherited

getVisibility()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::getVisibility()
Returns
TypeDescription
\const
methodpublicisAbstract() : bool
inherited

isAbstract()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::isAbstract()
Returns
TypeDescription
bool
methodpublicisFinal() : bool
inherited

isFinal()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::isFinal()
Returns
TypeDescription
bool
methodpublicisSourceDirty() : bool
inherited

isSourceDirty()

Inherited from: \Zend_CodeGenerator_Php_Abstract::isSourceDirty()\Zend_CodeGenerator_Php_Member_Abstract::isSourceDirty()
Returns
TypeDescription
bool
methodpublicisStatic() : bool
inherited

isStatic()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::isStatic()
Returns
TypeDescription
bool
methodpublicsetAbstract(bool $isAbstract) : \Zend_CodeGenerator_Php_Member_Abstract
inherited

setAbstract()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::setAbstract()
Parameters
NameTypeDescription
$isAbstractbool
Returns
TypeDescription
\Zend_CodeGenerator_Php_Member_Abstract
methodpublicsetBody(string $body) : \Zend_CodeGenerator_Php_Method

setBody()

Parameters
NameTypeDescription
$bodystring
Returns
TypeDescription
\Zend_CodeGenerator_Php_Method
methodpublicsetConfig(\Zend_Config $config) : \Zend_CodeGenerator_Abstract
inherited

setConfig()

Inherited from: \Zend_CodeGenerator_Abstract::setConfig()\Zend_CodeGenerator_Php_Abstract::setConfig()\Zend_CodeGenerator_Php_Member_Abstract::setConfig()
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_CodeGenerator_Abstract
methodpublicsetDocblock(\Zend_CodeGenerator_Php_Docblock | array | string $docblock) : \Zend_CodeGenerator_Php_File
inherited

setDocblock() Set the docblock

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::setDocblock()
Parameters
NameTypeDescription
$docblock\Zend_CodeGenerator_Php_Docblock | array | string
Returns
TypeDescription
\Zend_CodeGenerator_Php_File
methodpublicsetFinal(bool $isFinal) : \Zend_CodeGenerator_Php_Member_Abstract

setFinal()

Parameters
NameTypeDescription
$isFinalbool
Returns
TypeDescription
\Zend_CodeGenerator_Php_Member_Abstract
methodpublicsetIndentation(string | int $indentation) : \Zend_CodeGenerator_Php_Abstract
inherited

setIndentation()

Inherited from: \Zend_CodeGenerator_Php_Abstract::setIndentation()\Zend_CodeGenerator_Php_Member_Abstract::setIndentation()
Parameters
NameTypeDescription
$indentationstring | int
Returns
TypeDescription
\Zend_CodeGenerator_Php_Abstract
methodpublicsetName(string $name) : \Zend_CodeGenerator_Php_Member_Abstract
inherited

setName()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::setName()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_CodeGenerator_Php_Member_Abstract
methodpublicsetOptions(array $options) : \Zend_CodeGenerator_Abstract
inherited

setOptions()

Inherited from: \Zend_CodeGenerator_Abstract::setOptions()\Zend_CodeGenerator_Php_Abstract::setOptions()\Zend_CodeGenerator_Php_Member_Abstract::setOptions()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_CodeGenerator_Abstract
methodpublicsetParameter(\Zend_CodeGenerator_Php_Parameter | array $parameter) : \Zend_CodeGenerator_Php_Method

setParameter()

Parameters
NameTypeDescription
$parameter\Zend_CodeGenerator_Php_Parameter | array
Returns
TypeDescription
\Zend_CodeGenerator_Php_Method
methodpublicsetParameters(array $parameters) : \Zend_CodeGenerator_Php_Method

setParameters()

Parameters
NameTypeDescription
$parametersarray
Returns
TypeDescription
\Zend_CodeGenerator_Php_Method
methodpublicsetSourceContent(string $sourceContent) : void
inherited

setSourceContent()

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

setSourceDirty()

Inherited from: \Zend_CodeGenerator_Php_Abstract::setSourceDirty()\Zend_CodeGenerator_Php_Member_Abstract::setSourceDirty()
Parameters
NameTypeDescription
$isSourceDirtybool
Returns
TypeDescription
\Zend_CodeGenerator_Php_Abstract
methodpublicsetStatic(bool $isStatic) : \Zend_CodeGenerator_Php_Member_Abstract
inherited

setStatic()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::setStatic()
Parameters
NameTypeDescription
$isStaticbool
Returns
TypeDescription
\Zend_CodeGenerator_Php_Member_Abstract
methodpublicsetVisibility(\const $visibility) : \Zend_CodeGenerator_Php_Member_Abstract
inherited

setVisitibility()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::setVisibility()
Parameters
NameTypeDescription
$visibility\const
Returns
TypeDescription
\Zend_CodeGenerator_Php_Member_Abstract
Documentation was generated by phpDocumentor 2.0.0a12.