Docs For Class atkTableRenderer

Child Class	Description
atkTableRendererGrouped	Renders table with row based groups. A grouped table is a table with some rows grouped together. They are visually folded and can be expanded by clicking.

[ Top ]

Property Summary

mixed	$m_cellalignment
mixed	$m_cellclass
mixed	$m_colalignment
mixed	$m_colclass
mixed	$m_defaultalignment
mixed	$m_defaultclass
mixed	$m_flags
mixed	$m_maxWidth
mixed	$m_rowalignment
mixed	$m_rowclass
mixed	$m_span
mixed	$m_style
mixed	$m_tableMatrix

[ Top ]

Method Summary

atkTableRenderer	atkTableRenderer()	Constructs a new table renderer
string	getAlignment()	Gets the alignment for a specific cell
String	getClass()	Determines the class to be set for a specific cell
bool\|string	getSpan()	Gets the spanning for a specific cell
void	registerStyle()	Registers a style with the page.
String	render()	Render a table.
void	setAlignment()	Set the alignment for a particular cell.
void	setClass()	Set the class for a particular cell.
void	setColAlignment()	Set the alignment for an entire column.
void	setColClass()	Set the class for an entire column.
void	setColSpan()	Set the colspan for a cel
void	setDefaultAlignment()	Set the default alignment for all cells in the table.
void	setDefaultClass()	Set the default class for all cells in the table.
void	setFlag()	Sets a flag on this object. Allowed: TBL_HEADER, TBL_FOOTER, TBL_ALTERNATE and TBL_DATA
void	setRowAlignment()	Set the alignment for an entire row.
void	setRowClass()	Set the class for an entire row.
void	setRowSpan()	Set the rowspan for a cel
void	setTableStyle()	Sets the table style class and registers it in the result page
string	_alignmentStr()	Gets the alignmentstring for an alignment flag
String	_classStr()	Constructs the html class attribute string using a classname
string	_getIdStr()	Gets the cell id string if available.
int	_getMaxCols()	Gets the maximum number of columns in a row
string	_getRowClassStr()	Gets the styleclass for a rownumber Supports alternating rowclasses if TBL_ALTERNATE is set
string	_getTableStyleStr()	Gets the table style attribute component
string	_renderBody()	Renders the body of the table. The body contains all rows except the header and footer rows. Surrounds the body with tbody tags.
string	_renderCell()	Renders one cell in the table.
string	_renderFillingCell()	Renders a filling cell used to display a correct two-dimensional table.
string	_renderFooter()	Renders one footer row.
string	_renderHeader()	Renders one header row.
string	_renderRow()	Renders one row in the table.
html	_renderTable()	Renders the table.
unknown	_renderValue()	Renders the value inside one cell.
void	_setSpan()	Sets spanning on a specifc column.
string	_spanStr()	Gets the span string for a cell

[ Top ]

Properties

mixed $m_cellalignment = array() [line 50]

[ Top ]

mixed $m_cellclass = array() [line 55]

[ Top ]

mixed $m_colalignment = array() [line 52]

[ Top ]

mixed $m_colclass = array() [line 57]

[ Top ]

mixed $m_defaultalignment = TBL_LEFT [line 54]

[ Top ]

mixed $m_defaultclass = "" [line 58]

[ Top ]

mixed $m_flags = 0 [line 60]

[ Top ]

mixed $m_maxWidth = 0 [line 59]

[ Top ]

mixed $m_rowalignment = array() [line 51]

[ Top ]

mixed $m_rowclass = array() [line 56]

[ Top ]

mixed $m_span = array() [line 53]

[ Top ]

mixed $m_style = '' [line 61]

[ Top ]

mixed $m_tableMatrix = null [line 62]

[ Top ]

Methods

Constructor atkTableRenderer [line 72]

atkTableRenderer atkTableRenderer(
[int
$flags = 0], [string
$style = ''], [string
$module = ''] 
)

Constructs a new table renderer

Parameters:

int	$flags:	flags to set (allowed: TBL_HEADER, TBL_FOOTER, TBL_ALTERNATE and TBL_DATA)
string	$style:	style class to set for the table
string	$module:	module to register style with

[ Top ]

getAlignment [line 672]

string getAlignment(
int
$row, int
$col 
)

Gets the alignment for a specific cell

Parameters:

int	$row:	row nuber
int	$col:	column number

API Tags:

Return:

aligment

Redefined in descendants as:

atkTableRendererGrouped::getAlignment() : Overloading extension of parent::getAlignment() Adds special rule for groupheaders.

[ Top ]

getClass [line 687]

String getClass(
Integer
$row, Integer
$col 
)

Determines the class to be set for a specific cell

Parameters:

Integer	$row:	Row number of the cell
Integer	$col:	Column number of the cell

API Tags:

Return:

Class string of the cell

[ Top ]

getSpan [line 702]

bool|string getSpan(
int
$row, int
$col 
)

Gets the spanning for a specific cell

Parameters:

int	$row:	row number of the cell
int	$col:	column number of the cell

API Tags:

Return:

spanning or false if nothing found for the cell

[ Top ]

registerStyle [line 235]

void registerStyle(
string
$style, [string
$module = ""] 
)

Registers a style with the page.

Parameters:

string	$style:	styleclass name
string	$module:	module to look for stylesheets

[ Top ]

render [line 328]

String render(
array
$data, [int
$flags = 0], [string
$style = ""], [string
$module = ""] 
)

Render a table.

Example:

$tbl = &atknew("atk.utils.atktablerenderer");
$tbl->render($data, TBL_HEADER|TBL_ALTERNATE, "recordlist");

Parameters:

array	$data:	A multidimensional array containing the rows and columns with data. The first dimension represents the rows. The second dimension represents the cols. If rows to not contain a complete amount of cols (compared to the other rows), the row is automatically filled upon the right by a spacer cell.
int	$flags:	(obsolete). Set flags in constructor or setFlag() One or more bitwise flags that influence the way the table is rendered. Valid flags: TBL_HEADER: the first row will be rendered as a table header. TBL_FOOTER: the last row will be rendered as a table footer. TBL_ALTERNATE: The rows of the table should alternate in color. TBL_DATA: Alias for TBL_HEADER\|TBL_ALTERNATE.
string	$style:	(obsolete) Use the constructor parameter or setTableStyle() The style to render the table in (without .css extension).
string	$module:	(obsolete) Use the constructor parameter or setTableStyle() The module where is style is located.

API Tags:

Return:

The rendered table.

[ Top ]

setAlignment [line 112]

void setAlignment(
int
$row, int
$col, int
$alignment 
)

Set the alignment for a particular cell.

Parameters:

int	$row:	The row to set.
int	$col:	The column to set.
int	$alignment:	The desired alignment (TBL_LEFT, TBL_RIGHT or TBL_CENTER).

[ Top ]

setClass [line 158]

void setClass(
int
$row, int
$col, string
$class 
)

Set the class for a particular cell.

Parameters:

int	$row:	The row to set.
int	$col:	The column to set.
string	$class:	Classname to be used by default for table cells

[ Top ]

setColAlignment [line 136]

void setColAlignment(
int
$col, int
$alignment 
)

Set the alignment for an entire column.

Parameters:

int	$col:	The column to set.
int	$alignment:	The desired alignment (TBL_LEFT, TBL_RIGHT or TBL_CENTER).

[ Top ]

setColClass [line 180]

void setColClass(
int
$col, string
$class 
)

Set the class for an entire column.

Parameters:

int	$col:	The column to set.
string	$class:	Classname to be used by default for table cells

[ Top ]

setColSpan [line 212]

void setColSpan(
int
$row, int
$col, int
$span 
)

Set the colspan for a cel

Parameters:

int	$row:	The row to set
int	$col:	The col to set
int	$span:	The span width

[ Top ]

setDefaultAlignment [line 99]

void setDefaultAlignment(
int
$alignment 
)

Set the default alignment for all cells in the table.

Parameters:

int

$alignment:

The desired alignment (TBL_LEFT, TBL_RIGHT or TBL_CENTER).

[ Top ]

setDefaultClass [line 146]

void setDefaultClass(
string
$class 
)

Set the default class for all cells in the table.

Parameters:

string

$class:

Classname to be used by default for table cells

[ Top ]

setFlag [line 88]

void setFlag(
int
$flag 
)

Sets a flag on this object. Allowed: TBL_HEADER, TBL_FOOTER, TBL_ALTERNATE and TBL_DATA

Parameters:

int

$flag:

[ Top ]

setRowAlignment [line 124]

void setRowAlignment(
int
$row, int
$alignment 
)

Set the alignment for an entire row.

Parameters:

int	$row:	The row to set.
int	$alignment:	The desired alignment (TBL_LEFT, TBL_RIGHT or TBL_CENTER).

[ Top ]

setRowClass [line 169]

void setRowClass(
int
$row, string
$class 
)

Set the class for an entire row.

Parameters:

int	$row:	The row to set.
string	$class:	Classname to be used by default for table cells

[ Top ]

setRowSpan [line 224]

void setRowSpan(
int
$row, int
$col, int
$span 
)

Set the rowspan for a cel

Parameters:

int	$row:	The row to set
int	$col:	The col to set
int	$span:	The span width

[ Top ]

setTableStyle [line 346]

void setTableStyle(
string
$class, [string
$module = ""] 
)

Sets the table style class and registers it in the result page

Parameters:

string	$class:	styleclass name
string	$module:	module to look for stylesheets

[ Top ]

_alignmentStr [line 612]

string _alignmentStr(
int
$alignment 
)

Gets the alignmentstring for an alignment flag

Parameters:

int

$alignment:

alignmentflag TBL_[LEFT, RIGHT, CENTER, BOTTOM or MIDDLE]

API Tags:

Return:

html alignment for a cell or row

[ Top ]

_classStr [line 657]

String _classStr(
String
$class 
)

Constructs the html class attribute string using a classname

Parameters:

String

$class:

Classname

API Tags:

Return:	HTML Class attribute string
Access:	private

[ Top ]

_getIdStr [line 595]

string _getIdStr(
array
$data 
)

Gets the cell id string if available.

Parameters:

array

$data:

cell data

API Tags:

Return:

html id string like 'id="1"';

[ Top ]

_getMaxCols [line 248]

int _getMaxCols(
aray
$data, [
$rownr = ''] 
)

Gets the maximum number of columns in a row

Parameters:

aray	$data:	table data
	$rownr:

API Tags:

Return:

max number of rows

Redefined in descendants as:

atkTableRendererGrouped::_getMaxCols() : Gets the maximum number of columns in a row.

[ Top ]

_getRowClassStr [line 501]

string _getRowClassStr(
string|int
$row 
)

Gets the styleclass for a rownumber Supports alternating rowclasses if TBL_ALTERNATE is set

Parameters:

string|int

$row:

row number or rowclassname

API Tags:

Return:

html class string like 'class=row1'

[ Top ]

_getTableStyleStr [line 357]

string _getTableStyleStr(
)

Gets the table style attribute component

[ Top ]

_renderBody [line 571]

string _renderBody(
array
$data, [int
$rowOffset = 0] 
)

Renders the body of the table. The body contains all rows except the header and footer rows. Surrounds the body with tbody tags.

Parameters:

array	$data:	all body rows
int	$rowOffset:	how many header rows are drawn before the body

API Tags:

Return:

html table body

Redefined in descendants as:

atkTableRendererGrouped::_renderBody() : Renders the body of the table. The body contains all rows except the header and footer rows. Surrounds the body with tbody tags.

[ Top ]

_renderCell [line 451]

string _renderCell(
array|string
$data, int
$row, int
$col, string
$type 
)

Renders one cell in the table.

Parameters:

array\|string	$data:	value of the cell
int	$row:	row number of current cell
int	$col:	column number of current cell
string	$type:	type of tag to use. mostly 'td'

API Tags:

Return:

rendered cell

[ Top ]

_renderFillingCell [line 558]

string _renderFillingCell(
int
$colspan, string
$type 
)

Renders a filling cell used to display a correct two-dimensional table.

Parameters:

int	$colspan:	columns to span
string	$type:	tagtype to use

API Tags:

Return:

html filling cell

[ Top ]

_renderFooter [line 486]

string _renderFooter(
array
$data, int
$row 
)

Renders one footer row.

Parameters:

array	$data:	row data
int	$row:	rownumber of the footer

API Tags:

Return:

rendered footer row

[ Top ]

_renderHeader [line 472]

string _renderHeader(
array
$data, int
$row 
)

Renders one header row.

Parameters:

array	$data:	row data
int	$row:	rownumber of the header, mostly 0

API Tags:

Return:

rendered header row

[ Top ]

_renderRow [line 525]

string _renderRow(
array
$data, int
$row, [string
$columntype = 'td'] 
)

Renders one row in the table.

Parameters:

array	$data:	rowdata array
int	$row:	rownumber
string	$columntype:	tagname to use to render columns inside this row

API Tags:

Return:

html of the row

[ Top ]

_renderTable [line 374]

html _renderTable(
array
$data 
)

Renders the table.

Parameters:

array

$data:

API Tags:

Return:

of the rendered table

[ Top ]

_renderValue [line 421]

unknown _renderValue(
array|string
$cell 
)

Renders the value inside one cell.

Supports the cell having id/value. This method only extracts the value.

Parameters:

array|string

$cell:

[ Top ]

_setSpan [line 193]

void _setSpan(
int
$row, int
$col, int
$span, [string
$type = "col"] 
)

Sets spanning on a specifc column.

Parameters:

int	$row:	row number
int	$col:	row column
int	$span:	width
string	$type:

[ Top ]

_spanStr [line 632]

string _spanStr(
array
$span 
)

Gets the span string for a cell

Parameters:

array

$span:

array containing spanning info

API Tags:

Return:

html spanning string

[ Top ]