You are here

Home » API reference » Drupal Commerce Connector for AvaTax 8 » AddressValidator.php

class AddressValidator in Drupal Commerce Connector for AvaTax 8

Address validator controller.

Hierarchy

Expanded class hierarchy of AddressValidator

File

src/Controller/AddressValidator.php, line 17

Namespace

Drupal\commerce_avatax\Controller
View source 
class AddressValidator extends ControllerBase {

  /**
   * The AvaTax library.
   *
   * @var \Drupal\commerce_avatax\AvataxLibInterface
   */
  protected $avataxLib;

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\Renderer
   */
  protected $renderer;

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

  /**
   * Constructs a new AddressValidator object.
   *
   * @param \Drupal\commerce_avatax\AvataxLibInterface $avatax_lib
   *   The AvaTax library.
   * @param \Drupal\Core\Render\Renderer $renderer
   *   The renderer.
   * @param \CommerceGuys\Addressing\Country\CountryRepositoryInterface $country_repository
   *   The country repository.
   */
  public function __construct(AvataxLibInterface $avatax_lib, Renderer $renderer, CountryRepositoryInterface $country_repository) {
    $this->avataxLib = $avatax_lib;
    $this->renderer = $renderer;
    $this->countryRepository = $country_repository;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('commerce_avatax.avatax_lib'), $container
      ->get('renderer'), $container
      ->get('address.country_repository'));
  }

  /**
   * Provides address validation.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   The response.
   */
  public function process(Request $request) {
    $content = $request
      ->getContent();
    if (empty($content)) {
      return new JsonResponse([
        'valid' => FALSE,
        'output' => NULL,
      ], 400);
    }
    $data = $this->avataxLib
      ->validateAddress(Json::decode($content));

    // If we have suggestion show it.
    if (!empty($data['suggestion'])) {
      $data['output'] = $this
        ->formatSuggestedAddress($data['original'], $data['suggestion'], $data['fields']);
      $data['payload'] = base64_encode(Json::encode($data['suggestion']));
    }
    elseif (!empty($data['original']) && !$data['valid']) {
      $data['output'] = $this
        ->formatSuggestedAddress($data['original']);
    }
    return new JsonResponse($data);
  }

  /**
   * Format an address for use in modal.
   *
   * @param array $original
   *   Original formatted address.
   * @param array $suggestion
   *   Suggested formatted address.
   * @param array $fields
   *   Fields which are different on suggestion and original address.
   *
   * @return \Drupal\Component\Render\MarkupInterface|string
   *   Return a formatted address for use in the order request.
   */
  protected function formatSuggestedAddress(array $original, array $suggestion = [], array $fields = []) {
    $countries = $this->countryRepository
      ->getAll();
    if (isset($original['country_code'])) {
      $original['country_code'] = $countries[$original['country_code']] ?? $original['country_code'];
    }
    if (isset($suggestion['country_code'])) {
      $suggestion['country_code'] = $countries[$suggestion['country_code']] ?? $suggestion['country_code'];
    }
    $build = [
      '#theme' => 'avatax_address',
      '#original' => $original,
      '#suggestion' => $suggestion,
      '#fields' => $fields,
    ];

    // Render output for modal.
    return $this->renderer
      ->renderPlain($build);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AddressValidator::$avataxLib protected property The AvaTax library.
AddressValidator::$countryRepository protected property The country repository.
AddressValidator::$renderer protected property The renderer.
AddressValidator::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
AddressValidator::formatSuggestedAddress protected function Format an address for use in modal.
AddressValidator::process public function Provides address validation.
AddressValidator::__construct public function Constructs a new AddressValidator object.
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.