class ControlDirections in Geolocation Field 8.3

Provides Directions Service.

Plugin annotation


@MapFeature(
  id = "geolocation_google_maps_control_directions",
  name = @Translation("Directions"),
  description = @Translation("Integrate direction finder."),
  type = "google_maps",
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\geolocation\MapFeatureBase implements ContainerFactoryPluginInterface, MapFeatureInterface
    class \Drupal\geolocation_google_maps\Plugin\geolocation\MapFeature\ControlElementBase
    class \Drupal\geolocation_google_maps\Plugin\geolocation\MapFeature\ControlGoogleElementBase
    class \Drupal\geolocation_google_maps\Plugin\geolocation\MapFeature\ControlDirections

Expanded class hierarchy of ControlDirections

File

modules/geolocation_google_maps/src/Plugin/geolocation/MapFeature/ControlDirections.php, line 18

Namespace

Drupal\geolocation_google_maps\Plugin\geolocation\MapFeature

View source

class ControlDirections extends ControlGoogleElementBase {

  /**
   * {@inheritdoc}
   */
  public static function getDefaultSettings() {
    $settings = parent::getDefaultSettings();
    $settings['origin_source'] = 'exposed';
    $settings['origin_static_value'] = '';
    $settings['destination_source'] = 'exposed';
    $settings['destination_static_value'] = '';
    $settings['travel_mode'] = 'exposed';
    $settings['directions_container'] = 'below';
    $settings['directions_container_custom_id'] = '';
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm(array $settings, array $parents) {
    $states_prefix = array_shift($parents) . '[' . implode('][', $parents) . ']';
    $form = parent::getSettingsForm($settings, $parents);
    $form['origin_source'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Origin source'),
      '#options' => [
        'exposed' => $this
          ->t('Exposed textfield for user.'),
        'static' => $this
          ->t('Static value'),
      ],
      '#description' => $this
        ->t('Origin point for directions.'),
      '#default_value' => $settings['origin_source'],
    ];
    $form['origin_static_value'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Static origin'),
      '#description' => $this
        ->t('Enter an address or coordinates as "lat, lng". Tokens supported.'),
      '#default_value' => $settings['origin_static_value'],
      '#states' => [
        'visible' => [
          'select[name="' . $states_prefix . '[origin_source]"]' => [
            'value' => 'static',
          ],
        ],
      ],
    ];
    $form['destination_source'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Destination source'),
      '#options' => [
        'exposed' => $this
          ->t('Exposed textfield for user.'),
        'static' => $this
          ->t('Static value'),
      ],
      '#description' => $this
        ->t('Destination point for directions.'),
      '#default_value' => $settings['destination_source'],
    ];
    $form['destination_static_value'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Static destination'),
      '#description' => $this
        ->t('Enter an address or coordinates as "lat, lng". Tokens supported.'),
      '#default_value' => $settings['destination_static_value'],
      '#states' => [
        'visible' => [
          'select[name="' . $states_prefix . '[destination_source]"]' => [
            'value' => 'static',
          ],
        ],
      ],
    ];
    $form['travel_mode'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Travel mode'),
      '#options' => [
        'exposed' => $this
          ->t('Exposed'),
        'driving' => $this
          ->t('Driving'),
        'walking' => $this
          ->t('Walking'),
        'bicycling' => $this
          ->t('Bicycling'),
        'transit' => $this
          ->t('Transit'),
      ],
      '#default_value' => $settings['travel_mode'],
    ];
    $form['directions_container'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Directions container'),
      '#options' => [
        'above' => $this
          ->t('Attach above map.'),
        'below' => $this
          ->t('Attach below map'),
        'custom' => $this
          ->t('Inject to custom Element by #ID'),
      ],
      '#default_value' => $settings['directions_container'],
    ];
    $form['directions_container_custom_id'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Directions custom container #ID'),
      '#default_value' => $settings['directions_container_custom_id'],
      '#states' => [
        'visible' => [
          'select[name="' . $states_prefix . '[directions_container]"]' => [
            'value' => 'custom',
          ],
        ],
      ],
    ];
    return $form;
  }

  /**
   * Directions control form.
   *
   * @param array $settings
   *   Settings.
   *
   * @return array
   *   Directions form.
   */
  public function getDirectionsControlForm(array $settings, array $context = []) {
    $form = [
      '#type' => 'form',
      '#form_id' => 'directions_control',
      '#attributes' => [
        'id' => Html::getUniqueId('geolocation-google-maps-directions-controls'),
        'class' => [
          'geolocation-google-maps-directions-controls',
        ],
      ],
    ];
    if ($settings['origin_source'] == 'exposed' || $settings['destination_source'] == 'exposed') {
      $form['#attributes']['class'][] = 'geolocation-google-maps-directions-controls-block';
    }
    switch ($settings['origin_source']) {
      case 'exposed':
        $form['origin'] = [
          '#type' => 'textfield',
          '#title' => $this
            ->t('Origin'),
          '#size' => 24,
          '#name' => 'geolocation-google-maps-directions-controls-origin',
          '#description' => $this
            ->t('Enter an address like "Chicago, IL".'),
          '#description_display' => 'after',
        ];
        break;
      case 'static':
        $form['origin'] = [
          '#type' => 'hidden',
          '#name' => 'geolocation-google-maps-directions-controls-origin',
          '#value' => \Drupal::token()
            ->replace($settings['origin_static_value'], $context),
        ];
        break;
    }
    switch ($settings['destination_source']) {
      case 'exposed':
        $form['destination'] = [
          '#type' => 'textfield',
          '#title' => $this
            ->t('Destination'),
          '#size' => 24,
          '#name' => 'geolocation-google-maps-directions-controls-destination',
          '#description' => $this
            ->t('Enter an address like "Darwin, NSW, Australia".'),
          '#description_display' => 'after',
        ];
        break;
      case 'static':
        $form['destination'] = [
          '#type' => 'hidden',
          '#name' => 'geolocation-google-maps-directions-controls-destination',
          '#value' => \Drupal::token()
            ->replace($settings['destination_static_value'], $context),
        ];
        break;
    }
    switch ($settings['travel_mode']) {
      case 'exposed':
        $form['travel_mode'] = [
          '#type' => 'select',
          '#title' => $this
            ->t('Origin'),
          '#options' => [
            'driving' => $this
              ->t('Driving'),
            'walking' => $this
              ->t('Walking'),
            'bicycling' => $this
              ->t('Bicycling'),
            'transit' => $this
              ->t('Transit'),
          ],
          '#name' => 'geolocation-google-maps-directions-controls-travel-mode',
          '#description_display' => 'after',
        ];
        break;
      default:
        $form['travel_mode'] = [
          '#type' => 'hidden',
          '#name' => 'geolocation-google-maps-directions-controls-travel-mode',
          '#value' => $settings['travel_mode'],
        ];
        break;
    }
    $form['get_directions'] = [
      '#type' => 'button',
      '#value' => $this
        ->t('Get Directions'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function alterMap(array $render_array, array $feature_settings, array $context = []) {
    $render_array = parent::alterMap($render_array, $feature_settings, $context);
    $render_array['#controls']['directions'] = $this
      ->getDirectionsControlForm($feature_settings, $context);
    switch ($feature_settings['directions_container']) {
      case 'above':
        if (empty($render_array['#prefix'])) {
          $render_array['#prefix'] = '';
        }
        $render_array['#prefix'] .= '<div class="geolocation-google-maps-directions-container"></div>';
        break;
      case 'below':
        if (empty($render_array['#suffix'])) {
          $render_array['#suffix'] = '';
        }
        $render_array['#suffix'] .= '<div class="geolocation-google-maps-directions-container"></div>';
        break;
    }
    $render_array['#attached'] = BubbleableMetadata::mergeAttachments(empty($render_array['#attached']) ? [] : $render_array['#attached'], [
      'library' => [
        'geolocation_google_maps/mapfeature.' . $this
          ->getPluginId(),
      ],
      'drupalSettings' => [
        'geolocation' => [
          'maps' => [
            $render_array['#id'] => [
              $this
                ->getPluginId() => [
                'enable' => TRUE,
                'settings' => $feature_settings,
              ],
            ],
          ],
        ],
      ],
    ]);
    return $render_array;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControlDirections::alterMap	public	function	Alter render array. Overrides ControlGoogleElementBase::alterMap
ControlDirections::getDefaultSettings	public static	function	Provide a populated settings array. Overrides ControlGoogleElementBase::getDefaultSettings
ControlDirections::getDirectionsControlForm	public	function	Directions control form.
ControlDirections::getSettingsForm	public	function	Provide a generic map settings form array. Overrides ControlGoogleElementBase::getSettingsForm
ControlElementBase::validateSettingsForm	public	function	Validate Feature Form. Overrides MapFeatureBase::validateSettingsForm
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
MapFeatureBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	2
MapFeatureBase::getSettings	public	function	Provide map feature specific settings ready to handover to JS. Overrides MapFeatureInterface::getSettings
MapFeatureBase::getSettingsSummary	public	function	Provide a summary array to use in field formatters. Overrides MapFeatureInterface::getSettingsSummary	2
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.

You are here

class ControlDirections in Geolocation Field 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation