You are here

Home » API reference » Commerce Variation Add to Cart 8 » VariationAddToCartFormatter.php

class VariationAddToCartFormatter in Commerce Variation Add to Cart 8

Plugin implementation of the 'variation_add_to_cart_form' formatter.

Plugin annotation


@FieldFormatter(
  id = "variation_add_to_cart",
  label = @Translation("Variation add to cart form"),
  field_types = {
    "entity_reference"
  }
)

Hierarchy

Expanded class hierarchy of VariationAddToCartFormatter

File

src/Plugin/Field/FieldFormatter/VariationAddToCartFormatter.php, line 27

Namespace

Drupal\commerce_variation_add_to_cart\Plugin\Field\FieldFormatter
View source 
class VariationAddToCartFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The entity query.
   *
   * @var \Drupal\Core\Entity\Query\QueryInterface
   */
  protected $entityQuery;

  /**
   * The current request.
   *
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $currentRequest;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $instance
      ->setEntityQuery($container
      ->get('entity_type.manager'));
    $instance
      ->setCurrentRequest($container
      ->get('request_stack'));
    return $instance;
  }

  /**
   * Sets entity query.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function setEntityQuery(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityQuery = $entity_type_manager
      ->getStorage('commerce_product_attribute')
      ->getQuery();
  }

  /**
   * Sets the current request.
   *
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   */
  public function setCurrentRequest(RequestStack $request_stack) {
    $this->currentRequest = $request_stack
      ->getCurrentRequest();
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'show_title' => FALSE,
      'show_quantity' => TRUE,
      'show_price' => TRUE,
      'show_currency' => TRUE,
      'price_format' => '2',
      'attributes' => [],
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $attributes = $this->entityQuery
      ->execute();
    $form['show_title'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show variation title.'),
      '#default_value' => $this
        ->getSetting('show_title'),
    ];
    $form['show_quantity'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show quantity box.'),
      '#default_value' => $this
        ->getSetting('show_quantity'),
    ];
    $form['show_price'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show price.'),
      '#default_value' => $this
        ->getSetting('show_price'),
    ];
    $form['show_currency'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show currency.'),
      '#default_value' => $this
        ->getSetting('show_currency'),
    ];
    $form['price_format'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Price format.'),
      '#options' => [
        '0' => '0',
        '2' => '0.00',
      ],
      '#default_value' => $this
        ->getSetting('price_format'),
    ];
    $form['attributes'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Display the following attributes'),
      '#options' => $attributes,
      '#default_value' => $this
        ->getSetting('attributes'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    if ($this
      ->getSetting('show_title')) {
      $summary[] = $this
        ->t('Show variation title.');
    }
    else {
      $summary[] = $this
        ->t('Do not show variation title.');
    }
    if ($this
      ->getSetting('show_quantity')) {
      $summary[] = $this
        ->t('Show quantity box.');
    }
    else {
      $summary[] = $this
        ->t('Do not show quantity box.');
    }
    if ($this
      ->getSetting('show_price')) {
      $summary[] = $this
        ->t('Show price.');
    }
    else {
      $summary[] = $this
        ->t('Do not show price.');
    }
    if ($this
      ->getSetting('show_currency')) {
      $summary[] = $this
        ->t('Show currency.');
    }
    else {
      $summary[] = $this
        ->t('Do not show currency.');
    }
    if ($this
      ->getSetting('price_format') == 2) {
      $summary[] = $this
        ->t('Price format 0.00');
    }
    else {
      $summary[] = $this
        ->t('Price format 0');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $current_path = $this->currentRequest
      ->getRequestUri();
    $element = [];
    foreach ($items as $delta => $item) {
      $variation = ProductVariation::load($item->target_id);
      $is_active = !empty($variation) ? $variation
        ->isPublished() : FALSE;
      if (!$is_active) {
        continue;
      }
      $product_id = $variation
        ->getProductId();
      $variation_price = $variation
        ->getPrice();
      $variation_price_number = $variation_price
        ->getNumber();
      $variation_price_currency = $variation_price
        ->getCurrencyCode();
      $attributes_values = [];
      $attributes = $variation
        ->getAttributeValueIds();
      foreach ($attributes as $key => $value) {
        $variation_attr = str_replace('attribute_', '', $key);
        $selected_attr = $this
          ->getSetting('attributes');
        if (isset($selected_attr[$variation_attr]) && $selected_attr[$variation_attr] === $variation_attr) {
          $attribute_name = ProductAttributeValue::load($value);
          $attributes_values[] = $attribute_name
            ->getName();
        }
      }
      $element[$delta] = [
        '#theme' => 'variation_add_to_cart_formatter',
        '#variation' => $variation,
        '#product_id' => $product_id,
        '#variation_id' => $item->target_id,
        '#show_title' => $this
          ->getSetting('show_title'),
        '#title' => $variation
          ->getTitle(),
        '#show_price' => $this
          ->getSetting('show_price'),
        '#price_number' => $variation_price_number,
        '#price_format' => $this
          ->getSetting('price_format'),
        '#show_currency' => $this
          ->getSetting('show_currency'),
        '#price_currency' => $variation_price_currency,
        '#show_quantity' => $this
          ->getSetting('show_quantity') == 1 ? 'number' : 'hidden',
        '#attributes' => $attributes_values,
        '#destination' => $current_path,
      ];
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    $has_cart = \Drupal::moduleHandler()
      ->moduleExists('commerce_cart');
    $entity_type = $field_definition
      ->getTargetEntityTypeId();
    $field_name = $field_definition
      ->getName();
    return $has_cart && $entity_type == 'commerce_product' && $field_name == 'variations';
  }

}

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::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.
VariationAddToCartFormatter::$currentRequest protected property The current request.
VariationAddToCartFormatter::$entityQuery protected property The entity query.
VariationAddToCartFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
VariationAddToCartFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
VariationAddToCartFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
VariationAddToCartFormatter::setCurrentRequest public function Sets the current request.
VariationAddToCartFormatter::setEntityQuery public function Sets entity query.
VariationAddToCartFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
VariationAddToCartFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
VariationAddToCartFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements