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
JFormRuleContactEmailSubject
JFormRuleContactEmailMessage
JFormRuleBoolean Form Rule class for the Joomla Platform.
JFormRuleUsername Form Rule class for the Joomla Platform.
JFormRuleEmail Form Rule class for the Joomla Platform.
JFormRuleRules Form Rule class for the Joomla Platform.
JFormRuleUrl Form Rule class for the Joomla Platform.
JFormRuleColor Form Rule class for the Joomla Platform.
JFormRuleTel Form Rule class for the Joomla Platform
JFormRuleEquals Form Rule class for the Joomla Platform.
JFormRuleOptions Form Rule class for the Joomla Platform.
JFormRuleCaptcha Form Rule class for the Joomla Framework.
JFormRulePrefix Form Rule class for the prefix DB.
Variable Summary
string $modifiers
string $regex
Method Summary
boolean test (object &$element, mixed $value, [string $group = null], [object &$input = null], [object &$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: JException on invalid rule.
  • access: public
boolean test (object &$element, mixed $value, [string $group = null], [object &$input = null], [object &$form = null])
  • object &$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]".
  • object &$input: An optional JRegistry object with the entire data set to validate against the entire form.
  • object &$form: The form object for which the field is being tested.

Redefined in descendants as:

Documentation generated on Mon, 25 Jun 2012 13:59:21 -0500 by phpDocumentor 1.4.4