You are here

Home » API reference » Search API Location 8 » LocationInputPluginBase.php

abstract class LocationInputPluginBase in Search API Location 8

Defines a base class from which other data type classes may extend.

Hierarchy

Expanded class hierarchy of LocationInputPluginBase

3 files declare their use of LocationInputPluginBase
Geocode.php in modules/search_api_location_geocoder/src/Plugin/search_api_location/location_input/Geocode.php
Map.php in src/Plugin/search_api_location/location_input/Map.php
Raw.php in src/Plugin/search_api_location/location_input/Raw.php

File

src/LocationInput/LocationInputPluginBase.php, line 11

Namespace

Drupal\search_api_location\LocationInput
View source 
abstract class LocationInputPluginBase extends ConfigurablePluginBase implements LocationInputInterface {

  /**
   * {@inheritdoc}
   */
  public function hasInput(array $input, array $options) {
    $input['value'] = trim($input['value']);
    if (!$input['value'] || !($options['operator'] || is_numeric($input['distance']['from']))) {
      return FALSE;
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $configuration = parent::defaultConfiguration();
    $configuration += [
      'radius_type' => 'select',
      'radius_options' => "- -\n5 5 km\n10 10 km\n16.09 10 mi",
      'radius_units' => 'km',
    ];
    return $configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['radius_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Type of distance input'),
      '#description' => $this
        ->t('Select the type of input element for the distance option.'),
      '#options' => [
        'select' => $this
          ->t('Select'),
        'textfield' => $this
          ->t('Text field'),
      ],
      '#default_value' => $this->configuration['radius_type'],
    ];
    $form['radius_options'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Distance options'),
      '#description' => $this
        ->t('Add one line per option for “Range” you want to provide. The first part of each line is the distance in kilometres, everything after the first space is the label. "-" as the distance ignores the location for filtering, but will still use it for facets, sorts and distance calculation. Skipping the distance altogether (i.e., starting the line with a space) will provide an option for ignoring the entered location completely.'),
      '#default_value' => $this->configuration['radius_options'],
      '#states' => [
        'visible' => [
          'select[name="options[plugin-' . $this->pluginId . '][radius_type]"]' => [
            'value' => 'select',
          ],
        ],
      ],
    ];
    $form['radius_units'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Distance units'),
      '#description' => $this
        ->t('Choose the units for the distance.'),
      '#default_value' => $this->configuration['radius_units'],
      '#options' => array_column(search_api_location_get_units(), 'label', 'id'),
      '#states' => [
        'visible' => [
          'select[name="options[plugin-' . $this->pluginId . '][radius_type]"]' => [
            'value' => 'textfield',
          ],
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getForm(array $form, FormStateInterface $form_state, array $options) {
    $plugin_settings = $options['plugin-' . $options['plugin']];
    $is_views_ui_form = $form_state
      ->getBuildInfo()['form_id'] == 'views_ui_config_item_form';
    $operator_prefix = '';
    if ($is_views_ui_form) {
      $states_selector = 'input[name="options[operator]"]';
    }
    else {
      $states_selector = 'select[name="' . $options['expose']['operator_id'] . '"]';
    }
    if (!$is_views_ui_form && !($options['exposed'] && $options['expose']['use_operator'])) {
      $operator_prefix = $options['operator_options'][$options['operator']] . ' ';
    }
    $form['value']['#tree'] = TRUE;
    if ($plugin_settings['radius_type'] == 'select') {
      $distance_options = [];
      $lines = array_filter(array_map('trim', explode("\n", $plugin_settings['radius_options'])));
      foreach ($lines as $line) {
        $pos = strpos($line, ' ');
        $range = substr($line, 0, $pos);
        $distance_options[$range] = trim(substr($line, $pos + 1));
      }
      $form['value']['distance']['from'] = [
        '#type' => 'select',
        '#title' => ' ',
        '#options' => $distance_options,
        '#default_value' => $options['value']['distance']['from'],
        '#field_prefix' => $operator_prefix,
      ];
      $form['value']['distance']['to'] = [
        '#type' => 'select',
        '#title' => ' ',
        '#options' => $distance_options,
        '#default_value' => $options['value']['distance']['to'],
        '#field_prefix' => 'and ',
        '#states' => [
          'visible' => [
            $states_selector => [
              'value' => 'between',
            ],
          ],
        ],
      ];
    }
    elseif ($plugin_settings['radius_type'] == 'textfield') {
      $distance_suffix = $plugin_settings['radius_units'];
      $form['value']['distance']['from'] = [
        '#type' => 'textfield',
        '#title' => ' ',
        '#size' => 5,
        '#default_value' => $options['value']['distance']['from'],
        '#field_prefix' => $operator_prefix,
        '#field_suffix' => $distance_suffix,
      ];
      $form['value']['distance']['to'] = [
        '#title' => ' ',
        '#type' => 'textfield',
        '#size' => 5,
        '#default_value' => $options['value']['distance']['to'],
        '#field_prefix' => 'and ',
        '#field_suffix' => $distance_suffix,
        '#states' => [
          'visible' => [
            $states_selector => [
              'value' => 'between',
            ],
          ],
        ],
      ];
    }
    if (!$is_views_ui_form && !($options['exposed'] && $options['expose']['use_operator']) && $options['operator'] != 'between') {
      unset($form['value']['distance']['to']);
    }
    $form['value']['value'] = [
      '#type' => 'textfield',
      '#title' => ' ',
      '#size' => 20,
      '#default_value' => $options['value']['value'],
      '#field_prefix' => 'from ',
    ];
    return $form;
  }

}

Members

Namesort descending 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
LocationInputInterface::getParsedInput public function Returns the parsed user input. 3
LocationInputPluginBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
LocationInputPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurablePluginBase::defaultConfiguration 2
LocationInputPluginBase::getForm public function Returns a form to configure settings for the plugin. Overrides LocationInputInterface::getForm 1
LocationInputPluginBase::hasInput public function Checks if the location passed in is correct for the current settings. Overrides LocationInputInterface::hasInput 1
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
PluginFormInterface::submitConfigurationForm public function Form submission handler. 32
PluginFormInterface::validateConfigurationForm public function Form validation handler. 18
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.