Docs For Class FOFRenderAbstract

Description

Abstract view renderer class. The renderer is what turns XML view templates into actual HTML code, renders the submenu links and potentially wraps the HTML output in a div with a component-specific ID.

abstract:
since: 2.0

Located in /libraries/fof/render/abstract.php (line 18)

Direct descendents

Class	Description
FOFRenderJoomla	Default Joomla! 1.5, 1.7, 2.5 view renderer class
FOFRenderStrapper	Akeeba Strapper view renderer class.

Variable Summary

int $enabled

int $priority

Method Summary

object getInformation ()

void postRender (string $view, string $task, FOFInput $input, [array $config = array()])

void preRender (string $view, string $task, FOFInput $input, [array $config = array()])

void renderCategoryLinkbar (string $extension, [array $config = array()])

string renderForm (FOFForm &$form, FOFModel $model, FOFInput $input, [string $formType = null], [boolean $raw = false])

string renderFormBrowse (FOFForm &$form, FOFModel $model, FOFInput $input)

string renderFormEdit (FOFForm &$form, FOFModel $model, FOFInput $input)

string renderFormRaw (FOFForm &$form, FOFModel $model, FOFInput $input, string $formType)

string renderFormRead (FOFForm &$form, FOFModel $model, FOFInput $input)

Variables

int $enabled = false (line 24)

var: Is this renderer enabled?
access: protected

int $priority = 50 (line 21)

var: Priority of this renderer. Higher means more important
access: protected

Methods

getInformation (line 31)

Returns the information about this renderer

access: public

object getInformation ()

postRender (line 61)

Echoes any HTML to show after the view template

abstract:
access: public

void postRender (string $view, string $task, FOFInput $input, [array $config = array()])

string $view: The current view
string $task: The current task
FOFInput $input: The input array (request parameters)
array $config: The view configuration array

Redefined in descendants as:

FOFRenderJoomla::postRender() : Echoes any HTML to show after the view template
FOFRenderStrapper::postRender() : Echoes any HTML to show after the view template
FOFRenderJoomla3::postRender() : Echoes any HTML to show after the view template

preRender (line 49)

Echoes any HTML to show before the view template

abstract:
access: public

void preRender (string $view, string $task, FOFInput $input, [array $config = array()])

string $view: The current view
string $task: The current task
FOFInput $input: The input array (request parameters)
array $config: The view configuration array

Redefined in descendants as:

FOFRenderJoomla::preRender() : Echoes any HTML to show before the view template
FOFRenderStrapper::preRender() : Echoes any HTML to show before the view template
FOFRenderJoomla3::preRender() : Echoes any HTML to show before the view template

renderCategoryLinkbar (line 156)

Renders the submenu (link bar) for a category view when it is used in a extension

Note: this function has to be called from the addSubmenu function in the ExtensionNameHelper class located in administrator/components/com_ExtensionName/helpers/Extensionname.php

Example Code:

class ExtensionNameHelper { public static function addSubmenu($vName) { // Load FOF include_once JPATH_LIBRARIES . '/fof/include.php';

if (!defined('FOF_INCLUDED')) { JError::raiseError('500', 'FOF is not installed'); }

if (FOFPlatform::getInstance()->checkVersion(JVERSION, '3.0', 'ge')) { $strapper = new FOFRenderJoomla3; } else { $strapper = new FOFRenderJoomla; }

$strapper->renderCategoryLinkbar('com_babioonevent'); } }

access: public

void renderCategoryLinkbar (string $extension, [array $config = array()])

string $extension: The name of the extension
array $config: Extra configuration variables for the toolbar

renderForm (line 74)

Renders a FOFForm and returns the corresponding HTML

return: The HTML rendering of the form
access: public

string renderForm (FOFForm &$form, FOFModel $model, FOFInput $input, [string $formType = null], [boolean $raw = false])

FOFForm &$form: The form to render
FOFModel $model: The model providing our data
FOFInput $input: The input object
string $formType: The form type: edit, browse or read
boolean $raw: If true, the raw form fields rendering (without the surrounding form tag) is returned.

renderFormBrowse (line 185)

Renders a FOFForm for a Browse view and returns the corresponding HTML

return: The HTML rendering of the form
abstract:
access: protected

string renderFormBrowse (FOFForm &$form, FOFModel $model, FOFInput $input)

FOFForm &$form: The form to render
FOFModel $model: The model providing our data
FOFInput $input: The input object

Redefined in descendants as:

FOFRenderJoomla::renderFormBrowse() : Renders a FOFForm for a Browse view and returns the corresponding HTML
FOFRenderStrapper::renderFormBrowse() : Renders a FOFForm for a Browse view and returns the corresponding HTML

renderFormEdit (line 207)

Renders a FOFForm for an Edit view and returns the corresponding HTML

return: The HTML rendering of the form
abstract:
access: protected

string renderFormEdit (FOFForm &$form, FOFModel $model, FOFInput $input)

FOFForm &$form: The form to render
FOFModel $model: The model providing our data
FOFInput $input: The input object

Redefined in descendants as:

FOFRenderJoomla::renderFormEdit() : Renders a FOFForm for an Edit view and returns the corresponding HTML
FOFRenderStrapper::renderFormEdit() : Renders a FOFForm for an Edit view and returns the corresponding HTML

renderFormRaw (line 219)

Renders a raw FOFForm and returns the corresponding HTML

return: The HTML rendering of the form
abstract:
access: protected

string renderFormRaw (FOFForm &$form, FOFModel $model, FOFInput $input, string $formType)

FOFForm &$form: The form to render
FOFModel $model: The model providing our data
FOFInput $input: The input object
string $formType: The form type e.g. 'edit' or 'read'

Redefined in descendants as:

FOFRenderJoomla::renderFormRaw() : Renders a raw FOFForm and returns the corresponding HTML
FOFRenderStrapper::renderFormRaw() : Renders a raw FOFForm and returns the corresponding HTML

renderFormRead (line 196)

Renders a FOFForm for a Read view and returns the corresponding HTML

return: The HTML rendering of the form
abstract:
access: protected

string renderFormRead (FOFForm &$form, FOFModel $model, FOFInput $input)

FOFForm &$form: The form to render
FOFModel $model: The model providing our data
FOFInput $input: The input object

Redefined in descendants as:

FOFRenderJoomla::renderFormRead() : Renders a FOFForm for a Read view and returns the corresponding HTML
FOFRenderStrapper::renderFormRead() : Renders a FOFForm for a Read view and returns the corresponding HTML