eZ Components 1.1.2

Getting Started

Components

Archive (1.1)
Base (1.1.1)
Cache (1.1.2)
Configuration (1.0.4)
ConsoleTools (1.1.3)
Database (1.1.3)
DatabaseSchema (1.0.2)
Debug (1.0.1)
EventLog (1.0.2)
EventLogDatabaseTiein (1.0)
Execution (1.0.1)
File (1.0.1)
ImageAnalysis (1.0.1)
ImageConversion (1.1.2)
Mail (1.1.3)
PersistentObject (1.1)
PersistentObjectDatabaseSchemaTiein (1.0)
PhpGenerator (1.0.1)
SystemInformation (1.0.1)
Template (1.0)
Translation (1.1.1)
TranslationCacheTiein (1.1)
UserInput (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.

Parents

ezcBaseOptions
   |
   --ezcConsoleTableOptions

Properties

string	read/write	`$colPadding` Padding characters for side padding between data and lines.
mixed	read/write	`$colWidth` Either 'auto' for automatic selection of column widths, or an array of column widths like array( 10, 30, 10 ).
int	read/write	`$colWrap` Wrap style of text contained in strings. See ezcConsoleTable::WRAP_AUTO, ezcConsoleTable::WRAP_NONE and ezcConsoleTable::WRAP_CUT.
string	read/write	`$corner` Character to use for drawing line corners.
int	read/write	`$defaultAlign` Standard column alignment, applied to cells that have to explicit alignment assigned. See ezcConsoleTable::ALIGN_LEFT, ezcConsoleTable::ALIGN_RIGHT, ezcConsoleTable::ALIGN_CENTER and ezcConsoleTable::ALIGN_DEFAULT.
string	read/write	`$defaultBorderFormat` Standard border format, applied to rows that have 'default' as the border format.
string	read/write	`$defaultFormat` Standard column content format, applied to cells that have "default" as the content format.
string	read/write	`$lineHorizontal` Character to use for drawing horizontal lines.
string	read/write	`$lineVertical` Character to use for drawing vertical lines.
int	read/write	`$widthType` Type of the given table width (fixed or maximal value).

Inherited Member Variables

From ezcBaseOptions:

protected ezcBaseOptions::$properties

Method Summary

public void

__construct(
$options )

Construct a new options object.

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.

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

Class	Description
`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.

Last updated: Thu, 01 Nov 2007

eZ Components

User menu

Path