Class JFormRuleRules

Form Rule class for the Joomla Platform.

JFormRule

JFormRuleRules

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
Located at joomla/form/rule/rules.php

Methods summary

`public boolean`	# `test( SimpleXMLElement $element, mixed $value, string $group = null, Joomla\Registry\Registry $input = null, JForm $form = null )` Method to test the value. Method to test the value. 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]". `$input` `Joomla\Registry\Registry` - $input An optional Registry object with the entire data set to validate against the entire form. `$form` `JForm` - $form The form object for which the field is being tested. Returns `boolean` - True if the value is valid, false otherwise. Throws `UnexpectedValueException` - if rule is invalid. Since 11.1 Overrides `JFormRule::test`
`protected array`	# `getValueActions( mixed $value )` Method to get the list of permission action names from the form field value. Method to get the list of permission action names from the form field value. Parameters `$value` `mixed` - $value The form field value to validate. Returns `array` - A list of permission action names from the form field value. Since 11.1
`protected array`	# `getFieldActions( SimpleXMLElement $element )` Method to get the list of possible permission action names for the form field. Method to get the list of possible permission action names for the form field. Parameters `$element` `SimpleXMLElement` - $element The SimpleXMLElement object representing the `<field>` tag for the form field object. Returns `array` - A list of permission action names from the form field element definition. Since 11.1

Magic methods summary

Properties summary

Properties inherited from JFormRule

$modifiers, $regex

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JFormRuleRules

Methods summary

Parameters

Returns

Throws

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

Magic methods summary

Properties summary

Properties inherited from JFormRule