eZ Components 1.1

Getting Started

Archive (1.1)
Base (1.1)
Cache (1.1)
Configuration (1.0.2)
ConsoleTools (1.1)
Database (1.1)
DatabaseSchema (1.0)
Debug (1.0)
EventLog (1.0.1)
EventLogDatabaseTiein (1.0)
Execution (1.0)
File (1.0)
ImageAnalysis (1.0.1)
ImageConversion (1.1)
Mail (1.1)
PersistentObject (1.1)
PersistentObjectDatabaseSchemaTiein (1.0)
PhpGenerator (1.0)
SystemInformation (1.0)
Template (1.0)
Translation (1.1)
TranslationCacheTiein (1.1)
UserInput (1.0)

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

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

This class stores the options for the ezcConsoleOutput class.

ezcBaseOptions
   |
   --ezcConsoleProgressbarOptions

protected string	`$actFormat = '%.0f'` The format to display the actual value with.
protected string	`$barChar = "+"` The character to fill the bar with, during progress indication.
protected string	`$emptyChar = "-"` The character to pre-fill the bar, before indicating progress.
protected string	`$formatString = "%act% / %max% [%bar%] %fraction%%"` The format string to describe the complete progressbar.
protected string	`$fractionFormat = "%01.2f"` Format to display the fraction value.
protected string	`$maxFormat = '%.0f'` The format to display the actual value with.
protected string	`$progressChar = ">"` The character for the end of the progress area (the arrow!).
protected int	`$redrawFrequency = 1` How often to redraw the progressbar (on every Xth call to advance()).
protected int	`$step = 1` How many steps to advance the progressbar on each call to advance().
protected int	`$width = 78` The width of the bar itself.

public void

__set(
$key, $value )

Option write access.

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.
public abstract void	`ezcBaseOptions::__set()`

void __set( string $key, mixed $value )

Option write access.

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

Class	Description
`ezcBasePropertyNotFoundException`	If a desired property could not be found.
`ezcBaseSettingValueException`	If a desired property value is out of range.

Method	Description
`ezcBaseOptions::__set()`

Last updated: Wed, 28 Nov 2007