class Map in Search API Location 8

Represents the Raw Location Input.

Plugin annotation


@LocationInput(
  id = "geocode_map",
  label = @Translation("Map"),
  description = @Translation("Let user choose a location on a map."),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\search_api\Plugin\HideablePluginBase implements HideablePluginInterface
    class \Drupal\search_api\Plugin\ConfigurablePluginBase implements ConfigurablePluginInterface uses PluginDependencyTrait
    class \Drupal\search_api_location\LocationInput\LocationInputPluginBase implements LocationInputInterface
    class \Drupal\search_api_location\Plugin\search_api_location\location_input\Map

Expanded class hierarchy of Map

File

src/Plugin/search_api_location/location_input/Map.php, line 17

Namespace

Drupal\search_api_location\Plugin\search_api_location\location_input

View source

class Map extends LocationInputPluginBase {

  /**
   * {@inheritdoc}
   */
  public function hasInput(array $input, array $options) {
    return $input['lat'] && $input['lng'];
  }

  /**
   * {@inheritdoc}
   */
  public function getParsedInput(array $input) {
    if (!isset($input['lat']) || !isset($input['lng'])) {
      throw new \InvalidArgumentException('Input doesn\'t contain a location value.');
    }
    return $input['lat'] . ',' . $input['lng'];
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $configuration = parent::defaultConfiguration();
    $configuration += [
      'radius_border_color' => '',
      'radius_border_weight' => '',
      'radius_background_color' => '',
      'radius_background_transparency' => '',
      'marker_image' => '',
    ];
    return $configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['radius_border_color'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Border color'),
      '#description' => $this
        ->t('The hexadecimal value of the radius border color.'),
      '#default_value' => $this->configuration['radius_border_color'],
      '#size' => 7,
    ];
    $form['radius_border_weight'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Border weight'),
      '#description' => $this
        ->t('The radius border weight in pixels.'),
      '#default_value' => $this->configuration['radius_border_weight'],
      '#size' => 3,
    ];
    $form['radius_background_color'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Fill color'),
      '#description' => $this
        ->t('The hexadecimal value of the fill color.'),
      '#default_value' => $this->configuration['radius_background_color'],
      '#size' => 7,
    ];
    $form['radius_background_transparency'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Fill transparency'),
      '#description' => $this
        ->t('The opacity of the fill color (a value between 0.0 and 1.0)'),
      '#default_value' => $this->configuration['radius_background_transparency'],
      '#size' => 3,
    ];
    $form['marker_image'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Marker image'),
      '#description' => $this
        ->t('The path to the marker image.'),
      '#default_value' => $this->configuration['marker_image'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getForm(array $form, FormStateInterface $form_state, array $options) {
    $form['value']['#tree'] = TRUE;

    // Get the default values for existing field.
    $lat_default_value = (double) $form_state
      ->getUserInput()[$options['expose']['identifier']]['lat'] ?: "51.037932";
    $lng_default_value = (double) $form_state
      ->getUserInput()[$options['expose']['identifier']]['lng'] ?: "3.712105";
    $radius_default_value = (double) $form_state
      ->getUserInput()[$options['expose']['identifier']]['distance']['from'] ?: "1000";
    $id = $options['id'];

    // Hidden lat,lng input fields.
    $form['value']['lat'] = [
      '#type' => 'hidden',
      '#default_value' => $lat_default_value,
      '#attributes' => [
        'id' => [
          "sal-{$id}-lat",
        ],
      ],
    ];
    $form['value']['lng'] = [
      '#type' => 'hidden',
      '#default_value' => $lng_default_value,
      '#attributes' => [
        'id' => [
          "sal-{$id}-lng",
        ],
      ],
    ];
    $form['value']['distance']['from'] = [
      '#type' => 'hidden',
      '#default_value' => $radius_default_value,
      '#attributes' => [
        'id' => [
          "sal-{$id}-radius",
        ],
      ],
    ];

    // Add the map container.
    $form['value']['map'] = [
      '#type' => 'html_tag',
      '#tag' => 'div',
      '#attributes' => [
        'id' => "sal-{$id}-map",
        'class' => "sal-map",
      ],
      '#attached' => [
        'library' => [
          'search_api_location/location-picker',
        ],
        'drupalSettings' => [
          'search_api_location' => [
            $id => [
              'id' => $id,
              'lat' => (double) $lat_default_value,
              'lng' => (double) $lng_default_value,
              'radius' => $radius_default_value,
              'radius_border_color' => $options['plugin-geocode_map']['radius_border_color'],
              'radius_border_weight' => $options['plugin-geocode_map']['radius_border_weight'],
              'radius_background_color' => $options['plugin-geocode_map']['radius_background_color'],
              'radius_background_transparency' => $options['plugin-geocode_map']['radius_background_transparency'],
              'marker_image' => $options['plugin-geocode_map']['marker_image'],
            ],
          ],
        ],
      ],
    ];
    $form['value']['slider'] = [
      '#type' => 'html_tag',
      '#tag' => 'div',
      '#attributes' => [
        'id' => "sal-{$id}-slider",
        'class' => "sal-slider",
      ],
    ];
    return $form;
  }

  /**
   * Form validation handler.
   *
   * @param array $form
   *   An associative array containing the structure of the plugin form as built
   *   by static::buildConfigurationForm().
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the complete form.
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {

    // TODO: Implement validateConfigurationForm() method.
  }

  /**
   * Form submission handler.
   *
   * @param array $form
   *   An associative array containing the structure of the plugin form as built
   *   by static::buildConfigurationForm().
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the complete form.
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {

    // TODO: Implement submitConfigurationForm() method.
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurablePluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
ConfigurablePluginBase::calculatePluginDependencies Deprecated	protected	function	Calculates and adds dependencies of a specific plugin instance.
ConfigurablePluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	4
ConfigurablePluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurablePluginBase::getDescription	public	function	Returns the plugin's description. Overrides ConfigurablePluginInterface::getDescription
ConfigurablePluginBase::getPluginDependencies Deprecated	protected	function	Calculates and returns dependencies of a specific plugin instance.
ConfigurablePluginBase::label	public	function	Returns the label for use on the administration pages. Overrides ConfigurablePluginInterface::label
ConfigurablePluginBase::moduleHandler Deprecated	protected	function	Wraps the module handler.
ConfigurablePluginBase::onDependencyRemoval	public	function	Informs the plugin that some of its dependencies are being removed. Overrides ConfigurablePluginInterface::onDependencyRemoval	5
ConfigurablePluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	3
ConfigurablePluginBase::themeHandler Deprecated	protected	function	Wraps the theme handler.
ConfigurablePluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	2
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
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
HideablePluginBase::isHidden	public	function	Determines whether this plugin should be hidden in the UI. Overrides HideablePluginInterface::isHidden	1
Map::buildConfigurationForm	public	function	Form constructor. Overrides LocationInputPluginBase::buildConfigurationForm
Map::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides LocationInputPluginBase::defaultConfiguration
Map::getForm	public	function	Returns a form to configure settings for the plugin. Overrides LocationInputPluginBase::getForm
Map::getParsedInput	public	function	Returns the parsed user input. Overrides LocationInputInterface::getParsedInput
Map::hasInput	public	function	Checks if the location passed in is correct for the current settings. Overrides LocationInputPluginBase::hasInput
Map::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
Map::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
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.
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance. Aliased as: traitCalculatePluginDependencies	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance. Aliased as: traitGetPluginDependencies
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler. Aliased as: traitModuleHandler	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler. Aliased as: traitThemeHandler	1
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 Map in Search API Location 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation