PhpRiot
Become Zend Certified

Prepare for the ZCE exam using our quizzes (web or iPad/iPhone). More info...


When you're ready get 7.5% off your exam voucher using voucher CJQNOV23 at the Zend Store

Zend_CodeGenerator Examples

Example 112. Generating PHP classes

The following example generates an empty class with a class-level DocBlock.

<?php
$foo      
= new Zend_CodeGenerator_Php_Class();
$docblock = new Zend_CodeGenerator_Php_Docblock(array(
    
'shortDescription' => 'Sample generated class',
    
'longDescription'  => 'This is a class generated with Zend_CodeGenerator.',
    
'tags'             => array(
        array(
            
'name'        => 'version',
            
'description' => '$Rev:$',
        ),
        array(
            
'name'        => 'license',
            
'description' => 'New BSD',
        ),
    ),
));
$foo->setName('Foo')
    ->
setDocblock($docblock);
echo 
$foo->generate();

The above code will result in the following:

<?php
/**
 * Sample generated class
 *
 * This is a class generated with Zend_CodeGenerator.
 *
 * @version $Rev:$
 * @license New BSD
 *
 */
class Foo
{

}

Example 113. Generating PHP classes with class properties

Building on the previous example, we now add properties to our generated class.

<?php
$foo      
= new Zend_CodeGenerator_Php_Class();
$docblock = new Zend_CodeGenerator_Php_Docblock(array(
    
'shortDescription' => 'Sample generated class',
    
'longDescription'  => 'This is a class generated with Zend_CodeGenerator.',
    
'tags'             => array(
        array(
            
'name'        => 'version',
            
'description' => '$Rev:$',
        ),
        array(
            
'name'        => 'license',
            
'description' => 'New BSD',
        ),
    ),
));
$foo->setName('Foo')
    ->
setDocblock($docblock)
    ->
setProperties(array(
        array(
            
'name'         => '_bar',
            
'visibility'   => 'protected',
            
'defaultValue' => 'baz',
        ),
        array(
            
'name'         => 'baz',
            
'visibility'   => 'public',
            
'defaultValue' => 'bat',
        ),
        array(
            
'name'         => 'bat',
            
'const'        => true,
            
'defaultValue' => 'foobarbazbat',
        ),
    ));
echo 
$foo->generate();

The above results in the following class definition:

<?php
/**
 * Sample generated class
 *
 * This is a class generated with Zend_CodeGenerator.
 *
 * @version $Rev:$
 * @license New BSD
 *
 */
class Foo
{

    protected 
$_bar 'baz';

    public 
$baz 'bat';

    const 
bat 'foobarbazbat';

}

Example 114. Generating PHP classes with class methods

Zend_CodeGenerator_Php_Class allows you to attach methods with optional content to your classes. Methods may be attached as either arrays or concrete Zend_CodeGenerator_Php_Method instances.

<?php
$foo      
= new Zend_CodeGenerator_Php_Class();
$docblock = new Zend_CodeGenerator_Php_Docblock(array(
    
'shortDescription' => 'Sample generated class',
    
'longDescription'  => 'This is a class generated with Zend_CodeGenerator.',
    
'tags'             => array(
        array(
            
'name'        => 'version',
            
'description' => '$Rev:$',
        ),
        array(
            
'name'        => 'license',
            
'description' => 'New BSD',
        ),
    ),
));
$foo->setName('Foo')
    ->
setDocblock($docblock)
    ->
setProperties(array(
        array(
            
'name'         => '_bar',
            
'visibility'   => 'protected',
            
'defaultValue' => 'baz',
        ),
        array(
            
'name'         => 'baz',
            
'visibility'   => 'public',
            
'defaultValue' => 'bat',
        ),
        array(
            
'name'         => 'bat',
            
'const'        => true,
            
'defaultValue' => 'foobarbazbat',
        ),
    ))
    ->
setMethods(array(
        
// Method passed as array
        
array(
            
'name'       => 'setBar',
            
'parameters' => array(
                array(
'name' => 'bar'),
            ),
            
'body'       => '$this->_bar = $bar;' "\n" 'return $this;',
            
'docblock'   => new Zend_CodeGenerator_Php_Docblock(array(
                
'shortDescription' => 'Set the bar property',
                
'tags'             => array(
                    new 
Zend_CodeGenerator_Php_Docblock_Tag_Param(array(
                        
'paramName' => 'bar',
                        
'datatype'  => 'string'
                    
)),
                    new 
Zend_CodeGenerator_Php_Docblock_Tag_Return(array(
                        
'datatype'  => 'string',
                    )),
                ),
            )),
        ),
        
// Method passed as concrete instance
        
new Zend_CodeGenerator_Php_Method(array(
            
'name' => 'getBar',
            
'body'       => 'return $this->_bar;',
            
'docblock'   => new Zend_CodeGenerator_Php_Docblock(array(
                
'shortDescription' => 'Retrieve the bar property',
                
'tags'             => array(
                    new 
Zend_CodeGenerator_Php_Docblock_Tag_Return(array(
                        
'datatype'  => 'string|null',
                    )),
                ),
            )),
        )),
    ));

echo 
$foo->generate();

The above generates the following output:

<?php
/**
 * Sample generated class
 *
 * This is a class generated with Zend_CodeGenerator.
 *
 * @version $Rev:$
 * @license New BSD
 */
class Foo
{

    protected 
$_bar 'baz';

    public 
$baz 'bat';

    const 
bat 'foobarbazbat';

    
/**
     * Set the bar property
     *
     * @param string bar
     * @return string
     */
    
public function setBar($bar)
    {
        
$this->_bar $bar;
        return 
$this;
    }

    
/**
     * Retrieve the bar property
     *
     * @return string|null
     */
    
public function getBar()
    {
        return 
$this->_bar;
    }

}

Example 115. Generating PHP files

Zend_CodeGenerator_Php_File can be used to generate the contents of a PHP file. You can include classes as well as arbitrary content body. When attaching classes, you should attach either concrete Zend_CodeGenerator_Php_Class instances or an array defining the class.

In the example below, we will assume you've defined $foo per one of the class definitions in a previous example.

<?php
$file 
= new Zend_CodeGenerator_Php_File(array(
    
'classes'  => array($foo);
    
'docblock' => new Zend_CodeGenerator_Php_Docblock(array(
        
'shortDescription' => 'Foo class file',
        
'tags'             => array(
            array(
                
'name'        => 'license',
                
'description' => 'New BSD',
            ),
        ),
    )),
    
'body'     => 'define(\'APPLICATION_ENV\', \'testing\');',
));

Calling generate() will generate the code -- but not write it to a file. You will need to capture the contents and write them to a file yourself. As an example:

<?php
$code 
$file->generate();
file_put_contents('Foo.php'$code);

The above will generate the following file:


<?php
/**
 * Foo class file
 *
 * @license New BSD
 */

/**
 * Sample generated class
 *
 * This is a class generated with Zend_CodeGenerator.
 *
 * @version $Rev:$
 * @license New BSD
 */
class Foo
{

    protected 
$_bar 'baz';

    public 
$baz 'bat';

    const 
bat 'foobarbazbat';

    
/**
     * Set the bar property
     *
     * @param string bar
     * @return string
     */
    
public function setBar($bar)
    {
        
$this->_bar $bar;
        return 
$this;
    }

    
/**
     * Retrieve the bar property
     *
     * @return string|null
     */
    
public function getBar()
    {
        return 
$this->_bar;
    }

}

define('APPLICATION_ENV''testing');

Example 116. Seeding PHP file code generation via reflection

You can add PHP code to an existing PHP file using the code generator. To do so, you need to first do reflection on it. The static method fromReflectedFileName() allows you to do this.

<?php
$generator 
Zend_CodeGenerator_Php_File::fromReflectedFileName($path);
$body $generator->getBody();
$body .= "\n\$foo->bar();";
file_put_contents($path$generator->generate());

Example 117. Seeding PHP class generation via reflection

You may add code to an existing class. To do so, first use the static fromReflection() method to map the class into a generator object. From there, you may add additional properties or methods, and then regenerate the class.

<?php
$generator 
Zend_CodeGenerator_Php_Class::fromReflection(
    new 
Zend_Reflection_Class($class)
);
$generator->setMethod(array(
    
'name'       => 'setBaz',
    
'parameters' => array(
        array(
'name' => 'baz'),
    ),
    
'body'       => '$this->_baz = $baz;' "\n" 'return $this;',
    
'docblock'   => new Zend_CodeGenerator_Php_Docblock(array(
        
'shortDescription' => 'Set the baz property',
        
'tags'             => array(
            new 
Zend_CodeGenerator_Php_Docblock_Tag_Param(array(
                
'paramName' => 'baz',
                
'datatype'  => 'string'
            
)),
            new 
Zend_CodeGenerator_Php_Docblock_Tag_Return(array(
                
'datatype'  => 'string',
            )),
        ),
    )),
));
$code $generator->generate();

Zend Framework