You are here

Home » API reference » Commerce Core 8.2 » TaxNumberDefaultFormatter.php

class TaxNumberDefaultFormatter in Commerce Core 8.2

Plugin implementation of the 'commerce_tax_number_default' formatter.

Plugin annotation


@FieldFormatter(
  id = "commerce_tax_number_default",
  label = @Translation("Default"),
  field_types = {
    "commerce_tax_number"
  }
)

Hierarchy

Expanded class hierarchy of TaxNumberDefaultFormatter

File

modules/tax/src/Plugin/Field/FieldFormatter/TaxNumberDefaultFormatter.php, line 24

Namespace

Drupal\commerce_tax\Plugin\Field\FieldFormatter
View source 
class TaxNumberDefaultFormatter extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'show_verification' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['show_verification'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show verification details.'),
      '#default_value' => $this
        ->getSetting('show_verification'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    if ($this
      ->getSetting('show_verification')) {
      $summary[] = $this
        ->t('Show verification details.');
    }
    else {
      $summary[] = $this
        ->t('Do not show verification details.');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $states = [
      'success' => $this
        ->t('Success'),
      'failure' => $this
        ->t('Failure'),
      'unknown' => $this
        ->t('Unknown'),
    ];
    $entity = $items
      ->getEntity();
    $elements = [];
    foreach ($items as $delta => $item) {
      $element = [];
      $element['value'] = [
        '#plain_text' => $item->value,
      ];
      if ($this
        ->getSetting('show_verification')) {
        $element['#attached']['library'][] = 'commerce_tax/tax_number';
        $context = UrlData::encode([
          $entity
            ->getEntityTypeId(),
          $entity
            ->id(),
          $this->fieldDefinition
            ->getName(),
          $this->viewMode,
        ]);
        if ($item->verification_result) {
          $element['value'] = [
            '#type' => 'link',
            '#title' => $item->value,
            '#url' => Url::fromRoute('commerce_tax.verification_result', [
              'tax_number' => $item->value,
              'context' => $context,
            ]),
            '#attributes' => [
              'class' => [
                'use-ajax',
              ],
              'data-dialog-type' => 'modal',
              'data-dialog-options' => Json::encode([
                'width' => 500,
                'title' => $item->value,
              ]),
            ],
          ];
        }
        if ($item->verification_state && isset($states[$item->verification_state])) {
          $element['verification_state'] = [
            '#type' => 'html_tag',
            '#tag' => 'span',
            '#attributes' => [
              'title' => $this
                ->t('Verification state: @state', [
                '@state' => $states[$item->verification_state],
              ]),
              'class' => [
                'commerce-tax-number__verification-icon',
                'commerce-tax-number__verification-icon--' . $item->verification_state,
              ],
            ],
          ];
          $options = [
            'query' => [
              'destination' => Url::fromRoute('<current>')
                ->toString(),
            ],
          ];
          $element['reverify'] = [
            '#type' => 'container',
            '#access' => $item->verification_state == VerificationResult::STATE_UNKNOWN,
          ];
          $element['reverify']['link'] = [
            '#type' => 'link',
            '#title' => $this
              ->t('Reverify'),
            '#url' => Url::fromRoute('commerce_tax.verify', [
              'tax_number' => $item->value,
              'context' => $context,
            ], $options),
          ];
        }
      }
      $elements[$delta] = $element;
    }
    return $elements;
  }

}

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
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.
TaxNumberDefaultFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
TaxNumberDefaultFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
TaxNumberDefaultFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
TaxNumberDefaultFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements