Docs For Class atkExcelCSVRecordList

Home

Documentation home

Atk index

Docs For Class atkExcelCSVRecordList [ package: atk ]

Class: atkExcelCSVRecordList

Source Location: /recordlist/class.atkexcelcsvrecordlist.inc

Class atkExcelCSVRecordList

Class Overview

CVS for Excel recordlist renderer.

Note: End of line characters within values are replaced for excel 2003 compatibility reasons!

Located in /recordlist/class.atkexcelcsvrecordlist.inc [line 31]

Wiki documentation

atkRecordList
   |
   --atkCustomRecordList
      |
      --atkExcelCSVRecordList

Author(s):

Patrick van der Velden <patrick@ibuildings.nl>

Information Tags:

Properties

$lfreplace

Methods

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkCustomRecordList atkCustomRecordList::$m_exportcsv atkCustomRecordList::$m_mode Inherited From atkRecordList atkRecordList::$m_actionloader atkRecordList::$m_actionSessionStatus atkRecordList::$m_flags atkRecordList::$m_hasActionColumn atkRecordList::$m_masternode atkRecordList::$m_node	Inherited From atkCustomRecordList atkCustomRecordList::eolreplace() Replace any eol character(s) by something else atkCustomRecordList::isHidden() Is this attribute hidden? atkCustomRecordList::render() Creates a special Recordlist that can be used for exporting to files or to make it printable atkCustomRecordList::setExportingCSVToFile() Set exporting csv to file 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 atkCustomRecordList

atkCustomRecordList::$m_exportcsv

atkCustomRecordList::$m_mode

Inherited From atkRecordList

atkRecordList::$m_actionloader

atkRecordList::$m_actionSessionStatus

atkRecordList::$m_flags

atkRecordList::$m_hasActionColumn

atkRecordList::$m_masternode

atkRecordList::$m_node

Inherited From atkCustomRecordList

atkCustomRecordList::eolreplace()

Replace any eol character(s) by something else

atkCustomRecordList::isHidden()

Is this attribute hidden?

atkCustomRecordList::render()

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

atkCustomRecordList::setExportingCSVToFile()

Set exporting csv to file

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

$lfreplace

[ Top ]

Method Summary

void	render()	Creates a special Recordlist that can be used for exporting to files or to make it printable
void	setLfReplacementString()	Replace line feeds within cell values with another string.

[ Top ]

Properties

mixed $lfreplace = null [line 34]

[ Top ]

Methods

render [line 47]

void render(

&$node, array
$recordset, [string
$compression = ""], [array
$suppressList = ""], [array
$outputparams = array()], [Boolean
$titlerow = true], [Boolean
$decode = false], 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	$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)
Boolean	$titlerow:	Should titlerow be rendered or not
Boolean	$decode:	Should data be decoded or not (for exports)
	&$node:

Redefinition of:

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

[ Top ]

setLfReplacementString [line 58]

void setLfReplacementString(
String
$string 
)

Replace line feeds within cell values with another string.

Note: Excel 2003 requires this feature for csv imports.

Parameters:

String

$string:

The line feed replacement string

[ Top ]