Source for file Handle.php

Documentation is available at Handle.php

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

Documentation generated on Fri, 11 Nov 2011 03:58:14 +0900 by phpDocumentor 1.4.3