Docs For Class FOFViewCsv

Description

FrameworkOnFramework CSV View class. Automatically renders the data in CSV format.

since: 1.0

Located in /libraries/fof/view/csv.php (line 20)

JObject
   |
   --FOFView
      |
      --FOFViewRaw
         |
         --FOFViewHtml
            |
            --FOFViewCsv

Variable Summary

array $csvFields

string $csvFilename

boolean $csvHeader

Method Summary

FOFViewCsv __construct ([array $config = array()])

boolean onDisplay ([string $tpl = null])

Variables

array $csvFields = array() (line 41)

The columns to include in the CSV output. If it's empty it will be ignored.

access: protected

string $csvFilename = null (line 34)

The filename of the downloaded CSV file.

access: protected

boolean $csvHeader = true (line 27)

Should I produce a CSV header row.

access: protected

Inherited Variables

Inherited from FOFViewRaw

FOFViewRaw::$lists
FOFViewRaw::$perms

Inherited from FOFView

FOFView::$config
FOFView::$doPostRender
FOFView::$doPreRender
FOFView::$input
FOFView::$rendererObject
FOFView::$renderers
FOFView::$_basePath
FOFView::$_charset
FOFView::$_defaultModel
FOFView::$_escape
FOFView::$_layout
FOFView::$_layoutExt
FOFView::$_layoutTemplate
FOFView::$_models
FOFView::$_name
FOFView::$_output
FOFView::$_path
FOFView::$_template

Inherited from JObject

JObject::$_errors

Methods

Constructor __construct (line 48)

Public constructor. Instantiates a FOFViewCsv object.

access: public

FOFViewCsv __construct ([array $config = array()])

array $config: The configuration data array

Redefinition of:

FOFViewHtml::__construct(): Class constructor

onDisplay (line 100)

Executes before rendering a generic page, default to actions necessary for the Browse task.

return: Return true to allow rendering of the page
access: protected

boolean onDisplay ([string $tpl = null])

string $tpl: Subtemplate to use

Redefinition of:

FOFViewRaw::onDisplay(): Executes before rendering a generic page, default to actions necessary for the Browse task.

Inherited Methods

Inherited From FOFViewHtml

FOFViewHtml::__construct()
FOFViewHtml::postRender()
FOFViewHtml::preRender()
FOFViewHtml::renderLinkbar()

Inherited From FOFViewRaw

FOFViewRaw::__construct()
FOFViewRaw::display()
FOFViewRaw::getLists()
FOFViewRaw::getPerms()
FOFViewRaw::hasAjaxOrderingSupport()
FOFViewRaw::onAdd()
FOFViewRaw::onBrowse()
FOFViewRaw::onDisplay()
FOFViewRaw::onEdit()
FOFViewRaw::onRead()
FOFViewRaw::postRender()
FOFViewRaw::preRender()

Inherited From FOFView

FOFView::__construct()
FOFView::addHelperPath()
FOFView::addTemplatePath()
FOFView::assign()
FOFView::assignRef()
FOFView::display()
FOFView::escape()
FOFView::findRenderer()
FOFView::get()
FOFView::getLayout()
FOFView::getLayoutTemplate()
FOFView::getModel()
FOFView::getName()
FOFView::getRenderer()
FOFView::getViewOptionAndName()
FOFView::loadAnyTemplate()
FOFView::loadHelper()
FOFView::loadTemplate()
FOFView::registerRenderer()
FOFView::setEscape()
FOFView::setLayout()
FOFView::setLayoutExt()
FOFView::setModel()
FOFView::setPostRender()
FOFView::setPreRender()
FOFView::setRenderer()
FOFView::_addPath()
FOFView::_createFileName()
FOFView::_setPath()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()