CodeGenerator/Php/Method.php

Show:

inherited

Classes
- \Zend_CodeGenerator_Php_Method

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: 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

 
                VISIBILITY_PUBLIC
                = 'public'

inheritedInherited from: \Zend_CodeGenerator_Php_Member_Abstract::VISIBILITY_PUBLIC

Inherited_from: \Zend_CodeGenerator_Php_Member_Abstract::VISIBILITY_PUBLIC

 
                VISIBILITY_PROTECTED
                = 'protected'

inheritedInherited from: \Zend_CodeGenerator_Php_Member_Abstract::VISIBILITY_PROTECTED

Inherited_from: \Zend_CodeGenerator_Php_Member_Abstract::VISIBILITY_PROTECTED

 
                VISIBILITY_PRIVATE
                = 'private'

inheritedInherited from: \Zend_CodeGenerator_Php_Member_Abstract::VISIBILITY_PRIVATE

Inherited_from: \Zend_CodeGenerator_Php_Member_Abstract::VISIBILITY_PRIVATE

 
                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

string $_body = null

Default valuenullDetails

Type: string

\Zend_CodeGenerator_Php_Docblock $_docblock = null

Default valuenullDetails

Type: \Zend_CodeGenerator_Php_Docblock

int|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

bool $_isAbstract = false

inherited

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::$$_isAbstract

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_CodeGenerator_Php_Member_Abstract::$$_isAbstract

bool $_isFinal = false

Default valuefalseDetails

Type: bool

bool $_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

bool $_isStatic = false

inherited

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::$$_isStatic

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_CodeGenerator_Php_Member_Abstract::$$_isStatic

string $_name = null

inherited

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::$$_name

Default valuenullDetails

Type: string
Inherited_from: \Zend_CodeGenerator_Php_Member_Abstract::$$_name

array $_parameters = array()

Default valuearray()Details

Type: array

string $_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

\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

__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

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_Member_Abstract::__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_Member_Abstract::_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_Member_Abstract::_prepare()

fromReflection(\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

generate() : string

generate()

Returns

Type	Description
string

getBody() : string

getBody()

Returns

Type	Description
string

getDocblock() : \Zend_CodeGenerator_Php_Docblock

inherited

getDocblock()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::getDocblock()

Returns

Type	Description
\Zend_CodeGenerator_Php_Docblock

getIndentation() : string | int

inherited

getIndentation()

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

Returns

Type	Description
string \| int

getName() : string

inherited

getName()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::getName()

Returns

Type	Description
string

getParameters() : array

getParameters()

Returns

Type	Description
array	Array of Zend_CodeGenerator_Php_Parameter

getSourceContent() : string

inherited

getSourceContent()

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

Returns

Type	Description
string

getVisibility() : \const

inherited

getVisibility()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::getVisibility()

Returns

Type	Description
\const

isAbstract() : bool

inherited

isAbstract()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::isAbstract()

Returns

Type	Description
bool

isFinal() : bool

inherited

isFinal()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::isFinal()

Returns

Type	Description
bool

isSourceDirty() : bool

inherited

isSourceDirty()

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

Returns

Type	Description
bool

isStatic() : bool

inherited

isStatic()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::isStatic()

Returns

Type	Description
bool

setAbstract(bool $isAbstract) : \Zend_CodeGenerator_Php_Member_Abstract

inherited

setAbstract()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::setAbstract()

Parameters

Name	Type	Description
$isAbstract	bool

Returns

Type	Description
\Zend_CodeGenerator_Php_Member_Abstract

setBody(string $body) : \Zend_CodeGenerator_Php_Method

setBody()

Parameters

Name	Type	Description
$body	string

Returns

Type	Description
\Zend_CodeGenerator_Php_Method

setConfig(\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

Name	Type	Description
$config	\Zend_Config

Returns

Type	Description
\Zend_CodeGenerator_Abstract

setDocblock(\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

Name	Type	Description
$docblock	\Zend_CodeGenerator_Php_Docblock \| array \| string

Returns

Type	Description
\Zend_CodeGenerator_Php_File

setFinal(bool $isFinal) : \Zend_CodeGenerator_Php_Member_Abstract

setFinal()

Parameters

Name	Type	Description
$isFinal	bool

Returns

Type	Description
\Zend_CodeGenerator_Php_Member_Abstract

setIndentation(string | int $indentation) : \Zend_CodeGenerator_Php_Abstract

inherited

setIndentation()

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

Parameters

Name	Type	Description
$indentation	string \| int

Returns

Type	Description
\Zend_CodeGenerator_Php_Abstract

setName(string $name) : \Zend_CodeGenerator_Php_Member_Abstract

inherited

setName()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::setName()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_CodeGenerator_Php_Member_Abstract

setOptions(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

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_CodeGenerator_Abstract

setParameter(\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

setParameters(array $parameters) : \Zend_CodeGenerator_Php_Method

setParameters()

Parameters

Name	Type	Description
$parameters	array

Returns

Type	Description
\Zend_CodeGenerator_Php_Method

setSourceContent(string $sourceContent) : void

inherited

setSourceContent()

Inherited from: \Zend_CodeGenerator_Abstract::setSourceContent()\Zend_CodeGenerator_Php_Abstract::setSourceContent()\Zend_CodeGenerator_Php_Member_Abstract::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_Member_Abstract::setSourceDirty()

Parameters

Name	Type	Description
$isSourceDirty	bool

Returns

Type	Description
\Zend_CodeGenerator_Php_Abstract

setStatic(bool $isStatic) : \Zend_CodeGenerator_Php_Member_Abstract

inherited

setStatic()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::setStatic()

Parameters

Name	Type	Description
$isStatic	bool

Returns

Type	Description
\Zend_CodeGenerator_Php_Member_Abstract

setVisibility(\const $visibility) : \Zend_CodeGenerator_Php_Member_Abstract

inherited

setVisitibility()

Inherited from: \Zend_CodeGenerator_Php_Member_Abstract::setVisibility()

Parameters

Name	Type	Description
$visibility	\const

Returns

Type	Description
\Zend_CodeGenerator_Php_Member_Abstract

CodeGenerator/Php/Method.php

\Zend_CodeGenerator_Php_Methodjump to top

Constants

Properties

Methods

\Zend_CodeGenerator_Php_Method
jump to top