Text/Table.php

Show:

inherited

Classes
- \Zend_Text_Table

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Text_Table
Version: $Id: Table.php 25024 2012-07-30 15:08:15Z rob $

\Zend_Text_Table
jump to top

Package: Zend\Text\Table

Zend_Text_Table enables developers to create tables out of characters

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                AUTO_SEPARATE_NONE
                = 0

Auto seperator settings

 
                AUTO_SEPARATE_HEADER
                = 1

 
                AUTO_SEPARATE_FOOTER
                = 2

 
                AUTO_SEPARATE_ALL
                = 4

Properties

integer $_autoSeparate = self::AUTO_SEPARATE_ALL

Auto separation mode

Default valueself::AUTO_SEPARATE_ALLDetails

Type: integer

array $_columnWidths = null

List of all column widths

Default valuenullDetails

Type: array

\Zend_Text_Table_Decorator_Interface $_decorator = null

Decorator used for the table borders

Default valuenullDetails

Type: \Zend_Text_Table_Decorator_Interface

array $_defaultColumnAligns = array()

Default column aligns for rows created by appendRow(array $data)

Default valuearray()Details

Type: array

string $_inputCharset = 'utf-8'

static

Charset which is used for input by default

Default value'utf-8'Details

Type: string

string $_outputCharset = 'utf-8'

static

Charset which is used internally

Default value'utf-8'Details

Type: string

integer $_padding = 0

Padding for columns

Default value0Details

Type: integer

string $_pluginLoader = null

Plugin loader for decorators

Default valuenullDetails

Type: string

array $_rows = array()

Rows of the table

Default valuearray()Details

Type: array

array $_skipOptions = array('options', 'config', 'defaultColumnAlign')

Option keys to skip when calling setOptions()

Default valuearray('options', 'config', 'defaultColumnAlign')Details

Type: array

Methods

__construct(\Zend_Config | array $options = null) : void

Create a basic table object

Parameters

Name	Type	Description
$options	\Zend_Config \| array	Configuration options

Throws

Exception	Description
\Zend_Text_Table_Exception	When no columns widths were set

__toString() : string

Magic method which returns the rendered table

Returns

Type	Description
string

appendRow(array | \Zend_Text_Table_Row $row) : \Zend_Text_Table

Append a row to the table

Parameters

Name	Type	Description
$row	array \| \Zend_Text_Table_Row	The row to append to the table

Returns

Type	Description
\Zend_Text_Table

Throws

Exception	Description
\Zend_Text_Table_Exception	When $row is neither an array nor Zend_Zext_Table_Row
\Zend_Text_Table_Exception	When a row contains too many columns

getInputCharset() : void

static

Get the input charset for column contents

getOutputCharset() : void

static

Get the output charset for column contents

getPluginLoader() : \Zend_Loader_PluginLoader

Get the plugin loader for decorators

Returns

Type	Description
\Zend_Loader_PluginLoader

render() : string

Render the table

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Text_Table_Exception	When no rows were added to the table

setAutoSeparate(integer $autoSeparate) : \Zend_Text_Table

Set auto separation mode

Parameters

Name	Type	Description
$autoSeparate	integer	Auto separation mode

Returns

Type	Description
\Zend_Text_Table

setColumnWidths(array $columnWidths) : \Zend_Text_Table

Set column widths

Parameters

Name	Type	Description
$columnWidths	array	Widths of all columns

Returns

Type	Description
\Zend_Text_Table

Throws

Exception	Description
\Zend_Text_Table_Exception	When no columns were supplied
\Zend_Text_Table_Exception	When a column has an invalid width

setConfig(\Zend_Config $config) : \Zend_Text_Table

Set options from config object

Parameters

Name	Type	Description
$config	\Zend_Config	Configuration for Zend_Text_Table

Returns

Type	Description
\Zend_Text_Table

setDecorator(\Zend_Text_Table_Decorator_Interface | string $decorator) : \Zend_Text_Table

Set decorator

Parameters

Name	Type	Description
$decorator	\Zend_Text_Table_Decorator_Interface \| string	Decorator to use

Returns

Type	Description
\Zend_Text_Table

setDefaultColumnAlign(integer $columnNum, string $align) : \Zend_Text_Table

Set default column align for rows created by appendRow(array $data)

Parameters

Name	Type	Description
$columnNum	integer
$align	string

Returns

Type	Description
\Zend_Text_Table

setInputCharset(string $charset) : void

static

Set the input charset for column contents

Parameters

Name	Type	Description
$charset	string

setOptions(array $options) : \Zend_Text_Table

Set options from array

Parameters

Name	Type	Description
$options	array	Configuration for Zend_Text_Table

Returns

Type	Description
\Zend_Text_Table

setOutputCharset(string $charset) : void

static

Set the output charset for column contents

Parameters

Name	Type	Description
$charset	string

setPadding(integer $padding) : \Zend_Text_Table

Set the column padding

Parameters

Name	Type	Description
$padding	integer	The padding for the columns

Returns

Type	Description
\Zend_Text_Table

Text/Table.php

\Zend_Text_Tablejump to top

Constants

Properties

Methods

\Zend_Text_Table
jump to top