You are here

Home » API reference » Ubercart 8.4 » PercentageTaxRate.php

class PercentageTaxRate in Ubercart 8.4

Defines the fixed percentage tax rate.

Plugin annotation


@UbercartTaxRate(
  id = "percentage_rate",
  label = @Translation("Percentage rate"),
  weight = 1,
)

Hierarchy

Expanded class hierarchy of PercentageTaxRate

File

uc_tax/src/Plugin/Ubercart/TaxRate/PercentageTaxRate.php, line 19

Namespace

Drupal\uc_tax\Plugin\Ubercart\TaxRate
View source 
class PercentageTaxRate extends TaxRatePluginBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'rate' => 0,
      'jurisdiction' => '',
      'field' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $fields = [
      '' => $this
        ->t('- None -'),
    ];
    $result = \Drupal::entityQuery('field_config')
      ->condition('field_type', 'number')
      ->execute();
    foreach (FieldConfig::loadMultiple($result) as $field) {
      $fields[$field
        ->getName()] = $field
        ->label();
    }
    $form['rate'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Default tax rate'),
      '#min' => 0,
      '#step' => 'any',
      '#description' => $this
        ->t('The percentage of the item price to add to the shipping cost for an item.'),
      '#default_value' => $this->configuration['rate'],
      '#field_suffix' => $this
        ->t('% (percent)'),
      '#required' => TRUE,
    ];
    $form['jurisdiction'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Jurisdiction'),
      '#description' => $this
        ->t('Administrative label for the taxing authority, used to prepare reports of collected taxes.'),
      '#default_value' => $this->configuration['jurisdiction'],
      '#required' => FALSE,
    ];
    $form['field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Tax rate override field'),
      '#description' => $this
        ->t('Overrides the default percentage tax rate for a product, when the field is attached to a product content type and has a value.'),
      '#options' => $fields,
      '#default_value' => $this->configuration['field'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['rate'] = $form_state
      ->getValue('rate');
    $this->configuration['field'] = $form_state
      ->getValue('field');
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    return $this
      ->t('Rate: @rate%', [
      '@rate' => $this->configuration['rate'],
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function calculateTax(OrderInterface $order) {
    $rate = $this->configuration['rate'];
    $jurisdiction = $this->configuration['jurisdiction'];
    $field = $this->configuration['field'];
    foreach ($order->products as $product) {
      if (isset($product->nid->entity->{$field}->value)) {
        $product_rate = $product->nid->entity->{$field}->value * $product->qty->value;
      }
      else {
        $product_rate = $this->configuration['rate'] * $product->qty->value;
      }
      $rate += $product->price->value * floatval($product_rate) / 100;
    }
    return [
      $rate,
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
PercentageTaxRate::buildConfigurationForm public function Form constructor. Overrides TaxRatePluginBase::buildConfigurationForm
PercentageTaxRate::calculateTax public function Returns the amount of tax for the order. Overrides TaxRatePluginBase::calculateTax
PercentageTaxRate::defaultConfiguration public function Gets default configuration for this plugin. Overrides TaxRatePluginBase::defaultConfiguration
PercentageTaxRate::getSummary public function Returns a short description of this tax rate. Overrides TaxRatePluginInterface::getSummary
PercentageTaxRate::submitConfigurationForm public function Form submission handler. Overrides TaxRatePluginBase::submitConfigurationForm
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.
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.
TaxRatePluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
TaxRatePluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
TaxRatePluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
TaxRatePluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct