You are here

Home » API reference » Duration Field 3.0.x » GranularityElement.php

class GranularityElement in Duration Field 3.0.x

Same name and namespace in other branches
  1. 8.2 src/Element/GranularityElement.php \Drupal\duration_field\Element\GranularityElement

Provides the Granularity form element.

This form element takes a granularity string as its input, and outputs a granularity string upon submission. See GranularityStringData for information about granularity strings.

Plugin annotation

@FormElement("granularity");

Hierarchy

Expanded class hierarchy of GranularityElement

See also

\Drupal\Plugin\DataType\GranularityStringData

1 #type use of GranularityElement
DurationField::fieldSettingsForm in src/Plugin/Field/FieldType/DurationField.php
Returns a form for the field-level settings.

File

src/Element/GranularityElement.php, line 20

Namespace

Drupal\duration_field\Element
View source 
class GranularityElement extends FormElement {
  use ProcessStatesTrait;

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#tree' => TRUE,
      '#element_validate' => [
        [
          $class,
          'validateElement',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderElement',
        ],
      ],
      '#process' => [
        'Drupal\\Core\\Render\\Element\\RenderElement::processAjaxForm',
        [
          $class,
          'processElement',
        ],
      ],
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    if ($input !== FALSE && !is_null($input)) {
      return \Drupal::service('duration_field.granularity.service')
        ->convertGranularityArrayToGranularityString($input);
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function processElement(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = FALSE;
    if (isset($element['#value']) && $element['#value']) {
      $value = $element['#value'];
    }
    elseif (isset($element['#default_value']) && $element['#default_value']) {
      $value = $element['#default_value'];
    }
    $granularities = explode(':', $value);
    $time_mappings = [
      'y' => t('Years'),
      'm' => t('Months'),
      'd' => t('Days'),
      'h' => t('Hours'),
      'i' => t('Minutes'),
      's' => t('Seconds'),
    ];

    // Create a wrapper for the elements. This is done in this manner
    // rather than nesting the elements in a wrapper with #prefix and #suffix
    // so as to not end up with [wrapper] as part of the name attribute
    // of the elements.
    $div = '<div';
    $classes = [
      'granularity-inner-wrapper',
    ];
    if (!empty($element['#states'])) {
      self::processStates($element);
    }
    foreach ($element['#attributes'] as $attribute => $attribute_value) {
      if (is_string($attribute_value)) {
        $div .= ' ' . $attribute . "='" . $attribute_value . "'";
      }
      elseif ($attribute == 'class') {
        $classes = array_merge($classes, $attribute_value);
      }
    }
    $div .= ' class="' . implode(' ', $classes) . '"';
    $div .= '>';
    $element['wrapper_open'] = [
      '#markup' => $div,
      '#weight' => -1,
    ];
    foreach ($time_mappings as $key => $label) {
      $element[$key] = [
        '#id' => $element['#id'] . '-' . $key,
        '#type' => 'checkbox',
        '#title' => $label,
        // Elements included in the #value or #default_value will be checked.
        '#default_value' => in_array($key, $granularities),
        '#weight' => 0,
        '#min' => 0,
      ];
      if (!empty($element['#ajax'])) {
        $element[$key]['#ajax'] = $element['#ajax'];
      }
    }
    $element['wrapper_close'] = [
      '#markup' => '</div>',
      '#weight' => 1,
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function preRenderElement(array $element) {

    // Set the wrapper as a container to the inner values.
    $element['#attributes']['type'] = 'container';
    Element::setAttributes($element, [
      'id',
      'name',
      'value',
    ]);
    static::setAttributes($element, [
      'form-granularity',
    ]);
    return $element;
  }

  /**
   * {@inheritdoc}
   *
   * Converts the submitted values array to a granularity string, and sets the
   * string as the value of the form element. All handlers after this point will
   * receive the string as the value for the form element.
   */
  public static function validateElement(&$element, FormStateInterface $form_state, $form) {
    $form_state
      ->setValueForElement($element, \Drupal::service('duration_field.granularity.service')
      ->convertGranularityArrayToGranularityString($form_state
      ->getValue($element['#parents'])));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
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.
GranularityElement::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
GranularityElement::preRenderElement public static function
GranularityElement::processElement public static function
GranularityElement::validateElement public static function Converts the submitted values array to a granularity string, and sets the string as the value of the form element. All handlers after this point will receive the string as the value for the form element.
GranularityElement::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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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. 98
ProcessStatesTrait::processStates public static function Processes a form element for #states support.
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. 4
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.