CodeGenerator/Php/Member/Abstract.php

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

Constant  VISIBILITY_PUBLIC = 'public'
Constant  VISIBILITY_PROTECTED = 'protected'
Constant  VISIBILITY_PRIVATE = 'private'
Constant  LINE_FEED = "\n"
inherited

Line feed to use in place of EOL

Inherited from: \Zend_CodeGenerator_Php_Abstract::LINE_FEED

Properties

Propertyprotected\Zend_CodeGenerator_Php_Docblock $_docblock = null

Default valuenullDetails
Type
\Zend_CodeGenerator_Php_Docblock
Propertyprotectedint|string $_indentation = ' '
Default value' 'Details
Type
int | string
Inherited_from
\Zend_CodeGenerator_Php_Abstract::$$_indentation  
Propertyprotectedbool $_isAbstract = false

Default valuefalseDetails
Type
bool
Propertyprotectedbool $_isFinal = false

Default valuefalseDetails
Type
bool
Propertyprotectedbool $_isSourceDirty = true
Default valuetrueDetails
Type
bool
Inherited_from
\Zend_CodeGenerator_Php_Abstract::$$_isSourceDirty  
Propertyprotectedbool $_isStatic = false

Default valuefalseDetails
Type
bool
Propertyprotectedstring $_name = null

Default valuenullDetails
Type
string
Propertyprotectedstring $_sourceContent = null
Default valuenullDetails
Type
string
Inherited_from
\Zend_CodeGenerator_Abstract::$$_sourceContent  
Inherited_from
\Zend_CodeGenerator_Php_Abstract::$$_sourceContent  
Propertyprotected\const $_visibility = self::VISIBILITY_PUBLIC

Default valueself::VISIBILITY_PUBLICDetails
Type
\const

Methods

methodpublic__construct(array $options = array()) : void
Parameters
Name Type Description
$options array
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
Type Description
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
Type Description
\Zend_CodeGenerator_Php_Docblock
methodpublicgetIndentation() : string | int
inherited

getIndentation()

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

getName()

Returns
Type Description
string
methodpublicgetSourceContent() : string
Returns
Type Description
string
methodpublicgetVisibility() : \const

getVisibility()

Returns
Type Description
\const
methodpublicisAbstract() : bool

isAbstract()

Returns
Type Description
bool
methodpublicisFinal() : bool

isFinal()

Returns
Type Description
bool
methodpublicisSourceDirty() : bool
inherited

isSourceDirty()

Inherited from: \Zend_CodeGenerator_Php_Abstract::isSourceDirty()
Returns
Type Description
bool
methodpublicisStatic() : bool

isStatic()

Returns
Type Description
bool
methodpublicsetAbstract(bool $isAbstract) : \Zend_CodeGenerator_Php_Member_Abstract

setAbstract()

Parameters
Name Type Description
$isAbstract bool
Returns
Type Description
\Zend_CodeGenerator_Php_Member_Abstract
methodpublicsetConfig(\Zend_Config $config) : \Zend_CodeGenerator_Abstract
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

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
inherited

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

setName()

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_CodeGenerator_Php_Member_Abstract
methodpublicsetOptions(array $options) : \Zend_CodeGenerator_Abstract
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_CodeGenerator_Abstract
methodpublicsetSourceContent(string $sourceContent) : void
Parameters
Name Type Description
$sourceContent string
methodpublicsetSourceDirty(bool $isSourceDirty = true) : \Zend_CodeGenerator_Php_Abstract
inherited

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

setStatic()

Parameters
Name Type Description
$isStatic bool
Returns
Type Description
\Zend_CodeGenerator_Php_Member_Abstract
methodpublicsetVisibility(\const $visibility) : \Zend_CodeGenerator_Php_Member_Abstract

setVisitibility()

Parameters
Name Type Description
$visibility \const
Returns
Type Description
\Zend_CodeGenerator_Php_Member_Abstract
Documentation was generated by phpDocumentor 2.0.0a8.