| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2009 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 1346 lines (40 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| __construct($form = null) X-Ref |
| Method to instantiate the form field object. param: Form $form The form to attach to the form field object. |
| __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 |
| setForm(Form $form) X-Ref |
| Method to attach a Form object to the field. param: Form $form The Form object to attach to the form field. return: FormField The form field object so that the method can be used in a chain. |
| 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. This acts as as an array container for the field. return: boolean True on success. |
| setValue($value) X-Ref |
| Simple method to set the value param: mixed $value Value to set return: void |
| getId($fieldId, $fieldName) X-Ref |
| Method to get the id used for the field input tag. param: string $fieldId The field element id. param: string $fieldName The field element name. return: string The id to be used for the field input tag. |
| getInput() X-Ref |
| Method to get the field input markup. return: string The field input markup. |
| getTitle() X-Ref |
| Method to get the field title. return: string The field title. |
| getLabel() X-Ref |
| Method to get the field label markup. return: string The field label 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. |
| getFieldName($fieldName) X-Ref |
| Method to get the field name used. param: string $fieldName The field element name. return: string The field name |
| getAttribute($name, $default = null) X-Ref |
| Method to get an attribute of the field param: string $name Name of the attribute to get param: mixed $default Optional value to return if attribute not found return: mixed Value of the attribute / default |
| getDataAttributes() X-Ref |
| Method to get data attributes. For example, data-user-type return: array list of data attribute(s) |
| renderDataAttributes() X-Ref |
| Method to render data attributes to html. return: string A HTML Tag Attribute string of data attribute(s) |
| render($layoutId, $data = array() X-Ref |
| Render a layout of this field param: string $layoutId Layout identifier param: array $data Optional data for the layout return: string |
| renderField($options = array() X-Ref |
| Method to get a control group with label and input. param: array $options Options to be passed into the rendering of the field return: string A string containing the html for the control group |
| 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. |
| validate($value, $group = null, Registry $input = null) X-Ref |
| Method to validate a FormField object based on field data. 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 validate return: boolean|\Exception Boolean true if field value is valid, Exception on failure. |
| postProcess($value, $group = null, Registry $input = null) X-Ref |
| Method to post-process 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 processed value. |
| getLayoutData() X-Ref |
| Method to get the data to be passed to the layout for rendering. return: array |
| getLayoutPaths() X-Ref |
| Allow to override renderer include paths in child fields return: array |
| getRenderer($layoutId = 'default') X-Ref |
| Get the renderer param: string $layoutId Id to load return: FileLayout |
| isDebugEnabled() X-Ref |
| Is debug enabled for this field return: boolean |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |