Docs For Class atkPrintableRecordList

Home

Documentation home

Atk index

Docs For Class atkPrintableRecordList [ package: atk ]

Class: atkPrintableRecordList

Source Location: /recordlist/class.atkprintablerecordlist.inc

Class atkPrintableRecordList

Class Overview

Recordlist implementation that renders a recordlist that is 'printer-friendly'.

It doesn't render any actions or links, and can only be used as a readonly list of records.

Located in /recordlist/class.atkprintablerecordlist.inc [line 34]

Wiki documentation

atkRecordList
   |
   --atkPrintableRecordList

Author(s):

Ivo Jansch <ivo@achievo.org>

Information Tags:

Methods

render

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkRecordList atkRecordList::$m_actionloader atkRecordList::$m_actionSessionStatus atkRecordList::$m_flags atkRecordList::$m_hasActionColumn atkRecordList::$m_masternode atkRecordList::$m_node	Inherited From atkRecordList atkRecordList::convertFlags() Converts the given node flags to recordlist flags where possible. atkRecordList::getCustomMraHtml() Get custom mra HTML code atkRecordList::getMasterNode() Get the masternode atkRecordList::getMasterNodeType() Get the nodetype of the master node atkRecordList::getRecordlistData() Get records for a recordlist without actually rendering the recordlist. atkRecordList::listArray() Function outputs an array with all information necessary to output a recordlist. atkRecordList::render() Render the recordlist atkRecordList::setActionSessionStatus() Sets the action session status for actions in the recordlist. atkRecordList::setMasterNode() Make the recordlist use a different masternode than the node than it is rendering. atkRecordList::setNode() atkRecordList::_hasActionColumn() Checks wether the recordlist should display a column which holds the actions.

Inherited Properties

Inherited Methods

Inherited From atkRecordList

atkRecordList::$m_actionloader

atkRecordList::$m_actionSessionStatus

atkRecordList::$m_flags

atkRecordList::$m_hasActionColumn

atkRecordList::$m_masternode

atkRecordList::$m_node

Inherited From atkRecordList

atkRecordList::convertFlags()

Converts the given node flags to recordlist flags where possible.

atkRecordList::getCustomMraHtml()

Get custom mra HTML code

atkRecordList::getMasterNode()

Get the masternode

atkRecordList::getMasterNodeType()

Get the nodetype of the master node

atkRecordList::getRecordlistData()

Get records for a recordlist without actually rendering the recordlist.

atkRecordList::listArray()

Function outputs an array with all information necessary to output a recordlist.

atkRecordList::render()

Render the recordlist

atkRecordList::setActionSessionStatus()

Sets the action session status for actions in the recordlist.

atkRecordList::setMasterNode()

Make the recordlist use a different masternode than the node than it is rendering.

atkRecordList::setNode()

atkRecordList::_hasActionColumn()

Checks wether the recordlist should display a column which holds the actions.

[ Top ]

Method Summary

String

render()

Creates printableRecordlist obsolete by specialRecordList

[ Top ]

Properties

Methods

render [line 52]

String render(

&$node, Array
$recordset, [Array
$suppressList = ""], [int
$flags = 0], atkNode
$node 
)

Creates printableRecordlist obsolete by specialRecordList

Parameters:

atkNode	$node:	the node
Array	$recordset:	the list of records
Array	$suppressList:	fields we don't display
int	$flags:	The prefix for embeded fields
	&$node:

API Tags:

Return:

The rendered recordlist

Redefinition of:

atkRecordList::render(): Render the recordlist

[ Top ]