PHP Class FOF30\Render\AkeebaStrapper

Renderer options linkbar_style Style for linkbars: joomla3|classic. Default: joomla3
Inheritance: extends RenderBase, implements FOF30\Render\RenderInterface
Show file Open project: akeeba/fof Class Usage Examples

Public Methods

Method Description
__construct ( Container $container ) Public constructor. Determines the priority of this class and if it should be enabled
postRender ( string $view, string $task ) : void Echoes any HTML to show after the view template
preRender ( string $view, string $task ) : void Echoes any HTML to show before the view template
renderFieldset ( stdClass &$fieldset, Form &$form, DataModel $model, string $formType, boolean $showHeader = true, string &$innerHtml = null ) : string Renders a raw fieldset of a F0FForm and returns the corresponding HTML
renderFieldsetLabel ( object $field, Form &$form, string $title ) : string Renders a label for a fieldset.
renderForm ( Form &$form, DataModel $model, string $formType = null, boolean $raw = false ) : string Renders a Form and returns the corresponding HTML
renderFormBrowse ( Form &$form, DataModel $model ) : string Renders a Form for a Browse view and returns the corresponding HTML
renderFormEdit ( Form &$form, DataModel $model ) : string Renders a Form for an Edit view and returns the corresponding HTML
renderFormRaw ( Form &$form, DataModel $model, string $formType = null ) : string Renders a raw Form and returns the corresponding HTML
renderFormRead ( Form &$form, DataModel $model ) : string Renders a Form for a Read view and returns the corresponding HTML

Protected Methods

Method Description
loadValidationScript ( Form &$form ) : void Loads the validation script for an edit form
renderButtons ( string $view, string $task ) : void Renders the toolbar buttons
renderLinkbar ( string $view, string $task ) : void Renders the submenu (link bar)
renderLinkbarItems ( Toolbar $toolbar ) : void Render the linkbar
renderLinkbar_classic ( string $view, string $task ) : void Renders the submenu (link bar) in F0F's classic style, using a Bootstrapped tab bar.
renderLinkbar_joomla ( string $view, string $task ) : void 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.

Method Details

__construct() public method

Public constructor. Determines the priority of this class and if it should be enabled
public __construct ( Container $container )
$container FOF30\Container\Container

loadValidationScript() protected method

Loads the validation script for an edit form
protected loadValidationScript ( Form &$form ) : void
$form FOF30\Form\Form
return void

postRender() public method

Echoes any HTML to show after the view template
public postRender ( string $view, string $task ) : void
$view string The current view
$task string The current task
return void

preRender() public method

Echoes any HTML to show before the view template
public preRender ( string $view, string $task ) : void
$view string The current view
$task string The current task
return void

renderButtons() protected method

Renders the toolbar buttons
protected renderButtons ( string $view, string $task ) : void
$view string The active view name
$task string The current task
return void

renderFieldset() public method

Renders a raw fieldset of a F0FForm and returns the corresponding HTML
public renderFieldset ( stdClass &$fieldset, Form &$form, DataModel $model, string $formType, boolean $showHeader = true, string &$innerHtml = null ) : string
$fieldset stdClass
$form FOF30\Form\Form
$model FOF30\Model\DataModel The model providing our data
$formType string The form type e.g. 'edit' or 'read'
$showHeader boolean Should I render the fieldset's header?
$innerHtml string Render inner tab if set
return string The HTML rendering of the fieldset

renderFieldsetLabel() public method

Renders a label for a fieldset.
public renderFieldsetLabel ( object $field, Form &$form, string $title ) : string
$field object The field of the label to render
$form FOF30\Form\Form
$title string The title of the label
return string The rendered label

renderForm() public method

Renders a Form and returns the corresponding HTML
public renderForm ( Form &$form, DataModel $model, string $formType = null, boolean $raw = false ) : string
$form FOF30\Form\Form
$model FOF30\Model\DataModel The model providing our data
$formType string The form type: edit, browse or read
$raw boolean If true, the raw form fields rendering (without the surrounding form tag) is returned.
return string The HTML rendering of the form

renderFormBrowse() public method

Renders a Form for a Browse view and returns the corresponding HTML
public renderFormBrowse ( Form &$form, DataModel $model ) : string
$form FOF30\Form\Form
$model FOF30\Model\DataModel The model providing our data
return string The HTML rendering of the form

renderFormEdit() public method

Renders a Form for an Edit view and returns the corresponding HTML
public renderFormEdit ( Form &$form, DataModel $model ) : string
$form FOF30\Form\Form
$model FOF30\Model\DataModel The model providing our data
return string The HTML rendering of the form

renderFormRaw() public method

Renders a raw Form and returns the corresponding HTML
public renderFormRaw ( Form &$form, DataModel $model, string $formType = null ) : string
$form FOF30\Form\Form
$model FOF30\Model\DataModel The model providing our data
$formType string The form type e.g. 'edit' or 'read'
return string The HTML rendering of the form

renderFormRead() public method

Renders a Form for a Read view and returns the corresponding HTML
public renderFormRead ( Form &$form, DataModel $model ) : string
$form FOF30\Form\Form
$model FOF30\Model\DataModel The model providing our data
return string The HTML rendering of the form

renderLinkbarItems() protected method

Render the linkbar
protected renderLinkbarItems ( Toolbar $toolbar ) : void
$toolbar FOF30\Toolbar\Toolbar A toolbar object
return void