You are here

Home » API reference » Commerce Price Table 8 » PriceTableDefaultFormatter.php

class PriceTableDefaultFormatter in Commerce Price Table 8

Plugin implementation of the 'commerce_price_table' formatter.

Plugin annotation


@FieldFormatter(
  id = "commerce_multiprice_default",
  label = @Translation("Price chart"),
  field_types = {
    "commerce_price_table"
  }
)

Hierarchy

Expanded class hierarchy of PriceTableDefaultFormatter

File

src/Plugin/Field/FieldFormatter/PriceTableDefaultFormatter.php, line 22

Namespace

Drupal\commerce_price_table\Plugin\Field\FieldFormatter
View source 
class PriceTableDefaultFormatter extends PriceDefaultFormatter {

  /**
   * Price table display orientation constants.
   */
  const HORIZONTAL_MODE = 0;
  const VERTICAL_MODE = 1;

  /**
   * The currency formatter.
   *
   * @var \CommerceGuys\Intl\Formatter\CurrencyFormatterInterface
   */
  protected $currencyFormatter;

  /**
   * Constructs a new PriceTableDefaultFormatter object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \CommerceGuys\Intl\Formatter\CurrencyFormatterInterface $currency_formatter
   *   The currency formatter.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, CurrencyFormatterInterface $currency_formatter) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $currency_formatter);
    $this->currencyFormatter = $currency_formatter;
  }

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

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $settings = [
      'price_label' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Price label for the price table'),
        '#default_value' => $this
          ->getSetting('price_label'),
      ],
      'quantity_label' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Quantity label for the price table'),
        '#default_value' => $this
          ->getSetting('quantity_label'),
      ],
      'table_orientation' => [
        '#type' => 'radios',
        '#options' => $this
          ->getOrientationOptionsList(),
        '#title' => $this
          ->t('Orientation of the price table'),
        '#default_value' => $this
          ->getSetting('table_orientation'),
      ],
    ] + parent::settingsForm($form, $form_state);
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $quantity_label = $this
      ->getSetting('quantity_label');
    $price_label = $this
      ->getSetting('price_label');
    $summary = [
      $this
        ->t('Quantity label: @label', [
        '@label' => !empty($quantity_label) ? $quantity_label : $this
          ->t('Quantity'),
      ]),
      $this
        ->t('Price label: @label', [
        '@label' => !empty($price_label) ? $price_label : $this
          ->t('Price'),
      ]),
      $this
        ->t('Orientation: @label', [
        '@label' => $this
          ->getOrientationLabel($this
          ->getSetting('table_orientation')),
      ]),
    ] + parent::settingsSummary();
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $header = [];
    $elements = [];
    $options = $this
      ->getFormattingOptions();
    foreach ($items as $delta => $item) {
      if (isset($item->min_qty) && $item->max_qty && $item->amount) {
        $header[] = $this
          ->getQuantityHeaders($item);
        $row[] = [
          'data' => $this->currencyFormatter
            ->format($item->amount, $item->currency_code, $options),
        ];
      }
    }
    if ($this
      ->getSetting('table_orientation') == PriceTableDefaultFormatter::VERTICAL_MODE) {
      $rows = [];
      $header_old = $header;
      $header = [
        $header_old[0],
        $row[0],
      ];
      for ($index = 1; $index < count($row); $index++) {
        $rows[] = [
          'data' => [
            $header_old[$index],
            $row[$index]['data'],
          ],
        ];
      }
    }
    else {
      $rows = isset($row) ? [
        $row,
      ] : [];
    }
    $elements[] = [
      '#type' => 'table',
      '#header' => $header,
      '#rows' => $rows,
    ];
    return $elements;
  }

  /**
   * Gets the formatting options for the currency formatter.
   *
   * @return array
   *   The formatting options.
   */
  protected function getFormattingOptions() {
    $options = [
      'currency_display' => $this
        ->getSetting('currency_display'),
    ];
    if ($this
      ->getSetting('strip_trailing_zeroes')) {
      $options['minimum_fraction_digits'] = 0;
    }
    return $options;
  }

  /**
   * Helper method that takes care of the quantity displayed in the headers of
   * the price table.
   */
  protected function getQuantityHeaders($item) {

    // Set the quantity text to unlimited if it's -1. $item->min_qty
    $max_qty = $item->max_qty == -1 ? $this
      ->t('Unlimited') : $item->max_qty;

    // If max and min qtys are the same, only show one.
    if ($item->min_qty == $max_qty) {
      $quantity_text = $item->min_qty;
    }
    else {
      $quantity_text = $item->min_qty . ' - ' . $max_qty;
    }
    return $quantity_text;
  }

  /**
   * Return list with available orientation options.
   *
   * @return array
   */
  protected function getOrientationOptionsList() {
    return [
      PriceTableDefaultFormatter::HORIZONTAL_MODE => $this
        ->t('Horizontal'),
      PriceTableDefaultFormatter::VERTICAL_MODE => $this
        ->t('Vertical'),
    ];
  }

  /**
   * Return orientation mode label.
   *
   * @param int $orientation_id
   *   ID of orientation mode.
   *
   * @return string
   */
  protected function getOrientationLabel($orientation_id) {
    $orientation_options = $this
      ->getOrientationOptionsList();
    if (array_key_exists($orientation_id, $orientation_options)) {
      return $orientation_options[$orientation_id];
    }

    // If no match found, then return default orientation label.
    return $orientation_options[PriceTableDefaultFormatter::HORIZONTAL_MODE];
  }

}

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::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
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
PriceDefaultFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create 2
PriceTableDefaultFormatter::$currencyFormatter protected property The currency formatter. Overrides PriceDefaultFormatter::$currencyFormatter
PriceTableDefaultFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PriceDefaultFormatter::defaultSettings
PriceTableDefaultFormatter::getFormattingOptions protected function Gets the formatting options for the currency formatter. Overrides PriceDefaultFormatter::getFormattingOptions
PriceTableDefaultFormatter::getOrientationLabel protected function Return orientation mode label.
PriceTableDefaultFormatter::getOrientationOptionsList protected function Return list with available orientation options.
PriceTableDefaultFormatter::getQuantityHeaders protected function Helper method that takes care of the quantity displayed in the headers of the price table.
PriceTableDefaultFormatter::HORIZONTAL_MODE constant Price table display orientation constants.
PriceTableDefaultFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides PriceDefaultFormatter::settingsForm
PriceTableDefaultFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides PriceDefaultFormatter::settingsSummary
PriceTableDefaultFormatter::VERTICAL_MODE constant
PriceTableDefaultFormatter::viewElements public function Builds a renderable array for a field value. Overrides PriceDefaultFormatter::viewElements
PriceTableDefaultFormatter::__construct public function Constructs a new PriceTableDefaultFormatter object. Overrides PriceDefaultFormatter::__construct
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.