1 <?php
2 /**
3 * @package Joomla.Platform
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
8 */
9
10 defined('JPATH_PLATFORM') or die;
11
12 use Joomla\Registry\Registry;
13
14 /**
15 * Form Rule class for the Joomla Platform.
16 *
17 * @since 11.2
18 */
19 class JFormRuleColor extends JFormRule
20 {
21 /**
22 * Method to test for a valid color in hexadecimal.
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 11.2
35 */
36 public function test(SimpleXMLElement $element, $value, $group = null, Registry $input = null, JForm $form = null)
37 {
38 $value = trim($value);
39
40 // If the field is empty and not required, the field is valid.
41 $required = ((string) $element['required'] == 'true' || (string) $element['required'] == 'required');
42
43 if (!$required && empty($value))
44 {
45 return true;
46 }
47
48 if ($value[0] != '#')
49 {
50 return false;
51 }
52
53 // Remove the leading # if present to validate the numeric part
54 $value = ltrim($value, '#');
55
56 // The value must be 6 or 3 characters long
57 if (!((strlen($value) == 6 || strlen($value) == 3) && ctype_xdigit($value)))
58 {
59 return false;
60 }
61
62 return true;
63 }
64 }
65