Class: Console_CommandLine_Action_Counter

Source Location: /Console_CommandLine-1.0.2/CommandLine/Action/Counter.php

Class Overview

Console_CommandLine_Action
 |
 --Console_CommandLine_Action_Counter

Class that represent the Version action.

Author(s):

David JEAN LOUIS <izimobil at gmail.com>

Version:

Release: 1.0.2

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(): Execute the action with the value entered by the user.
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 64]
Class that represent the Version action.

The execute methode add 1 to the value of the result option array entry. The value is incremented each time the option is found, for example with an option defined like that:

 $parser->addOption(

   'verbose',
   array(
     'short_name' => '-v',
     'action'   => 'Counter'
   )
 );

If the user type:

 $ script.php -v -v -v

or:

 $ script.php -vvv

the verbose variable will be set to to 3.

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

[ Top ]

Method Detail

execute [line 77]

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

Execute the action with the value entered by the user.

Access: public

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

Parameters:

mixed $value — the option value

array $params — an optional array of parameters

[ Top ]