Source for file CreatePlugin.php

Documentation is available at CreatePlugin.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  CreatePlugin.php
  5.  *
  6.  *  @author     Yoshinari Takaoka <takaoka@beatcraft.com>
  7.  *  @license    http://www.opensource.org/licenses/bsd-license.php The BSD License
  8.  *  @package    Ethna
  9.  *  @version    $Id: d1507c3241e27776f51f9d886d668f4e127ad90e $
  10.  */
  11.  
  12. // {{{ Ethna_Plugin_Generator_CreatePlugin
  13. /**
  14.  *  プラグインパッケージスケルトン生成クラス
  15.  *
  16.  *  @author     Yoshinari Takaoka <takaoka@beatcraft.com>
  17.  *  @access     public
  18.  *  @package    Ethna
  19.  */
  20. class Ethna_Plugin_Generator_CreatePlugin extends Ethna_Plugin_Generator
  21. {
  22.     /**
  23.      *  テンプレートのスケルトンを生成する
  24.      *
  25.      *  @access public
  26.      *  @param  string  $basedir        ベースディレクトリ
  27.      *  @param  array   $types          プラグインのtype (Validator, Handle等)
  28.      *  @param  string  $forpackage     iniファイル生成フラグ
  29.      *  @param  string  $plugin_name    プラグイン名
  30.      *  @return true|Ethna_Error       true:成功 Ethna_Error:失敗
  31.      */
  32.     function generate($basedir, $types = array(), $forpackage = false, $plugin_name)
  33.     {
  34.         $plugin_dir = "$basedir/plugin";
  35.         if (!$forpackage) {
  36.             $chk_ctl = Ethna_Handle::getAppController(getcwd());
  37.             if (Ethna::isError($chk_ctl)) {
  38.                 return Ethna::raiseError(
  39.                            "ERROR: You are not in Ethna project. specify [-p|--plugin-package] option, or change directory to the Ethna Project\n"
  40.                 );
  41.             }
  42.             $plugin_dir = $chk_ctl->getDirectory('plugin');
  43.         }
  44.  
  45.         //  create plugin directory
  46.         if (!file_exists($plugin_dir)) {
  47.             Ethna_Util::mkdir($plugin_dir, 0755);
  48.         }
  49.  
  50.         //   type check.
  51.         if (empty($types)) {
  52.             return Ethna::raiseError('please specify plugin type.');
  53.         }
  54.  
  55.         //
  56.         //   type check
  57.         //
  58.         foreach ($types as $type) {
  59.             switch (strtolower($type)) {
  60.             case 'f':
  61.             case 'v':
  62.             case 'sm':
  63.             case 'sb':
  64.             case 'sf':
  65.                 break;
  66.             default:
  67.                 return Ethna::raiseError("unknown plugin type: ${type}", 'usage');
  68.             }
  69.         }
  70.  
  71.         //
  72.         //   Generate Plugin PHP File   
  73.         //
  74.         $plugin_name = ucfirst(strtolower($plugin_name));
  75.         $lplugin_name = strtolower($plugin_name);
  76.         $macro['plugin_name'] = $plugin_name;
  77.         foreach ($types as $type) {
  78.             $ltype = strtolower($type);
  79.             $macro['plugin_type'] = $type;
  80.             $plugin_file_skel = "plugin/skel.plugin.${ltype}.php";
  81.         
  82.             //   create directory
  83.             switch ($type) {
  84.             case 'f':
  85.                 $type = 'Filter';
  86.                 $pfilename = "${plugin_name}.php";
  87.                 break;
  88.             case 'v':
  89.                 $type = 'Validator';
  90.                 $pfilename = "${plugin_name}.php";
  91.                 break;
  92.             case 'sm':
  93.                 $type = 'Smarty';
  94.                 $pfilename = "modifier.${lplugin_name}.php";
  95.                 $macro['plugin_name'] = $lplugin_name;
  96.                 break;
  97.             case 'sb':
  98.                 $type = 'Smarty';
  99.                 $pfilename = "block.${lplugin_name}.php";
  100.                 $macro['plugin_name'] = $lplugin_name;
  101.                 break;
  102.             case 'sf':
  103.                 $type = 'Smarty';
  104.                 $pfilename = "function.${lplugin_name}.php";
  105.                 $macro['plugin_name'] = $lplugin_name;
  106.                 break;
  107.             }
  108.             $type_dir = "$plugin_dir/$type";
  109.             if (!file_exists($type_dir)) {
  110.                 Ethna_Util::mkdir($type_dir, 0755);
  111.             }
  112.  
  113.             $type_file_path = "$type_dir/${pfilename}";
  114.  
  115.             // generate
  116.             if (file_exists($type_file_path)) {
  117.                 printf("file [%s] already exists -> skip\n", $type_file_path);
  118.             } else if ($this->_generateFile($plugin_file_skel, $type_file_path, $macro) == false) {
  119.                 printf("[warning] file creation failed [%s]\n", $type_file_path);
  120.             } else {
  121.                 printf("plugin php file successfully created [%s]\n", $type_file_path);
  122.             }
  123.         } 
  124.  
  125.         //   generate ini file
  126.         if ($forpackage) {
  127.             $ini_skel = 'plugin/skel.plugin.ini';
  128.             $ini_file = strtolower($plugin_name) . '.ini';
  129.             $ini_path = "$plugin_dir/$ini_file";
  130.         
  131.             if (file_exists($ini_path)) {
  132.                 printf("file [%s] already exists -> skip\n", $ini_file);
  133.             } else if ($this->_generateFile($ini_skel, $ini_path, $macro) == false) {
  134.                 printf("[warning] file creation failed [%s]\n", $ini_file);
  135.             } else {
  136.                 printf("plugin ini file successfully created [%s]\n", $ini_file);
  137.             }
  138.         }
  139.  
  140.         $true = true;
  141.         return $true;
  142.     }
  143. }
  144. // }}}

Documentation generated on Fri, 11 Nov 2011 03:57:55 +0900 by phpDocumentor 1.4.3