API Documentation

CodeGenerator/Php/File.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: File.php 24457 2011-09-11 13:34:44Z padraic $  

\Zend_CodeGenerator_Php_File

Extends from
\Zend_CodeGenerator_Php_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
Propertyprotectedarray  $_classes= 'array'

Default valuearrayDetails
Type
array
Propertyprotected\Zend_CodeGenerator_Php_Docblock  $_docblock= 'null'

Default valuenullDetails
Type
\Zend_CodeGenerator_Php_Docblock
Propertyprotectedarray  $_fileCodeGenerators= 'array'
static

Array of Zend_CodeGenerator_Php_File
Default valuearrayDetails
Type
array
Propertyprotectedstring  $_filename= 'null'

Default valuenullDetails
Type
string
Propertyprotected  $_markerClass= '/* Zend_CodeGenerator_Php_File-ClassMarker: {?} */'
static
Default value/* Zend_CodeGenerator_Php_File-ClassMarker: {?} */Details
Type
Propertyprotected  $_markerDocblock= '/* Zend_CodeGenerator_Php_File-DocblockMarker */'
static
Default value/* Zend_CodeGenerator_Php_File-DocblockMarker */Details
Type
Propertyprotected  $_markerRequire= '/* Zend_CodeGenerator_Php_File-RequireMarker: {?} */'
static
Default value/* Zend_CodeGenerator_Php_File-RequireMarker: {?} */Details
Type
Propertyprotectedarray  $_requiredFiles= '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()
methodpublicfromReflectedFileName( string $filePath, bool $usePreviousCodeGeneratorIfItExists = true, bool $includeIfNotAlreadyIncluded = true ) : \Zend_CodeGenerator_Php_File
static

fromReflectedFileName() - use this if you intend on generating code generation objects based on the same file.

This will keep previous changes to the file in tact during the same PHP process

Parameters
Name Type Description
$filePath string
$usePreviousCodeGeneratorIfItExists bool
$includeIfNotAlreadyIncluded bool
Returns
Type Description
\Zend_CodeGenerator_Php_File
methodpublicfromReflection( \Zend_Reflection_File $reflectionFile ) : \Zend_CodeGenerator_Php_File
static

fromReflection()

Parameters
Name Type Description
$reflectionFile \Zend_Reflection_File
Returns
Type Description
\Zend_CodeGenerator_Php_File
methodpublicgenerate( ) : string

generate()

Returns
Type Description
string
methodpublicgetBody( ) : string

getBody()

Returns
Type Description
string
methodpublicgetClass( string $name = null ) : \Zend_CodeGenerator_Php_Class

getClass()

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_CodeGenerator_Php_Class
methodpublicgetClasses( ) : array

getClasses()

Returns
Type Description
array Array of Zend_CodeGenerator_Php_Class
methodpublicgetDocblock( ) : \Zend_CodeGenerator_Php_Docblock

Get docblock

Returns
Type Description
\Zend_CodeGenerator_Php_Docblock
methodpublicgetFilename( ) : string

getFilename()

Returns
Type Description
string
methodpublicgetIndentation( ) : string|int

getIndentation()

Inherited from: \Zend_CodeGenerator_Php_Abstract::getIndentation()
Returns
Type Description
stringint
methodpublicgetRequiredFiles( ) : array

getRequiredFiles()

Returns
Type Description
array
methodpublicgetSourceContent( ) : string

getSourceContent()

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

isSourceDirty()

Returns
Type Description
bool
methodpublicregisterFileCodeGenerator(  $fileCodeGenerator,  $fileName = null ) : void
static

Parameters
Name Type Description
$fileCodeGenerator
$fileName
methodpublicsetBody( string $body ) : \Zend_CodeGenerator_Php_File

setBody()

Parameters
Name Type Description
$body string
Returns
Type Description
\Zend_CodeGenerator_Php_File
methodpublicsetClass( \Zend_CodeGenerator_Php_Class|array $class ) : \Zend_CodeGenerator_Php_File

setClass()

Parameters
Name Type Description
$class \Zend_CodeGenerator_Php_Class|array
Returns
Type Description
\Zend_CodeGenerator_Php_File
methodpublicsetClasses( array $classes ) : \Zend_CodeGenerator_Php_File

setClasses()

Parameters
Name Type Description
$classes array
Returns
Type Description
\Zend_CodeGenerator_Php_File
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

Parameters
Name Type Description
$docblock \Zend_CodeGenerator_Php_Docblock|array|string
Returns
Type Description
\Zend_CodeGenerator_Php_File
methodpublicsetFilename( string $filename ) : \Zend_CodeGenerator_Php_File

setFilename()

Parameters
Name Type Description
$filename string
Returns
Type Description
\Zend_CodeGenerator_Php_File
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
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
methodpublicsetRequiredFiles( array $requiredFiles ) : \Zend_CodeGenerator_Php_File

setRequiredFiles

Parameters
Name Type Description
$requiredFiles array
Returns
Type Description
\Zend_CodeGenerator_Php_File
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
methodpublicwrite( ) : void

Documentation was generated by DocBlox 0.13.3.