Source for file Ethna_Plugin_Handle.php

Documentation is available at Ethna_Plugin_Handle.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  Ethna_Plugin_Handle.php
  5.  *
  6.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  7.  *  @license    http://www.opensource.org/licenses/bsd-license.php The BSD License
  8.  *  @package    Ethna
  9.  *  @version    $Id$
  10.  */
  11.  
  12. require_once ETHNA_BASE . '/class/Ethna_Getopt.php';
  13.  
  14. // {{{ Ethna_Plugin_Handle
  15. /**
  16.  *  コマンドラインハンドラプラグインの基底クラス
  17.  *  
  18.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  19.  *  @access     public
  20.  *  @package    Ethna
  21.  */
  22. class Ethna_Plugin_Handle
  23. {
  24.     /** @var    handler's id */
  25.     var $id;
  26.  
  27.     /** @var    command line arguments */
  28.     var $arg_list;
  29.  
  30.     /**
  31.      *  Ethna_Handle constructor (stub for php4)
  32.      *
  33.      *  @access public
  34.      */
  35.     function Ethna_Plugin_Handle(&$controller, $type, $name)
  36.     {
  37.         $id = $name;
  38.         $id = preg_replace('/^([A-Z])/e', "strtolower('\$1')", $id);
  39.         $id = preg_replace('/([A-Z])/e', "'-' . strtolower('\$1')", $id);
  40.         $this->id = $id;
  41.     }
  42.  
  43.     /**
  44.      *  get handler-id
  45.      *
  46.      *  @access public
  47.      */
  48.     function getId()
  49.     {
  50.         return $this->id;
  51.     }
  52.  
  53.     /**
  54.      *  get handler's description
  55.      *
  56.      *  @access public
  57.      */
  58.     function getDescription()
  59.     {
  60.         return "description of " . $this->id;
  61.     }
  62.  
  63.     /**
  64.      *  get handler's usage
  65.      *
  66.      *  @access public
  67.      */
  68.     function getUsage()
  69.     {
  70.         return "usage of " . $this->id;
  71.     }
  72.  
  73.     /**
  74.      *  set arguments
  75.      *
  76.      *  @access public
  77.      */
  78.     function setArgList($arg_list)
  79.     {
  80.         $this->arg_list = $arg_list;
  81.     }
  82.  
  83.     /**
  84.      * easy getopt :)
  85.      *
  86.      * @param   array   $lopts  long options
  87.      * @return  array   list($opts, $args)
  88.      * @access  protected
  89.      */
  90.     function &_getopt($lopts = array())
  91.     {
  92.         // create opts
  93.         // ex: $lopts = array('foo', 'bar=');
  94.         $lopts = to_array($lopts);
  95.         $sopts = '';
  96.         $opt_def = array();
  97.         foreach ($lopts as $lopt) {
  98.             if ($lopt{strlen($lopt) - 2} === '=') {
  99.                 $opt_def[$lopt{0}] = substr($lopt, 0, strlen($lopt) - 2);
  100.                 $sopts .= $lopt{0} . '::';
  101.             } else if ($lopt{strlen($lopt) - 1} === '=') {
  102.                 $opt_def[$lopt{0}] = substr($lopt, 0, strlen($lopt) - 1);
  103.                 $sopts .= $lopt{0} . ':';
  104.             } else {
  105.                 $opt_def[$lopt{0}] = $lopt;
  106.                 $sopts .= $lopt{0};
  107.             }
  108.         }
  109.  
  110.         // do getopt
  111.         // ex: $sopts = 'fb:';
  112.         $opt = new Ethna_Getopt();
  113.         $opts_args = $opt->getopt($this->arg_list, $sopts, $lopts);
  114.         if (Ethna::isError($opts_args)) {
  115.             return $opts_args;
  116.         }
  117.  
  118.         // parse opts
  119.         // ex: "-ff --bar=baz" gets
  120.         //      $opts = array('foo' => array(true, true),
  121.         //                    'bar' => array('baz'));
  122.         $opts = array();
  123.         foreach ($opts_args[0] as $opt) {
  124.             $opt[0] = $opt[0]{0} === '-' ? $opt_def[$opt[0]{2}] : $opt_def[$opt[0]{0}];
  125.             $opt[1] = $opt[1] === null ? true : $opt[1];
  126.             if (isset($opts[$opt[0]]) === false) {
  127.                 $opts[$opt[0]] = array($opt[1]);
  128.             } else {
  129.                 $opts[$opt[0]][] = $opt[1];
  130.             }
  131.         }
  132.         $opts_args[0] = $opts;
  133.  
  134.         return $opts_args;
  135.     }
  136.  
  137.     /**
  138.      *  just perform
  139.      *
  140.      *  @access public
  141.      */
  142.     function perform()
  143.     {
  144.     }
  145.  
  146.     /**
  147.      *  show usage
  148.      *
  149.      *  @access public
  150.      */
  151.     function usage()
  152.     {
  153.         echo "usage:\n";
  154.         echo $this->getUsage() . "\n\n";
  155.     }
  156. }
  157. // }}}
  158. ?>

Documentation generated on Fri, 11 Nov 2011 04:00:20 +0900 by phpDocumentor 1.4.3