Class: Console_CommandLine_Action_Callback

Source Location: /Console_CommandLine-1.2.0/Console/CommandLine/Action/Callback.php

Class Overview

Console_CommandLine_Action
   |
   --Console_CommandLine_Action_Callback

Class that represent the Callback action.

Author(s):

David JEAN LOUIS <izimobil at gmail.com>

Version:

Release: 1.2.0

Copyright:

2007 David JEAN LOUIS

Methods

execute

Inherited Variables

Class: Console_CommandLine_Action

Console_CommandLine_Action::$option
Console_CommandLine_Action::$parser
Console_CommandLine_Action::$result

Inherited Methods

Class: Console_CommandLine_Action

Console_CommandLine_Action::__construct(): Constructor
Console_CommandLine_Action::execute(): Executes the action with the value entered by the user.
Console_CommandLine_Action::format(): Allow a value to be pre-formatted prior to being used in a choices test.
Console_CommandLine_Action::getResult(): Convenience method to retrieve the value of result->options[name].
Console_CommandLine_Action::setResult(): Convenience method to assign the result->options[name] value.

Class Details

[line 62]
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.

Author: David JEAN LOUIS <izimobil@gmail.com>
Version: Release: 1.2.0
Link: http://pear.php.net/package/Console_CommandLine
Since: Class available since release 0.1.0
License: MIT License

[ Top ]

Method Detail

execute [line 74]

string execute(
[mixed
$value = false], [array
$params = array()])

Executes the action with the value entered by the user.

Access: public

Overrides Console_CommandLine_Action::execute() (Executes the action with the value entered by the user.)

Parameters:

mixed	`$value`	—	The value of the option
array	`$params`	—	An optional array of parameters

[ Top ]