GeocoderApiEnpoints.php in Geocoder 8.2

Namespace

Drupal\geocoder\Controller

File

src/Controller/GeocoderApiEnpoints.php

<?php

namespace Drupal\geocoder\Controller;

use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Controller\ControllerBase;
use Drupal\geocoder\DumperPluginManager;
use Drupal\geocoder\FormatterPluginManager;
use Geocoder\Model\Address;
use Geocoder\Model\AddressCollection;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Drupal\geocoder\Geocoder;
use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Cache\CacheableJsonResponse;
use Drupal\Core\Cache\CacheableMetadata;

/**
 * Class GeocoderApiEnpoints.
 */
class GeocoderApiEnpoints extends ControllerBase {

  /**
   * The config factory service.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $config;

  /**
   * Geocoder Service.
   *
   * @var \Drupal\geocoder\Geocoder
   */
  protected $geocoder;

  /**
   * The dumper plugin manager service.
   *
   * @var \Drupal\geocoder\DumperPluginManager
   */
  protected $dumperPluginManager;

  /**
   * The Geocoder formatter plugin manager service.
   *
   * @var \Drupal\geocoder\FormatterPluginManager
   */
  protected $geocoderFormatterPluginManager;

  /**
   * The Response.
   *
   * @var \Symfony\Component\HttpFoundation\Response
   */
  protected $response;

  /**
   * Get the Address Formatter.
   */
  protected function getAddressFormatter($address_format = NULL) {
    return $address_format ?: 'default_formatted_address';
  }

  /**
   * Set Geocoders Options.
   *
   * Merges Geocoders Options from Request Query and Module Configurations.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The Request object.
   *
   * @return array
   *   The merged Plugins Options array.
   */
  protected function setGeocodersOptions(Request $request) : array {

    // Retrieve geocoders options from the module configurations.
    $geocoders_configs = $this->config
      ->get('plugins_options') ?: [];

    // Get possible query string specific geocoders options.
    $geocoders_options = $request
      ->get('options') ?: [];

    // Merge geocoders options.
    $options = NestedArray::mergeDeep($geocoders_configs, $geocoders_options);
    return $options;
  }

  /**
   * Add a geometry property if not defined (as Google Maps Geocoding does).
   *
   * @param \Geocoder\Model\Address $address
   *   The Address array.
   *
   * @return array
   *   The Address Geometry Property.
   */
  protected function addGeometryProperty(Address $address) {

    /* @var array $address_array */
    $address_array = $address
      ->toArray();
    return [
      'location' => [
        'lat' => $address_array['latitude'],
        'lng' => $address_array['longitude'],
      ],
      'viewport' => [
        'northeast' => [
          'lat' => $address_array['bounds']['north'],
          'lng' => $address_array['bounds']['east'],
        ],
        'southwest' => [
          'lat' => $address_array['bounds']['south'],
          'lng' => $address_array['bounds']['west'],
        ],
      ],
    ];
  }

  /**
   * Get Address Collection Response.
   *
   * @param \Geocoder\Model\AddressCollection $geo_collection
   *   The Address Collection.
   * @param \Drupal\geocoder\DumperInterface|null $dumper
   *   The Dumper or null.
   * @param string|null $address_format
   *   The specific @GeocoderFormatter id to be used.
   */
  protected function getAddressCollectionResponse(AddressCollection $geo_collection, $dumper = NULL, $address_format = NULL) : void {
    $result = [];

    /** @var \Geocoder\Model\Address $geo_address **/
    foreach ($geo_collection
      ->all() as $k => $geo_address) {
      if (isset($dumper)) {
        $result[$k] = $dumper
          ->dump($geo_address);
      }
      else {
        $result[$k] = $geo_address
          ->toArray();

        // If a formatted_address property is not defined (as Google Maps
        // Geocoding does), then create it with our own formatter.
        if (!isset($result[$k]['formatted_address'])) {
          try {
            $result[$k]['formatted_address'] = $this->geocoderFormatterPluginManager
              ->createInstance($this
              ->getAddressFormatter($address_format))
              ->format($geo_address);
          } catch (\Exception $e) {
            watchdog_exception('geocoder', $e);
          }
        }

        // If a geometry property is not defined
        // (as Google Maps Geocoding does), then create it with our own dumper.
        if (!isset($result[$k]['geometry'])) {
          $result[$k]['geometry'] = $this
            ->addGeometryProperty($geo_address);
        }
      }
    }
    $this->response = new CacheableJsonResponse($result, 200);
    $this->response
      ->addCacheableDependency(CacheableMetadata::createFromObject($result));
  }

  /**
   * Get the output Dumper Format.
   *
   * @param string $format
   *   The Dumper Format.
   *
   * @return object|null
   *   The Dumper object or Null.
   */
  protected function getDumper($format) {
    $dumper = NULL;
    if (isset($format)) {
      try {
        $dumper = $this->dumperPluginManager
          ->createInstance($format);
      } catch (\Exception $e) {
        $dumper = NULL;
      }
    }
    return $dumper;
  }

  /**
   * Constructs a new GeofieldMapGeocoder object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\geocoder\Geocoder $geocoder
   *   The Geocoder service.
   * @param \Drupal\geocoder\DumperPluginManager $dumper_plugin_manager
   *   The dumper plugin manager service.
   * @param \Drupal\geocoder\FormatterPluginManager $geocoder_formatter_plugin_manager
   *   The geocoder formatter plugin manager service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, Geocoder $geocoder, DumperPluginManager $dumper_plugin_manager, FormatterPluginManager $geocoder_formatter_plugin_manager) {
    $this->config = $config_factory
      ->get('geocoder.settings');
    $this->geocoder = $geocoder;
    $this->dumperPluginManager = $dumper_plugin_manager;
    $this->geocoderFormatterPluginManager = $geocoder_formatter_plugin_manager;

    // Define a default empty Response as 204 No Content.
    $this->response = new Response('', 204);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('geocoder'), $container
      ->get('plugin.manager.geocoder.dumper'), $container
      ->get('plugin.manager.geocoder.formatter'));
  }

  /**
   * {@inheritdoc}
   */
  public function geocode(Request $request) {
    $address = $request
      ->get('address');
    $geocoders_ids = $request
      ->get('geocoder');
    $geocoders = explode(',', str_replace(' ', '', $geocoders_ids));
    $format = $request
      ->get('format');
    $address_format = $request
      ->get('address_format');
    if (isset($address)) {
      $options = $this
        ->setGeocodersOptions($request);
      $dumper = $this
        ->getDumper($format);
      $geo_collection = $this->geocoder
        ->geocode($address, $geocoders, $options);
      if ($geo_collection && $geo_collection instanceof AddressCollection) {
        $this
          ->getAddressCollectionResponse($geo_collection, $dumper, $address_format);
      }
    }
    return $this->response;
  }

  /**
   * {@inheritdoc}
   */
  public function reverseGeocode(Request $request) {
    $latlng = $request
      ->get('latlng');
    $geocoders_ids = $request
      ->get('geocoder');
    $geocoders = explode(',', $geocoders_ids);
    $format = $request
      ->get('format');
    if (isset($latlng)) {
      $latlng = explode(',', $request
        ->get('latlng'));
      $options = $this
        ->setGeocodersOptions($request);
      $dumper = $this
        ->getDumper($format);
      $geo_collection = $this->geocoder
        ->reverse($latlng[0], $latlng[1], $geocoders, $options);
      if ($geo_collection && $geo_collection instanceof AddressCollection) {
        $this
          ->getAddressCollectionResponse($geo_collection, $dumper);
      }
    }
    return $this->response;
  }

}

Classes

Name	Description
GeocoderApiEnpoints	Class GeocoderApiEnpoints.