1 <?php
2 /**
3 * @package Joomla.Libraries
4 * @subpackage Form
5 *
6 * @copyright Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
7 * @license GNU General Public License version 2 or later; see LICENSE.txt
8 */
9
10 defined('JPATH_PLATFORM') or die;
11
12 use Joomla\Registry\Registry;
13
14 /**
15 * Form Rule class for the Joomla Framework.
16 *
17 * @since 2.5
18 */
19 class JFormRuleCaptcha extends JFormRule
20 {
21 /**
22 * Method to test if the Captcha is correct.
23 *
24 * @param SimpleXMLElement $element The SimpleXMLElement object representing the `<field>` tag for the form field object.
25 * @param mixed $value The form field value to validate.
26 * @param string $group The field name group control value. This acts as an array container for the field.
27 * For example if the field has name="foo" and the group value is set to "bar" then the
28 * full field name would end up being "bar[foo]".
29 * @param Registry $input An optional Registry object with the entire data set to validate against the entire form.
30 * @param JForm $form The form object for which the field is being tested.
31 *
32 * @return boolean True if the value is valid, false otherwise.
33 *
34 * @since 2.5
35 */
36 public function test(SimpleXMLElement $element, $value, $group = null, Registry $input = null, JForm $form = null)
37 {
38 $app = JFactory::getApplication();
39 $plugin = $app->get('captcha');
40
41 if ($app->isClient('site'))
42 {
43 $plugin = $app->getParams()->get('captcha', $plugin);
44 }
45
46 $namespace = $element['namespace'] ?: $form->getName();
47
48 // Use 0 for none
49 if ($plugin === 0 || $plugin === '0')
50 {
51 return true;
52 }
53 else
54 {
55 $captcha = JCaptcha::getInstance((string) $plugin, array('namespace' => (string) $namespace));
56 }
57
58 // Test the value.
59 if (!$captcha->checkAnswer($value))
60 {
61 $error = $captcha->getError();
62
63 if ($error instanceof Exception)
64 {
65 return $error;
66 }
67 else
68 {
69 return new JException($error);
70 }
71 }
72
73 return true;
74 }
75 }
76