class ConfigSettingsForm in Drupal Commerce Connector for AvaTax 8

Configuration form for AvaTax settings.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\commerce_avatax\Form\ConfigSettingsForm

Expanded class hierarchy of ConfigSettingsForm

1 string reference to 'ConfigSettingsForm'

commerce_avatax.routing.yml in ./commerce_avatax.routing.yml: commerce_avatax.routing.yml

File

src/Form/ConfigSettingsForm.php, line 17

Namespace

Drupal\commerce_avatax\Form

View source

class ConfigSettingsForm extends ConfigFormBase {

  /**
   * The messenger.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Constructs a ConfigSettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The string translation.
   */
  public function __construct(ConfigFactoryInterface $config_factory, MessengerInterface $messenger, ModuleHandlerInterface $module_handler, TranslationInterface $string_translation) {
    parent::__construct($config_factory);
    $this->messenger = $messenger;
    $this->moduleHandler = $module_handler;
    $this->stringTranslation = $string_translation;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('messenger'), $container
      ->get('module_handler'), $container
      ->get('string_translation'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'commerce_avatax_config_settings';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'commerce_avatax.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('commerce_avatax.settings');
    $form['configuration'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Configuration'),
      '#open' => TRUE,
      '#id' => 'configuration-wrapper',
    ];
    $form['configuration']['api_mode'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('API mode:'),
      '#default_value' => $config
        ->get('api_mode'),
      '#options' => [
        'development' => $this
          ->t('Development'),
        'production' => $this
          ->t('Production'),
      ],
      '#required' => TRUE,
      '#description' => $this
        ->t('The mode to use when calculating taxes.'),
    ];
    $form['configuration']['account_id'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Account ID:'),
      '#default_value' => $config
        ->get('account_id'),
      '#required' => TRUE,
      '#description' => $this
        ->t('The account ID to use when calculating taxes.'),
    ];
    $form['configuration']['license_key'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('License key:'),
      '#default_value' => $config
        ->get('license_key'),
      '#required' => TRUE,
      '#description' => $this
        ->t('The license key to send to AvaTax when calculating taxes.'),
    ];
    $form['configuration']['company_code'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Company code:'),
      '#default_value' => $config
        ->get('company_code'),
      '#required' => TRUE,
      '#description' => $this
        ->t('The default company code to send to AvaTax when calculating taxes, if company code is not set on the store of a given order.'),
    ];
    $form['configuration']['validate'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Validate credentials'),
      '#limit_validation_errors' => [],
      '#ajax' => [
        'callback' => [
          $this,
          'validateCredentials',
        ],
        'wrapper' => 'configuration-wrapper',
      ],
    ];
    $form['configuration']['address_validation'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Address validation'),
      '#open' => TRUE,
      '#tree' => TRUE,
    ];
    $address_validation_settings = $config
      ->get('address_validation');
    $form['configuration']['address_validation']['enable'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Validate addresses in checkout'),
      '#description' => $this
        ->t('If checked, addresses entered in checkout will be validated.'),
      '#default_value' => $address_validation_settings['enable'],
    ];
    $form['configuration']['address_validation']['countries'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Countries'),
      '#default_value' => $address_validation_settings['countries'],
      '#options' => [
        'CA' => $this
          ->t('Canada'),
        'US' => $this
          ->t('United States'),
      ],
      '#description' => $this
        ->t('Restricts the address validation to the selected countries. If unchecked, US/CA addresses will be validated by default.'),
      '#states' => [
        'visible' => [
          ':input[name="address_validation[enable]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['configuration']['address_validation']['postal_code_match'] = [
      '#type' => 'checkbox',
      '#title' => t('Match on postal code'),
      '#description' => t('Postal codes are 9 digits, but most people enter the first 5 digits, do you want AvaTax to match all 9 digits?'),
      '#default_value' => $address_validation_settings['postal_code_match'],
      '#states' => [
        'visible' => [
          ':input[name="address_validation[enable]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['configuration']['advanced'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Advanced'),
      '#open' => TRUE,
    ];
    $form['configuration']['advanced']['disable_tax_calculation'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Disable tax calculation'),
      '#description' => $this
        ->t("Enable this option if you don't want to use AvaTax for the tax calculation."),
      '#default_value' => $config
        ->get('disable_tax_calculation'),
    ];
    $form['configuration']['advanced']['disable_commit'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Disable document committing.'),
      '#description' => $this
        ->t('Enable this option if you are only using the AvaTax service to display taxes and a backend system is performing the final commit of the tax document.'),
      '#default_value' => $config
        ->get('disable_commit'),
      '#states' => [
        'invisible' => [
          ':input[name="disable_tax_calculation"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['configuration']['advanced']['logging'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable logging'),
      '#description' => $this
        ->t('Enables detailed AvaTax transaction logging.'),
      '#default_value' => $config
        ->get('logging'),
      '#states' => [
        'invisible' => [
          ':input[name="disable_tax_calculation"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['configuration']['advanced']['shipping_tax_code'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Shipping Tax Code'),
      '#default_value' => $config
        ->get('shipping_tax_code'),
      '#required' => TRUE,
      '#description' => $this
        ->t('Browse shipping codes in Avalara\'s <a href="@tax-code-finder" target="_blank">tax code finder</a>.', [
        '@tax-code-finder' => 'https://taxcode.avatax.avalara.com/search?category=Freight&tab=decision_tree',
      ]),
      '#access' => $this->moduleHandler
        ->moduleExists('commerce_shipping'),
      '#states' => [
        'invisible' => [
          ':input[name="disable_tax_calculation"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['configuration']['advanced']['customer_code_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Customer code field'),
      '#default_value' => $config
        ->get('customer_code_field'),
      '#options' => [
        'mail' => $this
          ->t('Email'),
        'uid' => $this
          ->t('Customer ID'),
      ],
      '#required' => TRUE,
      '#description' => $this
        ->t('The "customerCode" field to use when the actual customer code field is empty (this setting affects authenticated users only).'),
      '#states' => [
        'invisible' => [
          ':input[name="disable_tax_calculation"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * Ajax callback for validation.
   */
  public function validateCredentials(array &$form, FormStateInterface $form_state) {
    return $form['configuration'];
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    $values = $form_state
      ->getValues();
    try {
      $client_factory = \Drupal::service('commerce_avatax.client_factory');
      $client = $client_factory
        ->createInstance($values);
      $ping_request = $client
        ->get('/api/v2/utilities/ping', [
        'headers' => [
          'Authorization' => 'Basic ' . base64_encode($values['account_id'] . ':' . $values['license_key']),
        ],
      ]);
      $ping_request = Json::decode($ping_request
        ->getBody()
        ->getContents());
      if (!empty($ping_request['authenticated']) && $ping_request['authenticated'] === TRUE) {
        $this->messenger
          ->addMessage($this
          ->t('AvaTax response confirmed using the account and license key above.'));
      }
      else {
        $form_state
          ->setError($form['configuration']['account_id'], $this
          ->t('Could not confirm the provided credentials.'));
        $form_state
          ->setError($form['configuration']['license_key'], $this
          ->t('Could not confirm the provided credentials.'));
      }
    } catch (\Exception $e) {
      $form_state
        ->setError($form['configuration'], $e
        ->getMessage());
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $address_validation = $form_state
      ->getValue('address_validation');
    $address_validation['countries'] = array_filter($address_validation['countries']);
    $this
      ->config('commerce_avatax.settings')
      ->set('api_mode', $form_state
      ->getValue('api_mode'))
      ->set('account_id', $form_state
      ->getValue('account_id'))
      ->set('company_code', $form_state
      ->getValue('company_code'))
      ->set('address_validation', $address_validation)
      ->set('customer_code_field', $form_state
      ->getValue('customer_code_field'))
      ->set('disable_commit', $form_state
      ->getValue('disable_commit'))
      ->set('disable_tax_calculation', $form_state
      ->getValue('disable_tax_calculation'))
      ->set('license_key', $form_state
      ->getValue('license_key'))
      ->set('logging', $form_state
      ->getValue('logging'))
      ->set('shipping_tax_code', $form_state
      ->getValue('shipping_tax_code'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
ConfigSettingsForm::$messenger	protected	property	The messenger. Overrides MessengerTrait::$messenger
ConfigSettingsForm::$moduleHandler	protected	property	The module handler.
ConfigSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
ConfigSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
ConfigSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ConfigSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
ConfigSettingsForm::validateCredentials	public	function	Ajax callback for validation.
ConfigSettingsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
ConfigSettingsForm::__construct	public	function	Constructs a ConfigSettingsForm object. Overrides ConfigFormBase::__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
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
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	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.

You are here

class ConfigSettingsForm in Drupal Commerce Connector for AvaTax 8

Hierarchy

File

Namespace

Members

API Navigation