Class JFormRule

Description

Form Rule class for the Joomla Platform.

  • since: 11.1

Located in /libraries/joomla/form/rule.php (line 25)


	
			
Direct descendents
Class Description
 class JFormRuleContactEmailMessage JFormRule for com_contact to make sure the message body contains no banned word.
 class JFormRuleContactEmailSubject JFormRule for com_contact to make sure the subject contains no banned word.
 class JFormRulePrefix Form Rule class for the prefix DB.
 class JFormRuleCaptcha Form Rule class for the Joomla Framework.
 class JFormRuleNotequals Form Rule class for the Joomla Platform.
 class JFormRulePassword Form Rule class for the Joomla Platform.
 class JFormRuleBoolean Form Rule class for the Joomla Platform.
 class JFormRuleColor Form Rule class for the Joomla Platform.
 class JFormRuleEmail Form Rule class for the Joomla Platform.
 class JFormRuleEquals Form Rule class for the Joomla Platform.
 class JFormRuleOptions Form Rule class for the Joomla Platform.
 class JFormRuleRules Form Rule class for the Joomla Platform.
 class JFormRuleTel Form Rule class for the Joomla Platform
 class JFormRuleUrl Form Rule class for the Joomla Platform.
 class JFormRuleUsername Form Rule class for the Joomla Platform.
Variable Summary
 string $modifiers
 string $regex
Method Summary
 boolean test (SimpleXMLElement $element, mixed $value, [string $group = null], [JRegistry $input = null], [JForm $form = null])
Variables
string $modifiers (line 41)

The regular expression modifiers to use when testing a form field value.

  • since: 11.1
  • access: protected

Redefined in descendants as:
string $regex (line 33)

The regular expression to use in testing a form field value.

  • since: 11.1
  • access: protected

Redefined in descendants as:
Methods
test (line 59)

Method to test the value.

  • return: True if the value is valid, false otherwise.
  • since: 11.1
  • throws: UnexpectedValueException if rule is invalid.
  • access: public
boolean test (SimpleXMLElement $element, mixed $value, [string $group = null], [JRegistry $input = null], [JForm $form = null])
  • 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]".
  • JRegistry $input: An optional JRegistry object with the entire data set to validate against the entire form.
  • JForm $form: The form object for which the field is being tested.

Redefined in descendants as:

Documentation generated on Tue, 19 Nov 2013 15:12:32 +0100 by phpDocumentor 1.4.3