Path

ez components / documentation / api reference / 1.1 / consoletools

eZ Components 1.1

ConsoleTools: ezcConsoleStatusbar

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

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" );

Member Variables

protected array(bool=>int) $counter = array(
true => 0,
false => 0,
)
Counter for success and failure outputs.
protected ezcConsoleStatusbarOptions $options
Options
protected ezcConsoleOutput $outputHandler
The ezcConsoleOutput object to use.

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.
public mixed __get( $key )
Property read access.
public bool __isset( $key )
Property isset access.
public void __set( $key, $val )
Property write access.

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

ezcConsoleStatusbarOptions 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

void setOptions( array(string=>string)|ezcConsoleOutputOptions $options )
Set new options.
This method allows you to change the options of a statusbar.

Parameters

Name Type Description
$options array(string=>string)|ezcConsoleOutputOptions The options to set.

Throws

ClassDescription
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.

__get

mixed __get( string $key )
Property read access.

Parameters

Name Type Description
$key string Name of the property.

Throws

ClassDescription
ezcBasePropertyNotFoundException If the the desired property is not found.

__isset

bool __isset( string $key )
Property isset access.

Parameters

Name Type Description
$key string Name of the property.

__set

void __set( string $key, mixed $val )
Property write access.

Parameters

Name Type Description
$key string Name of the property.
$val mixed The value for the property.

Throws

ClassDescription
ezcBasePropertyNotFoundException If a desired property could not be found.
ezcBaseValueException If a desired property value is out of range.

Last updated: Wed, 28 Nov 2007