61 lines
1.7 KiB
PHP
61 lines
1.7 KiB
PHP
<?php
|
|
|
|
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
|
|
|
|
/**
|
|
* This file is part of the PEAR Console_CommandLine package.
|
|
*
|
|
* PHP version 5
|
|
*
|
|
* LICENSE: This source file is subject to the MIT license that is available
|
|
* through the world-wide-web at the following URI:
|
|
* http://opensource.org/licenses/mit-license.php
|
|
*
|
|
* @category Console
|
|
* @package Console_CommandLine
|
|
* @author David JEAN LOUIS <izimobil@gmail.com>
|
|
* @copyright 2007 David JEAN LOUIS
|
|
* @license http://opensource.org/licenses/mit-license.php MIT License
|
|
* @version CVS: $Id$
|
|
* @link http://pear.php.net/package/Console_CommandLine
|
|
* @since File available since release 0.1.0
|
|
* @filesource
|
|
*/
|
|
|
|
/**
|
|
* Required by this class.
|
|
*/
|
|
require_once 'Console/CommandLine/Action.php';
|
|
|
|
/**
|
|
* Class that represent the Help action, a special action that displays the
|
|
* help message, telling the user how to use the program.
|
|
*
|
|
* @category Console
|
|
* @package Console_CommandLine
|
|
* @author David JEAN LOUIS <izimobil@gmail.com>
|
|
* @copyright 2007 David JEAN LOUIS
|
|
* @license http://opensource.org/licenses/mit-license.php MIT License
|
|
* @version Release: 1.2.0
|
|
* @link http://pear.php.net/package/Console_CommandLine
|
|
* @since Class available since release 0.1.0
|
|
*/
|
|
class Console_CommandLine_Action_Help extends Console_CommandLine_Action
|
|
{
|
|
// execute() {{{
|
|
|
|
/**
|
|
* Executes the action with the value entered by the user.
|
|
*
|
|
* @param mixed $value The option value
|
|
* @param array $params An optional array of parameters
|
|
*
|
|
* @return string
|
|
*/
|
|
public function execute($value = false, $params = array())
|
|
{
|
|
return $this->parser->displayUsage();
|
|
}
|
|
// }}}
|
|
}
|