ConsoleTools: ezcConsoleStatusbar
[ ]
[ ]
[ ]
[ ]
[ ]
Class: ezcConsoleStatusbar
|
Creating and maintaining status-bars to be printed to the console. [
source]
1. // Construction
2. $status = new ezcConsoleStatusbar( new ezcConsoleOutput() );
3.
4. // Set option
5. $status->options['successChar'] = '*';
6.
7. // Run statusbar
8. foreach ( $files as $file )
9. {
10. $res = $file->upload();
11. // Add status if form of bool true/false to statusbar.
12. $status->add( $res ); // $res is true or false
13. }
14.
15. // Retreive and display final statusbar results
16. $msg = $status->getSuccess() . ' succeeded, ' . $status->getFailure() . ' failed.';
17. $out->outputText( "Finished uploading files: $msg\n" );
Properties
Member Variables
|
protected array(bool=>int) |
$counter
= array(
true => 0,
false => 0,
)
Counter for success and failure outputs. |
|
protected ezcConsoleOutput |
$outputHandler
The ezcConsoleOutput object to use. |
|
protected array(string=>mixed) |
$properties
Container to hold the properties |
Method Summary
|
public ezcConsoleStatusbar |
__construct(
$outHandler, [$options = array()] )
Creates a new status bar. |
|
public void |
add(
$status )
Add a status to the status bar. |
|
public int |
getFailureCount(
)
Returns number of failures during the run. |
|
public ezcConsoleStatusbarOptions |
getOptions(
)
Returns the current options. |
|
public int |
getSuccessCount(
)
Returns number of successes during the run. |
|
public void |
reset(
)
Reset the state of the status-bar object to its initial one. |
|
public void |
setOptions(
$options )
Set new options. |
Methods
__construct
ezcConsoleStatusbar __construct(
ezcConsoleOutput
$outHandler, [
$options = array()] )
Creates a new status bar.
Parameters
| Name |
Type |
Description |
$outHandler |
ezcConsoleOutput |
Handler to utilize for output |
$options |
array(string=>string) |
Options |
See also:
ezcConsoleStatusbar::$options.
add
void add(
bool
$status )
Add a status to the status bar.
Adds a new status to the bar which is printed immediately. If the cursor is currently not at the beginning of a line, it will move to the next line.
Parameters
| Name |
Type |
Description |
$status |
bool |
Print successChar on true, failureChar on false. |
getFailureCount
int getFailureCount(
)
Returns number of failures during the run.
Returns the number of failure characters printed from this status bar.
getOptions
Returns the current options.
Returns the options currently set for this progressbar.
getSuccessCount
int getSuccessCount(
)
Returns number of successes during the run.
Returns the number of success characters printed from this status bar.
reset
void reset(
)
Reset the state of the status-bar object to its initial one.
setOptions
Set new options.
This method allows you to change the options of a statusbar.
Parameters
Throws
| Class | Description |
|---|
ezcBaseSettingNotFoundException |
If you tried to set a non-existent option value. |
ezcBaseSettingValueException |
If the value is not valid for the desired option. |
ezcBaseValueException |
If you submit neither an array nor an instance of ezcConsoleOutputOptions. |
Last updated: Thu, 01 Nov 2007
