Back to CaptchaRule class

Method test

public bool
test
(\SimpleXMLElement $element, mixed $value, mixed $group = null, \Joomla\Registry\Registry $input = null, \Joomla\CMS\Form\Form $form = null)
Method to test if the Captcha is correct.
Parameters
  • \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 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]".
  • \Joomla\Registry\Registry $input An optional Registry object with the entire data set to validate against the entire form.
  • \Joomla\CMS\Form\Form $form The form object for which the field is being tested.
Returns
  • bool True if the value is valid, false otherwise.
Since
  • 2.5
Class: CaptchaRule
Project: Joomla

Method test - Source code

/**
 * Method to test if the Captcha is correct.
 *
 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 * @param   mixed              $value    The form field value to validate.
 * @param   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]".
 * @param   Registry           $input    An optional Registry object with the entire data set to validate against the entire form.
 * @param   Form               $form     The form object for which the field is being tested.
 *
 * @return  boolean  True if the value is valid, false otherwise.
 *
 * @since   2.5
 */
public function test(\SimpleXMLElement $element, $value, $group = null, Registry $input = null, Form $form = null)
{
    $app = Factory::getApplication();
    $plugin = $app->get('captcha');
    if ($app->isClient('site')) {
        $plugin = $app->getParams()->get('captcha', $plugin);
    }
    $namespace = $element['namespace'] ?: $form->getName();
    // Use 0 for none
    if ($plugin === 0 || $plugin === '0') {
        return true;
    }
    try {
        $captcha = Captcha::getInstance((string) $plugin, array('namespace' => (string) $namespace));
        return $captcha->checkAnswer($value);
    } catch (\RuntimeException $e) {
        $app->enqueueMessage($e->getMessage(), 'error');
    }
    return false;
}