Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe FOFRenderAbstract
+ Graphe d'héritage de FOFRenderAbstract:

Fonctions membres publiques

 getInformation ()
 
 preRender ($view, $task, $input, $config=array())
 
 postRender ($view, $task, $input, $config=array())
 
 renderForm (FOFForm &$form, FOFModel $model, FOFInput $input, $formType=null, $raw=false)
 
 renderCategoryLinkbar ($extension, $config=array())
 

Fonctions membres protégées

 renderFormBrowse (FOFForm &$form, FOFModel $model, FOFInput $input)
 
 renderFormRead (FOFForm &$form, FOFModel $model, FOFInput $input)
 
 renderFormEdit (FOFForm &$form, FOFModel $model, FOFInput $input)
 
 renderFormRaw (FOFForm &$form, FOFModel $model, FOFInput $input, $formType)
 
 renderFieldset (stdClass &$fieldset, FOFForm &$form, FOFModel $model, FOFInput $input, $formType, $showHeader=true)
 
 renderFieldsetLabel ($field, FOFForm &$form, $title)
 
 isTabFieldset ($fieldset)
 

Attributs protégés

 $priority = 50
 
 $enabled = false
 

Documentation des fonctions membres

◆ getInformation()

getInformation ( )

Returns the information about this renderer

Renvoie
object

◆ isTabFieldset()

isTabFieldset (   $fieldset)
protected

Checks if the fieldset defines a tab pane

Paramètres
SimpleXMLElement$fieldset
Renvoie
boolean

Références $class, et $classes.

◆ postRender()

postRender (   $view,
  $task,
  $input,
  $config = array() 
)
abstract

Echoes any HTML to show after the view template

Paramètres
string$viewThe current view
string$taskThe current task
FOFInput$inputThe input array (request parameters)
array$configThe view configuration array
Renvoie
void

◆ preRender()

preRender (   $view,
  $task,
  $input,
  $config = array() 
)
abstract

Echoes any HTML to show before the view template

Paramètres
string$viewThe current view
string$taskThe current task
FOFInput$inputThe input array (request parameters)
array$configThe view configuration array
Renvoie
void

◆ renderCategoryLinkbar()

renderCategoryLinkbar (   $extension,
  $config = array() 
)

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 (version_compare(JVERSION, '3.0', 'ge'))
            {
                    $strapper = new FOFRenderJoomla3;
            }
            else
            {
                    $strapper = new FOFRenderJoomla;
            }

            $strapper->renderCategoryLinkbar('com_babioonevent');
    }
 }
Paramètres
string$extensionThe name of the extension
array$configExtra configuration variables for the toolbar
Renvoie
void

Références $config, $extension, $toolbar, FOFToolbar\getAnInstance(), et FOFPlatform\getInstance().

◆ renderFieldset()

renderFieldset ( stdClass &  $fieldset,
FOFForm $form,
FOFModel  $model,
FOFInput  $input,
  $formType,
  $showHeader = true 
)
protected

Renders a raw fieldset of a FOFForm and returns the corresponding HTML

: Convert to an abstract method or interface at FOF3

Paramètres
stdClass&$fieldsetThe fieldset to render
FOFForm&$formThe form to render
FOFModel$modelThe model providing our data
FOFInput$inputThe input object
string$formTypeThe form type e.g. 'edit' or 'read'
boolean$showHeaderShould I render the fieldset's header?
Renvoie
string The HTML rendering of the fieldset

◆ renderFieldsetLabel()

renderFieldsetLabel (   $field,
FOFForm $form,
  $title 
)
protected

Renders a label for a fieldset.

: Convert to an abstract method or interface at FOF3

Paramètres
object$fieldThe field of the label to render
FOFForm&$formThe form to render
string$titleThe title of the label
Renvoie
string The rendered label

◆ renderForm()

renderForm ( FOFForm $form,
FOFModel  $model,
FOFInput  $input,
  $formType = null,
  $raw = false 
)

Renders a FOFForm and returns the corresponding HTML

Paramètres
FOFForm&$formThe form to render
FOFModel$modelThe model providing our data
FOFInput$inputThe input object
string$formTypeThe form type: edit, browse or read
boolean$rawIf true, the raw form fields rendering (without the surrounding form tag) is returned.
Renvoie
string The HTML rendering of the form

Références $form, et $input.

◆ renderFormBrowse()

renderFormBrowse ( FOFForm $form,
FOFModel  $model,
FOFInput  $input 
)
abstractprotected

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

Paramètres
FOFForm&$formThe form to render
FOFModel$modelThe model providing our data
FOFInput$inputThe input object
Renvoie
string The HTML rendering of the form

◆ renderFormEdit()

renderFormEdit ( FOFForm $form,
FOFModel  $model,
FOFInput  $input 
)
abstractprotected

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

Paramètres
FOFForm&$formThe form to render
FOFModel$modelThe model providing our data
FOFInput$inputThe input object
Renvoie
string The HTML rendering of the form

◆ renderFormRaw()

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

Renders a raw FOFForm and returns the corresponding HTML

Paramètres
FOFForm&$formThe form to render
FOFModel$modelThe model providing our data
FOFInput$inputThe input object
string$formTypeThe form type e.g. 'edit' or 'read'
Renvoie
string The HTML rendering of the form

◆ renderFormRead()

renderFormRead ( FOFForm $form,
FOFModel  $model,
FOFInput  $input 
)
abstractprotected

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

Paramètres
FOFForm&$formThe form to render
FOFModel$modelThe model providing our data
FOFInput$inputThe input object
Renvoie
string The HTML rendering of the form

Documentation des champs

◆ $enabled

$enabled = false
protected

◆ $priority

$priority = 50
protected

La documentation de cette classe a été générée à partir du fichier suivant :