Path

ez components / documentation / api reference / 2008.2.1 / consoletools

eZ Components 2008.2.1

ConsoleTools: ezcConsoleOutputOptions

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

Class: ezcConsoleOutputOptions

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

Parents

ezcBaseOptions
   |
   --ezcConsoleOutputOptions

Properties

int read/write  $autobreak
Determines, whether text is automatically wrapped after a specific amount of characters in a line. If set to 0 (default), lines will not be wrapped automatically.
bool read/write  $useFormats
Whether to use formatting or not.
int read/write  $verbosityLevel
Determines the level of verbosity.

Inherited Member Variables

From ezcBaseOptions:
protected  ezcBaseOptions::$properties

Method Summary

public void __construct( $options )
Construct a new options object.

Inherited Methods

From ezcBaseOptions :
public ezcBaseOptions 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.

Methods

__construct

void __construct( array(string=>mixed) $options )
Construct a new options object.
NOTE: For BC reasons the old method of instanciating this class is kept, but the usage of the new version is highly encouraged.

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: Mon, 09 Feb 2009