Docs For Class atkCustomRecordList

Home

Documentation home

Atk index

Docs For Class atkCustomRecordList [ package: atk ]

Class: atkCustomRecordList

Source Location: /recordlist/class.atkcustomrecordlist.inc

Class atkCustomRecordList

Class Overview

Custom recordlist renderer.

Located in /recordlist/class.atkcustomrecordlist.inc [line 30]

Wiki documentation

atkRecordList
   |
   --atkCustomRecordList

Author(s):

Paul Verhoef <paul@ibuildings.nl>

Information Tags:

Properties

Methods

[ Top ]

Descendants

Child Class	Description
atkCSVRecordList	CVS recordlist renderer.
atkExcelCSVRecordList	CVS for Excel recordlist renderer.
atkHTMLRecordList	HTML recordlist renderer.

[ 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 ]

Property Summary

mixed	$m_exportcsv
mixed	$m_mode

[ Top ]

Method Summary

void	eolreplace()	Replace any eol character(s) by something else
bool	isHidden()	Is this attribute hidden?
void	render()	Creates a special Recordlist that can be used for exporting to files or to make it printable
void	setExportingCSVToFile()	Set exporting csv to file

[ Top ]

Properties

mixed $m_exportcsv = true [line 33]

Redefined in descendants as:

[ Top ]

mixed $m_mode [line 34]

API Tags:

Access:

protected

[ Top ]

Methods

eolreplace [line 233]

void eolreplace(
String
$string, String
$replacement 
)

Replace any eol character(s) by something else

Parameters:

String	$string:	The string to process
String	$replacement:	The replacement string for '\r\n', '\n' and/or '\r'

[ Top ]

isHidden [line 209]

bool isHidden(
atkAttribute
$attribute 
)

Is this attribute hidden?

Parameters:

atkAttribute

$attribute:

API Tags:

Return:	Boolean to indicate if attribute is hidden or not
Access:	protected

[ Top ]

render [line 56]

void render(

&$node, array
$recordset, String
$sol, String
$sof, String
$eof, String
$eol, [int
$type = "0"], [string
$compression = ""], [array
$suppressList = ""], [array
$outputparams = array()], [String
$mode = "list"], [Boolean
$titlerow = true], [Boolean
$decode = false], [String
$fsep = ""], [String
$rfeplace = null], atkNode
$node 
)

Creates a special Recordlist that can be used for exporting to files or to make it printable

Parameters:

atkNode	$node:	The node to use as definition for the columns.
array	$recordset:	The records to render
String	$sol:	String to use at start of each row
String	$sof:	String to use at start of each field
String	$eof:	String to use at end of each field
String	$eol:	String to use at end of each row
int	$type:	0=Render rows in simple html tabl; 1= raw export
string	$compression:	Compression technique (bzip / gzip)
array	$suppressList:	List of attributes from $node that should be ignored
array	$outputparams:	Key-Value parameters for output. Currently existing: filename - the name of the file (without extension .csv)
String	$mode:	The mode that is passed to attributes' display() method (for overrides). Defaults to 'list'.
Boolean	$titlerow:	Should titlerow be rendered or not
Boolean	$decode:	Should data be decoded or not (for exports)
String	$fsep:	String to use between fields
String	$rfeplace:	String for replacing line feeds in recordset field values (null = do not replace)
	&$node:

Redefinition of:

atkRecordList::render(): Render the recordlist

Redefined in descendants as:

atkCSVRecordList::render() : Creates a special Recordlist that can be used for exporting to files or to make it printable
atkExcelCSVRecordList::render() : Creates a special Recordlist that can be used for exporting to files or to make it printable
atkHTMLRecordList::render() : Creates a special Recordlist that can be used for exporting to files or to make it printable

[ Top ]

setExportingCSVToFile [line 222]

void setExportingCSVToFile(
[bool
$export = true] 
)

Set exporting csv to file

Parameters:

bool

$export:

[ Top ]