Class JFormFieldRules

Form Field class for the Joomla Platform. Field for assigning permissions to groups for a given asset

JFormField

JFormFieldRules

Direct known subclasses

FOFFormFieldRules

Package: Joomla\Platform\Form
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
See: JAccess
Located at joomla/form/fields/rules.php

Methods summary

`public mixed`	# `__get( string $name )` Method to get certain otherwise inaccessible properties from the form field object. Method to get certain otherwise inaccessible properties from the form field object. Parameters `$name` `string` - $name The property name for which to the the value. Returns `mixed` - The property value or null. Since 3.2 Overrides `JFormField::__get`
`public`	# `__set( string $name, mixed $value )` Method to set certain otherwise inaccessible properties of the form field object. Method to set certain otherwise inaccessible properties of the form field object. Parameters `$name` `string` - $name The property name for which to the the value. `$value` `mixed` - $value The value of the property. Since 3.2 Overrides `JFormField::__set`
`public boolean`	# `setup( SimpleXMLElement $element, mixed $value, string $group = null )` Method to attach a JForm object to the field. Method to attach a JForm object to the field. Parameters `$element` `SimpleXMLElement` - $element The SimpleXMLElement object representing the `<field>` tag for the form field object. `$value` `mixed` - $value The form field value to validate. `$group` `string` - $group The field name group control value. This acts 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]". Returns `boolean` - True on success. Since 3.2 See `JFormField::setup()` Overrides `JFormField::setup`
`protected string`	# `getInput( )` Method to get the field input markup for Access Control Lists. Optionally can be associated with a specific component and section. Method to get the field input markup for Access Control Lists. Optionally can be associated with a specific component and section. Returns `string` - The field input markup. Since 11.1 Todo: Add access check. Overrides `JFormField::getInput`
`protected array`	# `getUserGroups( )` Get a list of the user groups. Get a list of the user groups. Returns `array` Since 11.1

Methods inherited from JFormField

__construct(), getAttribute(), getControlGroup(), getFieldName(), getId(), getLabel(), getLayoutData(), getLayoutPaths(), getName(), getRenderer(), getTitle(), isDebugEnabled(), render(), renderField(), setForm(), setValue()

Magic methods summary

Properties summary

`protected string`	`$type`	# The form field type. The form field type. Since 11.1
`protected string`	`$section`	# The section. The section. Since 3.2
`protected string`	`$component`	# The component. The component. Since 3.2
`protected string`	`$assetField`	# The assetField. The assetField. Since 3.2

Properties inherited from JFormField

$autocomplete, $autofocus, $class, $count, $default, $description, $disabled, $element, $fieldname, $form, $formControl, $generated_fieldname, $group, $hidden, $hint, $id, $input, $label, $labelclass, $layout, $multiple, $name, $onchange, $onclick, $pattern, $readonly, $renderLabelLayout, $renderLayout, $repeat, $required, $showon, $size, $spellcheck, $translateDescription, $translateHint, $translateLabel, $validate, $value

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JFormFieldRules

Direct known subclasses

Methods summary

Parameters

Returns

Since

Overrides

Parameters

Since

Overrides

Parameters

Returns

Since

See

Overrides

Returns

Since

Todo:

Overrides

Returns

Since

Methods inherited from JFormField

Magic methods summary

Properties summary

Since

Since

Since

Since

Properties inherited from JFormField