PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of SubformField.php

Joomla! Content Management System

Copyright:	(C) 2016 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	451 lines (14 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

SubformField:: (8 methods):
  __get()
  __set()
  setup()
  getInput()
  getName()
  loadSubForm()
  loadSubFormData()
  filter()

Class: SubformField - X-Ref

The Field to load the form inside current form

__get($name) X-Ref

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

param: string $name The property name for which to get the value.
return: mixed The property value or null.

__set($name, $value) X-Ref

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

param: string $name The property name for which to set the value.
param: mixed $value The value of the property.
return: void

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

Method to attach a Form object to the field.

param: \SimpleXMLElement  $element  The SimpleXMLElement object representing the <field /> tag for the form field object.
param: mixed              $value    The form field value to validate.
param: string             $group    The field name group control value.
return: boolean  True on success.

getInput() X-Ref

Method to get the field input markup.

return: string The field input markup.

getName($fieldName) X-Ref

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

param: string $fieldName The field element name.
return: string The name to be used for the field input tag.

loadSubForm() X-Ref

Loads the form instance for the subform.

return: Form The form instance.

loadSubFormData(Form $subForm) X-Ref

Binds given data to the subform and its elements.

param: Form $subForm Form instance of the subform.
return: Form[] Array of Form instances for the rows.

filter($value, $group = null, Registry $input = null) X-Ref

Method to filter a field value.

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

PHP Cross Reference of Joomla 4.2.2 documentation

/libraries/src/Form/Field/ -> SubformField.php (summary)

Defines 1 class