Joomla! API

Download
Launch

UserField

Extends FormField

Field to select a user ID from a modal list.

since

1.6
package

Joomla CMS

Methods

__construct

Method to instantiate the form field object.

__construct(\Joomla\CMS\Form\Form form = null) : mixed
inherited
since

1.7.0

Arguments

form

\Joomla\CMS\Form\FormThe form to attach to the form field object.

Response

mixed

__get

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

__get(string name) : mixed
inherited
since

1.7.0

Arguments

name

stringThe property name for which to get the value.

Response

mixedThe property value or null.

__set

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

__set(string name, mixed value) : void
inherited
since

3.2

Arguments

name

stringThe property name for which to set the value.

value

mixedThe value of the property.

filter

Method to filter a field value.

filter(mixed value, string group = null, \Joomla\Registry\Registry input = null) : mixed
inherited
since

4.0.0
throws

\UnexpectedValueException

Arguments

value

mixedThe optional value to use as the default for the field.

group

stringThe optional dot-separated form group path on which to find the field.

input

\Joomla\Registry\RegistryAn optional Registry object with the entire data set to filter against the entire form.

Response

mixedThe filtered value.

getAttribute

Method to get an attribute of the field

getAttribute(string name, mixed default = null) : mixed
inherited
since

3.2

Arguments

name

stringName of the attribute to get

default

mixedOptional value to return if attribute not found

Response

mixedValue of the attribute / default

getDataAttributes

Method to get data attributes. For example, data-user-type

getDataAttributes() : array
inherited
since

4.0.0

Response

arraylist of data attribute(s)

getExcluded

Method to get the users to exclude from the list of users

getExcluded() : mixed
since

1.6

Response

mixedArray of users to exclude or null to to not exclude them

getFieldName

Method to get the field name used.

getFieldName(string fieldName) : string
inherited
since

1.7.0

Arguments

fieldName

stringThe field element name.

Response

stringThe field name

getGroups

Method to get the filtering groups (null means no filtering)

getGroups() : mixed
since

1.6

Response

mixedArray of filtering groups or null.

getId

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

getId(string fieldId, string fieldName) : string
inherited
since

1.7.0

Arguments

fieldId

stringThe field element id.

fieldName

stringThe field element name.

Response

stringThe id to be used for the field input tag.

getInput

Method to get the field input markup.

getInput() : string
inherited
since

1.7.0

Response

stringThe field input markup.

getLabel

Method to get the field label markup.

getLabel() : string
inherited
since

1.7.0

Response

stringThe field label markup.

getLayoutData

Method to get the data to be passed to the layout for rendering.

getLayoutData() : array
inherited
since

3.5

Response

array

getLayoutPaths

Allow to override renderer include paths in child fields

getLayoutPaths() : array
inherited
since

3.5

Response

array

getName

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

getName(string fieldName) : string
inherited
since

1.7.0

Arguments

fieldName

stringThe field element name.

Response

stringThe name to be used for the field input tag.

getRenderer

Get the renderer

getRenderer(string layoutId = 'default') : \Joomla\CMS\Layout\FileLayout
inherited
since

3.5

Arguments

layoutId

stringId to load

Response

\Joomla\CMS\Layout\FileLayout

getTitle

Method to get the field title.

getTitle() : string
inherited
since

1.7.0

Response

stringThe field title.

isDebugEnabled

Is debug enabled for this field

isDebugEnabled() : bool
inherited
since

3.5

Response

bool

postProcess

Method to post-process a field value.

postProcess(mixed value, string group = null, \Joomla\Registry\Registry input = null) : mixed
inherited
since

4.0.0

Arguments

value

mixedThe optional value to use as the default for the field.

group

stringThe optional dot-separated form group path on which to find the field.

input

\Joomla\Registry\RegistryAn optional Registry object with the entire data set to filter against the entire form.

Response

mixedThe processed value.

render

Render a layout of this field

render(string layoutId, array data = []) : string
inherited
since

3.5

Arguments

layoutId

stringLayout identifier

data

arrayOptional data for the layout

Response

string

renderDataAttributes

Method to render data attributes to html.

renderDataAttributes() : string
inherited
since

4.0.0

Response

stringA HTML Tag Attribute string of data attribute(s)

renderField

Method to get a control group with label and input.

renderField(array options = []) : string
inherited
since

3.2

Arguments

options

arrayOptions to be passed into the rendering of the field

Response

stringA string containing the html for the control group

setForm

Method to attach a Form object to the field.

setForm(\Joomla\CMS\Form\Form form) : \Joomla\CMS\Form\FormField
inherited
since

1.7.0

Arguments

form

\Joomla\CMS\Form\FormThe Form object to attach to the form field.

Response

\Joomla\CMS\Form\FormFieldThe form field object so that the method can be used in a chain.

setup

Method to attach a Form object to the field.

setup(\SimpleXMLElement element, mixed value, string group = null) : bool
inherited
since

1.7.0

Arguments

element

\SimpleXMLElementThe SimpleXMLElement object representing the <field> tag for the form field object.

value

mixedThe form field value to validate.

group

stringThe 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

boolTrue on success.

setValue

Simple method to set the value

setValue(mixed value) : void
inherited
since

3.2

Arguments

value

mixedValue to set

validate

Method to validate a FormField object based on field data.

validate(mixed value, string group = null, \Joomla\Registry\Registry input = null) : bool|\Exception
inherited
since

4.0.0
throws

\InvalidArgumentException

\UnexpectedValueException

Arguments

value

mixedThe optional value to use as the default for the field.

group

stringThe optional dot-separated form group path on which to find the field.

input

\Joomla\Registry\RegistryAn optional Registry object with the entire data set to validate against the entire form.

Response

bool|\ExceptionBoolean true if field value is valid, Exception on failure.

Properties

type

The form field type.

inherited
since

1.7.0

Type(s)

string

groups

Filtering groups

since

3.5

Type(s)

array

excluded

Users to exclude from the list of users

since

3.5

Type(s)

array

layout

Name of the layout being used to render the field

inherited
since

3.5

Type(s)

string

description

The description text for the form field. Usually used in tooltips.

inherited
since

1.7.0

Type(s)

string

hint

The hint text for the form field used to display hint inside the field.

inherited
since

3.2

Type(s)

string

autocomplete

The autocomplete state for the form field. If 'off' element will not be automatically completed by browser.

inherited
since

3.2

Type(s)

mixed

spellcheck

The spellcheck state for the form field.

inherited
since

3.2

Type(s)

bool

autofocus

The autofocus request for the form field. If true element will be automatically focused on document load.

inherited
since

3.2

Type(s)

bool

element

The SimpleXMLElement object of the <field> XML element that describes the form field.

inherited
since

1.7.0

Type(s)

\SimpleXMLElement

form

The Form object of the form attached to the form field.

inherited
since

1.7.0

Type(s)

\Joomla\CMS\Form\Form

formControl

The form control prefix for field names from the Form object attached to the form field.

inherited
since

1.7.0

Type(s)

string

hidden

The hidden state for the form field.

inherited
since

1.7.0

Type(s)

bool

hiddenLabel

Should the label be hidden when rendering the form field? This may be useful if you have the label rendering in a legend in your form field itself for radio buttons in a fieldset etc.

inherited

If you use this flag you should ensure you display the label in your form (for a11y etc.)

since

4.0.0

Type(s)

bool

hiddenDescription

Should the description be hidden when rendering the form field? This may be useful if you have the description rendering in your form field itself for e.g. note fields.

inherited
since

4.0.0

Type(s)

bool

translateLabel

True to translate the field label string.

inherited
since

1.7.0

Type(s)

bool

translateDescription

True to translate the field description string.

inherited
since

1.7.0

Type(s)

bool

translateHint

True to translate the field hint string.

inherited
since

3.2

Type(s)

bool

id

The document id for the form field.

inherited
since

1.7.0

Type(s)

string

input

The input for the form field.

inherited
since

1.7.0

Type(s)

string

label

The label for the form field.

inherited
since

1.7.0

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.

inherited
since

1.7.0

Type(s)

bool

repeat

Allows extensions to create repeat elements

inherited
since

3.2

Type(s)

mixed

pattern

The pattern (Reg Ex) of value of the form field.

inherited
since

1.7.0

Type(s)

string

validationtext

The validation text of invalid value of the form field.

inherited
since

4.0.0

Type(s)

string

name

The name of the form field.

inherited
since

1.7.0

Type(s)

string

fieldname

The name of the field.

inherited
since

1.7.0

Type(s)

string

group

The group of the field.

inherited
since

1.7.0

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.

inherited
since

1.7.0

Type(s)

bool

disabled

The disabled state for the form field. If true then the field will be disabled and user can't interact with the field.

inherited
since

3.2

Type(s)

bool

readonly

The readonly state for the form field. If true then the field will be readonly.

inherited
since

3.2

Type(s)

bool

validate

The validation method for the form field. This value will determine which method is used to validate the value for a field.

inherited
since

1.7.0

Type(s)

string

value

The value of the form field.

inherited
since

1.7.0

Type(s)

mixed

default

The default value of the form field.

inherited
since

1.7.0

Type(s)

mixed

size

The size of the form field.

inherited
since

3.2

Type(s)

int

class

The class of the form field

inherited
since

3.2

Type(s)

mixed

labelclass

The label's CSS class of the form field

inherited
since

1.7.0

Type(s)

mixed

onchange

The javascript onchange of the form field.

inherited
since

3.2

Type(s)

string

onclick

The javascript onclick of the form field.

inherited
since

3.2

Type(s)

string

showon

The conditions to show/hide the field.

inherited
since

3.7.0

Type(s)

string

parentclass

The parent class of the field

inherited
since

4.0.0

Type(s)

string

count

The count value for generated name field

inherited static
since

1.7.0

Type(s)

int

generated_fieldname

The string used for generated fields names

inherited static
since

1.7.0

Type(s)

string

renderLayout

Layout to render the form field

inherited

Type(s)

string

renderLabelLayout

Layout to render the label

inherited

Type(s)

string

dataAttributes

The data-attribute name and values of the form field.

inherited

For example, data-action-type="click" data-action-type="change"

since

4.0.0

Type(s)

array
  • \ Joomla
  • \ CMS
  • \ Form
  • \ Field
  • \ UserField