Exemples Zend_CodeGenerator
Génération de classes PHP
L'exemple suivant génère le code d'une classe avec son bloc de commentaires PHPDoc.
'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();
]]>
Le résultat est :
Générer des classes PHP avec des attributs de classe
Suivant l'exemple précédant, nous ajoutons maintenant des attributs à la
classe.
'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();
]]>
Le résultat sera :
Générer des classes PHP avec des méthodes
Zend_CodeGenerator_Php_Class vous permet d'attacher des
méthodes à vos classes générées. L'attachement se fait soit par des tableaux, soit
directement des objets Zend_CodeGenerator_Php_Method.
'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();
]]>
Le résultat sera :
_bar = $bar;
return $this;
}
/**
* Retrieve the bar property
*
* @return string|null
*/
public function getBar()
{
return $this->_bar;
}
}
]]>
Générer des fichiers PHP
Zend_CodeGenerator_Php_File sert à générer le contenu de
fichiers PHP. Il est possible d'insérer du code de classes,
ou n'importe quel code. Si
vous attachez des classes, vous pouvez les passer sous forme de tableaux ou directement
d'objets Zend_CodeGenerator_Php_Class.
Dans l'exemple suivant, nous supposons que vous avez défini $foo
comme étant le code d'une des classes des exemples précédents.
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\');',
));
]]>
L'appel à generate() va générer le code, mais pas l'écrire
dans un fichier. Pour ce faire, il faudra d'abord capturer le contenu:
generate();
file_put_contents('Foo.php', $code);
]]>
Le résultat sera :
_bar = $bar;
return $this;
}
/**
* Retrieve the bar property
*
* @return string|null
*/
public function getBar()
{
return $this->_bar;
}
}
define('APPLICATION_ENV', 'testing');
]]>
Ajouter du code à un fichier PHP existant en utilisant la réflexion
Vous pouvez ajouter du code PHP à n'importe quel fichier
PHP existant à condition d'utiliser la réflexion sur celui-ci
afin de l'analyser. La méthode fromReflectedFileName()
va vous y aider.
getBody();
$body .= "\n\$foo->bar();";
file_put_contents($path, $generator->generate());
]]>
Ajouter du code à une classe PHP existante en utilisant la réflexion
Vous pouvez aussi ajouter du code à une classe existante.
Utilisez fromReflection() pour transformer la classe en objet
Reflection. Ajoutez ensuite des méthodes, des attributs, puis régénérez le code de la
classe modifiée :
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();
]]>