Text/Table/Column.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Text_Table
- version
- $Id: Column.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Text_Table_Column
Description
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.
Zend_Text_Table_Column
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Text_Table
- Constants
- ALIGN_LEFT
- ALIGN_CENTER
- ALIGN_RIGHT
- Properties
- $_content
- $_align
- $_colSpan
- $_allowedAligns
- Methods
- __construct
- setContent
- setAlign
- setColSpan
- getColSpan
- render
Description
Column class for Zend_Text_Table_Row
Constants
ALIGN_LEFT
ALIGN_LEFT = 'left'
Aligns for columns
Details
- value
- left
ALIGN_CENTER
ALIGN_CENTER = 'center'
Details
- value
- center
ALIGN_RIGHT
ALIGN_RIGHT = 'right'
Details
- value
- right
Properties
$_align
string $_align = 'self'Align of the column
Details
- $_align
- string
- visibility
- protected
- default
- self
- final
- false
- static
- false
$_allowedAligns
array $_allowedAligns = 'array'Allowed align parameters
Details
- $_allowedAligns
- array
- visibility
- protected
- default
- array
- final
- false
- static
- false
$_colSpan
integer $_colSpan = '1'Colspan of the column
Details
- $_colSpan
- integer
- visibility
- protected
- default
- 1
- final
- false
- static
- false
$_content
string $_content = ''Content of the column
Details
- $_content
- string
- visibility
- protected
- default
- final
- false
- static
- false
Methods
__construct
__construct(
string $content
=
null, string $align
=
null, integer $colSpan
=
null, string $charset
=
null
)
:
Create a column for a Zend_Text_Table_Row object.
Arguments
- $content
- string
The content of the column - $align
- string
The align of the content - $colSpan
- integer
The colspan of the column - $charset
- string
The encoding of the content
Details
- visibility
- public
- final
- false
- static
- false
getColSpan
getColSpan(
)
:
integerGet the colspan
Output
- integer
Details
- visibility
- public
- final
- false
- static
- false
render
render(
integer $columnWidth, integer $padding
=
0
)
:
stringRender the column width the given column width
Arguments
- $columnWidth
- integer
The width of the column - $padding
- integer
The padding for the column
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
- throws
- When $columnWidth is lower than 1
- throws
- When padding is greater than columnWidth
setAlign
setAlign(
string $align
)
:
Zend_Text_Table_ColumnSet the align
Arguments
- $align
- string
Align of the column
Output
Details
- visibility
- public
- final
- false
- static
- false
- throws
- When supplied align is invalid
setColSpan
setColSpan(
int $colSpan
)
:
Zend_Text_Table_ColumnSet the colspan
Arguments
- $colSpan
- int
Output
Details
- visibility
- public
- final
- false
- static
- false
- throws
- When $colSpan is smaller than 1
setContent
setContent(
string $content, string $charset
=
null
)
:
Zend_Text_Table_ColumnSet the content.
If $charset is not defined, it is assumed that $content is encoded in the charset defined via Zend_Text_Table::setInputCharset() (defaults to utf-8).
Arguments
- $content
- string
Content of the column - $charset
- string
The charset of the content
Output
Details
- visibility
- public
- final
- false
- static
- false
- throws
- When $content is not a string