eZ Publish Community Project (Legacy Stack) 2013.4
Class

eZPHPCreator

class eZPHPCreator

Constants

VARIABLE

SPACE

TEXT

METHOD_CALL

CODE_PIECE

EOL_COMMENT

INCLUDE_STATEMENT

VARIABLE_UNSET

DEFINE

VARIABLE_UNSET_LIST

RAW_VARIABLE

VARIABLE_ASSIGNMENT

VARIABLE_APPEND_TEXT

VARIABLE_APPEND_ELEMENT

INCLUDE_ONCE_STATEMENT

INCLUDE_ALWAYS_STATEMENT

METHOD_CALL_PARAMETER_VALUE

METHOD_CALL_PARAMETER_VARIABLE

Properties

$PHPDir
$PHPFile
$FileResource
$Elements
$TextChunks
$isAtomic
$tmpFilename
$requestedFilename
$Spacing
$ClusteringEnabled
$ClusterFileScope

Methods

eZPHPCreator($dir, $file, $prefix = '', $options = array())

addDefine($name, $value, $caseSensitive = true, $parameters = array())

addRawVariable($name, $value)

addVariable($name, $value, $assignmentType = eZPHPCreator::VARIABLE_ASSIGNMENT, $parameters = array())

addVariableUnset($name, $parameters = array())

addVariableUnsetList($list, $parameters = array())

addSpace($lines = 1)

addText($text)

addMethodCall($objectName, $methodName, $methodParameters, $returnValue = false, $parameters = array())

addCodePiece($code, $parameters = array())

addComment($comment, $eol = true, $whitespaceHandling = true, $parameters = array())

addInclude($file, $type = eZPHPCreator::INCLUDE_ONCE_STATEMENT, $parameters = array())

thisVariableText($value, $column, $iteration, $maxIterations = 2)

open($atomic = false)

close()

exists()

canRestore($timestamp = false)

restore($variableDefinitions)

_restoreCall($path, $mtime, $variableDefinitions)

store($atomic = false)

fetch($addPHPMarkers = true)

writeChunks()

flushChunks()

write($text)

writeElements()

writeDefine($element)

writeInclude($element)

writeComment($element)

writeSpace($element)

writeCodePiece($element)

writeText($element)

writeMethodCall($element)

writeVariableUnset($element)

writeVariableUnsetList($element)

writeRawVariable($variableName, $variableValue)

writeVariable($variableName, $variableValue, $assignmentType = eZPHPCreator::VARIABLE_ASSIGNMENT, $variableParameters = array())

temporaryVariableName($prefix)

Details

at line 79
public eZPHPCreator($dir, $file, $prefix = '', $options = array())

Parameters

$dir
$file
$prefix
$options

at line 133
public addDefine($name, $value, $caseSensitive = true, $parameters = array())

Parameters

$name
$value
$caseSensitive
$parameters

at line 154
public addRawVariable($name, $value)

Parameters

$name
$value

at line 188
public addVariable($name, $value, $assignmentType = eZPHPCreator::VARIABLE_ASSIGNMENT, $parameters = array())

Parameters

$name
$value
$assignmentType
$parameters

at line 218
public addVariableUnset($name, $parameters = array())

Parameters

$name
$parameters

at line 246
public addVariableUnsetList($list, $parameters = array())

Parameters

$list
$parameters

at line 265
public addSpace($lines = 1)

Parameters

$lines

at line 282
public addText($text)

Parameters

$text

at line 320
public addMethodCall($objectName, $methodName, $methodParameters, $returnValue = false, $parameters = array())

Parameters

$objectName
$methodName
$methodParameters
$returnValue
$parameters

at line 355
public addCodePiece($code, $parameters = array())

Parameters

$code
$parameters

at line 385
public addComment($comment, $eol = true, $whitespaceHandling = true, $parameters = array())

Parameters

$comment
$eol
$whitespaceHandling
$parameters

at line 416
public addInclude($file, $type = eZPHPCreator::INCLUDE_ONCE_STATEMENT, $parameters = array())

Parameters

$file
$type
$parameters

at line 476
public thisVariableText($value, $column, $iteration, $maxIterations = 2)

Parameters

$value
$column
$iteration
$maxIterations

at line 754
public open($atomic = false)

Parameters

$atomic

at line 792
public close()

at line 816
public exists()

at line 836
public canRestore($timestamp = false)

Parameters

$timestamp

at line 879
public restore($variableDefinitions)

Parameters

$variableDefinitions

at line 903
public _restoreCall($path, $mtime, $variableDefinitions)

Parameters

$path
$mtime
$variableDefinitions

at line 938
public store($atomic = false)

Parameters

$atomic

at line 973
public fetch($addPHPMarkers = true)

Parameters

$addPHPMarkers

at line 993
public writeChunks()

at line 1024
public flushChunks()

at line 1032
public write($text)

Parameters

$text

at line 1040
public writeElements()

at line 1094
public writeDefine($element)

Parameters

$element

at line 1120
public writeInclude($element)

Parameters

$element

at line 1144
public writeComment($element)

Parameters

$element

at line 1174
public writeSpace($element)

Parameters

$element

at line 1183
public writeCodePiece($element)

Parameters

$element

at line 1197
public writeText($element)

Parameters

$element

at line 1208
public writeMethodCall($element)

Parameters

$element

at line 1254
public writeVariableUnset($element)

Parameters

$element

at line 1269
public writeVariableUnsetList($element)

Parameters

$element

at line 1291
public writeRawVariable($variableName, $variableValue)

Parameters

$variableName
$variableValue

at line 1299
public writeVariable($variableName, $variableValue, $assignmentType = eZPHPCreator::VARIABLE_ASSIGNMENT, $variableParameters = array())

Parameters

$variableName
$variableValue
$assignmentType
$variableParameters

at line 1320
public temporaryVariableName($prefix)

Parameters

$prefix