class Location in Geolocation Field 8.3

Location based map center.

Plugin annotation

@MapCenter(
  id = "location_plugins",
  name = @Translation("Location Plugins"),
  description = @Translation("Select a location plugin."),
)

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\Location implements MapCenterInterface

6 string references to 'Location'

views.view.geolocation_demo_commonmap_boundary_filter_with_ajax.yml in modules/geolocation_google_maps/modules/geolocation_google_maps_demo/config/optional/views.view.geolocation_demo_commonmap_boundary_filter_with_ajax.yml

modules/geolocation_google_maps/modules/geolocation_google_maps_demo/config/optional/views.view.geolocation_demo_commonmap_boundary_filter_with_ajax.yml

views.view.geolocation_demo_commonmap_with_attachment.yml in modules/geolocation_google_maps/modules/geolocation_google_maps_demo/config/optional/views.view.geolocation_demo_commonmap_with_attachment.yml

modules/geolocation_google_maps/modules/geolocation_google_maps_demo/config/optional/views.view.geolocation_demo_commonmap_with_attachment.yml

views.view.geolocation_demo_commonmap_with_marker_icons.yml in modules/geolocation_google_maps/modules/geolocation_google_maps_demo/config/optional/views.view.geolocation_demo_commonmap_with_marker_icons.yml

modules/geolocation_google_maps/modules/geolocation_google_maps_demo/config/optional/views.view.geolocation_demo_commonmap_with_marker_icons.yml

views.view.geolocation_demo_common_map_ajax.yml in modules/geolocation_google_maps/modules/geolocation_google_maps_demo/config/optional/views.view.geolocation_demo_common_map_ajax.yml

modules/geolocation_google_maps/modules/geolocation_google_maps_demo/config/optional/views.view.geolocation_demo_common_map_ajax.yml

views.view.geolocation_demo_interactive_commonmap_with_address_input.yml in modules/geolocation_google_maps/modules/geolocation_google_maps_demo/config/optional/views.view.geolocation_demo_interactive_commonmap_with_address_input.yml

modules/geolocation_google_maps/modules/geolocation_google_maps_demo/config/optional/views.view.geolocation_demo_interactive_commonmap_with_address_input.yml

... See full list

File

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

Namespace

Drupal\geolocation\Plugin\geolocation\MapCenter

class Location extends MapCenterBase implements MapCenterInterface {

  /**
   * Location manager.
   *
   * @var \Drupal\geolocation\LocationManager
   */
  protected $locationManager;

  /**
   * Location Plugin ID.
   *
   * @var string
   */
  protected $locationPluginId = '';

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, LocationManager $location_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->locationManager = $location_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.location'));
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm($location_plugin_id = NULL, array $settings = [], $context = NULL) {
    if (!$this->locationManager
      ->hasDefinition($location_plugin_id)) {
      return [];
    }
    $form = [];

    /** @var \Drupal\geolocation\LocationInterface $location_plugin */
    $location_plugin = $this->locationManager
      ->createInstance($location_plugin_id);
    $location_options = $location_plugin
      ->getAvailableLocationOptions($context);
    if (!$location_options) {
      return [];
    }
    $option_id = NULL;
    if (!empty($settings['location_option_id'])) {
      $settings['location_option_id'];
      $option_id = $settings['location_option_id'];
    }
    if (count($location_options) == 1) {
      $option_id = key($location_options);
      $form['location_option_id'] = [
        '#type' => 'value',
        '#value' => $option_id,
      ];
    }
    else {
      $options = [];
      foreach ($location_options as $location_option_id => $location_option_definition) {
        $options[$location_option_id] = $location_option_definition['name'];
      }
      $form['location_option_id'] = [
        '#type' => 'select',
        '#options' => $options,
        '#default_value' => $option_id,
      ];
    }

    /** @var \Drupal\geolocation\LocationInterface $location_plugin */
    $location_plugin = $this->locationManager
      ->createInstance($location_plugin_id);
    $form = array_merge_recursive($form, $location_plugin
      ->getSettingsForm($option_id, $settings, $context));
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getAvailableMapCenterOptions($context = NULL) {
    $options = [];

    /** @var \Drupal\geolocation\LocationInterface $location_plugin */
    foreach ($this->locationManager
      ->getDefinitions() as $location_plugin_id => $location_plugin_definition) {

      /** @var \Drupal\geolocation\LocationInterface $location_plugin */
      $location_plugin = $this->locationManager
        ->createInstance($location_plugin_id);
      $location_options = $location_plugin
        ->getAvailableLocationOptions($context);
      if (!$location_options) {
        continue;
      }
      $options[$location_plugin_id] = $location_plugin_definition['name'];
    }
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function alterMap(array $map, $center_plugin_id, array $center_option_settings, $context = NULL) {
    if (!$this->locationManager
      ->hasDefinition($center_plugin_id)) {
      return $map;
    }

    /** @var \Drupal\geolocation\LocationInterface $location */
    $location = $this->locationManager
      ->createInstance($center_plugin_id);
    if (!empty($center_option_settings['location_option_id'])) {
      $location_id = $center_option_settings['location_option_id'];
    }
    else {
      $location_id = $center_plugin_id;
    }
    $map['#attached']['drupalSettings']['geolocation']['maps'][$map['#id']]['map_center']['location_plugins_' . $location_id] = $map['#attached']['drupalSettings']['geolocation']['maps'][$map['#id']]['map_center']['location_plugins'];
    unset($map['#attached']['drupalSettings']['geolocation']['maps'][$map['#id']]['map_center']['location_plugins']);
    $map_center = $location
      ->getCoordinates($location_id, $center_option_settings, $context);
    if (!empty($map_center)) {
      $map['#centre'] = $map_center;
    }
    $map['#attached'] = BubbleableMetadata::mergeAttachments($map['#attached'], [
      'library' => [
        'geolocation/map_center.static_location',
      ],
      'drupalSettings' => [
        'geolocation' => [
          'maps' => [
            $map['#id'] => [
              'map_center' => [
                'location_plugins_' . $location_id => [
                  'success' => !empty($map_center),
                ],
              ],
            ],
          ],
        ],
      ],
    ]);
    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
Location::$locationManager	protected	property	Location manager.
Location::$locationPluginId	protected	property	Location Plugin ID.
Location::alterMap	public	function	Alter map.. Overrides MapCenterBase::alterMap
Location::create	public static	function	Creates an instance of the plugin. Overrides MapCenterBase::create
Location::getAvailableMapCenterOptions	public	function	For one MapCenter (i.e. boundary filter), return all options (all filters). Overrides MapCenterBase::getAvailableMapCenterOptions
Location::getSettingsForm	public	function	Settings form by ID and context. Overrides MapCenterBase::getSettingsForm
Location::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
MapCenterBase::getDefaultSettings	public static	function	Provide a populated settings array. Overrides MapCenterInterface::getDefaultSettings	3
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.
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.