Docs For Class atkDGComponent

Child Class	Description
atkDGEditControl	The data grid no records found message. Can be used to render a simple message underneath the grid stating there are no records found in the database.
atkDGIndex	The data grid index. Can be used to render an alphanumeric index for an ATK data grid.
atkDGLimit	The data grid limit box. Can be used to render a limit box for an ATK data grid.
atkDGList	The data grid list component renders the recordlist.
atkDGNoRecordsFound	The data grid no records found message. Can be used to render a simple message underneath the grid stating there are no records found in the database.
atkDGPaginator	The data grid paginator. Can be used to render pagination links for an ATK data grid.
atkDGRenderer	The grid renderer is responsible for rendering the grid components and ofcourse the grid itself.
atkDGSummary	The data grid summary. Can be used to render a summary for an ATK data grid.

[ Top ]

Property Summary

atkDataGrid	$m_grid	The atkDataGrid.
array	$m_options	The component options.

[ Top ]

Method Summary

atkDGComponent	__construct()	Constructor.
void	destroy()	Destroy.
atkDataGrid	getGrid()	Returns the data grid.
atkNode	getNode()	Returns the data grid node.
mixed	getOption()	Returns the value for the component option with the given name.
atkPage	getPage()	Returns the page object.
atkTheme	getTheme()	Return the theme object.
atkUi	getUi()	Returns the UI object.
string	render()	Renders the component.
void	text()	Translate the given string using the grid node.

[ Top ]

Properties

atkDataGrid $m_grid [line 31]

The atkDataGrid.

API Tags:

Access:

private

[ Top ]

array $m_options [line 38]

The component options.

API Tags:

Access:

private

[ Top ]

Methods

Constructor __construct [line 46]

atkDGComponent __construct(
atkDataGrid
$grid, [array
$options = array()] 
)

Constructor.

Parameters:

atkDataGrid	$grid:	grid
array	$options:	component options

API Tags:

Access:

public

Redefined in descendants as:

atkDGPaginator::__construct() : Constructor.

[ Top ]

destroy [line 55]

void destroy(
)

Destroy.

API Tags:

Access:

public

[ Top ]

getGrid [line 77]

atkDataGrid getGrid(
)

Returns the data grid.

API Tags:

Return:	data grid
Access:	protected

[ Top ]

getNode [line 87]

atkNode getNode(
)

Returns the data grid node.

API Tags:

Return:	node
Access:	protected

[ Top ]

getOption [line 67]

mixed getOption(
string
$name, [
$fallback = null] 
)

Returns the value for the component option with the given name.

Parameters:

string	$name:	option name
	$fallback:

API Tags:

Return:	option value
Access:	protected

[ Top ]

getPage [line 97]

atkPage getPage(
)

Returns the page object.

API Tags:

Return:	page
Access:	protected

[ Top ]

getTheme [line 117]

atkTheme getTheme(
)

Return the theme object.

API Tags:

Return:	theme
Access:	protected

[ Top ]

getUi [line 107]

atkUi getUi(
)

Returns the UI object.

API Tags:

Return:	ui
Access:	protected

[ Top ]

render [line 143]

string render(
)

Renders the component.

API Tags:

Return:	component HTML
Abstract:
Access:	public

Redefined in descendants as:

atkDGEditControl::render() : Renders the no records found message for the given data grid.
atkDGIndex::render() : Renders the index for the given data grid.
atkDGLimit::render() : Renders the limit box for the given data grid.
atkDGList::render() : Render the list.
atkDGNoRecordsFound::render() : Renders the no records found message for the given data grid.
atkDGPaginator::render() : Renders the paginator for the given data grid.
atkDGRenderer::render() : Render the grid.
atkDGSummary::render() : Renders the summary for the given data grid.

[ Top ]

text [line 133]

void text(
string
$string, [string
$fallback = ''], [boolean
$useDefault = true] 
)

Translate the given string using the grid node.

The value of $fallback will be returned if no translation can be found. If you want NULL to be returned when no translation can be found then leave the fallback empty and set $useDefault to false.

Parameters:

string	$string:	string to translate
string	$fallback:	fallback in-case no translation can be found
boolean	$useDefault:	use default ATK translation if no translation can be found?

API Tags:

Access:

protected

[ Top ]