eZPublish  4.5
eZPHPCreator Class Reference

eZPHPCreator provides a simple interface for creating and executing PHP code. More...

Public Member Functions

 eZPHPCreator ($dir, $file, $prefix= '', $options=array())
 
 thisVariableText ($value, $column=0, $iteration=0, $maxIterations=2)
 
 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())
 

Static Public Member Functions

static prependSpacing ($text, $spacing, $skipEmptyLines=true, $spacingString=" ", $splitString="\n")
 
static variableNameText ($variableName, $assignmentType, $variableParameters=array())
 
static variableText ($value, $column=0, $iteration=0, $maxIterations=false)
 

Public Attributes

 $ClusterFileScope = false
 
 $ClusteringEnabled = false
 
 $Elements
 
 $FileResource
 
 $isAtomic
 
 $PHPDir
 
 $PHPFile
 
 $requestedFilename
 
 $Spacing = true
 
 $TextChunks
 
 $tmpFilename
 
const CODE_PIECE = 5
 
const DEFINE = 9
 
const EOL_COMMENT = 6
 
const INCLUDE_ALWAYS_STATEMENT = 2
 
const INCLUDE_ONCE_STATEMENT = 1
 
const INCLUDE_STATEMENT = 7
 
const METHOD_CALL = 4
 
const METHOD_CALL_PARAMETER_VALUE = 1
 
const METHOD_CALL_PARAMETER_VARIABLE = 2
 
const RAW_VARIABLE = 11
 
const SPACE = 2
 
const TEXT = 3
 
const VARIABLE = 1
 
const VARIABLE_APPEND_ELEMENT = 3
 
const VARIABLE_APPEND_TEXT = 2
 
const VARIABLE_ASSIGNMENT = 1
 
const VARIABLE_UNSET = 8
 
const VARIABLE_UNSET_LIST = 10
 

Private Member Functions

 flushChunks ()
 
 temporaryVariableName ($prefix)
 
 write ($text)
 
 writeChunks ()
 
 writeCodePiece ($element)
 
 writeComment ($element)
 
 writeDefine ($element)
 
 writeElements ()
 
 writeInclude ($element)
 
 writeMethodCall ($element)
 
 writeRawVariable ($variableName, $variableValue)
 
 writeSpace ($element)
 
 writeText ($element)
 
 writeVariable ($variableName, $variableValue, $assignmentType=eZPHPCreator::VARIABLE_ASSIGNMENT, $variableParameters=array())
 
 writeVariableUnset ($element)
 
 writeVariableUnsetList ($element)
 
 open ($atomic=false)
 
 close ()
 
 exists ()
 
 canRestore ($timestamp=false)
 
 restore ($variableDefinitions)
 
 store ($atomic=false)
 
 fetch ($addPHPMarkers=true)
 
 _restoreCall ($path, $mtime, $variableDefinitions)
 

Detailed Description

eZPHPCreator provides a simple interface for creating and executing PHP code.

To create PHP code you must create an instance of this class, add any number of elements you choose with addDefine(), addVariable(), addVariableUnset(), addVariableUnsetList(), addSpace(), addText(), addMethodCall(), addCodePiece(), addComment() and addInclude(). After that you call store() to write all changes to disk.

$php = new eZPHPCreator( 'cache', 'code.php' );
$php->addComment( 'Auto generated' );
$php->addInclude( 'inc.php' );
$php->addVariable( 'count', 10 );
$php->store();

To restore PHP code you must create an instance of this class, check if you can restore it with canRestore() then restore variables with restore(). The class will include PHP file and run all code, once the file is done it will catch any variables you require and return it to you.

$php = new eZPHPCreator( 'cache', 'code.php' );
if ( $php->canRestore() )
{
$variables = $php->restore( array( 'max_count' => 'count' ) );
print( "Max count was " . $variables['max_count'] );
}
$php->close();

Member Function Documentation

eZPHPCreator::_restoreCall (   $path,
  $mtime,
  $variableDefinitions 
)
private

Processes the PHP file and returns the specified data.

Referenced by restore().

eZPHPCreator::addCodePiece (   $code,
  $parameters = array() 
)
 Adds custom PHP code to the file, you should only use this a last resort if any
 of the other \em add functions done give you the required result.

 \param $code Contains the code as text, the text will not be modified (except for spacing).
              This means that each expression must be ended with a newline even if it's just one.
 \param $parameters Optional parameters, can be any of the following:
        - \a spacing, The number of spaces to place before each code line, default is \c 0.

 Example:
$php->addCodePiece( "if ( \$value > 2 )\n{\n \$value = 2;\n}\n" );

Would result in the PHP code.

if ( $value > 2 )
{
$value = 2;
}
eZPHPCreator::addComment (   $comment,
  $eol = true,
  $whitespaceHandling = true,
  $parameters = array() 
)
 Adds a comment to the code, the comment will be display using multiple end-of-line
 comments (//), one for each newline in the text \a $comment.

 \param $eol Whether to add a newline at the last comment line
 \param $whitespaceHandling Whether to remove trailing whitespace from each line
 \param $parameters Optional parameters, can be any of the following:
        - \a spacing, The number of spaces to place before each code line, default is \c 0.

 Example:
$php->addComment( "This file is auto generated\nDo not edit!" );

Would result in the PHP code.

// This file is auto generated
// Do not edit!
eZPHPCreator::addDefine (   $name,
  $value,
  $caseSensitive = true,
  $parameters = array() 
)
 Adds a new define statement to the code with the name \a $name and value \a $value.
 The parameter \a $caseSensitive determines if the define should be made case sensitive or not.

 Example:
$php->addDefine( 'MY_CONSTANT', 5 );

Would result in the PHP code.

define( 'MY_CONSTANT', 5 );
Parameters
$parametersOptional parameters, can be any of the following:
  • spacing, The number of spaces to place before each code line, default is 0.
Note
$name must start with a letter or underscore, followed by any number of letters, numbers, or underscores. See http://php.net/manual/en/language.constants.php for more information.
See Also
http://php.net/manual/en/function.define.php
eZPHPCreator::addInclude (   $file,
  $type = eZPHPCreator::INCLUDE_ONCE_STATEMENT,
  $parameters = array() 
)
 Adds an include statement to the code, the file to include is \a $file.

 \param $type What type of include statement to use, can be one of the following:
              - \b eZPHPCreator::INCLUDE_ONCE_STATEMENT, use \em include_once()
              - \b eZPHPCreator::INCLUDE_ALWAYS_STATEMENT, use \em include()
 \param $parameters Optional parameters, can be any of the following:
        - \a spacing, The number of spaces to place before each code line, default is \c 0.

 Example:
$php->addInclude( 'lib/ezutils/classes/ezphpcreator.php' );

Would result in the PHP code.

//include_once( 'lib/ezutils/classes/ezphpcreator.php' );
eZPHPCreator::addMethodCall (   $objectName,
  $methodName,
  $methodParameters,
  $returnValue = false,
  $parameters = array() 
)
 Adds code to call the method \a $methodName on the object named \a $objectName,
 \a $methodParameters should be an array with parameter entries where each entry contains:
 - \a 0, The parameter value
 - \a 1 (\em optional), The type of parameter, is one of:
   - \b eZPHPCreator::METHOD_CALL_PARAMETER_VALUE, Use value directly (default if this entry is missing)
   - \b eZPHPCreator::METHOD_CALL_PARAMETER_VARIABLE, Use value as the name of the variable.

 Optionally the \a $returnValue parameter can be used to decide what should be done
 with the return value of the method call. It can either be \c false which means
 to do nothing or an array with the following entries.
 - \a 0, The name of the variable to assign the value to
 - \a 1 (\em optional), The type of assignment, uses the same value as addVariable().

 \param $parameters Optional parameters, can be any of the following:
        - \a spacing, The number of spaces to place before each code line, default is \c 0.

 Example:
$php->addMethodCall( 'node', 'name', array(), array( 'name' ) );
$php->addMethodCall( 'php', 'addMethodCall',
array( array( 'node' ), array( 'name' ) ) );

Would result in the PHP code.

$name = $node->name();
$php->addMethodCall( 'node', 'name' );
eZPHPCreator::addRawVariable (   $name,
  $value 
)
 Adds a new raw variable tothe code with the name \a $name and value \a $value.

 Example:
$php->addVariable( 'TransLationRoot', $cache['root'] );

This function makes use of PHP's var_export() function which is optimized for this task.

eZPHPCreator::addSpace (   $lines = 1)
 Adds some space to the code in form of newlines. The number of lines
 is controlled with \a $lines which is \c 1 by default.
 You can use this to get more readable PHP code.

 Example:
$php->addSpace( 1 );
eZPHPCreator::addText (   $text)
 Adds some plain text to the code. The text will be placed
 outside of PHP start and end markers and will in principle
 work as printing the text.

 Example:
$php->addText( 'Print me!' );
eZPHPCreator::addVariable (   $name,
  $value,
  $assignmentType = eZPHPCreator::VARIABLE_ASSIGNMENT,
  $parameters = array() 
)
 Adds a new variable to the code with the name \a $name and value \a $value.

 Example:
$php->addVariable( 'offset', 5 );
$php->addVariable( 'text', 'some more text', eZPHPCreator::VARIABLE_APPEND_TEXT );
$php->addVariable( 'array', 42, eZPHPCreator::VARIABLE_APPEND_ELEMENT );

Would result in the PHP code.

$offset = 5;
$text .= 'some more text';
$array[] = 42;
Parameters
$assignmentTypeControls the way the value is assigned, choose one of the following:
$parametersOptional parameters, can be any of the following:
  • spacing, The number of spaces to place before each code line, default is 0.
  • full-tree, Whether to displays array values as one large expression (true) or split it up into multiple variables (false)
eZPHPCreator::addVariableUnset (   $name,
  $parameters = array() 
)
 Adds code to unset a variable with the name \a $name.

 Example:
$php->addVariableUnset( 'offset' );

Would result in the PHP code.

unset( $offset );
Parameters
$parametersOptional parameters, can be any of the following:
  • spacing, The number of spaces to place before each code line, default is 0.
See Also
http://php.net/manual/en/function.unset.php
eZPHPCreator::addVariableUnsetList (   $list,
  $parameters = array() 
)
 Adds code to unset a list of variables with name from \a $list.

 Example:
$php->addVariableUnsetList( array ( 'var1', 'var2' ) );

Would result in the PHP code.

unset( $var1, $var2 );
Parameters
$parametersOptional parameters, can be any of the following:
  • spacing, The number of spaces to place before each code line, default is 0.
See Also
http://php.net/manual/en/function.unset.php
eZPHPCreator::canRestore (   $timestamp = false)
Returns
true if file exists and can be restored.
Parameters
$timestampThe timestamp to check the modification time of the file against, if the modification time is larger or equal to $timestamp the file can be restored. Otherwise the file is considered too old.
Note
The file name and path is supplied to the constructor of this class.
eZPHPCreator::close ( )

Closes the currently open file if any.

Referenced by store().

eZPHPCreator::exists ( )
Returns
true if the file and path already exists.
Note
The file name and path is supplied to the constructor of this class.
eZPHPCreator::eZPHPCreator (   $dir,
  $file,
  $prefix = '',
  $options = array() 
)

Initializes the creator with the directory path $dir and filename $file.

eZPHPCreator::fetch (   $addPHPMarkers = true)

Creates a text string out of all elements and returns it.

Note
Calling this multiple times will resulting text processing each time.
eZPHPCreator::flushChunks ( )
private

Referenced by fetch(), and store().

eZPHPCreator::open (   $atomic = false)

Opens the file for writing and sets correct file permissions.

Returns
The current file resource or false if it failed to open the file.
Note
The file name and path is supplied to the constructor of this class.
Multiple calls to this method will only open the file once.

Referenced by store().

static eZPHPCreator::prependSpacing (   $text,
  $spacing,
  $skipEmptyLines = true,
  $spacingString = " ",
  $splitString = "\n" 
)
static

Splits $text into multiple lines using $splitString for splitting. For each line it will prepend the string $spacingString n times as specified by $spacing.

It will try to be smart and not do anything when $spacing is set to 0.

Parameters
$skipEmptyLinesIf true it will not prepend the string for empty lines.
$spacingMust be a positive number, 0 means to not prepend anything.

Referenced by writeCodePiece(), writeMethodCall(), writeVariable(), writeVariableUnset(), and writeVariableUnsetList().

eZPHPCreator::restore (   $variableDefinitions)
 Tries to restore the PHP file and fetch the defined variables in \a $variableDefinitions.
 This basically means including the file using include().

 \param $variableDefinitions Associative array with the return variable name being the key
                             matched variable as value.

 \return An associatve array with the variables that were found according to \a $variableDefinitions.

 Example:
$values = $php->restore( array( 'MyValue' => 'node' ) );
print( $values['MyValue'] );
Note
The file name and path is supplied to the constructor of this class.
eZPHPCreator::store (   $atomic = false)

Stores the PHP cache, returns false if the cache file could not be created.

eZPHPCreator::temporaryVariableName (   $prefix)
private

Referenced by thisVariableText().

eZPHPCreator::thisVariableText (   $value,
  $column = 0,
  $iteration = 0,
  $maxIterations = 2 
)

Creates a text representation of the value $value which can be placed in files and be read back by a PHP parser as it was. The type of the values determines the output, it can be one of the following.

  • boolean, becomes true or false
  • null, becomes null
  • string, adds \ (backslash) to backslashes, double quotes, dollar signs and newlines. Then wraps the whole string in " (double quotes).
  • numeric, displays the value as-is.
  • array, expands all value recursively using this function
  • object, creates a representation of an object creation if the object has serializeData implemented.
Parameters
$columnDetermines the starting column in which the text will be placed. This is used for expanding arrays and objects which can span multiple lines.
$iterationThe current iteration, starts at 0 and increases with 1 for each recursive call
$maxIterationsThe maximum number of iterations to allow, if the iteration exceeds this the array or object will be split into multiple variables. Can be set to false to the array or object as-is.
Note
This function can be called statically if $maxIterations is set to false

Referenced by writeDefine(), writeInclude(), writeMethodCall(), and writeVariable().

static eZPHPCreator::variableNameText (   $variableName,
  $assignmentType,
  $variableParameters = array() 
)
static

Creates a variable statement with an assignment type and returns it.

Parameters
$variableNameThe name of the variable
$assignmentTypeWhat kind of assignment to use, is one of the following;
$variableParametersOptional parameters for the statement

Referenced by writeMethodCall(), and writeVariable().

eZPHPCreator::writeChunks ( )
private

Referenced by store().

eZPHPCreator::writeCodePiece (   $element)
private

Referenced by writeElements().

eZPHPCreator::writeComment (   $element)
private

Referenced by writeElements().

eZPHPCreator::writeDefine (   $element)
private

Referenced by writeElements().

eZPHPCreator::writeElements ( )
private

Referenced by fetch(), and store().

eZPHPCreator::writeInclude (   $element)
private

Referenced by writeElements().

eZPHPCreator::writeMethodCall (   $element)
private

Referenced by writeElements().

eZPHPCreator::writeRawVariable (   $variableName,
  $variableValue 
)
private

Referenced by writeElements().

eZPHPCreator::writeSpace (   $element)
private

Referenced by writeElements().

eZPHPCreator::writeText (   $element)
private

Referenced by writeElements().

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

Referenced by thisVariableText(), and writeElements().

eZPHPCreator::writeVariableUnset (   $element)
private

Referenced by writeElements().

eZPHPCreator::writeVariableUnsetList (   $element)
private

Referenced by writeElements().

Member Data Documentation

eZPHPCreator::$ClusterFileScope = false
eZPHPCreator::$ClusteringEnabled = false
eZPHPCreator::$Elements
eZPHPCreator::$FileResource

Referenced by open().

eZPHPCreator::$isAtomic
eZPHPCreator::$PHPDir
eZPHPCreator::$PHPFile
eZPHPCreator::$requestedFilename
eZPHPCreator::$Spacing = true
eZPHPCreator::$TextChunks
eZPHPCreator::$tmpFilename
const eZPHPCreator::CODE_PIECE = 5

Referenced by addCodePiece(), and writeElements().

const eZPHPCreator::DEFINE = 9

Referenced by addDefine(), and writeElements().

const eZPHPCreator::EOL_COMMENT = 6

Referenced by addComment(), and writeElements().

const eZPHPCreator::INCLUDE_ALWAYS_STATEMENT = 2

Referenced by writeInclude().

const eZPHPCreator::INCLUDE_ONCE_STATEMENT = 1
const eZPHPCreator::INCLUDE_STATEMENT = 7

Referenced by addInclude(), and writeElements().

const eZPHPCreator::METHOD_CALL = 4

Referenced by addMethodCall(), and writeElements().

const eZPHPCreator::METHOD_CALL_PARAMETER_VALUE = 1

Referenced by writeMethodCall().

const eZPHPCreator::METHOD_CALL_PARAMETER_VARIABLE = 2

Referenced by writeMethodCall().

const eZPHPCreator::RAW_VARIABLE = 11

Referenced by addRawVariable(), and writeElements().

const eZPHPCreator::SPACE = 2

Referenced by addSpace(), and writeElements().

const eZPHPCreator::TEXT = 3

Referenced by addText(), and writeElements().

const eZPHPCreator::VARIABLE = 1

Referenced by addVariable(), and writeElements().

const eZPHPCreator::VARIABLE_APPEND_ELEMENT = 3

Referenced by variableNameText().

const eZPHPCreator::VARIABLE_APPEND_TEXT = 2

Referenced by variableNameText().

const eZPHPCreator::VARIABLE_UNSET = 8

Referenced by addVariableUnset(), and writeElements().

const eZPHPCreator::VARIABLE_UNSET_LIST = 10

The documentation for this class was generated from the following file: