* @copyright 2007-2009 David JEAN LOUIS * @license http://opensource.org/licenses/mit-license.php MIT License * @version 0.2.3 * @link http://pear2.php.net/PEAR2_Console_CommandLine * @since File available since release 0.1.0 * * @filesource */ namespace PEAR2\Console\CommandLine\Action; use PEAR2\Console\CommandLine; /** * Class that represent the Callback action. * * The result option array entry value is set to the return value of the * callback defined in the option. * * There are two steps to defining a callback option: * - define the option itself using the callback action * - write the callback; this is a function (or method) that takes five * arguments, as described below. * * All callbacks are called as follows: * * callable_func( * $value, // the value of the option * $option_instance, // the option instance * $result_instance, // the result instance * $parser_instance, // the parser instance * $params // an array of params as specified in the option * ); * * and *must* return the option value. * * @category Console * @package PEAR2\Console\CommandLine * @author David JEAN LOUIS * @copyright 2007-2009 David JEAN LOUIS * @license http://opensource.org/licenses/mit-license.php MIT License * @link http://pear2.php.net/PEAR2_Console_CommandLine * @since Class available since release 0.1.0 */ class Callback extends CommandLine\Action { // execute() {{{ /** * Executes the action with the value entered by the user. * * @param mixed $value The value of the option * @param array $params An optional array of parameters * * @return string */ public function execute($value = false, $params = array()) { $this->setResult( call_user_func( $this->option->callback, $value, $this->option, $this->result, $this->parser, $params ) ); } // }}} }