class ViewsProximityFilter in Geolocation Field 8.3

Derive center from proximity filter.

Plugin annotation

@Location(
  id = "views_proximity_filter",
  name = @Translation("Proximity filter"),
  description = @Translation("Set map center from proximity filter."),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\geolocation\LocationBase implements ContainerFactoryPluginInterface, LocationInterface
      • class \Drupal\geolocation\Plugin\geolocation\Location\ViewsProximityFilter implements LocationInterface uses ViewsContextTrait

1 file declares its use of ViewsProximityFilter

GeometryViewsProximityFilter.php in modules/geolocation_geometry/src/Plugin/geolocation/Location/GeometryViewsProximityFilter.php

File

src/Plugin/geolocation/Location/ViewsProximityFilter.php, line 20

Namespace

Drupal\geolocation\Plugin\geolocation\Location

class ViewsProximityFilter extends LocationBase implements LocationInterface {
  use ViewsContextTrait;

  /**
   * Proximity center manager.
   *
   * @var \Drupal\geolocation\LocationInputManager
   */
  protected $locationInputManager;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, LocationInputManager $location_input_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->locationInputManager = $location_input_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.locationinput'));
  }

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

      /** @var \Drupal\views\Plugin\views\filter\FilterPluginBase $filter */
      foreach ($displayHandler
        ->getHandlers('filter') as $delta => $filter) {
        if ($filter
          ->getPluginId() === 'geolocation_filter_proximity' && $filter !== $context) {
          $options[$delta] = $this
            ->t('Proximity filter') . ' - ' . $filter
            ->adminLabel();
        }
      }
    }
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function getCoordinates($location_option_id, array $location_option_settings, $context = NULL) {
    if (!($displayHandler = self::getViewsDisplayHandler($context))) {
      return parent::getCoordinates($location_option_id, $location_option_settings, $context);
    }
    $filter = $displayHandler
      ->getHandler('filter', $location_option_id);
    if (empty($filter)) {
      return parent::getCoordinates($location_option_id, $location_option_settings, $context);
    }
    if (array_key_exists('lat', $filter->value) && array_key_exists('lng', $filter->value)) {
      return [
        'lat' => (double) $filter->value['lat'],
        'lng' => (double) $filter->value['lng'],
      ];
    }
    return $this->locationInputManager
      ->getCoordinates((array) $filter->value['center'], $filter->options['location_input'], $filter);
  }

}

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
LocationBase::getDefaultSettings	public static	function	Provide a populated settings array. Overrides LocationInterface::getDefaultSettings	2
LocationBase::getSettings	public	function	Provide Location option specific settings. Overrides LocationInterface::getSettings
LocationBase::getSettingsForm	public	function	Settings form by ID and context. Overrides LocationInterface::getSettingsForm	2
LocationBase::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.
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.
ViewsContextTrait::getViewsDisplayHandler	protected static	function	Get display handler from context.
ViewsProximityFilter::$locationInputManager	protected	property	Proximity center manager.
ViewsProximityFilter::create	public static	function	Creates an instance of the plugin. Overrides LocationBase::create
ViewsProximityFilter::getAvailableLocationOptions	public	function	For one Location (i.e. boundary filter), return all options (all filters). Overrides LocationBase::getAvailableLocationOptions	1
ViewsProximityFilter::getCoordinates	public	function	Get map location. Overrides LocationBase::getCoordinates
ViewsProximityFilter::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct