Class: Console_CommandLine_Action_StoreTrue

Source Location: /Console_CommandLine-1.0.0RC3/CommandLine/Action/StoreTrue.php

Class Overview

Console_CommandLine_Action
   |
   --Console_CommandLine_Action_StoreTrue

Class that represent the StoreTrue action.

Author(s):

David JEAN LOUIS <izimobil at gmail.com>

Version:

Release: 1.0.0RC3

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 45]
Class that represent the StoreTrue action.

The execute method store the boolean 'true' in the corrsponding result option array entry (the value is false if the option is not present in the command line entered by the user).

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

[ Top ]

Method Detail

execute [line 58]

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 array of optional parameters

[ Top ]