class GeofieldDms in Geofield 8

Provides a Geofield DMS form element.

Plugin annotation

@FormElement("geofield_dms");

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\geofield\Element\GeofieldDms

Expanded class hierarchy of GeofieldDms

1 #type use of GeofieldDms

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

File

src/Element/GeofieldDms.php, line 14

Namespace

Drupal\geofield\Element

View source

class GeofieldDms extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#process' => [
        [
          $class,
          'dmsProcess',
        ],
      ],
      '#element_validate' => [
        [
          $class,
          'elementValidate',
        ],
      ],
      '#theme_wrappers' => [
        'fieldset',
      ],
    ];
  }

  /**
   * Generates the Geofield DMS form element.
   *
   * @param array $element
   *   An associative array containing the properties and children of the
   *   element. Note that $element must be taken by reference here, so processed
   *   child elements are taken over into $form_state.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   *
   * @return array
   *   The processed element.
   */
  public static function dmsProcess(array &$element, FormStateInterface $form_state, array &$complete_form) {
    $element['#tree'] = TRUE;
    $element['#input'] = TRUE;
    $default_value = [];
    if (!empty($element['#default_value']['lon']) && !empty($element['#default_value']['lat'])) {
      $default_value = DmsConverter::decimalToDms($element['#default_value']['lon'], $element['#default_value']['lat']);
    }
    $options = [
      'lat' => [
        'N' => t('North'),
        'S' => t('South'),
      ],
      'lon' => [
        'E' => t('East'),
        'W' => t('West'),
      ],
    ];
    foreach ($options as $type => $option) {
      $component_default = !empty($default_value) ? $default_value
        ->get($type) : [];
      self::processComponent($element, $type, $option, $component_default);
    }
    unset($element['#value']);

    // Set this to false always to prevent notices.
    $element['#required'] = FALSE;
    return $element;
  }

  /**
   * Validates a Geofield DMS form element.
   *
   * @param array $element
   *   The element being processed.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   */
  public static function elementValidate(array &$element, FormStateInterface $form_state, array &$complete_form) {
  }

  /**
   * Helper function to generate each coordinate component form element.
   *
   * @param array $element
   *   The form element.
   * @param string $type
   *   The component type.
   * @param array $options
   *   The component options.
   * @param array $default_value
   *   The component default value array.
   */
  protected static function processComponent(array &$element, $type, array $options, array $default_value) {
    $element[$type] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'container-inline',
        ],
      ],
    ];
    $element[$type]['orientation'] = [
      '#type' => 'select',
      '#title' => '',
      '#options' => $options,
      '#multiple' => FALSE,
      '#required' => !empty($element['#required']) ? $element['#required'] : FALSE,
      '#default_value' => !empty($default_value) ? $default_value['orientation'] : '',
      '#attributes' => [
        'class' => [
          'geofield-' . $type . '-orientation',
          'container-inline',
        ],
        'style' => [
          'min-width: 6em',
        ],
      ],
    ];
    $element[$type]['degrees'] = [
      '#type' => 'number',
      '#min' => 0,
      '#step' => 1,
      '#max' => 180,
      '#title' => '',
      '#required' => !empty($element['#required']) ? $element['#required'] : FALSE,
      '#default_value' => !empty($default_value) ? $default_value['degrees'] : '',
      '#suffix' => '°',
      '#attributes' => [
        'class' => [
          'geofield-' . $type . '-degrees',
          'container-inline',
        ],
      ],
    ];
    $element[$type]['minutes'] = [
      '#type' => 'number',
      '#min' => 0,
      '#max' => 59,
      '#step' => 1,
      '#title' => '',
      '#required' => !empty($element['#required']) ? $element['#required'] : FALSE,
      '#default_value' => !empty($default_value) ? $default_value['minutes'] : '',
      '#suffix' => '\'',
      '#attributes' => [
        'class' => [
          'geofield-' . $type . '-minutes',
          'container-inline',
        ],
      ],
    ];
    $element[$type]['seconds'] = [
      '#type' => 'number',
      '#min' => 0,
      '#max' => 59,
      '#step' => 1,
      '#title' => '',
      '#required' => !empty($element['#required']) ? $element['#required'] : FALSE,
      '#default_value' => !empty($default_value) ? $default_value['seconds'] : '',
      '#suffix' => '"',
      '#attributes' => [
        'class' => [
          'geofield-' . $type . '-seconds',
          'container-inline',
        ],
      ],
    ];
  }

}

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.
FormElement::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback	15
GeofieldDms::dmsProcess	public static	function	Generates the Geofield DMS form element.
GeofieldDms::elementValidate	public static	function	Validates a Geofield DMS form element.
GeofieldDms::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
GeofieldDms::processComponent	protected static	function	Helper function to generate each coordinate component form element.
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 GeofieldDms in Geofield 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation