Référence de la classe SubformField

Graphe d'héritage de SubformField:

Fonctions membres publiques
	__get ($name)
	__set ($name, $value)
	setup (\SimpleXMLElement $element, $value, $group=null)
	loadSubForm ()
	filter ($value, $group=null, Registry $input=null)
Fonctions membres publiques hérités de FormField
	__construct ($form=null)
	__get ($name)
	__set ($name, $value)
	setForm (Form $form)
	setup (\SimpleXMLElement $element, $value, $group=null)
	setValue ($value)
	getAttribute ($name, $default=null)
	getDataAttributes ()
	renderDataAttributes ()
	render ($layoutId, $data=array())
	renderField ($options=array())
	filter ($value, $group=null, Registry $input=null)
	validate ($value, $group=null, Registry $input=null)
	postProcess ($value, $group=null, Registry $input=null)
Fonctions membres publiques hérités de DatabaseAwareInterface
	setDatabase (DatabaseInterface $db)

Fonctions membres protégées
	getInput ()
	getName ($fieldName)
	loadSubFormData (Form $subForm)
Fonctions membres protégées hérités de FormField
	getId ($fieldId, $fieldName)
	getInput ()
	getTitle ()
	getLabel ()
	getName ($fieldName)
	getFieldName ($fieldName)
	getLayoutData ()
	getLayoutPaths ()
	getRenderer ($layoutId='default')
	isDebugEnabled ()

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)
Attributs protégés hérités de FormField
	$description
	$hint
	$autocomplete = 'on'
	$spellcheck = true
	$autofocus = false
	$element
	$form
	$formControl
	$hidden = false
	$hiddenLabel = false
	$hiddenDescription = false
	$translateLabel = true
	$translateDescription = true
	$translateHint = true
	$id
	$input
	$label
	$multiple = false
	$pattern
	$validationtext
	$name
	$fieldname
	$group
	$required = false
	$disabled = false
	$readonly = false
	$type
	$validate
	$value
	$default
	$size
	$class
	$labelclass
	$onchange
	$onclick
	$showon
	$parentclass
	$layout
	$renderLayout = 'joomla.form.renderfield'
	$renderLabelLayout = 'joomla.form.renderlabel'
	$dataAttributes = array()

Membres hérités additionnels
Champs de données hérités de FormField
	$repeat = false
Attributs protégés statiques hérités de FormField
static	$count = 0
static	$generated_fieldname = '__field'

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

$name

The 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	$name	The property name for which to set the value.
mixed	$value	The value of the property.

Renvoie

void

Depuis

3.6

Références $name, $value, Path\clean(), JPATH_ROOT, null, et value.

filter()

filter	(		$value,
			$group = null,
		Registry	$input = null
	)

Method to filter a field value.

Paramètres

mixed	$value	The optional value to use as the default for the field.
string	$group	The optional dot-separated form group path on which to find the field.
Registry	$input	An optional Registry object with the entire data set to filter against the entire form.

Renvoie

mixed The filtered value.

Depuis

4.0.0

Exceptions

Références $input, $key, $return, $this, $val, $value, 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, $id, $name, $renderer, $tmpl, name, et null.

getName()

getName (   $fieldName )

protected

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

Paramètres

string

$fieldName

The 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

Références $control, $name, $tmpl, Form\getInstance(), et name.

loadSubFormData()

loadSubFormData ( Form  $subForm )

protected

Binds given data to the subform and its elements.

Paramètres

Form

$subForm

Form instance of the subform.

Renvoie

Form[] Array of Form instances for the rows.

Depuis

3.9.7

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

setup()

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

Method to attach a Form object to the field.

Paramètres

\SimpleXMLElement	$element	The SimpleXMLElement object representing the <field> tag for the form field object.
mixed	$value	The form field value to validate.
string	$group	The 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 multiple 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 :

• SubformField.php