class OpenlayersGeofieldWidget in Openlayers 8.4

Plugin implementation of an Openlayers widget.

Plugin annotation


@FieldWidget(
  id = "openlayers_geofield_widget",
  label = @Translation("Openlayers Map"),
  description = @Translation("Provides an Openlayers widget."),
  field_types = {
    "geofield",
  },
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
    class \Drupal\openlayers\Plugin\Field\FieldWidget\OpenlayersWidgetBase
    class \Drupal\openlayers\Plugin\Field\FieldWidget\OpenlayersGeofieldWidget

Expanded class hierarchy of OpenlayersGeofieldWidget

File

modules/openlayers_geofield/src/Plugin/Field/FieldWidget/OpenlayersGeofieldWidget.php, line 26

Namespace

Drupal\openlayers\Plugin\Field\FieldWidget

View source

class OpenlayersGeofieldWidget extends OpenlayersWidgetBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'toolbar' => [
        'position' => 'top',
        'drawPoint' => TRUE,
        'drawPolyline' => TRUE,
        'drawPolygon' => TRUE,
        'cutHole' => TRUE,
        'editMode' => TRUE,
        'deleteMode' => TRUE,
      ],
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $settings = $this
      ->getSettings();
    $form = parent::settingsForm($form, $form_state);
    $form['toolbar']['DrawPoint'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Adds button to draw point markers.'),
      '#default_value' => $settings['toolbar']['DrawPoint'],
    ];
    $form['toolbar']['DrawLine'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Adds button to draw polyline.'),
      '#default_value' => $settings['toolbar']['DrawLine'],
    ];
    $form['toolbar']['DrawPolygon'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Adds button to draw polygon.'),
      '#default_value' => $settings['toolbar']['DrawPolygon'],
    ];
    $form['toolbar']['DrawHole'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Adds button to cut hole in polygon.'),
      '#default_value' => $settings['toolbar']['DrawHole'],
    ];
    $form['toolbar']['Modify'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Adds button to edit features.'),
      '#default_value' => $settings['toolbar']['Modify'],
    ];
    $form['toolbar']['Delete'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Adds button to delete features.'),
      '#default_value' => $settings['toolbar']['Delete'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $map_label = \Drupal::config('openlayers.map.' . $this
      ->getSetting('map'))
      ->get('label');
    $summary[] = $this
      ->t('Openlayers map: @map', [
      '@map' => $map_label,
    ]);
    $summary[] = $this
      ->t('Map height: @height @height_unit', [
      '@height' => $this
        ->getSetting('height'),
      '@height_unit' => $this
        ->getSetting('height_unit'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element += [
      '#type' => 'textarea',
      '#default_value' => $items[$delta]->value ?: NULL,
    ];
    $element = [
      'value' => $element,
    ];

    // Attach class to wkt input element, so we can find it in js/openlayers.js.
    $field_name = $this->fieldDefinition
      ->getName();
    $element_name = str_replace('_', '-', $field_name) . '-' . $delta . '-value';
    $element['value']['#attributes']['class'][] = $element_name;

    // Determine map settings and add map element.
    $settings = $this
      ->getSettings();
    $map = new MapSettings($settings['map']);
    $cache_tags = $map->cacheTags;
    $map = $map->settings;

    // Add a specific map id.
    $map['id'] = 'openlayers-map-' . str_replace('_', '-', $field_name) . '-' . $delta;
    $js_settings = [
      'map' => $map,
      'features' => [],
    ];

    // Build JS settings for Openlayers widget.
    $js_settings['map_id'] = $map['id'];
    $js_settings['widget']['fieldType'] = 'geofield';
    $js_settings['widget']['valueElement'] = $element_name;
    $cardinality = $items
      ->getFieldDefinition()
      ->getFieldStorageDefinition()
      ->getCardinality();
    $js_settings['multiple'] = $cardinality == 1 ? FALSE : TRUE;
    $js_settings['cardinality'] = $cardinality > 0 ? $cardinality : 0;
    $js_settings['widget']['inputShow'] = intval($settings['input']['show']);
    $js_settings['widget']['inputEditable'] = intval($settings['input']['editable']);
    $js_settings['widget']['toolbarSettings'] = !empty($this
      ->getSetting('toolbar')) ? $this
      ->getSetting('toolbar') : [];
    $js_settings['widget']['center_zoom']['lat'] = floatval($settings['initial_settings']['lat']);
    $js_settings['widget']['center_zoom']['lon'] = floatval($settings['initial_settings']['lon']);
    $js_settings['widget']['center_zoom']['zoom'] = floatval($settings['initial_settings']['zoom']);
    $element['map'] = $this->openlayersService
      ->openlayersRenderMap($js_settings, $settings['height'] . $settings['height_unit'], $cache_tags);
    $element['map']['#weight'] = -1;
    $element['map']['#attached']['library'][] = 'openlayers/openlayers-widget';

    // Settings and geo-data are passed to the widget keyed by field id.
    $element['map']['#attached']['drupalSettings']['openlayers_widget'] = [
      $element['map']['#map_id'] => $js_settings,
    ];
    return $element;
  }

  /**
   *
   */
  public function getFieldDefinition() {
    return $this->fieldDefinition;
  }

}

Members

Name	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.
OpenlayersGeofieldWidget::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides OpenlayersWidgetBase::defaultSettings
OpenlayersGeofieldWidget::formElement	public	function	Returns the form for a single field widget. Overrides WidgetInterface::formElement
OpenlayersGeofieldWidget::getFieldDefinition	public	function
OpenlayersGeofieldWidget::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides OpenlayersWidgetBase::settingsForm
OpenlayersGeofieldWidget::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
OpenlayersWidgetBase::$openlayersService	protected	property	The geoPhpWrapper service.
OpenlayersWidgetBase::create	public static	function	Creates an instance of the plugin. Overrides WidgetBase::create
OpenlayersWidgetBase::__construct	public	function	OpenlayersWidget constructor. Overrides WidgetBase::__construct
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::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::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::setWidgetState	public static	function	Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState

You are here

class OpenlayersGeofieldWidget in Openlayers 8.4

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation