Class: Console_CommandLine_Action_Password

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

Class Overview

Console_CommandLine_Action
   |
   --Console_CommandLine_Action_Password

Class that represent the Password action, a special action that allow the user to specify the password on the commandline or to be prompted for entering it.

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 44]
Class that represent the Password action, a special action that allow the user to specify the password on the commandline or to be prompted for entering it.

Author: David JEAN LOUIS <izimobil@gmail.com>
Version: Release: 1.2.0
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 56]

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 option value
array	`$params`	—	An array of optional parameters

[ Top ]