Zeta Components - high quality PHP components

This class can be used to generate quick and simple PHP scripts. Typical usage would be to generate caches in the form of arrays that also require some logic.

The following example shows how you can use ezcPhpGenerator to make a method that produces a Fibonacci number.

1.  $generator = new ezcPhpGenerator( "~/file.php" );
2.  $generator->appendCustomCode( 'function fibonacci( $number )' );
3.  $generator->appendCustomCode( "{" );
4.  
5.  $generator->appendValueAssignment( "lo", 0 );
6.  $generator->appendValueAssignment( "hi", 1 );
7.  $generator->appendValueAssignment( "i", 2 );
8.  
9.  $generator->appendWhile( '$i < $number' );
10.  $generator->appendCustomCode( '$hi = $lo + $hi;' );
11.  $generator->appendCustomCode( '$lo = $hi - $lo;' );
12.  $generator->appendCustomCode( '$i++;' );
13.  $generator->appendEndWhile();
14.  $generator->appendCustomCode( 'return $hi;' );
15.  $generator->appendCustomCode( "}" );
16.  $generator->finish();

The above code will fill the file "~/file.php" with the following contents:

1.  <?php
2.  function fibonacci( $number )
3.  {
4.  $lo = 0;
5.  $hi = 1;
6.  $i = 2;
7.  while ( $i < $number )
8.  {
9.    $hi = $lo + $hi;
10.    $lo = $hi - $lo;
11.    $i++;
12.  }
13.  return $hi;
14.  }
15.  ?>

Constructs a new ezcPhpGenerator that writes to the file $fileName. If $includeStartEndTags is set the start and end PHP tags will be included. It is useful to omit these if you want to run the generated code using eval() later. $niceIndentation controls if the PHP output should be indented correctly. This option is useful if you want to debug the generated code.

Removes all temporary files that are in use.

Subsequent calls to any methods that generate code will fail.

The comment will be displayed using an end-of-line comment (//).

Example:

1.  $php->addComment( "This file is auto generated. Do not edit!" );
2.  <code>
3.  
4.  Produces the PHP code:
5.  <code>
6.  // This file is auto generated. Do not edit!

Inserts the $code directly into the generated code. Correct indenting and a linebreak at the end of your code will be inserted automatically.

Example:

1.  $php->addCodePiece( "if ( \$value > 2 )" . $php->lineBreak()
2.                      . '{' . $php->lineBreak() .  "\$value = 2;" );

Produces the PHP code:

1.  if ( $value > 2 )
2.  {
3.    $value = 2;
4.  }

The parameter $caseSensitive determines if the defined variable is case sensitive or not. Note that $name must start with a letter or underscore, followed by any number of letters, numbers, or underscores. http://php.net/manual/en/language.constants.php for more information. http://php.net/manual/en/function.define.php

Example:

1.  $php->addDefine( 'MY_CONSTANT', 5 );

Produces:

1.  define( 'MY_CONSTANT', 5 );

The do statement must be closed properly with a call to appendEndDo().

Example:

1.  $php->appendDo();
2.  $php->appendEndDo( '$myVar > 0' );

Produces the PHP code:

1.  do
2.  {
3.  } while ( $myVar > 0 );

If a $condition is provided an else if statement is generated. If not, an else statement is generated. You can only call this method after calling appendIf first.

Example:

1.  $php->appendIf( '$myVar === 0 ' );
2.  $php->appendElse( '$myVar2 === 0 ' );
3.  $php->appendElse();
4.  $php->appendEndIf();

Produces the PHP code:

1.  if ( $myVar === 0 )
2.  {
3.  }
4.  else if ( $myVar )
5.  {
6.  }
7.  else
8.  {
9.  }

Example:

1.  $php->addSpace( 1 );

The complete condition of the do statement is provided through $condition.

The complete condition of the foreach statement is provided through $condition. The foreach statement must be closed properly with a call to appendEndForeach().

Example:

1.  $php->appendForeach( '$myArray as $item ' );
2.  $php->appendEndForeach();

Produces the PHP code:

1.  foreach ( $myArray as $item )
2.  {
3.  }

Inserts a call to $functionName with the parameters $parameters. Set the $returnData parameter if you want to catch the return value.

Example:

1.  $php->appendFunctionCall( 'str_repeat', array( new ezcPhpGeneratorParameter( 'repeat' ),
2.                                                 new ezcPhpGeneratorParameter( 4, ezcPhpGenerator::VALUE ) );

Produces the PHP code:

1.  $var = str_repeat( $repeat, 4 );

The complete condition of the if statement is provided through $condition. The if statement must be closed properly with a call to appendEndIf().

Example:

1.  $php->appendIf( '$myVar === 0 ' );
2.  $php->appendEndIf();

Produces the PHP code:

1.  if ( $myVar === 0 )
2.  {
3.  }

Inserts a call to the method $methodName on the object $objectName with parameters $parameters. Set the $returnData parameter if you want to catch the return value.

Example:

1.  $php->appendMethodCall( 'node', 'name', array(), new ezcPhpGeneratorReturnType( 'result' ) );

Produces the PHP code:

1.  $result = $node->name();

A method call is inserted if $objectName is provided. If not a function call is inserted. This method is a helper method for appendFunctionCall and appendMethodCall. See their description for further description of the parameters and examples.

Example:

1.  $php->addVariableUnset( 'offset' );

Produces the PHP code:

1.  unset( $offset );

Example:

1.  $php->addVariableUnsetList( array ( 'var1', 'var2' ) );

Produces the PHP code:

1.  unset( $var1, $var2 );

$value is exported using var_export(). This allows you to use complex structures for $value. If you want to append an assignment to a variable in the generated code use appendVariableAssignment.

You can control the assignment type with the $assignmentType parameter.

Example:

1.  $array = array( 1, 2, 3 );
2.  $php->appendValueAssignment( 'ProducedArray', $array );

Produces the PHP code:

1.  $ProducedArray = array( 1, 2, 3 );

You can control the assignment type with the $assignmentType parameter.

Example:

1.  $php->addVariableAssignment( 'ProducedArray', 'otherVar' );

Produces the PHP code:

1.  $ProducedArray = $otherVar;

The complete condition of the while statement is provided through $condition. The while statement must be closed properly with a call to appendEndWhile().

Example:

1.  $php->appendWhile( '$myVar > 0' );
2.  $php->appendEndWhile();

Produces the PHP code:

1.  while ( $myVar > 0 )
2.  {
3.  }

This method must be called when you have finished generating a file. It moves the temporary file that was used for writing to the end result file and releases used resources. Subsequent calls to any methods generating code will fail.

If indenting is turned off it will return $text unmodified.