Path

ez components / documentation / api reference / 2006.2 / consoletools

eZ Components 2006.2

ConsoleTools: ezcConsoleProgressbarOptions

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

Class: ezcConsoleProgressbarOptions

Struct class to store the options of the ezcConsoleOutput class. [source]
This class stores the options for the ezcConsoleOutput class.

Parents

ezcBaseOptions
   |
   --ezcConsoleProgressbarOptions

Properties

string read/write  $actFormat
The format to display the actual value with.
string read/write  $barChar
The character to fill the bar with, during progress indication.
string read/write  $emptyChar
The character to pre-fill the bar, before indicating progress.
string read/write  $formatString
The format string to describe the complete progressbar.
string read/write  $fractionFormat
Format to display the fraction value.
string read/write  $maxFormat
The format to display the actual value with.
string read/write  $processChar
The character for the end of the progress area (the arrow!).
int read/write  $redrawFrequency
How often to redraw the progressbar (on every Xth call to advance()).
int read/write  $step
How many steps to advance the progressbar on each call to advance().
int read/write  $width
The width of the bar itself.

Inherited Member Variables

From ezcBaseOptions:
protected  ezcBaseOptions::$properties

Method Summary

public void __construct( [$options = array()] )
Construct a new options object.

Inherited Methods

From ezcBaseOptions :
public void ezcBaseOptions::__construct()
Construct a new options object.
public void ezcBaseOptions::merge()
Merge an array into the actual options object.
public bool ezcBaseOptions::offsetExists()
Returns if an option exists.
public mixed ezcBaseOptions::offsetGet()
Returns an option value.
public void ezcBaseOptions::offsetSet()
Set an option.
public void ezcBaseOptions::offsetUnset()
Unset an option.
public mixed ezcBaseOptions::__get()
Property get access.

Methods

__construct

void __construct( [ $options = array()] )
Construct a new options object.
Options are constructed from an option array by default. The constructor automatically passes the given options to the __set() method to set them in the class.

Parameters

Name Type Description
$options array(string=>mixed) The initial options to set.

Throws

ClassDescription
ezcBasePropertyNotFoundException If a the value for the property options is not an instance of
ezcBaseValueException If a the value for a property is out of range.

Redefinition of

Method Description
ezcBaseOptions::__construct() Construct a new options object.

Last updated: Thu, 01 Nov 2007