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

Fonctions membres publiques

 __get ($name)
 
 __set ($name, $value)
 
 setup (SimpleXMLElement $element, $value, $group=null)
 
 loadSubForm ()
 

Fonctions membres protégées

 getInput ()
 
 getName ($fieldName)
 

Attributs protégés

 $type = 'Subform'
 
 $formsource
 
 $min = 0
 
 $max = 1000
 
 $layout = 'joomla.form.field.subform.default'
 
 $groupByFieldset = false
 
 $buttons = array('add' => true, 'remove' => true, 'move' => true)
 

Fonctions membres privées

 loadSubFormData (Form &$subForm)
 

Description détaillée

The Field to load the form inside current form

with all attributes: <field name="field-name" type="subform" formsource="path/to/form.xml" min="1" max="3" multiple="true" buttons="add,remove,move" layout="joomla.form.field.subform.repeatable-table" groupbyfieldset="false" component="com_example" client="site" label="Field Label" description="Field Description">

Depuis
3.6

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 get the value.
Renvoie
mixed The property value or null.
Depuis
3.6

Références $name.

◆ __set()

__set (   $name,
  $value 
)

Method to set certain otherwise inaccessible properties of the form field object.

Paramètres
string$nameThe property name for which to set the value.
mixed$valueThe value of the property.
Renvoie
void
Depuis
3.6

Références $name, $value, JPATH_ROOT, et null.

◆ getInput()

getInput ( )
protected

Method to get the field input markup.

Renvoie
string The field input markup.
Depuis
3.6

For each rendering process of a subform element, we want to have a separate unique subform id present to could distinguish the eventhandlers regarding adding/moving/removing rows from nested subforms from their parents.

Références $buttons, $control, $data, $html, $name, $renderer, $tmpl, name, et null.

◆ 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
3.6

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

◆ loadSubForm()

loadSubForm ( )

Loads the form instance for the subform.

Renvoie
Form The form instance.
Exceptions
InvalidArgumentExceptionif no form provided.
RuntimeExceptionif the form could not be loaded.
Depuis
3.9.7

Références $control, $name, $tmpl, et name.

◆ loadSubFormData()

loadSubFormData ( Form $subForm)
private

Binds given data to the subform and its elements.

Paramètres
Form&$subFormForm instance of the subform.
Renvoie
Form[] Array of Form instances for the rows.
Depuis
3.9.7

Références $control, $i, $value, Form\bind(), Form\getName(), name, et value.

◆ setup()

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

Method to attach a JForm 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.
Renvoie
boolean True on success.
Depuis
3.6

Références $value, et value.

Documentation des champs

◆ $buttons

array $buttons = array('add' => true, 'remove' => true, 'move' => true)
protected

Which buttons to show in miltiple mode

◆ $formsource

$formsource
protected

◆ $groupByFieldset

$groupByFieldset = false
protected

◆ $layout

$layout = 'joomla.form.field.subform.default'
protected

◆ $max

$max = 1000
protected

◆ $min

$min = 0
protected

◆ $type

$type = 'Subform'
protected

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