Creating and maintaining status-bars to be printed to the console.
Source for this file: /ConsoleTools/src/statusbar.php
Version: | //autogen// |
ezcConsoleStatusbarOptions | read/write |
$options
Contains the options for this class. |
protected array(bool=>int) |
$counter
= array(
Counter for success and failure outputs. |
protected ezcConsoleOutput |
$outputHandler
The ezcConsoleOutput object to use. |
protected array(string=>mixed) |
$properties
Container to hold the properties |
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. |
Creates a new status bar.
Name | Type | Description |
---|---|---|
$outHandler |
ezcConsoleOutput | Handler to utilize for output |
$options |
array(string=>string) | Options |
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.
Name | Type | Description |
---|---|---|
$status |
bool | Print successChar on true, failureChar on false. |
Returns number of failures during the run.
Returns the number of failure characters printed from this status bar.
Returns the current options.
Returns the options currently set for this progressbar.
Returns number of successes during the run.
Returns the number of success characters printed from this status bar.
Reset the state of the status-bar object to its initial one.
Set new options.
This method allows you to change the options of a statusbar.
Name | Type | Description |
---|---|---|
$options |
array(string=>string)|ezcConsoleOutputOptions | The options to set. |
Type | 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. |