class AddressService in Geocoder 8.2

Class AddressService.

@package Drupal\geocoder_address

Hierarchy

• class \Drupal\Core\DependencyInjection\ServiceProviderBase implements ServiceModifierInterface, ServiceProviderInterface
  • class \Drupal\geocoder_address\AddressService

2 files declare their use of AddressService

Address.php in modules/geocoder_address/src/Plugin/Geocoder/Preprocessor/Address.php

AddressGeocodeFormatter.php in modules/geocoder_address/src/Plugin/Field/FieldFormatter/AddressGeocodeFormatter.php

1 string reference to 'AddressService'

geocoder_address.services.yml in modules/geocoder_address/geocoder_address.services.yml

modules/geocoder_address/geocoder_address.services.yml

1 service uses AddressService

geocoder_address.address in modules/geocoder_address/geocoder_address.services.yml

Drupal\geocoder_address\AddressService

File

modules/geocoder_address/src/AddressService.php, line 19

Namespace

Drupal\geocoder_address

class AddressService extends ServiceProviderBase {

  /**
   * The address format repository.
   *
   * @var \CommerceGuys\Addressing\AddressFormat\AddressFormatRepositoryInterface
   */
  protected $addressFormatRepository;

  /**
   * The country repository.
   *
   * @var \CommerceGuys\Addressing\Country\CountryRepositoryInterface
   */
  protected $countryRepository;

  /**
   * The subdivision repository.
   *
   * @var \CommerceGuys\Addressing\Subdivision\SubdivisionRepositoryInterface
   */
  protected $subdivisionRepository;

  /**
   * AddressService constructor.
   *
   * @param \CommerceGuys\Addressing\AddressFormat\AddressFormatRepositoryInterface $address_format_repository
   *   The address format repository.
   * @param \CommerceGuys\Addressing\Country\CountryRepositoryInterface $country_repository
   *   The subdivision repository.
   * @param \CommerceGuys\Addressing\Subdivision\SubdivisionRepositoryInterface $subdivision_repository
   *   The postal label formatter.
   */
  public function __construct(AddressFormatRepositoryInterface $address_format_repository, CountryRepositoryInterface $country_repository, SubdivisionRepositoryInterface $subdivision_repository) {
    $this->addressFormatRepository = $address_format_repository;
    $this->countryRepository = $country_repository;
    $this->subdivisionRepository = $subdivision_repository;
  }

  /**
   * Set formatter.
   *
   * The postal formatter seems to return the kind of value the geocoders
   * expect to receive. Other situations might use the DefaultFormatter()
   * instead.
   *
   * @param string $langcode
   *   The langcode.
   * @param string $countrycode
   *   The country code.
   * @param string $formatter
   *   The type of formatter to return, 'postal' or 'default'.
   *
   * @return mixed
   *   - 'postal': \CommerceGuys\Addressing\Formatter\PostalLabelFormatter
   *     A formatter that will convert the input values into a postal label.
   *   - 'default': \CommerceGuys\Addressing\Formatter\DefaultFormatter
   *     The default formatter.
   */
  public function getFormatter($langcode, $countrycode = 'US', $formatter = 'default') {
    $default_options = [
      'locale' => $langcode,
      'origin_country' => $countrycode,
    ];
    switch ($formatter) {
      case 'postal':
        return new PostalLabelFormatter($this->addressFormatRepository, $this->countryRepository, $this->subdivisionRepository, $default_options);
      default:
        return new DefaultFormatter($this->addressFormatRepository, $this->countryRepository, $this->subdivisionRepository, $default_options);
    }
  }

  /**
   * Convert an address array into a string address suitable for geocoding.
   *
   * Expects an array structured like the Address module as the input values.
   *
   * @param array $values
   *   An array keyed by any combination of the following:
   *   - given_name
   *   - additional_name
   *   - family_name
   *   - organization
   *   - address_line1
   *   - address_line2
   *   - postal_code
   *   - sorting_code
   *   - dependent_locality
   *   - locality
   *   - administrative_area
   *   - country_code
   *   - langcode.
   *
   * @return string
   *   The string representation of the address suitable for submission to a
   *   geocoder service.
   */
  public function addressArrayToGeoString(array $values) {

    // Make sure the address_array has all values populated.
    // @var \Drupal\address\Element\Address::applyDefaults()
    $values = ElementAddress::applyDefaults($values);

    // Without a country code this won't work.
    if (empty($values['country_code'])) {
      return '';
    }

    // Use the Address formatter to create a string ordered appropriately
    // for the country in the address.
    // @var CommerceGuys\Addressing\Address
    $address = new AddressingAddress();
    $address = $address
      ->withCountryCode($values['country_code'])
      ->withPostalCode($values['postal_code'])
      ->withAdministrativeArea($values['administrative_area'])
      ->withDependentLocality($values['dependent_locality'])
      ->withLocality($values['locality'])
      ->withAddressLine1($values['address_line1'])
      ->withAddressLine2($values['address_line2']);
    $countrycode = isset($values['country_code']) ? $values['country_code'] : NULL;
    $langcode = !empty($values['langcode']) ? $values['langcode'] : 'en';

    // Get the formatted address.
    // @var CommerceGuys\Addressing\Formatter\PostalLabelFormatter
    $formatter = $this
      ->getFormatter($langcode, $countrycode, 'postal');
    $address_string = $formatter
      ->format($address);

    // Clean up the returned multiline address to turn it into a single line of
    // text.
    $address_string = str_replace("\n", ' ', $address_string);
    $address_string = str_replace("<br>", ' ', $address_string);
    $address_string = strip_tags($address_string);
    $address_string .= isset($countrycode) ? ' ' . $countrycode : '';

    // Add Country code suffix, if defined.
    return $address_string;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AddressService::$addressFormatRepository	protected	property	The address format repository.
AddressService::$countryRepository	protected	property	The country repository.
AddressService::$subdivisionRepository	protected	property	The subdivision repository.
AddressService::addressArrayToGeoString	public	function	Convert an address array into a string address suitable for geocoding.
AddressService::getFormatter	public	function	Set formatter.
AddressService::__construct	public	function	AddressService constructor.
ServiceProviderBase::alter	public	function	Modifies existing service definitions. Overrides ServiceModifierInterface::alter	5
ServiceProviderBase::register	public	function	Registers services to the container. Overrides ServiceProviderInterface::register	1