Path

ez components / documentation / api reference / 1.0.1 / consoletools

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

Member Variables

protected string $colPadding = ' '
Padding characters for side padding between data and lines.
protected mixed $colWidth = 'auto'
Column width, either a fixed int value (number of chars) or 'auto'.
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 hozizontal 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 ezcConsoleTableOptions __construct( [$colWidth = 'auto'], [$colWrap = ezcConsoleTable::WRAP_AUTO], [$defaultAlign = ezcConsoleTable::ALIGN_LEFT], [$colPadding = ' '], [$widthType = ezcConsoleTable::WIDTH_MAX], [$lineVertical = '-'], [$lineHorizontal = '|'], [$corner = '+'], [$defaultFormat = 'default'], [$defaultBorderFormat = 'default'] )
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

ezcConsoleTableOptions __construct( [ $colWidth = 'auto'], [ $colWrap = ezcConsoleTable::WRAP_AUTO], [ $defaultAlign = ezcConsoleTable::ALIGN_LEFT], [ $colPadding = ' '], [ $widthType = ezcConsoleTable::WIDTH_MAX], [ $lineVertical = '-'], [ $lineHorizontal = '|'], [ $corner = '+'], [ $defaultFormat = 'default'], [ $defaultBorderFormat = 'default'] )
Create a new ezcConsoleProgressbarOptions struct.
Create a new ezcConsoleProgressbarOptions struct for use with ezcConsoleOutput.

Parameters

Name Type Description
$colWidth  
$colWrap  
$defaultAlign  
$colPadding  
$widthType  
$lineVertical  
$lineHorizontal  
$corner  
$defaultFormat  
$defaultBorderFormat  

__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