Zend_Text_Table Class Reference

Public Member Functions
	__construct ($options=null)
	setOptions (array $options)
	setConfig (Zend_Config $config)
	setColumnWidths (array $columnWidths)
	setAutoSeparate ($autoSeparate)
	setDecorator ($decorator)
	setPadding ($padding)
	getPluginLoader ()
	setDefaultColumnAlign ($columnNum, $align)
	appendRow ($row)
	render ()
	__toString ()

Static Public Member Functions
static	setInputCharset ($charset)
static	getInputCharset ()
static	setOutputCharset ($charset)
static	getOutputCharset ()

Data Fields
const	AUTO_SEPARATE_NONE = 0x0
const	AUTO_SEPARATE_HEADER = 0x1
const	AUTO_SEPARATE_FOOTER = 0x2
const	AUTO_SEPARATE_ALL = 0x4

Protected Attributes
	$_decorator = null
	$_columnWidths = null
	$_rows = array()
	$_autoSeparate = self::AUTO_SEPARATE_ALL
	$_padding = 0
	$_defaultColumnAligns = array()
	$_pluginLoader = null
	$_skipOptions

Static Protected Attributes
static	$_inputCharset = 'utf-8'
static	$_outputCharset = 'utf-8'

Detailed Description

Definition at line 30 of file Table.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Create a basic table object

Parameters

array	$columnsWidths	List of all column widths
Zend_Config | array	$options	Configuration options

Exceptions

Zend_Text_Table_Exception

When no columns widths were set

Definition at line 121 of file Table.php.

    {
        // Set options
        if (is_array($options)) {
            $this->setOptions($options);
        } else if ($options instanceof Zend_Config) {
            $this->setConfig($options);
        }

        // Check if column widths were set
        // @todo When column widths were not set, assume auto-sizing
        if ($this->_columnWidths === null) {
            #require_once 'Zend/Text/Table/Exception.php';
            throw new Zend_Text_Table_Exception('You must define the column widths');
        }

        // If no decorator was given, use default unicode decorator
        if ($this->_decorator === null) {
            if (self::getOutputCharset() === 'utf-8') {
                $this->setDecorator('unicode');
            } else {
                $this->setDecorator('ascii');
            }
        }
    }

Member Function Documentation

__toString()

__toString

(

)

Magic method which returns the rendered table

Returns

string

Definition at line 524 of file Table.php.

    {
        try {
            return $this->render();
        } catch (Exception $e) {
            trigger_error($e->getMessage(), E_USER_ERROR);
        }

    }

appendRow()

appendRow

(

$row

)

Append a row to the table

Parameters

array | Zend_Text_Table_Row

$row

The row to append to the table

Exceptions

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

Returns

Zend_Text_Table

Definition at line 330 of file Table.php.

    {
        if (!is_array($row) && !($row instanceof Zend_Text_Table_Row)) {
            #require_once 'Zend/Text/Table/Exception.php';
            throw new Zend_Text_Table_Exception('$row must be an array or instance of Zend_Text_Table_Row');
        }

        if (is_array($row)) {
            if (count($row) > count($this->_columnWidths)) {
                #require_once 'Zend/Text/Table/Exception.php';
                throw new Zend_Text_Table_Exception('Row contains too many columns');
            }

            #require_once 'Zend/Text/Table/Row.php';
            #require_once 'Zend/Text/Table/Column.php';

            $data   = $row;
            $row    = new Zend_Text_Table_Row();
            $colNum = 0;
            foreach ($data as $columnData) {
                if (isset($this->_defaultColumnAligns[$colNum])) {
                    $align = $this->_defaultColumnAligns[$colNum];
                } else {
                    $align = null;
                }

                $row->appendColumn(new Zend_Text_Table_Column($columnData, $align));
                $colNum++;
            }
        }

        $this->_rows[] = $row;

        return $this;
    }

getInputCharset()

static getInputCharset ( )

static

Get the input charset for column contents

Parameters

string

$charset

Definition at line 297 of file Table.php.

    {
        return self::$_inputCharset;
    }

getOutputCharset()

static getOutputCharset ( )

static

Get the output charset for column contents

Parameters

string

$charset

Definition at line 317 of file Table.php.

    {
        return self::$_outputCharset;
    }

getPluginLoader()

getPluginLoader

(

)

Get the plugin loader for decorators

Returns

Zend_Loader_PluginLoader

Definition at line 255 of file Table.php.

    {
        if ($this->_pluginLoader === null) {
            $prefix     = 'Zend_Text_Table_Decorator_';
            $pathPrefix = 'Zend/Text/Table/Decorator/';

            #require_once 'Zend/Loader/PluginLoader.php';
            $this->_pluginLoader = new Zend_Loader_PluginLoader(array($prefix => $pathPrefix));
        }

        return $this->_pluginLoader;
    }

render()

render

(

)

Render the table

Exceptions

Zend_Text_Table_Exception

When no rows were added to the table

Returns

string

Definition at line 372 of file Table.php.

    {
        // There should be at least one row
        if (count($this->_rows) === 0) {
            #require_once 'Zend/Text/Table/Exception.php';
            throw new Zend_Text_Table_Exception('No rows were added to the table yet');
        }

        // Initiate the result variable
        $result = '';

        // Count total columns
        $totalNumColumns = count($this->_columnWidths);

        // Now render all rows, starting from the first one
        $numRows = count($this->_rows);
        foreach ($this->_rows as $rowNum => $row) {
            // Get all column widths
            if (isset($columnWidths) === true) {
                $lastColumnWidths = $columnWidths;
            }

            $renderedRow  = $row->render($this->_columnWidths, $this->_decorator, $this->_padding);
            $columnWidths = $row->getColumnWidths();
            $numColumns   = count($columnWidths);

            // Check what we have to draw
            if ($rowNum === 0) {
                // If this is the first row, draw the table top
                $result .= $this->_decorator->getTopLeft();

                foreach ($columnWidths as $columnNum => $columnWidth) {
                    $result .= str_repeat($this->_decorator->getHorizontal(),
                                          $columnWidth);

                    if (($columnNum + 1) === $numColumns) {
                        $result .= $this->_decorator->getTopRight();
                    } else {
                        $result .= $this->_decorator->getHorizontalDown();
                    }
                }

                $result .= "\n";
            } else {
                // Else check if we have to draw the row separator
                if ($this->_autoSeparate & self::AUTO_SEPARATE_ALL) {
                    $drawSeparator = true;
                } else if ($rowNum === 1 && $this->_autoSeparate & self::AUTO_SEPARATE_HEADER) {
                    $drawSeparator = true;
                } else if ($rowNum === ($numRows - 1) && $this->_autoSeparate & self::AUTO_SEPARATE_FOOTER) {
                    $drawSeparator = true;
                } else {
                    $drawSeparator = false;
                }

                if ($drawSeparator) {
                    $result .= $this->_decorator->getVerticalRight();

                    $currentUpperColumn = 0;
                    $currentLowerColumn = 0;
                    $currentUpperWidth  = 0;
                    $currentLowerWidth  = 0;

                    // Loop through all column widths
                    foreach ($this->_columnWidths as $columnNum => $columnWidth) {
                        // Add the horizontal line
                        $result .= str_repeat($this->_decorator->getHorizontal(),
                                              $columnWidth);

                        // If this is the last line, break out
                        if (($columnNum + 1) === $totalNumColumns) {
                            break;
                        }

                        // Else check, which connector style has to be used
                        $connector          = 0x0;
                        $currentUpperWidth += $columnWidth;
                        $currentLowerWidth += $columnWidth;

                        if ($lastColumnWidths[$currentUpperColumn] === $currentUpperWidth) {
                            $connector          |= 0x1;
                            $currentUpperColumn += 1;
                            $currentUpperWidth   = 0;
                        } else {
                            $currentUpperWidth += 1;
                        }

                        if ($columnWidths[$currentLowerColumn] === $currentLowerWidth) {
                            $connector          |= 0x2;
                            $currentLowerColumn += 1;
                            $currentLowerWidth   = 0;
                        } else {
                            $currentLowerWidth += 1;
                        }

                        switch ($connector) {
                            case 0x0:
                                $result .= $this->_decorator->getHorizontal();
                                break;

                            case 0x1:
                                $result .= $this->_decorator->getHorizontalUp();
                                break;

                            case 0x2:
                                $result .= $this->_decorator->getHorizontalDown();
                                break;

                            case 0x3:
                                $result .= $this->_decorator->getCross();
                                break;

                            default:
                                // This can never happen, but the CS tells I have to have it ...
                                break;
                        }
                    }

                    $result .= $this->_decorator->getVerticalLeft() . "\n";
                }
            }

            // Add the rendered row to the result
            $result .= $renderedRow;

            // If this is the last row, draw the table bottom
            if (($rowNum + 1) === $numRows) {
                $result .= $this->_decorator->getBottomLeft();

                foreach ($columnWidths as $columnNum => $columnWidth) {
                    $result .= str_repeat($this->_decorator->getHorizontal(),
                                          $columnWidth);

                    if (($columnNum + 1) === $numColumns) {
                        $result .= $this->_decorator->getBottomRight();
                    } else {
                        $result .= $this->_decorator->getHorizontalUp();
                    }
                }

                $result .= "\n";
            }
        }

        return $result;
    }

setAutoSeparate()

setAutoSeparate

(

$autoSeparate

)

Set auto separation mode

Parameters

integer

$autoSeparate

Auto separation mode

Returns

Zend_Text_Table

Definition at line 214 of file Table.php.

    {
        $this->_autoSeparate = (int) $autoSeparate;
        return $this;
    }

setColumnWidths()

setColumnWidths

(

array

$columnWidths

)

Set column widths

Parameters

array

$columnWidths

Widths of all columns

Exceptions

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

Returns

Zend_Text_Table

Definition at line 188 of file Table.php.

    {
        if (count($columnWidths) === 0) {
            #require_once 'Zend/Text/Table/Exception.php';
            throw new Zend_Text_Table_Exception('You must supply at least one column');
        }

        foreach ($columnWidths as $columnNum => $columnWidth) {
            if (is_int($columnWidth) === false or $columnWidth < 1) {
                #require_once 'Zend/Text/Table/Exception.php';
                throw new Zend_Text_Table_Exception('Column ' . $columnNum . ' has an invalid'
                                                    . ' column width');
            }
        }

        $this->_columnWidths = $columnWidths;

        return $this;
    }

setConfig()

setConfig

(

Zend_Config

$config

)

Set options from config object

Parameters

Zend_Config

$config

Configuration for Zend_Text_Table

Returns

Zend_Text_Table

Definition at line 175 of file Table.php.

    {
        return $this->setOptions($config->toArray());
    }

setDecorator()

setDecorator

(

$decorator

)

Set decorator

Parameters

Zend_Text_Table_Decorator_Interface | string

$decorator

Decorator to use

Returns

Zend_Text_Table

Definition at line 226 of file Table.php.

    {
        if ($decorator instanceof Zend_Text_Table_Decorator_Interface) {
            $this->_decorator = $decorator;
        } else {
            $classname        = $this->getPluginLoader()->load($decorator);
            $this->_decorator = new $classname;
        }

        return $this;
    }

setDefaultColumnAlign()

setDefaultColumnAlign	(		$columnNum,
			$align
	)

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

Parameters

integer	$columnNum
string	$align

Returns

Zend_Text_Table

Definition at line 275 of file Table.php.

    {
        $this->_defaultColumnAligns[$columnNum] = $align;

        return $this;
    }

setInputCharset()

static setInputCharset (   $charset )

static

Set the input charset for column contents

Parameters

string

$charset

Definition at line 287 of file Table.php.

    {
        self::$_inputCharset = strtolower($charset);
    }

setOptions()

setOptions

(

array

$options

)

Set options from array

Parameters

array

$options

Configuration for Zend_Text_Table

Returns

Zend_Text_Table

Definition at line 153 of file Table.php.

    {
        foreach ($options as $key => $value) {
            if (in_array(strtolower($key), $this->_skipOptions)) {
                continue;
            }

            $method = 'set' . ucfirst($key);
            if (method_exists($this, $method)) {
                $this->$method($value);
            }
        }

        return $this;
    }

setOutputCharset()

static setOutputCharset (   $charset )

static

Set the output charset for column contents

Parameters

string

$charset

Definition at line 307 of file Table.php.

    {
        self::$_outputCharset = strtolower($charset);
    }

setPadding()

setPadding

(

$padding

)

Set the column padding

Parameters

integer

$padding

The padding for the columns

Returns

Zend_Text_Table

Definition at line 244 of file Table.php.

    {
        $this->_padding = max(0, (int) $padding);
        return $this;
    }

Field Documentation

$_autoSeparate

$_autoSeparate = self::AUTO_SEPARATE_ALL

protected

Definition at line 66 of file Table.php.

$_columnWidths

$_columnWidths = null

protected

Definition at line 52 of file Table.php.

$_decorator

$_decorator = null

protected

Definition at line 45 of file Table.php.

$_defaultColumnAligns

$_defaultColumnAligns = array()

protected

Definition at line 80 of file Table.php.

$_inputCharset

$_inputCharset = 'utf-8'

staticprotected

Definition at line 94 of file Table.php.

$_outputCharset

$_outputCharset = 'utf-8'

staticprotected

Definition at line 101 of file Table.php.

$_padding

$_padding = 0

protected

Definition at line 73 of file Table.php.

$_pluginLoader

$_pluginLoader = null

protected

Definition at line 87 of file Table.php.

$_rows

$_rows = array()

protected

Definition at line 59 of file Table.php.

$_skipOptions

$_skipOptions

protected

Initial value:

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

Definition at line 108 of file Table.php.

AUTO_SEPARATE_ALL

const AUTO_SEPARATE_ALL = 0x4

Definition at line 38 of file Table.php.

AUTO_SEPARATE_FOOTER

const AUTO_SEPARATE_FOOTER = 0x2

Definition at line 37 of file Table.php.

AUTO_SEPARATE_HEADER

const AUTO_SEPARATE_HEADER = 0x1

Definition at line 36 of file Table.php.

AUTO_SEPARATE_NONE

const AUTO_SEPARATE_NONE = 0x0

Auto seperator settings

Definition at line 35 of file Table.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Text/Table.php