1. class
  2. Joomla
  3. CMS
  4. Form
  5. Rule
  6. OptionsRule

OptionsRule

class OptionsRule extends FormRule

Form Rule class for the Joomla Platform.

Requires the value entered be one of the options in a field of type="list"

Methods

boolean
test( SimpleXMLElement $element, mixed $value, string $group = null, Registry $input = null, Form $form = null)

Method to test the value.

Details

boolean test( SimpleXMLElement $element, mixed $value, string $group = null, Registry $input = null, Form $form = null)

Method to test the value.

Parameters

SimpleXMLElement $element The SimpleXMLElement object representing the <field> tag for the form field object.
mixed $value The form field value to validate.
string $group 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]".
Registry $input An optional Registry object with the entire data set to validate against the entire form.
Form $form The form object for which the field is being tested.

Return Value

boolean True if the value is valid, false otherwise.