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

\Zend_CodeGenerator_Php_Member_Abstract

Package: Zend\CodeGenerator
Parent(s)
\Zend_CodeGenerator_Php_Abstract < \Zend_CodeGenerator_Abstract
Children
\Zend_CodeGenerator_Php_Property
\Zend_CodeGenerator_Php_Method
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  VISIBILITY_PUBLIC = 'public'
>VConstant  VISIBILITY_PROTECTED = 'protected'
>VConstant  VISIBILITY_PRIVATE = 'private'
>VConstant  LINE_FEED = "\n"
inherited
Line feed to use in place of EOL
Inherited from: \Zend_CodeGenerator_Php_Abstract::LINE_FEED

Properties

>VPropertyprotected\Zend_CodeGenerator_Php_Docblock $_docblock = null
Default valuenullDetails
Type
\Zend_CodeGenerator_Php_Docblock
>VPropertyprotectedint|string $_indentation = ' '
Default value' 'Details
Type
int | string
Inherited_from
\Zend_CodeGenerator_Php_Abstract::$$_indentation  
>VPropertyprotectedbool $_isAbstract = false
Default valuefalseDetails
Type
bool
>VPropertyprotectedbool $_isFinal = false
Default valuefalseDetails
Type
bool
>VPropertyprotectedbool $_isSourceDirty = true
Default valuetrueDetails
Type
bool
Inherited_from
\Zend_CodeGenerator_Php_Abstract::$$_isSourceDirty  
>VPropertyprotectedbool $_isStatic = false
Default valuefalseDetails
Type
bool
>VPropertyprotectedstring $_name = null
Default valuenullDetails
Type
string
>VPropertyprotected\const $_visibility = self::VISIBILITY_PUBLIC
Default valueself::VISIBILITY_PUBLICDetails
Type
\const

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()
methodpublicgenerate() : void
abstractinherited

generate() - must be implemented by the child

Inherited from: \Zend_CodeGenerator_Abstract::generate()\Zend_CodeGenerator_Php_Abstract::generate()
methodpublicgetDocblock() : \Zend_CodeGenerator_Php_Docblock

getDocblock()

Returns
TypeDescription
\Zend_CodeGenerator_Php_Docblock
methodpublicgetIndentation() : string | int
inherited

getIndentation()

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

getName()

Returns
TypeDescription
string
methodpublicgetSourceContent() : string
Returns
TypeDescription
string
methodpublicgetVisibility() : \const

getVisibility()

Returns
TypeDescription
\const
methodpublicisAbstract() : bool

isAbstract()

Returns
TypeDescription
bool
methodpublicisFinal() : bool

isFinal()

Returns
TypeDescription
bool
methodpublicisSourceDirty() : bool
inherited

isSourceDirty()

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

isStatic()

Returns
TypeDescription
bool
methodpublicsetAbstract(bool $isAbstract) : \Zend_CodeGenerator_Php_Member_Abstract

setAbstract()

Parameters
NameTypeDescription
$isAbstractbool
Returns
TypeDescription
\Zend_CodeGenerator_Php_Member_Abstract
methodpublicsetConfig(\Zend_Config $config) : \Zend_CodeGenerator_Abstract
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_CodeGenerator_Abstract
methodpublicsetDocblock(\Zend_CodeGenerator_Php_Docblock | array | string $docblock) : \Zend_CodeGenerator_Php_File

setDocblock() Set the docblock

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()
Parameters
NameTypeDescription
$indentationstring | int
Returns
TypeDescription
\Zend_CodeGenerator_Php_Abstract
methodpublicsetName(string $name) : \Zend_CodeGenerator_Php_Member_Abstract

setName()

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_CodeGenerator_Php_Member_Abstract
methodpublicsetOptions(array $options) : \Zend_CodeGenerator_Abstract
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_CodeGenerator_Abstract
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
methodpublicsetStatic(bool $isStatic) : \Zend_CodeGenerator_Php_Member_Abstract

setStatic()

Parameters
NameTypeDescription
$isStaticbool
Returns
TypeDescription
\Zend_CodeGenerator_Php_Member_Abstract
methodpublicsetVisibility(\const $visibility) : \Zend_CodeGenerator_Php_Member_Abstract

setVisitibility()

Parameters
NameTypeDescription
$visibility\const
Returns
TypeDescription
\Zend_CodeGenerator_Php_Member_Abstract
Documentation was generated by phpDocumentor 2.0.0a12.