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 FOFFormHeader
+ Graphe d'héritage de FOFFormHeader:

Fonctions membres publiques

 __construct (FOFForm $form=null)
 
 __get ($name)
 
 setForm (FOFForm $form)
 
 setup (SimpleXMLElement $element, $value, $group=null)
 

Fonctions membres protégées

 getId ($fieldId, $fieldName)
 
 getName ($fieldName)
 
 getFieldName ($fieldName)
 
 getLabel ()
 
 getValue ()
 
 getFilterSource ($filterSource)
 
 getSortable ()
 
 getHeader ()
 
 getFilter ()
 
 getButtons ()
 
 getOptions ()
 

Attributs protégés

 $description
 
 $element
 
 $form
 
 $label
 
 $header
 
 $filter
 
 $buttons
 
 $options
 
 $name
 
 $fieldname
 
 $group
 
 $type
 
 $value
 
 $tdwidth
 
 $filterSource
 
 $sortable = false
 

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( FOFForm  $form = null)

Method to instantiate the form field object.

Paramètres
FOFForm$formThe form to attach to the form field object.
Depuis
2.0

Références $form.

Documentation des fonctions membres

◆ __get()

__get (   $name)

Method to get certain otherwise inaccessible properties from the form field object.

Paramètres
string$nameThe property name for which to the the value.
Renvoie
mixed The property value or null.
Depuis
2.0

Références $buttons, $filter, $label, $name, $options, $value, null, et value.

◆ getButtons()

getButtons ( )
protected

Returns the HTML for the buttons to be rendered in the filter row, next to the text input filter, or null if this element should render no text input filter buttons.

Renvoie
string|null HTML code or null if nothing is to be rendered
Depuis
2.0

Références null.

◆ getFieldName()

getFieldName (   $fieldName)
protected

Method to get the field name used.

Paramètres
string$fieldNameThe field element name.
Renvoie
string The field name
Depuis
2.0

◆ getFilter()

getFilter ( )
protected

Returns the HTML for a text filter to be rendered in the filter row, or null if this element should render no text input filter.

Renvoie
string|null HTML code or null if nothing is to be rendered
Depuis
2.0

Références null.

◆ getFilterSource()

getFilterSource (   $filterSource)
protected

Return the key of the filter value in the model state or, if it's not set, the name of the field.

Paramètres
string$filterSourceThe filter source value to return
Renvoie
string

Références $name.

◆ getHeader()

getHeader ( )
protected

Returns the HTML for the header row, or null if this element should render no header element

Renvoie
string|null HTML code or null if nothing is to be rendered
Depuis
2.0

Références null.

◆ getId()

getId (   $fieldId,
  $fieldName 
)
protected

Method to get the id used for the field input tag.

Paramètres
string$fieldIdThe field element id.
string$fieldNameThe field element name.
Renvoie
string The id to be used for the field input tag.
Depuis
2.0

Références $id.

◆ getLabel()

getLabel ( )
protected

Method to get the field label.

Renvoie
string The field label.
Depuis
2.0

Références $params, $title, $view, et FOFInflector\pluralize().

◆ getName()

getName (   $fieldName)
protected

Method to get the name used for the field input tag.

Paramètres
string$fieldNameThe field element name.
Renvoie
string The name to be used for the field input tag.
Depuis
2.0

Références $groups, et $name.

◆ getOptions()

getOptions ( )
protected

Returns the JHtml options for a drop-down filter. Do not include an empty option, it is added automatically.

Renvoie
array The JHtml options for a drop-down filter
Depuis
2.0

◆ getSortable()

getSortable ( )
protected

Is this a sortable field?

Renvoie
boolean True if it's sortable

◆ getValue()

getValue ( )
protected

Get the filter value for this header field

Renvoie
mixed The filter value

◆ setForm()

setForm ( FOFForm  $form)

Method to attach a JForm object to the field.

Paramètres
FOFForm$formThe JForm object to attach to the form field.
Renvoie
FOFFormHeader The form field object so that the method can be used in a chain.
Depuis
2.0

Références $form.

◆ setup()

setup ( SimpleXMLElement  $element,
  $value,
  $group = null 
)

Method to attach a FOFForm object to the field.

Paramètres
SimpleXMLElement$elementThe SimpleXMLElement object representing the <field> tag for the form field object.
mixed$valueThe form field value to validate.
string$groupThe field name group control value. This acts as an array container for the field. For example if the field has name="foo" and the group value is set to "bar" then the full field name would end up being "bar[foo]".
Renvoie
boolean True on success.
Depuis
2.0

Références $class, $id, $name, description, name, null, et value.

Documentation des champs

◆ $buttons

$buttons
protected

◆ $description

$description
protected

◆ $element

$element
protected

◆ $fieldname

$fieldname
protected

◆ $filter

$filter
protected

◆ $filterSource

$filterSource
protected

◆ $form

$form
protected

◆ $group

$group
protected

◆ $header

$header
protected

◆ $label

$label
protected

◆ $name

$name
protected

◆ $options

$options
protected

◆ $sortable

$sortable = false
protected

◆ $tdwidth

$tdwidth
protected

◆ $type

$type
protected

◆ $value

$value
protected

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