class GeofieldBounds in Geofield 8

Provides a Geofield bounds form element.

Plugin annotation

@FormElement("geofield_bounds");

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\GeofieldElementBase
          • class \Drupal\geofield\Element\GeofieldBounds

1 #type use of GeofieldBounds

GeofieldBoundsWidget::formElement in src/Plugin/Field/FieldWidget/GeofieldBoundsWidget.php

Returns the form for a single field widget.

File

src/Element/GeofieldBounds.php, line 12

Namespace

Drupal\geofield\Element

class GeofieldBounds extends GeofieldElementBase {

  /**
   * {@inheritdoc}
   */
  public static function getComponents() {
    return [
      'top' => [
        'title' => t('Top'),
        'range' => 90,
      ],
      'right' => [
        'title' => t('Right'),
        'range' => 180,
      ],
      'bottom' => [
        'title' => t('Bottom'),
        'range' => 90,
      ],
      'left' => [
        'title' => t('Left'),
        'range' => 180,
      ],
    ];
  }

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

  /**
   * Validates a Geofield bounds 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 boundsValidate(array &$element, FormStateInterface $form_state, array &$complete_form) {
    static::elementValidate($element, $form_state, $complete_form);
    $pairs = [
      [
        'bigger' => 'top',
        'smaller' => 'bottom',
      ],
      [
        'bigger' => 'right',
        'smaller' => 'left',
      ],
    ];
    foreach ($pairs as $pair) {
      if ($element[$pair['smaller']]['#value'] > $element[$pair['bigger']]['#value']) {
        $components = static::getComponents();
        $form_state
          ->setError($element[$pair['smaller']], t('@title: @component_bigger must be greater than @component_smaller.', [
          '@title' => $element['#title'],
          '@component_bigger' => $components[$pair['bigger']]['title'],
          '@component_smaller' => $components[$pair['smaller']]['title'],
        ]));
      }
    }
  }

}

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
GeofieldBounds::boundsValidate	public static	function	Validates a Geofield bounds element.
GeofieldBounds::getComponents	public static	function	Components Getter. Overrides GeofieldElementBase::getComponents
GeofieldBounds::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
GeofieldElementBase::elementProcess	public static	function	Generates a Geofield generic component based form element.
GeofieldElementBase::elementValidate	public static	function	Validates a Geofield generic component based 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.