[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2017 Open Source Matters, Inc. <https://www.joomla.org>
   7   * @license    GNU General Public License version 2 or later; see LICENSE.txt
   8   */
   9  
  10  namespace Joomla\CMS\Form\Rule;
  11  
  12  use Joomla\CMS\Form\Form;
  13  use Joomla\CMS\Form\FormRule;
  14  use Joomla\Registry\Registry;
  15  
  16  // phpcs:disable PSR1.Files.SideEffects
  17  \defined('JPATH_PLATFORM') or die;
  18  // phpcs:enable PSR1.Files.SideEffects
  19  
  20  /**
  21   * Form Rule class for the Joomla Platform.
  22   *
  23   * @since  1.7.0
  24   */
  25  class ColorRule extends FormRule
  26  {
  27      /**
  28       * Method to test for a valid color in hexadecimal.
  29       *
  30       * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
  31       * @param   mixed              $value    The form field value to validate.
  32       * @param   string             $group    The field name group control value. This acts as an array container for the field.
  33       *                                       For example if the field has name="foo" and the group value is set to "bar" then the
  34       *                                       full field name would end up being "bar[foo]".
  35       * @param   Registry           $input    An optional Registry object with the entire data set to validate against the entire form.
  36       * @param   Form               $form     The form object for which the field is being tested.
  37       *
  38       * @return  boolean  True if the value is valid, false otherwise.
  39       *
  40       * @since   1.7.0
  41       */
  42      public function test(\SimpleXMLElement $element, $value, $group = null, Registry $input = null, Form $form = null)
  43      {
  44          $value = trim($value);
  45  
  46          // If the field is empty and not required, the field is valid.
  47          $required = ((string) $element['required'] === 'true' || (string) $element['required'] === 'required');
  48  
  49          if (!$required && empty($value)) {
  50              return true;
  51          }
  52  
  53          if ($value[0] != '#') {
  54              return false;
  55          }
  56  
  57          // Remove the leading # if present to validate the numeric part
  58          $value = ltrim($value, '#');
  59  
  60          // The value must be 6 or 3 characters long
  61          if (!((\strlen($value) == 6 || \strlen($value) == 3) && ctype_xdigit($value))) {
  62              return false;
  63          }
  64  
  65          return true;
  66      }
  67  }