Docs For Class FOFViewForm

Description

FrameworkOnFramework Form class. It preferrably renders an XML view template instead of a traditional PHP-based view template.

since: 2.0

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

JObject
   |
   --FOFView
      |
      --FOFViewRaw
         |
         --FOFViewHtml
            |
            --FOFViewForm

Variable Summary

FOFForm $form

Method Summary

boolean|null display ([string $tpl = null])

string getRenderedForm ()

boolean onAdd ([string $tpl = null])

Variables

FOFForm $form (line 23)

var: The form to render
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

display (line 32)

Displays the view

return: False if we can't render anything
access: public

boolean|null display ([string $tpl = null])

string $tpl: The template to use

Redefinition of:

FOFViewRaw::display(): Displays the view

getRenderedForm (line 100)

Returns the HTML rendering of the FOFForm attached to this view. Very useful for customising a form page without having to meticulously hand- code the entire form.

return: The HTML of the rendered form
access: public

string getRenderedForm ()

onAdd (line 125)

The event which runs when we are displaying the Add page

return: True to allow display of the view
access: protected

boolean onAdd ([string $tpl = null])

string $tpl: The view sub-template to use

Redefinition of:

FOFViewRaw::onAdd(): Executes before rendering the page for the Add 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()