Zend_CodeGenerator

導入

Zend_CodeGeneratorは、 新しいコードを作成するばかりではなく、既存のコードを更新するためにも、 オブジェクト指向インターフェースを用いた任意のコードを生成する機能を提供します。 現在の実装はPHPコードを生成することに限られますが、 他の仕事のためのコード生成をさせるために基底クラスを簡単に拡張することができます: JavaScript、設定ファイル、apache vhosts、その他。

Theory of Operation

最も代表的な使用例では、単にコード・ジェネレーター・クラスのインスタンスを生成して、 それに適切な設定を渡すか、またはインスタンス化のあと設定します。 コードを生成するために、単にオブジェクトをechoするか、 その generate()メソッドを呼びます。

  1. //構成をコンストラクタに渡す
  2. $file = new Zend_CodeGenerator_Php_File(array(
  3.     'classes' => array(
  4.         new Zend_CodeGenerator_Php_Class(array(
  5.             'name'    => 'World',
  6.             'methods' => array(
  7.                 new Zend_CodeGenerator_Php_Method(array(
  8.                     'name' => 'hello',
  9.                     'body' => 'echo \'Hello world!\';',
  10.                 )),
  11.             ),
  12.         )),
  13.     )
  14. ));
  15.  
  16. //インスタンス化のあと設定
  17. $method = new Zend_CodeGenerator_Php_Method();
  18. $method->setName('hello')
  19.        ->setBody('echo \'Hello world!\';');
  20.  
  21. $class = new Zend_CodeGenerator_Php_Class();
  22. $class->setName('World')
  23.       ->setMethod($method);
  24.  
  25. $file = new Zend_CodeGenerator_Php_File();
  26. $file->setClass($class);
  27.  
  28. //生成されたファイルのレンダリング
  29. echo $file;
  30.  
  31. //またはファイルへの書き出し:
  32. file_put_contents('World.php', $file->generate());

上記のサンプルは両方とも同じ結果でレンダリングされます:

  1. <?php
  2.  
  3. class World
  4. {
  5.  
  6.     public function hello()
  7.     {
  8.         echo 'Hello world!';
  9.     }
  10.  
  11. }

もう一つの一般的な使用例は、既存のコードを更新することです。 たとえばメソッドをクラスに加えるために。 この場合には、最初にreflectionを用いて既存のコードを調べて、 次に新しいメソッドを加えなければいけません。 Zend_Reflectionを導入することによって、 Zend_CodeGeneratorはつまらないほどこれを単純にします。

例えば、上記をファイル"World.php"に保存して、すでにincludeしたとしましょう。 それから下記のようにできます。

  1. $class = Zend_CodeGenerator_Php_Class::fromReflection(
  2.     new Zend_Reflection_Class('World')
  3. );
  4.  
  5. $method = new Zend_CodeGenerator_Php_Method();
  6. $method->setName('mrMcFeeley')
  7.        ->setBody('echo \'Hello, Mr. McFeeley!\';');
  8. $class->setMethod($method);
  9.  
  10. $file = new Zend_CodeGenerator_Php_File();
  11. $file->setClass($class);
  12.  
  13. //生成されたファイルのレンダリング
  14. echo $file;
  15.  
  16. //または、より良いですが、元のファイルに書き戻します。:
  17. file_put_contents('World.php', $file->generate());

クラスファイルの結果はこのようになります:

  1. <?php
  2.  
  3. class World
  4. {
  5.  
  6.     public function hello()
  7.     {
  8.         echo 'Hello world!';
  9.     }
  10.  
  11.     public function mrMcFeeley()
  12.     {
  13.         echo 'Hellow Mr. McFeeley!';
  14.     }
  15.  
  16. }

Zend_CodeGenerator