Class FOFRenderStrapper

Akeeba Strapper view renderer class.

FOFRenderStrapper

Direct known subclasses

FOFRenderJoomla3

Package: FrameworkOnFramework\render
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 2.0
Located at fof/render/strapper.php

Methods summary

`public`	# `__construct( )` Public constructor. Determines the priority of this class and if it should be enabled Public constructor. Determines the priority of this class and if it should be enabled
`public`	# `preRender( string $view, string $task, FOFInput $input, array $config = array() )` Echoes any HTML to show before the view template Echoes any HTML to show before the view template Parameters `$view` `string` - $view The current view `$task` `string` - $task The current task `$input` `FOFInput` - $input The input array (request parameters) `$config` `array` - $config The view configuration array
`public`	# `postRender( string $view, string $task, FOFInput $input, array $config = array() )` Echoes any HTML to show after the view template Echoes any HTML to show after the view template Parameters `$view` `string` - $view The current view `$task` `string` - $task The current task `$input` `FOFInput` - $input The input array (request parameters) `$config` `array` - $config The view configuration array
`protected`	# `loadValidationScript( FOFForm & $form )` Loads the validation script for an edit form Loads the validation script for an edit form Parameters `$form` `FOFForm` - &$form The form we are rendering
`protected`	# `renderLinkbar( string $view, string $task, FOFInput $input, array $config = array() )` Renders the submenu (link bar) Renders the submenu (link bar) Parameters `$view` `string` - $view The active view name `$task` `string` - $task The current task `$input` `FOFInput` - $input The input object `$config` `array` - $config Extra configuration variables for the toolbar
`protected`	# `renderLinkbar_classic( string $view, string $task, FOFInput $input, array $config = array() )` Renders the submenu (link bar) in FOF's classic style, using a Bootstrapped tab bar. Renders the submenu (link bar) in FOF's classic style, using a Bootstrapped tab bar. Parameters `$view` `string` - $view The active view name `$task` `string` - $task The current task `$input` `FOFInput` - $input The input object `$config` `array` - $config Extra configuration variables for the toolbar
`protected`	# `renderLinkbar_joomla( string $view, string $task, FOFInput $input, array $config = array() )` Renders the submenu (link bar) using Joomla!'s style. On Joomla! 2.5 this is a list of bar separated links, on Joomla! 3 it's a sidebar at the left-hand side of the page. Renders the submenu (link bar) using Joomla!'s style. On Joomla! 2.5 this is a list of bar separated links, on Joomla! 3 it's a sidebar at the left-hand side of the page. Parameters `$view` `string` - $view The active view name `$task` `string` - $task The current task `$input` `FOFInput` - $input The input object `$config` `array` - $config Extra configuration variables for the toolbar
`protected`	# `renderLinkbarItems( FOFToolbar $toolbar )` do the rendering job for the linkbar do the rendering job for the linkbar Parameters `$toolbar` `FOFToolbar` - $toolbar A toolbar object
`protected`	# `renderButtons( string $view, string $task, FOFInput $input, array $config = array() )` Renders the toolbar buttons Renders the toolbar buttons Parameters `$view` `string` - $view The active view name `$task` `string` - $task The current task `$input` `FOFInput` - $input The input object `$config` `array` - $config Extra configuration variables for the toolbar
`protected string`	# `renderFormBrowse( FOFForm & $form, FOFModel $model, FOFInput $input )` Renders a FOFForm for a Browse view and returns the corresponding HTML Renders a FOFForm for a Browse view and returns the corresponding HTML Parameters `$form` `FOFForm` - &$form The form to render `$model` `FOFModel` - $model The model providing our data `$input` `FOFInput` - $input The input object Returns `string` - The HTML rendering of the form
`protected string`	# `renderFormRead( FOFForm & $form, FOFModel $model, FOFInput $input )` Renders a FOFForm for a Read view and returns the corresponding HTML Renders a FOFForm for a Read view and returns the corresponding HTML Parameters `$form` `FOFForm` - &$form The form to render `$model` `FOFModel` - $model The model providing our data `$input` `FOFInput` - $input The input object Returns `string` - The HTML rendering of the form
`protected string`	# `renderFormEdit( FOFForm & $form, FOFModel $model, FOFInput $input )` Renders a FOFForm for an Edit view and returns the corresponding HTML Renders a FOFForm for an Edit view and returns the corresponding HTML Parameters `$form` `FOFForm` - &$form The form to render `$model` `FOFModel` - $model The model providing our data `$input` `FOFInput` - $input The input object Returns `string` - The HTML rendering of the form
`protected string`	# `renderFormRaw( FOFForm & $form, FOFModel $model, FOFInput $input, string $formType )` Renders a raw FOFForm and returns the corresponding HTML Renders a raw FOFForm and returns the corresponding HTML Parameters `$form` `FOFForm` - &$form The form to render `$model` `FOFModel` - $model The model providing our data `$input` `FOFInput` - $input The input object `$formType` `string` - $formType The form type e.g. 'edit' or 'read' Returns `string` - The HTML rendering of the form
`protected string`	# `renderFieldset( stdClass & $fieldset, FOFForm & $form, FOFModel $model, FOFInput $input, string $formType, boolean $showHeader = true, mixed & $innerHtml = null )` Renders a raw fieldset of a FOFForm and returns the corresponding HTML Renders a raw fieldset of a FOFForm and returns the corresponding HTML Parameters `$fieldset` `stdClass` - &$fieldset The fieldset to render `$form` `FOFForm` - &$form The form to render `$model` `FOFModel` - $model The model providing our data `$input` `FOFInput` - $input The input object `$formType` `string` - $formType The form type e.g. 'edit' or 'read' `$showHeader` `boolean` - $showHeader Should I render the fieldset's header? `$innerHtml` Returns `string` - The HTML rendering of the fieldset Overrides `FOFRenderAbstract::renderFieldset`
`protected string`	# `renderFieldsetLabel( object $field, FOFForm & $form, string $title )` Renders a label for a fieldset. Renders a label for a fieldset. Parameters `$field` `object` - $field The field of the label to render `$form` `FOFForm` - &$form The form to render `$title` `string` - $title The title of the label Returns `string` - The rendered label Overrides `FOFRenderAbstract::renderFieldsetLabel`

Methods inherited from FOFRenderAbstract

getInformation(), isTabFieldset(), renderCategoryLinkbar(), renderForm()

Magic methods summary

Properties summary

Properties inherited from FOFRenderAbstract

$enabled, $priority

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFRenderStrapper

Direct known subclasses

Methods summary

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Methods inherited from FOFRenderAbstract

Magic methods summary

Properties summary

Properties inherited from FOFRenderAbstract