class Dimensions in Physical Fields 8

Provides a dimension form element.

The size and maxlength properties are applied to each textfield individually.

Usage example:

$form['dimensions'] = [
  '#type' => 'physical_dimensions',
  '#title' => $this
    ->t('Dimensions'),
  '#default_value' => [
    'length' => '1.90',
    'width' => '2.5',
    'height' => '2.1',
    'unit' => LengthUnit::METER,
  ],
  '#size' => 60,
  '#maxlength' => 128,
  '#required' => TRUE,
];

Plugin annotation

@FormElement("physical_dimensions");

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\physical\Element\Dimensions

Expanded class hierarchy of Dimensions

3 string references to 'Dimensions'

DimensionsItem::getConstraints in src/Plugin/Field/FieldType/DimensionsItem.php: Gets a list of validation constraints.
DimensionsTestForm::buildForm in tests/modules/physical_test/src/Form/DimensionsTestForm.php: Form constructor.
physical.schema.yml in config/schema/physical.schema.yml: config/schema/physical.schema.yml

2 #type uses of Dimensions

DimensionsDefaultWidget::formElement in src/Plugin/Field/FieldWidget/DimensionsDefaultWidget.php: Returns the form for a single field widget.
DimensionsTestForm::buildForm in tests/modules/physical_test/src/Form/DimensionsTestForm.php: Form constructor.

File

src/Element/Dimensions.php, line 33

Namespace

Drupal\physical\Element

View source

class Dimensions extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      // All units are available by default.
      '#available_units' => [],
      '#size' => 10,
      '#maxlength' => 128,
      '#default_value' => NULL,
      '#attached' => [
        'library' => [
          'physical/admin',
        ],
      ],
      '#process' => [
        [
          $class,
          'processElement',
        ],
        [
          $class,
          'processAjaxForm',
        ],
        [
          $class,
          'processGroup',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderGroup',
        ],
      ],
      '#input' => TRUE,
      '#theme_wrappers' => [
        'fieldset',
      ],
    ];
  }

  /**
   * Builds the physical_dimensions form element.
   *
   * @param array $element
   *   The initial physical_dimensions form element.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   *
   * @return array
   *   The built physical_dimensions form element.
   *
   * @throws \InvalidArgumentException.
   */
  public static function processElement(array $element, FormStateInterface $form_state, array &$complete_form) {
    if (!is_array($element['#available_units'])) {
      throw new \InvalidArgumentException('The #available_units key must be an array.');
    }
    $default_value = $element['#default_value'];
    if (isset($default_value)) {
      if (!self::validateDefaultValue($default_value)) {
        throw new \InvalidArgumentException('The #default_value for a physical_dimensions element must be an array with "length", "width", "height", "unit" keys.');
      }
      LengthUnit::assertExists($default_value['unit']);
    }
    $element['#tree'] = TRUE;
    $element['#attributes']['class'][] = 'form-type-physical-dimensions';
    $properties = [
      'length' => t('Length'),
      'width' => t('Width'),
      'height' => t('Height'),
    ];
    foreach ($properties as $property => $label) {
      $element[$property] = [
        '#type' => 'physical_number',
        '#title' => $label,
        '#default_value' => $default_value ? $default_value[$property] : NULL,
        '#size' => $element['#size'],
        '#maxlength' => $element['#maxlength'],
        '#required' => $element['#required'],
        '#field_suffix' => '&times;',
      ];
    }
    unset($element['height']['#field_suffix']);
    unset($element['#size']);
    unset($element['#maxlength']);
    $units = LengthUnit::getLabels();

    // Restrict the list of available units, if needed.
    if ($element['#available_units']) {
      $available_units = $element['#available_units'];

      // The current unit should always be available.
      if ($default_value) {
        $available_units[] = $default_value['unit'];
      }
      $available_units = array_combine($available_units, $available_units);
      $units = array_intersect_key($units, $available_units);
    }
    if (count($units) === 1) {
      $last_visible_element = 'height';
      $unit_keys = array_keys($units);
      $unit = reset($unit_keys);
      $element['unit'] = [
        '#type' => 'value',
        '#value' => $unit,
      ];

      // Display the unit as a text element after the textfield.
      $element['height']['#field_suffix'] = $unit;
    }
    else {
      $last_visible_element = 'unit';
      $element['unit'] = [
        '#type' => 'select',
        '#options' => $units,
        '#default_value' => $default_value ? $default_value['unit'] : LengthUnit::getBaseUnit(),
        '#title_display' => 'invisible',
        '#field_suffix' => '',
      ];
    }

    // Add the help text if specified.
    if (!empty($element['#description'])) {
      $element[$last_visible_element]['#field_suffix'] .= '<div class="description">' . $element['#description'] . '</div>';
    }
    return $element;
  }

  /**
   * Validates the default value.
   *
   * @param mixed $default_value
   *   The default value.
   *
   * @return bool
   *   TRUE if the default value is valid, FALSE otherwise.
   */
  public static function validateDefaultValue($default_value) {
    if (!is_array($default_value)) {
      return FALSE;
    }
    foreach ([
      'length',
      'width',
      'height',
      'unit',
    ] as $property) {
      if (!array_key_exists($property, $default_value)) {
        return FALSE;
      }
    }
    return TRUE;
  }

}

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
Dimensions::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
Dimensions::processElement	public static	function	Builds the physical_dimensions form element.
Dimensions::validateDefaultValue	public static	function	Validates the default value.
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
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 Dimensions in Physical Fields 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation