Path

ez components / documentation / api reference / 1.1 / consoletools


eZ Components 1.1

ConsoleTools: ezcConsoleTableOptions

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

Class: ezcConsoleTableOptions

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

Parents

ezcBaseOptions
   |
   --ezcConsoleTableOptions

Member Variables

protected string $colPadding = " "
Padding characters for side padding between data and lines.
protected mixed $colWidth = "auto"
Column width: Either an array of column widths like:
protected int $colWrap = ezcConsoleTable::WRAP_AUTO
Wrap style of text contained in strings.
protected string $corner = "+"
Character to use for drawing line corners.
protected int $defaultAlign = ezcConsoleTable::ALIGN_LEFT
Standard column alignment, applied to cells that have to explicit alignment assigned.
protected string $defaultBorderFormat = "default"
Standard border format, applied to rows that have 'default' as the border format.
protected string $defaultFormat = "default"
Standard column content format, applied to cells that have "default" as the content format.
protected string $lineHorizontal = "|"
Character to use for drawing horizontal lines.
protected string $lineVertical = "-"
Character to use for drawing vertical lines.
protected int $widthType = ezcConsoleTable::WIDTH_MAX
Type of the given table width (fixed or maximal value).

Method Summary

public void __construct( $options )
Construct a new options object.
public void __set( $propertyName, $val )
Property write access.

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

Methods

__construct

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

Parameters

Name Type Description
$options array(string=>mixed) The initial options to set.

Throws

ClassDescription
ezcBasePropertyNotFoundException If the value for the property options is not an instance of
ezcBaseValueException If the value for a property is out of range.

Redefinition of

Method Description
ezcBaseOptions::__construct() Construct a new options object.

__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.

Redefinition of

Method Description
ezcBaseOptions::__set()  

Last updated: Wed, 28 Nov 2007