CodeGenerator/Php/File.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_CodeGenerator
subpackage: PHP
version: $Id: File.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_CodeGenerator_Php_File

Description

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.

Zend_CodeGenerator_Php_File
jump to top

Extends from: Zend_CodeGenerator_Php_Abstract
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_CodeGenerator
Properties: $_fileCodeGenerators; $_markerDocblock; $_markerRequire; $_markerClass; $_filename; $_docblock; $_requiredFiles; $_classes; $_body
Methods: registerFileCodeGenerator; fromReflectedFileName; fromReflection; setDocblock; getDocblock; setRequiredFiles; getRequiredFiles; setClasses; getClass; setClass; setFilename; getFilename; getClasses; setBody; getBody; isSourceDirty; generate; write

Description

Properties

$_body
jump to class

string $_body = 'null'

Details

$_body: string
visibility: protected
default: null
final: false
static: false

$_classes
jump to class

array $_classes = 'array'

Details

$_classes: array
visibility: protected
default: array
final: false
static: false

$_docblock
jump to class

Zend_CodeGenerator_Php_Docblock $_docblock = 'null'

Details

$_docblock: Zend_CodeGenerator_Php_Docblock
visibility: protected
default: null
final: false
static: false

$_fileCodeGenerators
jump to class

array $_fileCodeGenerators = 'array'

Details

$_fileCodeGenerators: array
Array of Zend_CodeGenerator_Php_File
visibility: protected
default: array
final: false
static: true

$_filename
jump to class

string $_filename = 'null'

Details

$_filename: string
visibility: protected
default: null
final: false
static: false

$_markerClass
jump to class

$_markerClass = '/* Zend_CodeGenerator_Php_File-ClassMarker: {?} */'

Details

visibility: protected
default: /* Zend_CodeGenerator_Php_File-ClassMarker: {?} */
final: false
static: true

$_markerDocblock
jump to class

$_markerDocblock = '/* Zend_CodeGenerator_Php_File-DocblockMarker */'

Details

visibility: protected
default: /* Zend_CodeGenerator_Php_File-DocblockMarker */
final: false
static: true

$_markerRequire
jump to class

$_markerRequire = '/* Zend_CodeGenerator_Php_File-RequireMarker: {?} */'

Details

visibility: protected
default: /* Zend_CodeGenerator_Php_File-RequireMarker: {?} */
final: false
static: true

$_requiredFiles
jump to class

array $_requiredFiles = 'array'

Details

$_requiredFiles: array
visibility: protected
default: array
final: false
static: false

Methods

fromReflectedFileName
jump to class

fromReflectedFileName(
          string $filePath, bool $usePreviousCodeGeneratorIfItExists
              =
              true, bool $includeIfNotAlreadyIncluded
              =
              true
          )
        
        :
        Zend_CodeGenerator_Php_File

fromReflectedFilePath() - 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

Arguments

$filePath: string
$usePreviousCodeGeneratorIfItExists: bool
$includeIfNotAlreadyIncluded: bool

Output

Zend_CodeGenerator_Php_File

Details

visibility: public
final: false
static: true

fromReflection
jump to class

fromReflection(
          Zend_Reflection_File $reflectionFile
          )
        
        :
        Zend_CodeGenerator_Php_File

fromReflection()

Arguments

$reflectionFile: Zend_Reflection_File

Output

Zend_CodeGenerator_Php_File

Details

visibility: public
final: false
static: true

generate
jump to class

generate(
          
          )
        
        :
        string

generate()

Output

string

Details

visibility: public
final: false
static: false

getBody
jump to class

getBody(
          
          )
        
        :
        string

getBody()

Output

string

Details

visibility: public
final: false
static: false

getClass
jump to class

getClass(
          string $name
              =
              null
          )
        
        :
        Zend_CodeGenerator_Php_Class

getClass()

Arguments

$name: string

Output

Zend_CodeGenerator_Php_Class

Details

visibility: public
final: false
static: false

getClasses
jump to class

getClasses(
          
          )
        
        :
        array

getClasses()

Output

array: Array of Zend_CodeGenerator_Php_Class

Details

visibility: public
final: false
static: false

getDocblock
jump to class

getDocblock(
          
          )
        
        :
        Zend_CodeGenerator_Php_Docblock

Get docblock

Output

Zend_CodeGenerator_Php_Docblock

Details

visibility: public
final: false
static: false

getFilename
jump to class

getFilename(
          
          )
        
        :
        string

getFilename()

Output

string

Details

visibility: public
final: false
static: false

getRequiredFiles
jump to class

getRequiredFiles(
          
          )
        
        :
        array

getRequiredFiles()

Output

array

Details

visibility: public
final: false
static: false

isSourceDirty
jump to class

isSourceDirty(
          
          )
        
        :
        bool

isSourceDirty()

Output

bool

Details

visibility: public
final: false
static: false

registerFileCodeGenerator
jump to class

registerFileCodeGenerator(
           $fileCodeGenerator,  $fileName
              =
              null
          )
        
        :

Arguments

$fileCodeGenerator
$fileName

Details

visibility: public
final: false
static: true

setBody
jump to class

setBody(
          string $body
          )
        
        :
        Zend_CodeGenerator_Php_File

setBody()

Arguments

$body: string

Output

Zend_CodeGenerator_Php_File

Details

visibility: public
final: false
static: false

setClass
jump to class

setClass(
          Zend_CodeGenerator_Php_Class|array $class
          )
        
        :
        Zend_CodeGenerator_Php_File

setClass()

Arguments

$class: Zend_CodeGenerator_Php_Classarray

Output

Zend_CodeGenerator_Php_File

Details

visibility: public
final: false
static: false

setClasses
jump to class

setClasses(
          array $classes
          )
        
        :
        Zend_CodeGenerator_Php_File

setClasses()

Arguments

$classes: array

Output

Zend_CodeGenerator_Php_File

Details

visibility: public
final: false
static: false

setDocblock
jump to class

setDocblock(
          Zend_CodeGenerator_Php_Docblock|array|string $docblock
          )
        
        :
        Zend_CodeGenerator_Php_File

setDocblock() Set the docblock

Arguments

$docblock: Zend_CodeGenerator_Php_Docblockarraystring

Output

Zend_CodeGenerator_Php_File

Details

visibility: public
final: false
static: false

setFilename
jump to class

setFilename(
          string $filename
          )
        
        :
        Zend_CodeGenerator_Php_File

setFilename()

Arguments

$filename: string

Output

Zend_CodeGenerator_Php_File

Details

visibility: public
final: false
static: false

setRequiredFiles
jump to class

setRequiredFiles(
          array $requiredFiles
          )
        
        :
        Zend_CodeGenerator_Php_File

setRequiredFiles

Arguments

$requiredFiles: array

Output

Zend_CodeGenerator_Php_File

Details

visibility: public
final: false
static: false

write
jump to class

Details

visibility: public
final: false
static: false

API Documentation

CodeGenerator/Php/File.php

Description

Zend_CodeGenerator_Php_Filejump to top

Description

Properties

$_bodyjump to class

Details

$_classesjump to class

Details

$_docblockjump to class

Details

$_fileCodeGeneratorsjump to class

Details

$_filenamejump to class

Details

$_markerClassjump to class

Details

$_markerDocblockjump to class

Details

$_markerRequirejump to class

Details

$_requiredFilesjump to class

Details

Methods

fromReflectedFileNamejump to class

Arguments

Output

Details

fromReflectionjump to class

Arguments

Output

Details

generatejump to class

Output

Details

getBodyjump to class

Output

Details

getClassjump to class

Arguments

Output

Details

getClassesjump to class

Output

Details

getDocblockjump to class

Output

Details

getFilenamejump to class

Output

Details

getRequiredFilesjump to class

Output

Details

isSourceDirtyjump to class

Output

Details

registerFileCodeGeneratorjump to class

Arguments

Details

setBodyjump to class

Arguments

Output

Details

setClassjump to class

Arguments

Output

Details

setClassesjump to class

Arguments

Output

Details

setDocblockjump to class

Arguments

Output

Details

setFilenamejump to class

Arguments

Output

Zend_CodeGenerator_Php_File
jump to top

$_body
jump to class

$_classes
jump to class

$_docblock
jump to class

$_fileCodeGenerators
jump to class

$_filename
jump to class

$_markerClass
jump to class

$_markerDocblock
jump to class

$_markerRequire
jump to class

$_requiredFiles
jump to class

fromReflectedFileName
jump to class

fromReflection
jump to class

generate
jump to class

getBody
jump to class

getClass
jump to class

getClasses
jump to class

getDocblock
jump to class

getFilename
jump to class

getRequiredFiles
jump to class

isSourceDirty
jump to class

registerFileCodeGenerator
jump to class

setBody
jump to class

setClass
jump to class

setClasses
jump to class

setDocblock
jump to class

setFilename
jump to class

setRequiredFiles
jump to class

write
jump to class