API Documentation

Zend/CodeGenerator/Php/File.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 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: File.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_CodeGenerator_Php_File

Package: Zend\CodeGenerator

Parent(s)
\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  

Properties

Propertyprotectedstring  $_body= 'null'

Default valuenullDetails
Type
string
Propertyprotectedarray  $_classes= 'array()'

Default valuearray()Details
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 valuearray()Details
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 valuearray()Details
Type
array

Methods

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
methodpublicgetRequiredFiles( ) : array

getRequiredFiles()

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

setRequiredFiles

Parameters
Name Type Description
$requiredFiles array
Returns
Type Description
\Zend_CodeGenerator_Php_File
methodpublicwrite( ) : void

Documentation was generated by DocBlox 0.15.1.