Source for file EntityGenerator.php

Documentation is available at EntityGenerator.php

  1. <?php
  2. /**
  3.  * Teeple2 - PHP5 Web Application Framework inspired by Seasar2
  4.  *
  5.  * PHP versions 5
  6.  *
  7.  * LICENSE: This source file is subject to version 3.0 of the PHP license
  8.  * that is available through the world-wide-web at the following URI:
  9.  * http://www.php.net/license/3_0.txt.  If you did not receive a copy of
  10.  * the PHP License and are unable to obtain it through the web, please
  11.  * send a note to license@php.net so we can mail you a copy immediately.
  12.  *
  13.  * @package     teeple
  14.  * @author      Mitsutaka Sato <miztaka@gmail.com>
  15.  * @license     http://www.php.net/license/3_0.txt  PHP License 3.0
  16.  */
  17.  
  18. require_once 'creole/Creole.php';
  19.  
  20. /**
  21.  * Entityを自動生成するロジックです。
  22.  *
  23.  * @package teeple
  24.  */
  25. class Teeple_EntityGenerator {
  26.  
  27.     /**
  28.      * @var Logger 
  29.      */
  30.     protected $log;
  31.  
  32.     /**
  33.      * @var Teeple_DataSource 
  34.      */
  35.     protected $dataSource;
  36.     public function setComponent_Teeple_DataSource($c) {
  37.         $this->dataSource = $c;
  38.     }
  39.  
  40.     /**
  41.      * コンストラクタです。
  42.      */
  43.     public function __construct() {
  44.         $this->log = LoggerManager::getLogger(get_class($this));
  45.     }
  46.  
  47.     /**
  48.      * Entityを生成します。
  49.      * 
  50.      */
  51.     public function execute() {
  52.         $config = $this->dataSource->getDataSourceConfig();
  53.         foreach ($config as $name => $dsn) {
  54.             $this->generate($name, $this->convertDSN($dsn));
  55.         }
  56.     }
  57.  
  58.     private function generate($name, $dsn) {
  59.  
  60.         $datasource = $name;
  61.         $outputdir = dirname(__FILE__)."/../../../components/entity";
  62.  
  63.         /*
  64.          * start.
  65.          */
  66.         $conn = Creole::getConnection($dsn);
  67.         $dbinfo = $conn->getDatabaseInfo();
  68.  
  69.         $base_dir = $outputdir .'/'. 'base';
  70.         if (! file_exists($base_dir) && ! mkdir($base_dir)) {
  71.             print "could not make directory for base: {$outputdir}";
  72.             exit;
  73.         }
  74.  
  75.         foreach($dbinfo->getTables() as $tbl) {
  76.             $classname = "";
  77.             $tablename = "";
  78.             $capName = "";
  79.             $pkdef = "";
  80.             $coldef = "";
  81.             $joindef = "";
  82.             $aliasesdef = "";
  83.  
  84.             $tablename = strtolower($tbl->getName());
  85.             $capName = $this->camelize($tablename);
  86.             $classname = "Entity_{$capName}";
  87.             $baseclassname = "Entity_Base_{$capName}";
  88.  
  89.             // columns
  90.             $cols = array();
  91.             foreach($tbl->getColumns() as $col) {
  92.                 $cols[] = strtolower($col->getName());
  93.             }
  94.  
  95.             // primary key
  96.             $pks = array();
  97.             $pk = $tbl->getPrimaryKey();
  98.             if (is_object($pk)) {
  99.                 foreach($pk->getColumns() as $pkcol) {
  100.                     $pks[] = strtolower($pkcol->getName());
  101.                 }
  102.             }
  103.  
  104.             // join
  105.             $aliases = array();
  106.             $joindef_buf = array();
  107.             $fks = $tbl->getForeignKeys();
  108.             if (is_array($fks)) {
  109.                 foreach($fks as $fk) {
  110.                     $alias = "";
  111.                     $entity = "";
  112.                     $refdef = array();
  113.  
  114.                     $refs = $fk->getReferences();
  115.                     if (is_array($refs)) {
  116.                         //$alias = strtolower($fk->getName());
  117.                         $alias = strtolower($refs[0][1]->getTable()->getName());
  118.                         $entity = 'Entity_'. $this->camelize($refs[0][1]->getTable()->getName());
  119.                         $aliases[] = array(
  120.                     'name' => $alias,
  121.                     'entity' => $entity
  122.                         );
  123.  
  124.                         foreach($refs as $ref) {
  125.                             $p = strtolower($ref[0]->getName());
  126.                             $c = strtolower($ref[1]->getName());
  127.                             $refdef[] = "                '{$p}' => '{$c}'";
  128.                         }
  129.  
  130.                         $buf = "";
  131.                         $buf .= "        '{$alias}' => array(\n";
  132.                         $buf .= "            'entity' => '{$entity}',\n";
  133.                         $buf .= "            'type' => 'INNER JOIN',\n";
  134.                         $buf .= "            'relation' => array(\n";
  135.                         $buf .= implode(",\n", $refdef);
  136.                         $buf .= "\n";
  137.                         $buf .= "            )\n";
  138.                         $buf .= "        )";
  139.  
  140.                         $joindef_buf[] = $buf;
  141.                     }
  142.                 }
  143.             }
  144.             if (count($joindef_buf)) {
  145.                 $joindef = implode(",\n", $joindef_buf);
  146.             }
  147.  
  148.             if (count($aliases)) {
  149.                 foreach ($aliases as $alias) {
  150.                     $aliasesdef .= <<<EOT
  151.     /**
  152.      * @var {$alias['entity']} 
  153.      */
  154.     public \${$alias['name']};
  155.  
  156.  
  157. EOT;
  158.                 }
  159.             }
  160.  
  161.             //$cols = array_diff($cols, $pks);
  162.             foreach ($cols as $col) {
  163.                 $coldef .= "    public \$".$col.";\n";
  164.             }
  165.  
  166.             //$coldef = "'". implode("',\n        '", $cols) ."'";
  167.             $pkdef = "'". implode("',\n'", $pks) ."'";
  168.  
  169.             // ベースクラスの作成
  170.             $filepath = $outputdir ."/base/{$capName}.php";
  171.             if (file_exists($filepath)) {
  172.                 print "{$tablename}: base class already exists. \n";
  173.                 continue;
  174.             }
  175.             if (!$handle = fopen($filepath, 'wb')) {
  176.                 print "{$filepath}: could not open file. \n";
  177.                 continue;
  178.             }
  179.  
  180.             $contents = <<<EOT
  181. class {$baseclassname} extends Teeple_ActiveRecord
  182. {
  183.  
  184.     /**
  185.      * 使用するデータソース名を指定します。
  186.      * 指定が無い場合は、DEFAULT_DATASOURCE で設定されているDataSource名が使用されます。
  187.      *
  188.      * @var string
  189.      */
  190.     public static \$_DATASOURCE = '{$datasource}';
  191.     
  192.     /**
  193.      * このエンティティのテーブル名を設定します。
  194.      * 
  195.      * <pre>
  196.      * スキーマを設定する場合は、"スキーマ.テーブル名"とします。
  197.      * 子クラスにて必ずセットする必要があります。
  198.      * </pre>
  199.      *
  200.      * @var string
  201.      */
  202.     public static \$_TABLENAME = '{$tablename}';
  203.     
  204.     /**
  205.      * プライマリキー列を設定します。
  206.      * 
  207.      * <pre>
  208.      * プライマリキーとなるカラム名を配列で指定します。
  209.      * 子クラスにて必ずセットする必要があります。
  210.      * </pre>
  211.      * 
  212.      * @var array 
  213.      */
  214.     public static \$_PK = array(
  215.         {$pkdef}
  216.     );
  217.     
  218.     /**
  219.      * このテーブルのカラム名をpublicプロパティとして設定します。(プライマリキーを除く)
  220.      * <pre>
  221.      * 子クラスにて必ずセットする必要があります。
  222.      * </pre>
  223.      */
  224. {$coldef}
  225.     
  226.     /**
  227.      * プライマリキーが自動セット(auto increment)かどうかを設定します。
  228.      * 
  229.      * <pre>
  230.      * 子クラスにて必ずセットする必要があります。
  231.      * </pre>
  232.      * 
  233.      * @var bool 
  234.      */
  235.     public static \$_AUTO = TRUE;
  236.  
  237. }
  238. EOT;
  239.  
  240.             $contents = "<?php \n\n". $contents ."\n\n?>";
  241.             if (fwrite($handle, $contents) === FALSE) {
  242.                 print "{$filepath}: failed to write to the file. \n";
  243.                 continue;
  244.             }
  245.  
  246.             print "{$tablename}: entity base class created . \n";
  247.             fclose($handle);
  248.  
  249.             // エンティティクラスの作成
  250.             $filepath = $outputdir ."/{$capName}.php";
  251.             if (file_exists($filepath)) {
  252.                 print "{$tablename}: entity class already exists. \n";
  253.                 continue;
  254.             }
  255.             if (!$handle = fopen($filepath, 'wb')) {
  256.                 print "{$filepath}: could not open file. \n";
  257.                 continue;
  258.             }
  259.  
  260.             $contents = <<<EOT
  261. /**
  262.  * Entity Class for {$tablename}
  263.  *
  264.  * エンティティに関するロジック等はここに実装します。
  265.  * @package entity
  266.  */
  267. class {$classname} extends {$baseclassname}
  268. {
  269.     /**
  270.      * インスタンスを取得します。
  271.      * @return {$classname}
  272.      */
  273.     public static function get() {
  274.         return Teeple_Container::getInstance()->getEntity('{$classname}');
  275.     }
  276.     
  277.     /**
  278.      * 単一行の検索を実行します。
  279.      * @param \$id
  280.      * @return {$classname}
  281.      */
  282.     public function find(\$id=null) {
  283.         return parent::find(\$id);
  284.     }
  285.     
  286.     /**
  287.      * JOINするテーブルを設定します。
  288.      * ※generatorが吐き出した雛形を修正してください。
  289.      * 
  290.      * ここに設定してある定義は、\$this->join('aliasname') で利用できる。<br/>
  291.      * ※ここに設定しただけではJOINされない。
  292.      * 
  293.      * <pre>
  294.      * 指定方法: 'アクセスするための別名' => 設定値の配列
  295.      * 設定値の配列：
  296.      *   'entity' => エンティティのクラス名
  297.      * 　'columns' => 取得するカラム文字列(SQLにセットするのと同じ形式)
  298.      *   'type' => JOINのタイプ(SQLに書く形式と同じ)(省略した場合はINNER JOIN)
  299.      *   'relation' => JOINするためのリレーション設定
  300.      *      「本クラスのキー名 => 対象クラスのキー名」となります。
  301.      *   'condition' => JOINするための設定だがリテラルで指定するもの
  302.      * 
  303.      * 値の例:
  304.      * 
  305.      * \$join_config = array(
  306.      *     'aliasname' => array(
  307.      *         'entity' => 'Entity_Fuga',
  308.      *         'columns' => 'foo, bar, hoge',
  309.      *         'type' => 'LEFT JOIN',
  310.      *         'relation' => array(
  311.      *             'foo_id' => 'bar_id'
  312.      *         ),
  313.      *         'condition' => 'aliasname.status = 1 AND parent.status = 1'
  314.      *     )
  315.      * );
  316.      * </pre>
  317.      * 
  318.      * @var array
  319.      */
  320.     public static \$_JOINCONFIG = array(
  321. {$joindef}
  322.     );
  323.     
  324. {$aliasesdef}
  325.  
  326. }
  327. EOT;
  328.  
  329.             $contents = "<?php \n\n". $contents ."\n\n?>";
  330.             if (fwrite($handle, $contents) === FALSE) {
  331.                 print "{$filepath}: failed to write to the file. \n";
  332.                 continue;
  333.             }
  334.  
  335.             print "{$tablename}: entity class created . \n";
  336.             fclose($handle);
  337.         } // end of foreach
  338.     }
  339.  
  340.     private function convertDSN($dsn) {
  341.  
  342.         $username = $dsn['user'];
  343.         $password = $dsn['pass'];
  344.         list($phptype, $conf) = explode(':', $dsn['dsn']);
  345.         $buff = explode(';', $conf);
  346.         foreach ($buff as $item) {
  347.             list($key, $val) = explode('=', $item);
  348.             switch($key) {
  349.                 case 'host':
  350.                     $hostspec = $val;
  351.                     break;
  352.                 case 'dbname':
  353.                     $database = $val;
  354.                     break;
  355.             }
  356.         }
  357.  
  358.         return array(
  359.             'phptype' => $phptype,
  360.             'hostspec' => $hostspec,
  361.             'username' => $username,
  362.             'password' => $password,
  363.             'database' => $database
  364.         );
  365.     }
  366.     
  367.     private function camelize($str) {
  368.         
  369.         $tablename = strtolower($str);
  370.         $ar = split('_', $tablename);
  371.         $capName = '';
  372.         foreach($ar as $val) {
  373.             $capName .= ucfirst($val);
  374.         }
  375.         return $capName;
  376.     }
  377.  
  378. }
  379.  
  380. ?>
Documentation generated on Mon, 26 Apr 2010 08:59:44 +0900 by phpDocumentor 1.4.3