You are here

abstract class TaxNumberTypeBase in Commerce Core 8.2

Provides the base class for tax number types.

Hierarchy

Expanded class hierarchy of TaxNumberTypeBase

File

modules/tax/src/Plugin/Commerce/TaxNumberType/TaxNumberTypeBase.php, line 10

Namespace

Drupal\commerce_tax\Plugin\Commerce\TaxNumberType
View source
abstract class TaxNumberTypeBase extends PluginBase implements TaxNumberTypeInterface {

  /**
   * {@inheritdoc}
   */
  public function getLabel() {
    return (string) $this->pluginDefinition['label'];
  }

  /**
   * {@inheritdoc}
   */
  public function getCountries() {
    return $this->pluginDefinition['countries'];
  }

  /**
   * {@inheritdoc}
   */
  public function getExamples() {
    return $this->pluginDefinition['examples'];
  }

  /**
   * {@inheritdoc}
   */
  public function getFormattedExamples() {
    $formatted_examples = '';
    if ($this->pluginDefinition['examples']) {
      $count = count($this->pluginDefinition['examples']);
      $formatted_examples = $this
        ->formatPlural($count, 'Example: @data.', 'Examples: @data.', [
        '@data' => implode(', ', $this->pluginDefinition['examples']),
      ]);
      $formatted_examples = (string) $formatted_examples;
    }
    return $formatted_examples;
  }

  /**
   * {@inheritdoc}
   */
  public function canonicalize($tax_number) {

    // Remove spaces, dots, dashes from the entered number.
    return preg_replace('/[ .-]/', '', $tax_number);
  }

}

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.
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
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.
TaxNumberTypeBase::canonicalize public function Canonicalizes the given tax number. Overrides TaxNumberTypeInterface::canonicalize
TaxNumberTypeBase::getCountries public function Gets the supported countries. Overrides TaxNumberTypeInterface::getCountries
TaxNumberTypeBase::getExamples public function Gets the tax number examples. Overrides TaxNumberTypeInterface::getExamples
TaxNumberTypeBase::getFormattedExamples public function Gets the tax number examples, formatted for display. Overrides TaxNumberTypeInterface::getFormattedExamples
TaxNumberTypeBase::getLabel public function Gets the tax number type label. Overrides TaxNumberTypeInterface::getLabel
TaxNumberTypeInterface::validate public function Validates the given tax number. 3