You are here

Home » API reference » Google Map Field 8 » OLMapFieldWidget.php

class OLMapFieldWidget in Google Map Field 8

Plugin implementation of the 'olmap_field' widget.

Plugin annotation


@FieldWidget(
  id = "olmap_field",
  label = @Translation("OpenLayers Map Field"),
  field_types = {
    "google_map_field"
  }
)

Hierarchy

Expanded class hierarchy of OLMapFieldWidget

File

src/Plugin/Field/FieldWidget/OLMapFieldWidget.php, line 20

Namespace

Drupal\google_map_field\Plugin\Field\FieldWidget
View source 
class OLMapFieldWidget extends WidgetBase {

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    static $unique = 0;
    $unique = $unique + 1;
    $instance_delta = $items
      ->getName() . '-' . $delta . '-' . $unique;
    $element += [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Map'),
    ];
    $element['#attached']['library'][] = 'google_map_field/olmap-field-widget-renderer';
    $element['#attached']['library'][] = 'google_map_field/olmap-apis';
    $element['preview'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Preview'),
      '#markup' => '<div class="olmap-field-preview" data-delta="' . $instance_delta . '"></div>',
      '#prefix' => '<div class="olmap-field-widget right">',
      '#suffix' => '</div>',
    ];
    $element['intro'] = [
      '#type' => 'markup',
      '#markup' => $this
        ->t('Use the "Set Map" button for more options.'),
      '#prefix' => '<div class="olmap-field-widget left">',
    ];
    $element['name'] = [
      '#title' => $this
        ->t('Map Name'),
      '#size' => 32,
      '#type' => 'textfield',
      '#default_value' => isset($items[$delta]->name) ? $items[$delta]->name : NULL,
      '#attributes' => [
        'data-name-delta' => $instance_delta,
      ],
    ];
    $element['lat'] = [
      '#title' => $this
        ->t('Latitude'),
      '#type' => 'textfield',
      '#size' => 18,
      '#default_value' => isset($items[$delta]->lat) ? $items[$delta]->lat : NULL,
      '#attributes' => [
        'data-lat-delta' => $instance_delta,
        'class' => [
          'olmap-field-watch-change',
        ],
      ],
    ];
    $element['lon'] = [
      '#title' => $this
        ->t('Longitude'),
      '#type' => 'textfield',
      '#size' => 18,
      '#default_value' => isset($items[$delta]->lon) ? $items[$delta]->lon : NULL,
      '#attributes' => [
        'data-lon-delta' => $instance_delta,
        'class' => [
          'olmap-field-watch-change',
        ],
      ],
      '#suffix' => '</div>',
    ];
    $element['zoom'] = [
      '#type' => 'hidden',
      '#default_value' => isset($items[$delta]->zoom) ? $items[$delta]->zoom : 9,
      '#attributes' => [
        'data-zoom-delta' => $instance_delta,
      ],
    ];
    $element['type'] = [
      '#type' => 'hidden',
      '#default_value' => isset($items[$delta]->type) ? $items[$delta]->type : 'roadmap',
      '#attributes' => [
        'data-type-delta' => $instance_delta,
      ],
    ];
    $element['width'] = [
      '#type' => 'hidden',
      '#default_value' => isset($items[$delta]->width) ? $items[$delta]->width : '100%',
      '#attributes' => [
        'data-width-delta' => $instance_delta,
      ],
    ];
    $element['height'] = [
      '#type' => 'hidden',
      '#default_value' => isset($items[$delta]->height) ? $items[$delta]->height : '450px',
      '#attributes' => [
        'data-height-delta' => $instance_delta,
      ],
    ];
    $element['marker'] = [
      '#type' => 'hidden',
      '#default_value' => isset($items[$delta]->marker) ? $items[$delta]->marker : "1",
      '#attributes' => [
        'data-marker-delta' => $instance_delta,
      ],
    ];
    $element['marker_icon'] = [
      '#type' => 'hidden',
      '#default_value' => isset($items[$delta]->marker_icon) ? $items[$delta]->marker_icon : "",
      '#attributes' => [
        'data-marker-icon-delta' => $instance_delta,
      ],
    ];
    $element['controls'] = [
      '#type' => 'hidden',
      '#default_value' => isset($items[$delta]->controls) ? $items[$delta]->controls : "1",
      '#attributes' => [
        'data-controls-delta' => $instance_delta,
      ],
    ];
    $element['infowindow'] = [
      '#type' => 'hidden',
      '#default_value' => isset($items[$delta]->infowindow) ? $items[$delta]->infowindow : "",
      '#attributes' => [
        'data-infowindow-delta' => $instance_delta,
      ],
    ];
    $element['actions'] = [
      '#type' => 'actions',
      '#attributes' => [
        'class' => [
          'field-map-actions',
        ],
      ],
    ];
    $element['actions']['open_map'] = [
      '#type' => 'button',
      '#value' => $this
        ->t('Set Map'),
      '#attributes' => [
        'data-delta' => $instance_delta,
        'id' => 'map_setter_' . $instance_delta,
      ],
    ];
    $element['actions']['clear_fields'] = [
      '#type' => 'button',
      '#value' => $this
        ->t('Clear'),
      '#attributes' => [
        'data-delta' => $instance_delta,
        'id' => 'clear_fields_' . $instance_delta,
        'class' => [
          'olmap-field-clear',
        ],
      ],
    ];
    $element['default_marker'] = [
      '#type' => 'hidden',
      '#default_value' => '/' . drupal_get_path('module', 'google_map_field') . '/images/pin.png',
      '#attributes' => [
        'data-default-marker-delta' => $instance_delta,
      ],
    ];
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
OLMapFieldWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 5
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 2
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues 7
WidgetBase::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm 16
WidgetBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary 15
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct public function Constructs a WidgetBase object. Overrides PluginBase::__construct 5