You are here

Home » API reference » Interval Field 8 » Interval.php

class Interval in Interval Field 8

Provides a form element for date/time intervals.

Plugin annotation

@FormElement("interval");

Hierarchy

Expanded class hierarchy of Interval

1 string reference to 'Interval'
IntervalItem::propertyDefinitions in src/Plugin/Field/FieldType/IntervalItem.php
Defines field item properties.
1 #type use of Interval
IntervalWidget::formElement in src/Plugin/Field/FieldWidget/IntervalWidget.php
Returns the form for a single field widget.

File

src/Element/Interval.php, line 13

Namespace

Drupal\interval\Element
View source 
class Interval extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      '#input' => TRUE,
      '#process' => [
        [
          get_class($this),
          'process',
        ],
      ],
      '#theme' => 'interval',
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }

  /**
   * Process callback.
   */
  public static function process(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = !empty($element['#default_value']) ? $element['#default_value'] : [
      'interval' => NULL,
      'period' => NULL,
    ];
    $element['interval'] = [
      '#title' => t('@title count', [
        '@title' => $element['#title'],
      ]),
      '#title_display' => 'invisible',
      '#type' => 'number',
      '#default_value' => $value['interval'],
      '#required' => $element['#required'],
      '#size' => 8,
    ];
    $intervals = \Drupal::service('plugin.manager.interval.intervals')
      ->getDefinitions();
    $periods = !empty($element['#periods']) ? $element['#periods'] : array_keys($intervals);
    $period_options = [];
    foreach ($intervals as $key => $detail) {
      if (in_array($key, $periods) && isset($detail['plural'])) {
        $period_options[$key] = $detail['plural'];
      }
    }
    $element['period'] = [
      '#title' => t('@title period', [
        '@title' => $element['#title'],
      ]),
      '#title_display' => 'invisible',
      '#type' => 'select',
      '#options' => $period_options,
      '#default_value' => $value['period'],
      '#required' => $element['#required'],
    ];
    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.
FormElement::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback 15
Interval::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
Interval::process public static function Process callback.
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.