CodeGenerator/Php/File.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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_CodeGenerator  
Subpackage
PHP  
Version
$Id$  

\Zend_CodeGenerator_Php_File
jump to top

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

Properties

>VPropertyprotectedstring $_body = null
Default valuenullDetails
Type
string
>VPropertyprotectedarray $_classes = array()
Default valuearray()Details
Type
array
>VPropertyprotected\Zend_CodeGenerator_Php_Docblock $_docblock = null
Default valuenullDetails
Type
\Zend_CodeGenerator_Php_Docblock
>VPropertyprotectedarray $_fileCodeGenerators = array()
static

Array of Zend_CodeGenerator_Php_File

Default valuearray()Details
Type
array
>VPropertyprotectedstring $_filename = null
Default valuenullDetails
Type
string
>VPropertyprotected$_markerClass = '/* Zend_CodeGenerator_Php_File-ClassMarker: {?} */'
static
Default value'/* Zend_CodeGenerator_Php_File-ClassMarker: {?} */'Details
Type
n/a
>VPropertyprotected$_markerDocblock = '/* Zend_CodeGenerator_Php_File-DocblockMarker */'
static
Default value'/* Zend_CodeGenerator_Php_File-DocblockMarker */'Details
Type
n/a
>VPropertyprotected$_markerRequire = '/* Zend_CodeGenerator_Php_File-RequireMarker: {?} */'
static
Default value'/* Zend_CodeGenerator_Php_File-RequireMarker: {?} */'Details
Type
n/a
>VPropertyprotectedarray $_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
NameTypeDescription
$filePathstring
$usePreviousCodeGeneratorIfItExistsbool
$includeIfNotAlreadyIncludedbool
Returns
TypeDescription
\Zend_CodeGenerator_Php_File
methodpublicfromReflection(\Zend_Reflection_File $reflectionFile) : \Zend_CodeGenerator_Php_File
static

fromReflection()

Parameters
NameTypeDescription
$reflectionFile\Zend_Reflection_File
Returns
TypeDescription
\Zend_CodeGenerator_Php_File
methodpublicgenerate() : string

generate()

Returns
TypeDescription
string
methodpublicgetBody() : string

getBody()

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

getClass()

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_CodeGenerator_Php_Class
methodpublicgetClasses() : array

getClasses()

Returns
TypeDescription
arrayArray of Zend_CodeGenerator_Php_Class
methodpublicgetDocblock() : \Zend_CodeGenerator_Php_Docblock

Get docblock

Returns
TypeDescription
\Zend_CodeGenerator_Php_Docblock
methodpublicgetFilename() : string

getFilename()

Returns
TypeDescription
string
methodpublicgetRequiredFiles() : array

getRequiredFiles()

Returns
TypeDescription
array
methodpublicisSourceDirty() : bool

isSourceDirty()

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

Parameters
NameTypeDescription
$fileCodeGenerator
$fileName
methodpublicsetBody(string $body) : \Zend_CodeGenerator_Php_File

setBody()

Parameters
NameTypeDescription
$bodystring
Returns
TypeDescription
\Zend_CodeGenerator_Php_File
methodpublicsetClass(\Zend_CodeGenerator_Php_Class | array $class) : \Zend_CodeGenerator_Php_File

setClass()

Parameters
NameTypeDescription
$class\Zend_CodeGenerator_Php_Class | array
Returns
TypeDescription
\Zend_CodeGenerator_Php_File
methodpublicsetClasses(array $classes) : \Zend_CodeGenerator_Php_File

setClasses()

Parameters
NameTypeDescription
$classesarray
Returns
TypeDescription
\Zend_CodeGenerator_Php_File
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
methodpublicsetFilename(string $filename) : \Zend_CodeGenerator_Php_File

setFilename()

Parameters
NameTypeDescription
$filenamestring
Returns
TypeDescription
\Zend_CodeGenerator_Php_File
methodpublicsetRequiredFiles(array $requiredFiles) : \Zend_CodeGenerator_Php_File

setRequiredFiles

Parameters
NameTypeDescription
$requiredFilesarray
Returns
TypeDescription
\Zend_CodeGenerator_Php_File
methodpublicwrite() : void

Documentation was generated by phpDocumentor 2.2.0 .