Class JFormRuleContactEmailMessage

Description
Description | Vars | Methods (details)

JFormRule for com_contact to make sure the message body contains no banned word.

Located in /components/com_contact/models/rules/contactemailmessage.php (line 18) 

JFormRule
   |
   --JFormRuleContactEmailMessage
Method Summary
Description | Vars | Methods (details)
boolean test (SimpleXMLElement $element, mixed $value, [string $group = null], [JRegistry $input = null], [JForm $form = null])
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JFormRule

JFormRule::$modifiers
 JFormRule::$regex
Methods
Description | Vars Methods (details)
test (line 33)

Method to test a message for banned words

  • return: True if the value is valid, false otherwise.
  • 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.
Redefinition of:
JFormRule::test()
Method to test the value.

Inherited Methods

Inherited From JFormRule

JFormRule::test()

Documentation generated on Tue, 19 Nov 2013 14:56:42 +0100 by phpDocumentor 1.4.3