class ViewsBoundaryArgument in Geolocation Field 8.3

Derive center from proximity argument.

Plugin annotation

@Location(
  id = "views_boundary_argument",
  name = @Translation("Boundary argument - center only"),
  description = @Translation("Set map center from boundary argument."),
)

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\ViewsBoundaryArgument implements LocationInterface uses ViewsContextTrait

File

src/Plugin/geolocation/Location/ViewsBoundaryArgument.php, line 18

Namespace

Drupal\geolocation\Plugin\geolocation\Location

class ViewsBoundaryArgument extends LocationBase implements LocationInterface {
  use ViewsContextTrait;

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

      /** @var \Drupal\views\Plugin\views\argument\ArgumentPluginBase $argument */
      foreach ($displayHandler
        ->getHandlers('argument') as $delta => $argument) {
        if ($argument
          ->getPluginId() === 'geolocation_argument_boundary') {
          $options[$delta] = $argument
            ->adminLabel();
        }
      }
    }
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function getCoordinates($location_option_id, array $location_option_settings, $context = NULL) {
    if ($displayHandler = self::getViewsDisplayHandler($context)) {

      /** @var \Drupal\geolocation\Plugin\views\argument\BoundaryArgument $argument */
      $argument = $displayHandler
        ->getHandler('argument', $location_option_id);
      if (empty($argument)) {
        return FALSE;
      }
      $values = $argument
        ->getParsedBoundary();

      // See documentation at
      // http://tubalmartin.github.io/spherical-geometry-php/#LatLngBounds
      $latitude = ($values['lat_south_west'] + $values['lat_north_east']) / 2;
      $longitude = ($values['lng_south_west'] + $values['lng_north_east']) / 2;
      if ($values['lng_south_west'] > $values['lng_north_east']) {
        $longitude = $longitude == 0 ? 180 : fmod(fmod($longitude + 180 - -180, 360) + 360, 360) + -180;
      }
      return [
        'lat' => $latitude,
        'lng' => $longitude,
      ];
    }
    return parent::getCoordinates($location_option_id, $location_option_settings, $context);
  }

}

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::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
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.
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.
ViewsBoundaryArgument::getAvailableLocationOptions	public	function	For one Location (i.e. boundary filter), return all options (all filters). Overrides LocationBase::getAvailableLocationOptions
ViewsBoundaryArgument::getCoordinates	public	function	Get map location. Overrides LocationBase::getCoordinates
ViewsContextTrait::getViewsDisplayHandler	protected static	function	Get display handler from context.