JFormFieldCategory
Extends \JFormFieldListForm Field class for the Joomla Platform.
Supports an HTML select list of categories
package |
Joomla.Platform |
---|---|
subpackage |
Form |
since |
11.1 |
Methods
__construct
Method to instantiate the form field object.
__construct(object $form = null)
since |
11.1 |
---|
Arguments
- $form
object
The form to attach to the form field object.
__get
Method to get certain otherwise inaccessible properties from the form field object.
__get(string $name) : mixed
since |
11.1 |
---|
Arguments
- $name
string
The property name for which to the the value.
Response
mixed
The property value or null.
getFieldName
Method to get the field name used.
getFieldName(string $fieldName) : string
since |
11.1 |
---|
Arguments
- $fieldName
string
The field element name.
Response
string
The field name
getId
Method to get the id used for the field input tag.
getId(string $fieldId, string $fieldName) : string
since |
11.1 |
---|
Arguments
- $fieldId
string
The field element id.- $fieldName
string
The field element name.
Response
string
The id to be used for the field input tag.
getInput
Method to get the field input markup.
getInput() : string
since |
11.1 |
---|
Response
string
The field input markup.
getLabel
Method to get the field label markup.
getLabel() : string
since |
11.1 |
---|
Response
string
The field label markup.
getName
Method to get the name used for the field input tag.
getName(string $fieldName) : string
since |
11.1 |
---|
Arguments
- $fieldName
string
The field element name.
Response
string
The name to be used for the field input tag.
getOptions
Method to get the field options.
getOptions() : array
since |
11.1 |
---|
Response
array
The field option objects.
getTitle
Method to get the field title.
getTitle() : string
since |
11.1 |
---|
Response
string
The field title.
setForm
Method to attach a JForm object to the field.
setForm(\JForm $form) : object
since |
11.1 |
---|
Arguments
- $form
\JForm
The JForm object to attach to the form field.
Response
object
The form field object so that the method can be used in a chain.
setup
Method to attach a JForm object to the field.
setup( &$element, mixed $value, string $group = null) : boolean
since |
11.1 |
---|
Arguments
- $element
- $value
mixed
The form field value to validate.- $group
string
The field name group control value. This acts as as an array container for the field. For example if the field has name="foo" and the group value is set to "bar" then the full field name would end up being "bar[foo]".
Response
boolean
True on success.
Properties
type
The form field type.
since |
11.1 |
---|
Type(s)
string
description
The description text for the form field. Usually used in tooltips.
since |
11.1 |
---|
Type(s)
string
element
The SimpleXMLElement object of the
since |
11.1 |
---|
Type(s)
\SimpleXMLElement
formControl
The form control prefix for field names from the JForm object attached to the form field.
since |
11.1 |
---|
Type(s)
string
translateLabel
True to translate the field label string.
since |
11.1 |
---|
Type(s)
boolean
translateDescription
True to translate the field description string.
since |
11.1 |
---|
Type(s)
boolean
id
The document id for the form field.
since |
11.1 |
---|
Type(s)
string
input
The input for the form field.
since |
11.1 |
---|
Type(s)
string
label
The label for the form field.
since |
11.1 |
---|
Type(s)
string
multiple
The multiple state for the form field. If true then multiple values are allowed for the field. Most often used for list field types.
since |
11.1 |
---|
Type(s)
boolean
name
The name of the form field.
since |
11.1 |
---|
Type(s)
string
fieldname
The name of the field.
since |
11.1 |
---|
Type(s)
string
group
The group of the field.
since |
11.1 |
---|
Type(s)
string
required
The required state for the form field. If true then there must be a value for the field to be considered valid.
since |
11.1 |
---|
Type(s)
boolean
validate
The validation method for the form field. This value will determine which method is used to validate the value for a field.
since |
11.1 |
---|
Type(s)
string
value
The value of the form field.
since |
11.1 |
---|
Type(s)
mixed
labelClass
The label's CSS class of the form field
since |
11.1 |
---|
Type(s)
mixed
count
The count value for generated name field
since |
11.1 |
---|
Type(s)
integer
generated_fieldname
The string used for generated fields names
since |
11.1 |
---|
Type(s)
integer