Zend_Text_Table_Row Class Reference

Public Member Functions
	createColumn ($content, array $options=null)
	appendColumn (Zend_Text_Table_Column $column)
	getColumn ($index)
	getColumns ()
	getColumnWidths ()
	render (array $columnWidths, Zend_Text_Table_Decorator_Interface $decorator, $padding=0)

Protected Attributes
	$_columns = array()
	$_columnWidths = null

Detailed Description

Definition at line 30 of file Row.php.

Member Function Documentation

appendColumn()

appendColumn

(

Zend_Text_Table_Column

$column

)

Append a column to the row

Parameters

Zend_Text_Table_Column

$column

The column to append to the row

Returns

Zend_Text_Table_Row

Definition at line 78 of file Row.php.

    {
        $this->_columns[] = $column;

        return $this;
    }

createColumn()

createColumn	(		$content,
		array	$options = null
	)

Create a new column and append it to the row

Parameters

string	$content
array	$options

Returns

Zend_Text_Table_Row

Definition at line 53 of file Row.php.

    {
        $align    = null;
        $colSpan  = null;
        $encoding = null;

        if ($options !== null) {
            extract($options, EXTR_IF_EXISTS);
        }

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

        $column = new Zend_Text_Table_Column($content, $align, $colSpan, $encoding);

        $this->appendColumn($column);

        return $this;
    }

getColumn()

getColumn

(

$index

)

Get a column by it's index

Returns null, when the index is out of range

Parameters

integer

$index

Returns

Zend_Text_Table_Column|null

Definition at line 93 of file Row.php.

    {
        if (!isset($this->_columns[$index])) {
            return null;
        }

        return $this->_columns[$index];
    }

getColumns()

getColumns

(

)

Get all columns of the row

Returns

array

Definition at line 107 of file Row.php.

    {
        return $this->_columns;
    }

getColumnWidths()

getColumnWidths

(

)

Get the widths of all columns, which were rendered last

Exceptions

Zend_Text_Table_Exception

When no columns were rendered yet

Returns

integer

Definition at line 118 of file Row.php.

    {
        if ($this->_columnWidths === null) {
            #require_once 'Zend/Text/Table/Exception.php';
            throw new Zend_Text_Table_Exception('No columns were rendered yet');
        }

        return $this->_columnWidths;
    }

render()

render	(	array	$columnWidths,
		Zend_Text_Table_Decorator_Interface	$decorator,
			$padding = 0
	)

Render the row

Parameters

array	$columnWidths	Width of all columns
Zend_Text_Table_Decorator_Interface	$decorator	Decorator for the row borders
integer	$padding	Padding for the columns

Exceptions

Zend_Text_Table_Exception

When there are too many columns

Returns

string

Definition at line 137 of file Row.php.

    {
        // Prepare an array to store all column widths
        $this->_columnWidths = array();

        // If there is no single column, create a column which spans over the
        // entire row
        if (count($this->_columns) === 0) {
            #require_once 'Zend/Text/Table/Column.php';
            $this->appendColumn(new Zend_Text_Table_Column(null, null, count($columnWidths)));
        }

        // First we have to render all columns, to get the maximum height
        $renderedColumns = array();
        $maxHeight       = 0;
        $colNum          = 0;
        foreach ($this->_columns as $column) {
            // Get the colspan of the column
            $colSpan = $column->getColSpan();

            // Verify if there are enough column widths defined
            if (($colNum + $colSpan) > count($columnWidths)) {
                #require_once 'Zend/Text/Table/Exception.php';
                throw new Zend_Text_Table_Exception('Too many columns');
            }

            // Calculate the column width
            $columnWidth = ($colSpan - 1 + array_sum(array_slice($columnWidths,
                                                                 $colNum,
                                                                 $colSpan)));

            // Render the column and split it's lines into an array
            $result = explode("\n", $column->render($columnWidth, $padding));

            // Store the width of the rendered column
            $this->_columnWidths[] = $columnWidth;

            // Store the rendered column and calculate the new max height
            $renderedColumns[] = $result;
            $maxHeight         = max($maxHeight, count($result));

            // Set up the internal column number
            $colNum += $colSpan;
        }

        // If the row doesnt contain enough columns to fill the entire row, fill
        // it with an empty column
        if ($colNum < count($columnWidths)) {
            $remainingWidth = (count($columnWidths) - $colNum - 1) +
                               array_sum(array_slice($columnWidths,
                                                     $colNum));
            $renderedColumns[] = array(str_repeat(' ', $remainingWidth));

            $this->_columnWidths[] = $remainingWidth;
        }

        // Add each single column line to the result
        $result = '';
        for ($line = 0; $line < $maxHeight; $line++) {
            $result .= $decorator->getVertical();

            foreach ($renderedColumns as $index => $renderedColumn) {
                if (isset($renderedColumn[$line]) === true) {
                    $result .= $renderedColumn[$line];
                } else {
                    $result .= str_repeat(' ', $this->_columnWidths[$index]);
                }

                $result .= $decorator->getVertical();
            }

            $result .= "\n";
        }

        return $result;
    }

Field Documentation

$_columns

$_columns = array()

protected

Definition at line 37 of file Row.php.

$_columnWidths

$_columnWidths = null

protected

Definition at line 44 of file Row.php.

---

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

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