LocalTaxTypeInterface.php in Commerce Core 8.2

Namespace

Drupal\commerce_tax\Plugin\Commerce\TaxType

File

modules/tax/src/Plugin/Commerce/TaxType/LocalTaxTypeInterface.php

<?php

namespace Drupal\commerce_tax\Plugin\Commerce\TaxType;

use CommerceGuys\Addressing\AddressInterface;

/**
 * Defines the interface for local tax type plugins.
 *
 * Local tax types store one or more tax zones with their
 * corresponding tax rates.
 */
interface LocalTaxTypeInterface extends TaxTypeInterface {

  /**
   * Gets whether tax should be rounded at the order item level.
   *
   * @return bool
   *   TRUE if tax should be rounded at the order item level, FALSE otherwise.
   */
  public function shouldRound();

  /**
   * Gets the tax zones.
   *
   * @return \Drupal\commerce_tax\TaxZone[]
   *   The tax zones, keyed by ID.
   */
  public function getZones();

  /**
   * Gets the tax zones which match the given address.
   *
   * @param \CommerceGuys\Addressing\AddressInterface $address
   *   The address.
   *
   * @return \Drupal\commerce_tax\TaxZone[]
   *   The tax zones, keyed by ID.
   */
  public function getMatchingZones(AddressInterface $address);

}

Interfaces

Name	Description
LocalTaxTypeInterface	Defines the interface for local tax type plugins.