API Documentation

Text/Table/Row.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Text_Table  
version
$Id: Row.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Text_Table_Row

Row class for Zend_Text_Table

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Text_Table  

Properties

Propertyprotectedarray  $_columnWidths= 'null'

Temporary stored column widths

Default valuenullDetails
Type
array
Propertyprotectedarray  $_columns= 'array'

List of all columns

Default valuearrayDetails
Type
array

Methods

methodpublicappendColumn( \Zend_Text_Table_Column $column ) : \Zend_Text_Table_Row

Append a column to the row

Parameters
Name Type Description
$column \Zend_Text_Table_Column The column to append to the row
Returns
Type Description
\Zend_Text_Table_Row
methodpubliccreateColumn( string $content, array $options = null ) : \Zend_Text_Table_Row

Create a new column and append it to the row

Parameters
Name Type Description
$content string
$options array
Returns
Type Description
\Zend_Text_Table_Row
methodpublicgetColumn( integer $index ) : \Zend_Text_Table_Column|null

Get a column by it's index

Returns null, when the index is out of range

Parameters
Name Type Description
$index integer
Returns
Type Description
\Zend_Text_Table_Columnnull
methodpublicgetColumnWidths( ) : integer

Get the widths of all columns, which were rendered last

Returns
Type Description
integer
Throws
Exception Description
\Zend_Text_Table_Exception When no columns were rendered yet
methodpublicgetColumns( ) : array

Get all columns of the row

Returns
Type Description
array
methodpublicrender( array $columnWidths, \Zend_Text_Table_Decorator_Interface $decorator, integer $padding = 0 ) : string

Render the row

Parameters
Name Type Description
$columnWidths array Width of all columns
$decorator \Zend_Text_Table_Decorator_Interface Decorator for the row borders
$padding integer Padding for the columns
Returns
Type Description
string
Throws
Exception Description
\Zend_Text_Table_Exception When there are too many columns
Documentation was generated by DocBlox 0.13.3.