API Documentation

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

\Zend_CodeGenerator_Php_Abstract

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

Constants

Constant  LINE_FEED = '\n'

Line feed to use in place of EOL

Properties

Propertyprotectedint|string  $_indentation= ' '

Default value Details
Type
intstring
Propertyprotectedbool  $_isSourceDirty= 'true'

Default valuetrueDetails
Type
bool

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

generate() - must be implemented by the child

Inherited from: \Zend_CodeGenerator_Abstract::generate()
methodpublicgetIndentation( ) : string|int

getIndentation()

Returns
Type Description
stringint
methodpublicgetSourceContent( ) : string

getSourceContent()

Inherited from: \Zend_CodeGenerator_Abstract::getSourceContent()
Returns
Type Description
string
methodpublicisSourceDirty( ) : bool

isSourceDirty()

Returns
Type Description
bool
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
methodpublicsetIndentation( string|int $indentation ) : \Zend_CodeGenerator_Php_Abstract

setIndentation()

Parameters
Name Type Description
$indentation string|int
Returns
Type Description
\Zend_CodeGenerator_Php_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
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()

Parameters
Name Type Description
$isSourceDirty bool
Returns
Type Description
\Zend_CodeGenerator_Php_Abstract
Documentation was generated by DocBlox 0.13.3.