Class JFormRuleCaptcha

Form Rule class for the Joomla Framework.

JFormRule

JFormRuleCaptcha

Package: Joomla\Libraries\Form
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 2.5
Located at cms/form/rule/captcha.php

Methods summary

`public boolean`	# `test( SimpleXMLElement $element, mixed $value, string $group = null, Joomla\Registry\Registry $input = null, JForm $form = null )` Method to test if the Captcha is correct. Method to test if the Captcha is correct. 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 2.5 Overrides `JFormRule::test`