Source for file Help.php

Documentation is available at Help.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  Plugin_Handle_Help.php
  5.  *
  6.  *  @author     Tomoyuki MARUTA <maru_cc@users.sourceforge.jp>
  7.  *  @license    http://www.opensource.org/licenses/bsd-license.php The BSD License
  8.  *  @package    Ethna
  9.  *  @version    $Id: c36b05e000b0136041f7bb96680fb79d51a28bcb $
  10.  */
  11.  
  12. // {{{ Ethna_Plugin_Handle_Help
  13. /**
  14.  *  add-action handler
  15.  *
  16.  *  @author     ICHII Takashi <ichii386@schweetheart.jp>
  17.  *  @access     public
  18.  *  @package    Ethna
  19.  */
  20. class Ethna_Plugin_Handle_Help extends Ethna_Plugin_Handle
  21. {
  22.     /**
  23.      *  show help
  24.      *
  25.      *  @access public
  26.      */
  27.     function perform()
  28.     {
  29.         $r = $this->_getopt();
  30.         if (Ethna::isError($r)) {
  31.             return $r;
  32.         }
  33.         list($opt_list, $arg_list) = $r;
  34.  
  35.         // action_name
  36.         $handle_name = array_shift($arg_list);
  37.         if (!strlen($handle_name)) {
  38.             $handler_list = $this->eh->getHandlerList();
  39.             printf("usage: ethna [option] [command] [args...]\n\n");
  40.             printf("available options are as follows:\n\n");
  41.             printf("  -v, --version    show version and exit\n");
  42.             printf("\navailable commands are as follows:\n\n");
  43.             foreach ($handler_list as $handler) {
  44.                 printf("  %s\n", $handler->getId());
  45.             }
  46.             return true;
  47.         }
  48.  
  49.         // getHandler
  50.         $handler = $this->eh->getHandler($handle_name);
  51.         if (Ethna::isError($handler) || $handler === false) { 
  52.             // command not found
  53.             return Ethna::raiseError('command not found.', 'usage');
  54.         }
  55.  
  56.         echo $handler->getDescription();
  57.  
  58.         return true;
  59.  
  60.     }
  61.  
  62.     /**
  63.      *  get handler's description
  64.      *
  65.      *  @access public
  66.      */
  67.     function getDescription()
  68.     {
  69.         return <<<EOS
  70. help:
  71.     {$this->id} [command_name]
  72.  
  73. EOS;
  74.     }
  75.  
  76.     /**
  77.      *  @access public
  78.      */
  79.     function getUsage()
  80.     {
  81.         return <<<EOS
  82. ethna {$this->id} [command_name]
  83. EOS;
  84.     }
  85. }
  86. // }}}

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