Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class SubformField - list of methods

The Field to load the form inside current form

Extends

FormField

Direct known subclasses

AccessiblemediaField
Package: Joomla\CMS\Form\Field
Copyright: (C) 2016 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Form/Field/SubformField.php
Project: Joomla

Method Summary

public mixed
__get
(mixed $name)

Method to get certain otherwise inaccessible properties from the form field object.
Parameters
  • string $name The property name for which to get the value.
Returns
  • mixed The property value or null.
Since
  • 3.6
Show source code of this method: __get Source Code

public void
__set
(mixed $name, mixed $value)

Method to set certain otherwise inaccessible properties of the form field object.
Parameters
  • string $name The property name for which to set the value.
  • mixed $value The value of the property.
Returns
  • void
Since
  • 3.6
Show source code of this method: __set Source Code

public bool
(\SimpleXMLElement $element, mixed $value, mixed $group = null)

Method to attach a Form object to the field.
Parameters
  • \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.
Returns
  • bool True on success.
Since
  • 3.6
Show source code of this method: setup Source Code

protected string
()

Method to get the field input markup.
Returns
  • string The field input markup.
Since
  • 3.6
Show source code of this method: getInput Source Code

protected string
(mixed $fieldName)

Method to get the name used for the field input tag.
Parameters
  • string $fieldName The field element name.
Returns
  • string The name to be used for the field input tag.
Since
  • 3.6
Show source code of this method: getName Source Code

public \Joomla\CMS\Form\Form
()

Loads the form instance for the subform.
Returns
  • \Joomla\CMS\Form\Form The form instance.
Since
  • 3.9.7
-
  • \InvalidArgumentException if no form provided.
  • \RuntimeException if the form could not be loaded.
Show source code of this method: loadSubForm Source Code

protected \Joomla\CMS\Form\Form[]
(\Joomla\CMS\Form\Form $subForm)

Binds given data to the subform and its elements.
Parameters
  • \Joomla\CMS\Form\Form $subForm Form instance of the subform.
Returns
  • \Joomla\CMS\Form\Form[] Array of Form instances for the rows.
Since
  • 3.9.7
Show source code of this method: loadSubFormData Source Code

public mixed
(mixed $value, mixed $group = null, \Joomla\Registry\Registry $input = null)

Method to filter a field value.
Parameters
  • 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.
  • \Joomla\Registry\Registry $input An optional Registry object with the entire data set to filter against the entire form.
Returns
  • mixed The filtered value.
Since
  • 4.0.0
-
  • \UnexpectedValueException
Show source code of this method: filter Source Code

Properties Summary

protected string
$type
The form field type.
protected string
$formsource
Form source
protected int
$min
Minimum items in repeat mode
protected int
$max
Maximum items in repeat mode
protected string
$layout
Layout to render the form
protected bool
$groupByFieldset
Whether group subform fields by it`s fieldset
protected array
$buttons
Which buttons to show in multiple mode

Tags Summary

Since
3.6