You are here

Home » API reference » Commerce Product Add-on 8 » PadoAddToCartFormatter.php

class PadoAddToCartFormatter in Commerce Product Add-on 8

Plugin implementation of the 'commerce_pado_add_to_cart' formatter.

Plugin annotation


@FieldFormatter(
  id = "commerce_pado_add_to_cart",
  label = @Translation("Add to cart form with add-ons"),
  field_types = {
    "entity_reference",
  },
)

Hierarchy

Expanded class hierarchy of PadoAddToCartFormatter

File

src/Plugin/Field/FieldFormatter/PadoAddToCartFormatter.php, line 21

Namespace

Drupal\commerce_pado\Plugin\Field\FieldFormatter
View source 
class PadoAddToCartFormatter extends AddToCartFormatter {

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

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['multiple'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Multiple.'),
      '#description' => $this
        ->t('Customer should be able to select multiple add-ons.'),
      '#default_value' => $this
        ->getSetting('multiple'),
    ];
    $form['add_on_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('The product entity reference field to select add-ons from.'),
      '#description' => $this
        ->t('All the variations belonging to the selected products in the field will be offered as add-ons.'),
      '#default_value' => $this
        ->getSetting('add_on_field'),
      '#options' => $this
        ->getReferenceFieldOptions($this->fieldDefinition),
      '#required' => TRUE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $add_on_field = $this
      ->getSetting('add_on_field');
    if (!empty($add_on_field)) {
      $summary[] = $this
        ->t('The selected product add-on field is @field.', [
        '@field' => $this
          ->getSetting('add_on_field'),
      ]);
    }
    else {
      $summary[] = $this
        ->t('Please select a product add-on field.');
    }
    if ($this
      ->getSetting('multiple')) {
      $summary[] = $this
        ->t('The customer can select multiple add-ons.');
    }
    else {
      $summary[] = $this
        ->t('The customer can select only one add-on.');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $elements[0]['add_to_cart_form'] = [
      '#lazy_builder' => [
        'commerce_pado.lazy_builders:addToCartWithAddOnsForm',
        [
          $items
            ->getEntity()
            ->id(),
          $this->viewMode,
          $this
            ->getSetting('combine'),
          $this
            ->getSetting('add_on_field'),
          $this
            ->getSetting('multiple'),
        ],
      ],
      '#create_placeholder' => TRUE,
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    $return = parent::isApplicable($field_definition);
    $options = [];
    if ($return) {
      $options = self::getReferenceFieldOptions($field_definition);
    }
    return $return && !empty($options);
  }

  /**
   * Get candidates for product add-on fields.
   *
   * @param FieldDefinitionInterface $field_definition
   *   The field definition of the variations field we want to display
   *   add-ons for.
   *
   * @return array
   *   All the product entity reference fields on the same product keyed by
   *   their field machine names.
   */
  public static function getReferenceFieldOptions(FieldDefinitionInterface $field_definition) {
    $options = [];
    $entity_type = $field_definition
      ->getTargetEntityTypeId();
    $bundle = $field_definition
      ->getTargetBundle();
    if (empty($bundle)) {
      return $options;
    }
    $fields = \Drupal::service('entity_field.manager')
      ->getFieldDefinitions($entity_type, $bundle);

    /** @var \Drupal\field\Entity\FieldConfig $field */
    foreach ($fields as $field) {
      if ($field
        ->getType() === 'entity_reference') {
        $field_storage_config = \Drupal\field\Entity\FieldStorageConfig::loadByName($entity_type, $field
          ->getName());
        if ($field_storage_config && $field_storage_config
          ->getSetting('target_type') == 'commerce_product') {
          $options[$field
            ->getName()] = $field
            ->getLabel() . ' (' . $field
            ->getName() . ')';
        }
      }
    }
    return $options;
  }

}

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::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.
PadoAddToCartFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides AddToCartFormatter::defaultSettings
PadoAddToCartFormatter::getReferenceFieldOptions public static function Get candidates for product add-on fields.
PadoAddToCartFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides AddToCartFormatter::isApplicable
PadoAddToCartFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides AddToCartFormatter::settingsForm
PadoAddToCartFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides AddToCartFormatter::settingsSummary
PadoAddToCartFormatter::viewElements public function Builds a renderable array for a field value. Overrides AddToCartFormatter::viewElements
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.