Erebot  latest
A modular IRC bot for PHP 7.0+
Erebot\Console\StoreProxyAction Class Reference

Custom action which acts as a proxy. More...

+ Inheritance diagram for Erebot\Console\StoreProxyAction:

Public Member Functions

 execute ($value=false, $params=array())
 setResult ($result, $option=null)

Detailed Description

Custom action which acts as a proxy.

This class can be used in conjunction with Console_CommandLine_ParallelOption to have multiple options that act on the same variable.

Definition at line 31 of file StoreProxyAction.php.

Member Function Documentation

Erebot\Console\StoreProxyAction::execute (   $value = false,
  $params = array() 

Executes this action whenever the associated option has been passed on the command-line.

mixed$value(optional) Value given to this option. The default is false.
array$params(optional) Parameters associated with this action. The default is an empty set of parameters (empty array).

Definition at line 63 of file StoreProxyAction.php.

References Erebot\Console\StoreProxyAction\setResult().

Erebot\Console\StoreProxyAction::setResult (   $result,
  $option = null 

Sets the result of this action. In our case, this actually changes the value of another option.

mixed$resultResult to assign to the other option.
mixed$option(optional) Name of the option this proxy will operate on. The default is null.

Definition at line 45 of file StoreProxyAction.php.

Referenced by Erebot\Console\StoreProxyAction\execute().

The documentation for this class was generated from the following file: