lib/ezutils/classes/ezphpcreator.php

Show: inherited
Table of Contents

File containing the eZPHPCreator class.

Copyright
Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.  
License
eZ Business Use License Agreement Version 2.0  
Package
lib  
Version
4.6.0  

\eZPHPCreator

Package: lib

File containing the eZPHPCreator class.

Copyright
Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.  
License
eZ Business Use License Agreement Version 2.0  
Version
4.6.0  

Constants

Constant  VARIABLE = 1
Constant  SPACE = 2
Constant  TEXT = 3
Constant  METHOD_CALL = 4
Constant  CODE_PIECE = 5
Constant  EOL_COMMENT = 6
Constant  INCLUDE_STATEMENT = 7
Constant  VARIABLE_UNSET = 8
Constant  DEFINE = 9
Constant  VARIABLE_UNSET_LIST = 10
Constant  RAW_VARIABLE = 11
Constant  VARIABLE_ASSIGNMENT = 1
Constant  VARIABLE_APPEND_TEXT = 2
Constant  VARIABLE_APPEND_ELEMENT = 3
Constant  INCLUDE_ONCE_STATEMENT = 1
Constant  INCLUDE_ALWAYS_STATEMENT = 2
Constant  METHOD_CALL_PARAMETER_VALUE = 1
Constant  METHOD_CALL_PARAMETER_VARIABLE = 2

Properties

Propertypublic  $ClusterFileScope= 'false'
Default valuefalseDetails
Type
n/a
Propertypublic  $ClusteringEnabled= 'false'
Default valuefalseDetails
Type
n/a
Propertypublic  $Elements= ''
Details
Type
n/a
Propertypublic  $FileResource= ''
Details
Type
n/a
Propertypublic  $PHPDir= ''
Details
Type
n/a
Propertypublic  $PHPFile= ''
Details
Type
n/a
Propertypublic  $Spacing= 'true'
Default valuetrueDetails
Type
n/a
Propertypublic  $TextChunks= ''
Details
Type
n/a
Propertypublic  $isAtomic= ''
Details
Type
n/a
Propertypublic  $requestedFilename= ''
Details
Type
n/a
Propertypublic  $tmpFilename= ''
Details
Type
n/a

Methods

methodpublic_restoreCall(  $path,  $mtime,  $variableDefinitions ) : void

Parameters
Name Type Description
$path
$mtime
$variableDefinitions
methodpublicaddCodePiece(  $code,  $parameters = array() ) : void

Parameters
Name Type Description
$code
$parameters
methodpublicaddComment(  $comment,  $eol = true,  $whitespaceHandling = true,  $parameters = array() ) : void

Parameters
Name Type Description
$comment
$eol
$whitespaceHandling
$parameters
methodpublicaddDefine(  $name,  $value,  $caseSensitive = true,  $parameters = array() ) : void

Parameters
Name Type Description
$name
$value
$caseSensitive
$parameters
methodpublicaddInclude(  $file,  $type = eZPHPCreator::INCLUDE_ONCE_STATEMENT,  $parameters = array() ) : void

Parameters
Name Type Description
$file
$type
$parameters
methodpublicaddMethodCall(  $objectName,  $methodName,  $methodParameters,  $returnValue = false,  $parameters = array() ) : void

Parameters
Name Type Description
$objectName
$methodName
$methodParameters
$returnValue
$parameters
methodpublicaddRawVariable(  $name,  $value ) : void

Parameters
Name Type Description
$name
$value
methodpublicaddSpace(  $lines = 1 ) : void

Parameters
Name Type Description
$lines
methodpublicaddText(  $text ) : void

Parameters
Name Type Description
$text
methodpublicaddVariable(  $name,  $value,  $assignmentType = eZPHPCreator::VARIABLE_ASSIGNMENT,  $parameters = array() ) : void

Parameters
Name Type Description
$name
$value
$assignmentType
$parameters
methodpublicaddVariableUnset(  $name,  $parameters = array() ) : void

Parameters
Name Type Description
$name
$parameters
methodpublicaddVariableUnsetList(  $list,  $parameters = array() ) : void

Parameters
Name Type Description
$list
$parameters
methodpubliccanRestore(  $timestamp = false ) : void

Parameters
Name Type Description
$timestamp
methodpublicclose( ) : void

methodpubliceZPHPCreator(  $dir,  $file,  $prefix = '',  $options = array() ) : void

Parameters
Name Type Description
$dir
$file
$prefix
$options
methodpublicexists( ) : void

methodpublicfetch(  $addPHPMarkers = true ) : void

Parameters
Name Type Description
$addPHPMarkers
methodpublicflushChunks( ) : void

methodpublicopen(  $atomic = false ) : void

Parameters
Name Type Description
$atomic
methodpublicprependSpacing(  $text,  $spacing,  $skipEmptyLines = true,  $spacingString = " ",  $splitString = "\n" ) : void
static

Parameters
Name Type Description
$text
$spacing
$skipEmptyLines
$spacingString
$splitString
methodpublicrestore(  $variableDefinitions ) : void

Parameters
Name Type Description
$variableDefinitions
methodpublicstore(  $atomic = false ) : void

Parameters
Name Type Description
$atomic
methodpublictemporaryVariableName(  $prefix ) : void

Parameters
Name Type Description
$prefix
methodpublicthisVariableText(  $value,  $column = 0,  $iteration = 0,  $maxIterations = 2 ) : void

Parameters
Name Type Description
$value
$column
$iteration
$maxIterations
methodpublicvariableNameText(  $variableName,  $assignmentType,  $variableParameters = array() ) : void
static

Parameters
Name Type Description
$variableName
$assignmentType
$variableParameters
methodpublicvariableText(  $value,  $column = 0,  $iteration = 0,  $maxIterations = false ) : void
static

Parameters
Name Type Description
$value
$column
$iteration
$maxIterations
methodpublicwrite(  $text ) : void

Parameters
Name Type Description
$text
methodpublicwriteChunks( ) : void

methodpublicwriteCodePiece(  $element ) : void

Parameters
Name Type Description
$element
methodpublicwriteComment(  $element ) : void

Parameters
Name Type Description
$element
methodpublicwriteDefine(  $element ) : void

Parameters
Name Type Description
$element
methodpublicwriteElements( ) : void

methodpublicwriteInclude(  $element ) : void

Parameters
Name Type Description
$element
methodpublicwriteMethodCall(  $element ) : void

Parameters
Name Type Description
$element
methodpublicwriteRawVariable(  $variableName,  $variableValue ) : void

Parameters
Name Type Description
$variableName
$variableValue
methodpublicwriteSpace(  $element ) : void

Parameters
Name Type Description
$element
methodpublicwriteText(  $element ) : void

Parameters
Name Type Description
$element
methodpublicwriteVariable(  $variableName,  $variableValue,  $assignmentType = eZPHPCreator::VARIABLE_ASSIGNMENT,  $variableParameters = array() ) : void

Parameters
Name Type Description
$variableName
$variableValue
$assignmentType
$variableParameters
methodpublicwriteVariableUnset(  $element ) : void

Parameters
Name Type Description
$element
methodpublicwriteVariableUnsetList(  $element ) : void

Parameters
Name Type Description
$element
Documentation was generated by DocBlox 0.18.1.