You are here

Home » API reference » Jquery Colorpicker 8 » JQueryColorpicker.php

class JQueryColorpicker in Jquery Colorpicker 8

Provides a jQuery colorpicker form element.

Plugin annotation

@FormElement("jquery_colorpicker");

Hierarchy

Expanded class hierarchy of JQueryColorpicker

1 file declares its use of JQueryColorpicker
JQueryColorpickerTest.php in tests/src/Unit/Element/JQueryColorpickerTest.php
1 #type use of JQueryColorpicker
JQueryColorpickerDefaultWidget::formElement in src/Plugin/Field/FieldWidget/JQueryColorpickerDefaultWidget.php
Returns the form for a single field widget.

File

src/Element/JQueryColorpicker.php, line 15

Namespace

Drupal\jquery_colorpicker\Element
View source 
class JQueryColorpicker extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#maxlength' => 7,
      '#size' => 7,
      '#element_validate' => [
        [
          $class,
          'validateElement',
        ],
      ],
      '#jquery_colorpicker_background' => 'select.png',
      '#pre_render' => [
        [
          $class,
          'preRenderjQueryColorpicker',
        ],
      ],
      '#process' => [
        'Drupal\\Core\\Render\\Element\\RenderElement::processAjaxForm',
        [
          $class,
          'processElement',
        ],
      ],
      '#theme' => 'jquery_colorpicker',
      '#theme_wrappers' => [
        'form_element',
      ],
      '#attached' => [
        'library' => [
          'jquery_colorpicker/element',
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function validateElement(&$element, FormStateInterface $form_state) {
    if (strlen($element['#value'])) {
      $jquery_colorpicker_service = \Drupal::service('jquery_colorpicker.service');
      $color = $jquery_colorpicker_service
        ->formatColor($element['#value']);
      if ($color != $element['#value']) {
        $form_state
          ->setValueForElement($element, $color);
      }
      $error = $jquery_colorpicker_service
        ->validateColor($element['#value']);
      if ($error) {
        $form_state
          ->setError($element, $error);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    if ($input !== FALSE && $input !== NULL) {

      // This should be a string, but allow other scalars since they might be
      // valid input in programmatic form submissions.
      return is_scalar($input) ? (string) $input : '';
    }
    return NULL;
  }

  /**
   * Prepares a #type 'jquery_colorpicker' render element a template.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #title, #value, #description, #size, #maxlength,
   *   #placeholder, #required, #attributes.
   *
   * @return array
   *   The $element with prepared variables ready for
   *   jquery-colorpicker.html.twig.
   */
  public static function preRenderjQueryColorpicker(array $element) {
    $element['#attributes']['type'] = 'text';
    Element::setAttributes($element, [
      'id',
      'name',
      'value',
      'size',
      'maxlength',
    ]);
    static::setAttributes($element, [
      'form-jquery_colorpicker',
    ]);
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function processElement(&$element, FormStateInterface $form_state, &$complete_form) {
    $element['#id'] = Html::getUniqueID('edit-' . implode('-', $element['#parents']));

    // Decide what background to use to render the element. In order to ensure
    // the background exists, we create an array of the two possibilities, that
    // we will use to compare the value submitted in the Form API definition.
    $backgrounds = [
      'select.png',
      'select2.png',
    ];

    // Now we check to see if the value in the Form API definition is valid.
    // If it is, we use it, if it's not, we use a default value.
    $background = isset($element['#jquery_colorpicker_background']) && in_array($element['#jquery_colorpicker_background'], $backgrounds) ? $element['#jquery_colorpicker_background'] : 'select.png';

    // Since we know the background, we can then get the URL of it to pass to
    // the javascript function.
    $background_url = file_create_url('libraries/jquery_colorpicker/images/' . $background);

    // Next we determine what the default value for the form element is. This
    // will also be passed to the javascript function.
    $element['#attached']['drupalSettings']['jqueryColorpicker']['elements'][$element['#id']]['background'] = $background_url;
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
JQueryColorpicker::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
JQueryColorpicker::preRenderjQueryColorpicker public static function Prepares a #type 'jquery_colorpicker' render element a template.
JQueryColorpicker::processElement public static function
JQueryColorpicker::validateElement public static function
JQueryColorpicker::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.