Path

ez components / documentation / api reference / 1.1.1 / consoletools

eZ Components 1.1.1

ConsoleTools: ezcConsoleProgressMonitorOptions

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

Class: ezcConsoleProgressMonitorOptions

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

Parents

ezcBaseOptions
   |
   --ezcConsoleProgressMonitorOptions

Properties

string read/write  $formatString
The format string to describe the complete progress monitor.

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