class HMS in HMS Field 8

Provides a one-line text field form element.

Plugin annotation

@FormElement("hms");

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
    class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
    class \Drupal\hms_field\Element\HMS

Expanded class hierarchy of HMS

1 #type use of HMS

HMSFieldWidget::formElement in src/Plugin/Field/FieldWidget/HMSFieldWidget.php: Returns the form for a single field widget.

File

src/Element/HMS.php, line 19: Contains \Drupal\hms_field\Element\Hmsfield.

Namespace

Drupal\hms_field\Element

View source

class HMS extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return array(
      '#input' => TRUE,
      '#size' => 8,
      '#maxlength' => 16,
      '#default_value' => FALSE,
      '#format' => 'h:mm:ss',
      '#placeholder' => 'h:mm:ss',
      '#autocomplete_route_name' => FALSE,
      '#process' => array(
        array(
          $class,
          'processAutocomplete',
        ),
        array(
          $class,
          'processAjaxForm',
        ),
        array(
          $class,
          'processPattern',
        ),
        array(
          $class,
          'processGroup',
        ),
      ),
      '#pre_render' => array(
        array(
          $class,
          'preRenderHMS',
        ),
      ),
      '#element_validate' => array(
        array(
          $class,
          'validateHMS',
        ),
      ),
      '#theme' => 'input__textfield',
      '#theme_wrappers' => array(
        'form_element',
      ),
    );
  }

  /**
   * Form element validation handler for #type 'hms'.
   *
   * Note that #required is validated by _form_validate() already.
   */
  public static function validateHMS(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = trim($element['#value']);
    $form_state
      ->setValueForElement($element, $value);
    if ($value !== '' && !\Drupal::service('hms_field.hms')
      ->isValid($value, $element['#format'], $element, $form_state)) {
      $form_state
        ->setError($element, t('Please enter a correct hms value in format %format.', array(
        '%format' => $element['#format'],
      )));
    }
    else {

      // Format given value to seconds if input is valid.
      $seconds = \Drupal::service('hms_field.hms')
        ->formatted_to_seconds($value, $element['#format'], $element, $form_state);
      $form_state
        ->setValueForElement($element, $seconds);
    }
  }

  /**
   * Prepares a #type 'hms' render element for input.html.twig.
   *
   * @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 input.html.twig.
   */
  public static function preRenderHMS($element) {
    Element::setAttributes($element, array(
      'id',
      'name',
      'value',
      'size',
      'maxlength',
      'placeholder',
    ));
    static::setAttributes($element, array(
      'form-hms',
    ));
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {

    // Get saved value from db.
    if ($input === FALSE) {
      $formatted = \Drupal::service('hms_field.hms')
        ->seconds_to_formatted($element['#default_value'], $element['#format']);
      return $formatted;
    }
  }

}

Members

Name	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.
HMS::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
HMS::preRenderHMS	public static	function	Prepares a #type 'hms' render element for input.html.twig.
HMS::validateHMS	public static	function	Form element validation handler for #type 'hms'.
HMS::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.

You are here

class HMS in HMS Field 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation