You are here

class Address in Geocoder 8.3

Same name and namespace in other branches
  1. 8.2 modules/geocoder_address/src/Plugin/Geocoder/Preprocessor/Address.php \Drupal\geocoder_address\Plugin\Geocoder\Preprocessor\Address

Provides a geocoder preprocessor plugin for address fields.

Plugin annotation


@GeocoderPreprocessor(
  id = "address",
  name = "Address",
  field_types = {
    "address"
  }
)

Hierarchy

Expanded class hierarchy of Address

File

modules/geocoder_address/src/Plugin/Geocoder/Preprocessor/Address.php, line 21

Namespace

Drupal\geocoder_address\Plugin\Geocoder\Preprocessor
View source
class Address extends PreprocessorBase {

  /**
   * The address service.
   *
   * @var \Drupal\geocoder_address\AddressService
   */
  protected $addressService;

  /**
   * PreprocessorBase constructor.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Locale\CountryManagerInterface $country_manager
   *   The Country Manager service.
   * @param \Drupal\geocoder_address\AddressService $address_service
   *   The Geocoder Address service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, CountryManagerInterface $country_manager, AddressService $address_service) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $country_manager);
    $this->addressService = $address_service;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('country_manager'), $container
      ->get('geocoder_address.address'));
  }

  /**
   * {@inheritdoc}
   */
  public function preprocess() {
    parent::preprocess();
    foreach ($this->field
      ->getValue() as $delta => $value) {
      $address = '';

      // Use the Address API to format the array of values into a string
      // that can be sent to the geocoder service.
      if (is_array($value)) {
        $address = $this->addressService
          ->addressArrayToGeoString($value);
      }
      $value['value'] = $address;
      $this->field
        ->set($delta, $value);
    }
    return $this;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Address::$addressService protected property The address service.
Address::create public static function Creates an instance of the plugin. Overrides PreprocessorBase::create
Address::preprocess public function Processes the values of the field before geocoding. Overrides PreprocessorBase::preprocess
Address::__construct public function PreprocessorBase constructor. Overrides PreprocessorBase::__construct
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
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.
PreprocessorBase::$countryManager protected property The country manager service.
PreprocessorBase::$field protected property The field that needs to be preprocessed.
PreprocessorBase::getPreparedReverseGeocodeValues public function Get prepared reverse geocode values. Overrides PreprocessorInterface::getPreparedReverseGeocodeValues
PreprocessorBase::setField public function Sets the field that needs to be preprocessed. Overrides PreprocessorInterface::setField
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.