Path

ez components / documentation / api reference / 1.0.1 / consoletools

eZ Components 1.0.1

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.
The ezcConsoleProgressbarOptions class has the following properties:
  • barChar string, contains the character to fill the progress bar with when it grows.
  • emptyChar string, contains the character to fill the empty space in the progress bar with.
  • progressChar string, contains the character for the right most position of the progress bar's progress.
  • formatString string, contains the format for the complete progress bar.
  • width string, contains the width of the progress bar in characters.
  • fractionFormat string, contains an sprintf() format for the fraction display.

Member Variables

protected array $properties = array(
'barChar' => '+',
'emptyChar' => '-',
'formatString' => '%act% / %max% [%bar%] %fraction%%',
'fractionFormat' => '%01.2f',
'progressChar' => '>',
'redrawFrequency' => 1,
'step' => 1,
'width' => 78,
)
Property array defining all this class' properties

Method Summary

public ezcConsoleProgressbarOptions __construct( [$barChar = '+'], [$emptyChar = '-'], [$progressChar = '>'], [$formatString = '%act% / %max% [%bar%] %fraction%%'], [$width = 78], [$fractionFormat = '%01.2f'], [$redrawFrequency = 1], [$step = 1], $verbosityLevel, $autobreak, $useFormats )
Create a new ezcConsoleProgressbarOptions struct.
public mixed __get( $propertyName )
Property read access.
public bool __isset( $propertyName )
Property isset access.
public void __set( $propertyName, $val )
Property write access.

Methods

__construct

ezcConsoleProgressbarOptions __construct( [ $barChar = '+'], [ $emptyChar = '-'], [ $progressChar = '>'], [ $formatString = '%act% / %max% [%bar%] %fraction%%'], [ $width = 78], [ $fractionFormat = '%01.2f'], [ $redrawFrequency = 1], [ $step = 1], int $verbosityLevel, int $autobreak, bool $useFormats )
Create a new ezcConsoleProgressbarOptions struct.
Create a new ezcConsoleProgressbarOptions struct for use with ezcConsoleOutput.

Parameters

Name Type Description
$verbosityLevel int Verbosity of the output to show.
$autobreak int Auto wrap lines after num chars (0 = unlimited)
$useFormats bool Whether to enable formated output
$barChar  
$emptyChar  
$progressChar  
$formatString  
$width  
$fractionFormat  
$redrawFrequency  
$step  

__get

mixed __get( string $propertyName )
Property read access.

Parameters

Name Type Description
$propertyName string Name of the property.

Throws

ClassDescription
ezcBasePropertyNotFoundException if the the desired property is not found.

__isset

bool __isset( string $propertyName )
Property isset access.

Parameters

Name Type Description
$propertyName string Name of the property.

__set

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

Parameters

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

Throws

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

Last updated: Fri, 02 Nov 2007