class ViewsBoundaryFilter in Geolocation Field 8.3

Derive center from boundary filter.

Plugin annotation

@MapCenter(
  id = "views_boundary_filter",
  name = @Translation("Boundary filter"),
  description = @Translation("Fit map to boundary filter."),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\geolocation\MapCenterBase implements ContainerFactoryPluginInterface, MapCenterInterface
      • class \Drupal\geolocation\Plugin\geolocation\MapCenter\ViewsBoundaryFilter implements MapCenterInterface uses ViewsContextTrait

1 file declares its use of ViewsBoundaryFilter

GeometryViewsBoundaryFilter.php in modules/geolocation_geometry/src/Plugin/geolocation/MapCenter/GeometryViewsBoundaryFilter.php

File

src/Plugin/geolocation/MapCenter/ViewsBoundaryFilter.php, line 19

Namespace

Drupal\geolocation\Plugin\geolocation\MapCenter

class ViewsBoundaryFilter extends MapCenterBase implements MapCenterInterface {
  use ViewsContextTrait;

  /**
   * {@inheritdoc}
   */
  public static function getDefaultSettings() {
    return array_replace_recursive(parent::getDefaultSettings(), [
      'clear_address_input' => TRUE,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm($center_option_id = NULL, array $settings = [], $context = NULL) {
    $form = parent::getSettingsForm($center_option_id, $settings, $context);
    $form['clear_address_input'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Clear address input on map bound change.'),
      '#default_value' => $settings['clear_address_input'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getAvailableMapCenterOptions($context) {
    $options = [];
    if ($displayHandler = self::getViewsDisplayHandler($context)) {

      /** @var \Drupal\views\Plugin\views\filter\FilterPluginBase $filter */
      foreach ($displayHandler
        ->getHandlers('filter') as $filter_id => $filter) {
        if ($filter
          ->getPluginId() === 'geolocation_filter_boundary') {

          // Preserve compatibility to v1.
          $options['boundary_filter_' . $filter_id] = $this
            ->t('Boundary filter') . ' - ' . $filter
            ->adminLabel();
        }
      }
    }
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function alterMap(array $map, $center_option_id, array $center_option_settings, $context = NULL) {
    $map = parent::alterMap($map, $center_option_id, $center_option_settings, $context);
    if (!($displayHandler = self::getViewsDisplayHandler($context))) {
      return $map;
    }

    /** @var \Drupal\geolocation\Plugin\views\filter\BoundaryFilter $handler */
    $handler = $displayHandler
      ->getHandler('filter', substr($center_option_id, 16));
    $map['#attached'] = BubbleableMetadata::mergeAttachments($map['#attached'], [
      'library' => [
        'geolocation/map_center.viewsBoundaryFilter',
      ],
      'drupalSettings' => [
        'geolocation' => [
          'maps' => [
            $map['#id'] => [
              'map_center' => [
                'views_boundary_filter' => [
                  'clearAddressInput' => (bool) $center_option_settings['clear_address_input'],
                  'identifier' => $handler->options['expose']['identifier'],
                ],
              ],
            ],
          ],
        ],
      ],
    ]);
    if (isset($handler->value['lat_north_east']) && $handler->value['lat_north_east'] !== "" && isset($handler->value['lng_north_east']) && $handler->value['lng_north_east'] !== "" && isset($handler->value['lat_south_west']) && $handler->value['lat_south_west'] !== "" && isset($handler->value['lng_south_west']) && $handler->value['lng_south_west'] !== "") {
      $map['#attached'] = BubbleableMetadata::mergeAttachments($map['#attached'], [
        'drupalSettings' => [
          'geolocation' => [
            'maps' => [
              $map['#id'] => [
                'map_center' => [
                  'views_boundary_filter' => [
                    'latNorthEast' => (double) $handler->value['lat_north_east'],
                    'lngNorthEast' => (double) $handler->value['lng_north_east'],
                    'latSouthWest' => (double) $handler->value['lat_south_west'],
                    'lngSouthWest' => (double) $handler->value['lng_south_west'],
                  ],
                ],
              ],
            ],
          ],
        ],
      ]);
    }
    return $map;
  }

}

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
MapCenterBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
MapCenterBase::getSettings	public	function	Provide MapCenter option specific settings. Overrides MapCenterInterface::getSettings
MapCenterBase::validateSettingsForm	public	function
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
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.
ViewsBoundaryFilter::alterMap	public	function	Alter map.. Overrides MapCenterBase::alterMap
ViewsBoundaryFilter::getAvailableMapCenterOptions	public	function	For one MapCenter (i.e. boundary filter), return all options (all filters). Overrides MapCenterBase::getAvailableMapCenterOptions	1
ViewsBoundaryFilter::getDefaultSettings	public static	function	Provide a populated settings array. Overrides MapCenterBase::getDefaultSettings
ViewsBoundaryFilter::getSettingsForm	public	function	Settings form by ID and context. Overrides MapCenterBase::getSettingsForm
ViewsContextTrait::getViewsDisplayHandler	protected static	function	Get display handler from context.