You are here

Home » API reference » Geolocation Field 8.3 » CommonMap.php

class CommonMap in Geolocation Field 8.3

Same name and namespace in other branches
  1. 8 src/Plugin/views/style/CommonMap.php \Drupal\geolocation\Plugin\views\style\CommonMap

Allow to display several field items on a common map.

Plugin annotation


@ViewsStyle(
  id = "maps_common",
  title = @Translation("Geolocation CommonMap"),
  help = @Translation("Display geolocations on a common map."),
  theme = "views_view_list",
  display_types = {"normal"},
)

Hierarchy

Expanded class hierarchy of CommonMap

1 file declares its use of CommonMap
AjaxResponseSubscriber.php in src/EventSubscriber/AjaxResponseSubscriber.php
1 string reference to 'CommonMap'
views.view.geolocation_demo_common_map.yml in modules/geolocation_google_maps/modules/geolocation_google_maps_demo/config/optional/views.view.geolocation_demo_common_map.yml
modules/geolocation_google_maps/modules/geolocation_google_maps_demo/config/optional/views.view.geolocation_demo_common_map.yml

File

src/Plugin/views/style/CommonMap.php, line 22

Namespace

Drupal\geolocation\Plugin\views\style
View source 
class CommonMap extends GeolocationStyleBase {

  /**
   * Map ID.
   *
   * @var bool|string
   */
  protected $mapId = FALSE;

  /**
   * Map provider manager.
   *
   * @var \Drupal\geolocation\MapProviderManager
   */
  protected $mapProviderManager = NULL;

  /**
   * MapCenter options manager.
   *
   * @var \Drupal\geolocation\MapCenterManager
   */
  protected $mapCenterManager = NULL;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, $map_provider_manager, $map_center_manager, $data_provider_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $data_provider_manager);
    $this->mapProviderManager = $map_provider_manager;
    $this->mapCenterManager = $map_center_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('plugin.manager.geolocation.mapprovider'), $container
      ->get('plugin.manager.geolocation.mapcenter'), $container
      ->get('plugin.manager.geolocation.dataprovider'));
  }

  /**
   * Map update option handling.
   *
   * Dynamic map and client location and potentially others update the view by
   * information determined on the client site. They may want to update the
   * view result as well. So we need to provide the possible ways to do that.
   *
   * @return array
   *   The determined options.
   */
  protected function getMapUpdateOptions() {
    $options = [];
    foreach ($this->displayHandler
      ->getOption('filters') as $filter_id => $filter) {

      /** @var \Drupal\views\Plugin\views\filter\FilterPluginBase $filter_handler */
      $filter_handler = $this->displayHandler
        ->getHandler('filter', $filter_id);
      if (!$filter_handler
        ->isExposed()) {
        continue;
      }
      if (!empty($filter_handler->isGeolocationCommonMapOption)) {
        $options['boundary_filter_' . $filter_id] = $this
          ->t('Boundary Filter') . ' - ' . $filter_handler
          ->adminLabel();
      }
    }
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function evenEmpty() {
    return (bool) $this->options['even_empty'];
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $render = parent::render();
    if ($render === FALSE) {
      return [];
    }
    if (!empty($this->options['dynamic_map']['enabled'])) {

      // @todo Not unique enough, but uniqueid() changes on every AJAX request.
      // For the geolocationCommonMapBehavior to work, this has to stay
      // identical.
      $this->mapId = $this->view
        ->id() . '-' . $this->view->current_display;
      $this->mapId = str_replace('_', '-', $this->mapId);
    }
    else {
      $this->mapId = $this->view->dom_id;
    }
    $map_settings = [];
    if (!empty($this->options['map_provider_settings'])) {
      $map_settings = $this->options['map_provider_settings'];
    }
    $build = [
      '#type' => 'geolocation_map',
      '#maptype' => $this->options['map_provider_id'],
      '#id' => $this->mapId,
      '#settings' => $map_settings,
      '#layers' => [],
      '#attached' => [
        'library' => [
          'geolocation/geolocation.commonmap',
        ],
      ],
      '#context' => [
        'view' => $this->view,
      ],
    ];

    /*
     * Dynamic map handling.
     */
    if (!empty($this->options['dynamic_map']['enabled'])) {
      if (!empty($this->options['dynamic_map']['update_target']) && $this->view->displayHandlers
        ->has($this->options['dynamic_map']['update_target'])) {
        $update_view_display_id = $this->options['dynamic_map']['update_target'];
      }
      else {
        $update_view_display_id = $this->view->current_display;
      }
      $build['#attached']['drupalSettings']['geolocation']['commonMap'][$this->mapId]['dynamic_map'] = [
        'enable' => TRUE,
        'hide_form' => $this->options['dynamic_map']['hide_form'],
        'views_refresh_delay' => $this->options['dynamic_map']['views_refresh_delay'],
        'update_view_id' => $this->view
          ->id(),
        'update_view_display_id' => $update_view_display_id,
      ];
      if (substr($this->options['dynamic_map']['update_handler'], 0, strlen('boundary_filter_')) === 'boundary_filter_') {
        $filter_id = substr($this->options['dynamic_map']['update_handler'], strlen('boundary_filter_'));
        $filters = $this->displayHandler
          ->getOption('filters');
        $filter_options = $filters[$filter_id];
        $build['#attached']['drupalSettings']['geolocation']['commonMap'][$this->mapId]['dynamic_map'] += [
          'boundary_filter' => TRUE,
          'parameter_identifier' => $filter_options['expose']['identifier'],
        ];
      }
    }
    $this
      ->renderFields($this->view->result);

    /*
     * Add locations to output.
     */
    foreach ($this->view->result as $row) {
      foreach ($this
        ->getLocationsFromRow($row) as $location) {
        $build['locations'][] = $location;
      }
    }
    $build = $this->mapCenterManager
      ->alterMap($build, $this->options['centre'], $this);
    if ($this->view
      ->getRequest()
      ->get('geolocation_common_map_dynamic_view')) {
      if (empty($build['#attributes'])) {
        $build['#attributes'] = [];
      }
      $build['#attributes'] = array_replace_recursive($build['#attributes'], [
        'data-preserve-map-center' => TRUE,
      ]);
    }
    if ($this->mapProviderManager
      ->hasDefinition($this->options['map_provider_id'])) {
      $build = $this->mapProviderManager
        ->createInstance($this->options['map_provider_id'], $this->options['map_provider_settings'])
        ->alterCommonMap($build, $this->options['map_provider_settings'], [
        'view' => $this,
      ]);
    }
    if (!empty($this->view->geolocationLayers) && !empty($this->view->geolocationLayers[$this->view->current_display])) {
      if (empty($build['#layers'])) {
        $build['#layers'] = [];
      }
      $build['#layers'][] = $this->view->geolocationLayers[$this->view->current_display];
    }
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['even_empty'] = [
      'default' => '1',
    ];
    $options['dynamic_map'] = [
      'contains' => [
        'enabled' => [
          'default' => 0,
        ],
        'update_handler' => [
          'default' => '',
        ],
        'update_target' => [
          'default' => '',
        ],
        'hide_form' => [
          'default' => 0,
        ],
        'views_refresh_delay' => [
          'default' => '1200',
        ],
      ],
    ];
    $options['centre'] = [
      'default' => [],
    ];
    $options['map_provider_id'] = [
      'default' => '',
    ];
    $options['map_provider_settings'] = [
      'default' => [],
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    $map_provider_options = $this->mapProviderManager
      ->getMapProviderOptions();
    if (empty($map_provider_options)) {
      $form = [
        '#type' => 'html_tag',
        '#tag' => 'span',
        '#value' => $this
          ->t("No map provider found."),
      ];
      return;
    }
    parent::buildOptionsForm($form, $form_state);
    $map_update_target_options = $this
      ->getMapUpdateOptions();

    /*
     * Dynamic map handling.
     */
    if (!empty($map_update_target_options)) {
      $form['dynamic_map'] = [
        '#title' => $this
          ->t('Dynamic Map'),
        '#type' => 'fieldset',
      ];
      $form['dynamic_map']['enabled'] = [
        '#title' => $this
          ->t('Update view on map boundary changes. Also known as "AirBnB" style.'),
        '#type' => 'checkbox',
        '#default_value' => $this->options['dynamic_map']['enabled'],
        '#description' => $this
          ->t("If enabled, moving the map will filter results based on current map boundary. This functionality requires an exposed boundary filter. Enabling AJAX is highly recommend for best user experience. If additional views are to be updated with the map change as well, it is highly recommended to use the view containing the map as 'parent' and the additional views as attachments."),
      ];
      $form['dynamic_map']['update_handler'] = [
        '#title' => $this
          ->t('Dynamic map update handler'),
        '#type' => 'select',
        '#default_value' => $this->options['dynamic_map']['update_handler'],
        '#description' => $this
          ->t("The map has to know how to feed back the update boundary data to the view."),
        '#options' => $map_update_target_options,
        '#states' => [
          'visible' => [
            ':input[name="style_options[dynamic_map][enabled]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
      $form['dynamic_map']['hide_form'] = [
        '#title' => $this
          ->t('Hide exposed filter form element if applicable.'),
        '#type' => 'checkbox',
        '#default_value' => $this->options['dynamic_map']['hide_form'],
        '#states' => [
          'visible' => [
            ':input[name="style_options[dynamic_map][enabled]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
      $form['dynamic_map']['views_refresh_delay'] = [
        '#title' => $this
          ->t('Minimum idle time in milliseconds required to trigger views refresh'),
        '#description' => $this
          ->t('Once the view refresh is triggered, any further change of the map bounds will have no effect until the map update is finished. User interactions like scrolling in and out or dragging the map might trigger the map idle event, before the user is finished interacting. This setting adds a delay before the view is refreshed to allow further map interactions.'),
        '#type' => 'number',
        '#min' => 0,
        '#default_value' => $this->options['dynamic_map']['views_refresh_delay'],
        '#states' => [
          'visible' => [
            ':input[name="style_options[dynamic_map][enabled]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
      if ($this->displayHandler
        ->getPluginId() !== 'page') {
        $update_targets = [
          $this->displayHandler->display['id'] => $this
            ->t('- This display -'),
        ];
        foreach ($this->view->displayHandlers
          ->getInstanceIds() as $instance_id) {
          $display_instance = $this->view->displayHandlers
            ->get($instance_id);
          if (in_array($display_instance
            ->getPluginId(), [
            'page',
            'block',
          ])) {
            $update_targets[$instance_id] = $display_instance->display['display_title'];
          }
        }
        if (!empty($update_targets)) {
          $form['dynamic_map']['update_target'] = [
            '#title' => $this
              ->t('Dynamic map update target'),
            '#type' => 'select',
            '#default_value' => $this->options['dynamic_map']['update_target'],
            '#description' => $this
              ->t("Targets other than page or block can only update themselves."),
            '#options' => $update_targets,
            '#states' => [
              'visible' => [
                ':input[name="style_options[dynamic_map][enabled]"]' => [
                  'checked' => TRUE,
                ],
              ],
            ],
          ];
        }
      }
    }

    /*
     * Centre handling.
     */
    $form['centre'] = $this->mapCenterManager
      ->getCenterOptionsForm((array) $this->options['centre'], $this);

    /*
     * Advanced settings
     */
    $form['advanced_settings'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Advanced settings'),
    ];
    $form['even_empty'] = [
      '#group' => 'style_options][advanced_settings',
      '#title' => $this
        ->t('Display map when no locations are found'),
      '#type' => 'checkbox',
      '#default_value' => $this->options['even_empty'],
    ];
    $form['map_provider_id'] = [
      '#type' => 'select',
      '#options' => $map_provider_options,
      '#title' => $this
        ->t('Map Provider'),
      '#default_value' => $this->options['map_provider_id'],
      '#ajax' => [
        'callback' => [
          get_class($this->mapProviderManager),
          'addSettingsFormAjax',
        ],
        'wrapper' => 'map-provider-settings',
        'effect' => 'fade',
      ],
    ];
    $form['map_provider_settings'] = [
      '#type' => 'html_tag',
      '#tag' => 'span',
      '#value' => $this
        ->t("No settings available."),
    ];
    $map_provider_id = NestedArray::getValue($form_state
      ->getUserInput(), [
      'style_options',
      'map_provider_id',
    ]);
    if (empty($map_provider_id)) {
      $map_provider_id = $this->options['map_provider_id'];
    }
    if (empty($map_provider_id)) {
      $map_provider_id = key($map_provider_options);
    }
    $map_provider_settings = $this->options['map_provider_settings'] ?? [];
    if (!empty($this->options['map_provider_id']) && $map_provider_id != $this->options['map_provider_id']) {
      $map_provider_settings = [];
      if (!empty($form_state
        ->getValue([
        'style_options',
        'map_provider_settings',
      ]))) {
        $form_state
          ->setValue([
          'style_options',
          'map_provider_settings',
        ], []);
        $form_state
          ->setUserInput($form_state
          ->getValues());
      }
    }
    if (!empty($map_provider_id)) {
      $form['map_provider_settings'] = $this->mapProviderManager
        ->createInstance($map_provider_id, $map_provider_settings)
        ->getSettingsForm($map_provider_settings, [
        'style_options',
        'map_provider_settings',
      ]);
    }
    $form['map_provider_settings'] = array_replace($form['map_provider_settings'], [
      '#prefix' => '<div id="map-provider-settings">',
      '#suffix' => '</div>',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $dependencies = parent::calculateDependencies();
    if (empty($this->options['map_provider_id'])) {
      return $dependencies;
    }
    $definition = $this->mapProviderManager
      ->getDefinition($this->options['map_provider_id']);
    return array_merge_recursive($dependencies, [
      'module' => [
        $definition['provider'],
      ],
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CommonMap::$mapCenterManager protected property MapCenter options manager.
CommonMap::$mapId protected property Map ID.
CommonMap::$mapProviderManager protected property Map provider manager.
CommonMap::buildOptionsForm public function Provide a form to edit options for this plugin. Overrides GeolocationStyleBase::buildOptionsForm
CommonMap::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies
CommonMap::create public static function Creates an instance of the plugin. Overrides GeolocationStyleBase::create
CommonMap::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides GeolocationStyleBase::defineOptions
CommonMap::evenEmpty public function Should the output of the style plugin be rendered even if it's a empty view. Overrides StylePluginBase::evenEmpty
CommonMap::getMapUpdateOptions protected function Map update option handling.
CommonMap::render public function Render the display in this style. Overrides GeolocationStyleBase::render
CommonMap::__construct public function Constructs a PluginBase object. Overrides GeolocationStyleBase::__construct
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
GeolocationStyleBase::$dataProviderManager protected property Data provider base.
GeolocationStyleBase::$usesFields protected property Does the style plugin for itself support to add fields to its output. Overrides StylePluginBase::$usesFields
GeolocationStyleBase::$usesGrouping protected property Does the style plugin support grouping of rows. Overrides StylePluginBase::$usesGrouping
GeolocationStyleBase::$usesRowClass protected property Does the style plugin support custom css class for the rows. Overrides StylePluginBase::$usesRowClass
GeolocationStyleBase::$usesRowPlugin protected property Whether or not this style uses a row plugin. Overrides StylePluginBase::$usesRowPlugin
GeolocationStyleBase::getLabelField public function Get label value if present.
GeolocationStyleBase::getLocationsFromRow protected function Render array from views result row.
GeolocationStyleBase::getTitleField public function Get title value if present.
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::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$view public property The top object of a view. 1
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::submitOptionsForm public function Handle any special handling on the validate form. Overrides ViewsPluginInterface::submitOptionsForm 16
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
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.
StylePluginBase::$defaultFieldLabels protected property Should field labels be enabled by default. 1
StylePluginBase::$groupingTheme protected property The theme function used to render the grouping set.
StylePluginBase::$rendered_fields protected property Stores the rendered field values, keyed by the row index and field name.
StylePluginBase::$rowTokens protected property Store all available tokens row rows.
StylePluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions
StylePluginBase::buildSort public function Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query. 1
StylePluginBase::buildSortPost public function Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view. 1
StylePluginBase::defaultFieldLabels public function Return TRUE if this style enables field labels by default. 1
StylePluginBase::destroy public function Clears a plugin. Overrides PluginBase::destroy
StylePluginBase::elementPreRenderRow public function #pre_render callback for view row field rendering.
StylePluginBase::getField public function Gets a rendered field.
StylePluginBase::getFieldValue public function Get the raw field value.
StylePluginBase::getRowClass public function Return the token replaced row class for the specified row.
StylePluginBase::init public function Overrides \Drupal\views\Plugin\views\PluginBase::init(). Overrides PluginBase::init
StylePluginBase::preRender public function Allow the style to do stuff before each row is rendered.
StylePluginBase::query public function Add anything to the query that we might need to. Overrides PluginBase::query 1
StylePluginBase::renderFields protected function Renders all of the fields for a given style and store them on the object.
StylePluginBase::renderGrouping public function Group records as needed for rendering.
StylePluginBase::renderGroupingSets public function Render the grouping sets.
StylePluginBase::renderRowGroup protected function Renders a group of rows of the grouped view.
StylePluginBase::tokenizeValue public function Take a value and apply token replacement logic to it.
StylePluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
StylePluginBase::usesFields public function Return TRUE if this style also uses fields. 3
StylePluginBase::usesGrouping public function Returns the usesGrouping property. 3
StylePluginBase::usesRowClass public function Returns the usesRowClass property. 3
StylePluginBase::usesRowPlugin public function Returns the usesRowPlugin property. 10
StylePluginBase::usesTokens public function Return TRUE if this style uses tokens.
StylePluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides PluginBase::validate
StylePluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm
StylePluginBase::wizardForm public function Provide a form in the views wizard if this style is selected.
StylePluginBase::wizardSubmit public function Alter the options of a display before they are added to the view. 1
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.