API Documentation

CodeGenerator/Php/Method.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: Method.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_CodeGenerator_Php_Method

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

Properties

Propertyprotectedstring  $_body= 'null'

Default valuenullDetails
Type
string
Propertyprotected\Zend_CodeGenerator_Php_Docblock  $_docblock= 'null'

Default valuenullDetails
Type
\Zend_CodeGenerator_Php_Docblock
Propertyprotectedbool  $_isFinal= 'false'

Default valuefalseDetails
Type
bool
Propertyprotectedarray  $_parameters= 'array'

Default valuearrayDetails
Type
array

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()
methodpublicfromReflection( \Zend_Reflection_Method $reflectionMethod ) : \Zend_CodeGenerator_Php_Method
static

fromReflection()

Parameters
Name Type Description
$reflectionMethod \Zend_Reflection_Method
Returns
Type Description
\Zend_CodeGenerator_Php_Method
methodpublicgenerate( ) : string

generate()

Returns
Type Description
string
methodpublicgetBody( ) : string

getBody()

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
methodpublicgetParameters( ) : array

getParameters()

Returns
Type Description
array Array of Zend_CodeGenerator_Php_Parameter
methodpublicgetSourceContent( ) : string

getSourceContent()

Inherited from: \Zend_CodeGenerator_Abstract::getSourceContent()
Returns
Type Description
string
methodpublicgetVisibility( ) : \const
Returns
Type Description
\const
methodpublicisAbstract( ) : bool
Returns
Type Description
bool
methodpublicisFinal( ) : bool
Returns
Type Description
bool
methodpublicisSourceDirty( ) : bool

isSourceDirty()

Inherited from: \Zend_CodeGenerator_Php_Abstract::isSourceDirty()
Returns
Type Description
bool
methodpublicisStatic( ) : bool
Returns
Type Description
bool
methodpublicsetAbstract( bool $isAbstract ) : \Zend_CodeGenerator_Php_Member_Abstract
Parameters
Name Type Description
$isAbstract bool
Returns
Type Description
\Zend_CodeGenerator_Php_Member_Abstract
methodpublicsetBody( string $body ) : \Zend_CodeGenerator_Php_Method

setBody()

Parameters
Name Type Description
$body string
Returns
Type Description
\Zend_CodeGenerator_Php_Method
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
methodpublicsetDocblock( \Zend_CodeGenerator_Php_Docblock|array|string $docblock ) : \Zend_CodeGenerator_Php_File

setDocblock() Set the docblock

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

setFinal()

Parameters
Name Type Description
$isFinal bool
Returns
Type Description
\Zend_CodeGenerator_Php_Member_Abstract
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_Member_Abstract
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_CodeGenerator_Php_Member_Abstract
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
methodpublicsetParameter( \Zend_CodeGenerator_Php_Parameter|array $parameter ) : \Zend_CodeGenerator_Php_Method

setParameter()

Parameters
Name Type Description
$parameter \Zend_CodeGenerator_Php_Parameter|array
Returns
Type Description
\Zend_CodeGenerator_Php_Method
methodpublicsetParameters( array $parameters ) : \Zend_CodeGenerator_Php_Method

setParameters()

Parameters
Name Type Description
$parameters array
Returns
Type Description
\Zend_CodeGenerator_Php_Method
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
methodpublicsetStatic( bool $isStatic ) : \Zend_CodeGenerator_Php_Member_Abstract
Parameters
Name Type Description
$isStatic bool
Returns
Type Description
\Zend_CodeGenerator_Php_Member_Abstract
methodpublicsetVisibility( \const $visibility ) : \Zend_CodeGenerator_Php_Member_Abstract
Parameters
Name Type Description
$visibility \const
Returns
Type Description
\Zend_CodeGenerator_Php_Member_Abstract
Documentation was generated by DocBlox 0.13.3.