Path

ez components / documentation / api reference / 1.0.1 / consoletools


eZ Components 1.0.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.

Member Variables

protected int $autobreak = 0
Determins, 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.
protected bool $useFormats = true
Wether to use formatings or not.
protected int $verbosityLevel = 1
Determines the level of verbosity.

Method Summary

public void __construct( [$verbosityLevel = 1], [$autobreak = 0], [$useFormats = true] )
Create a new ezcConsoleOutputOptions 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

void __construct( [int $verbosityLevel = 1], [int $autobreak = 0], [bool $useFormats = true] )
Create a new ezcConsoleOutputOptions struct.
Create a new ezcConsoleOutputOptions 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

__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