Source for file Action.php
Documentation is available at Action.php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
* This file is part of the PEAR Console_CommandLine package.
* 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
* @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
* @link http://pear.php.net/package/Console_CommandLine
* @since File available since release 0.1.0
* Class that represent an option action.
* @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
* A reference to the result instance.
* @var Console_CommandLine_Result $result The result instance
* A reference to the option instance.
* @var Console_CommandLine_Option $option The action option
* A reference to the parser instance.
* @var Console_CommandLine $parser The parser
* @param Console_CommandLine_Result $result The result instance
* @param Console_CommandLine_Option $option The action option
* @param Console_CommandLine $parser The current parser
* Convenience method to retrieve the value of result->options[name].
* @return mixed The result value or null
* Allow a value to be pre-formatted prior to being used in a choices test.
* Setting $value to the new format will keep the formatting.
* @param mixed &$value The value to format
* @return mixed The formatted value
public function format(&$value)
* Convenience method to assign the result->options[name] value.
* @param mixed $result The result value
* Executes the action with the value entered by the user.
* All children actions must implement this method.
* @param mixed $value The option value
* @param array $params An optional array of parameters
abstract public function execute($value = false , $params = array ());
Documentation generated on Mon, 11 Mar 2019 15:51:31 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|