You are here

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

class ProductAttributesOverview in Commerce Core 8.2

Plugin implementation of the 'commerce_product_attributes_overview' formatter.

Plugin annotation


@FieldFormatter(
  id = "commerce_product_attributes_overview",
  label = @Translation("Product attributes overview"),
  field_types = {
    "entity_reference",
  },
)

Hierarchy

Expanded class hierarchy of ProductAttributesOverview

File

modules/product/src/Plugin/Field/FieldFormatter/ProductAttributesOverview.php, line 30

Namespace

Drupal\commerce_product\Plugin\Field\FieldFormatter
View source 
class ProductAttributesOverview extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The entity display repository.
   *
   * @var \Drupal\Core\Entity|EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * The attribute field manager.
   *
   * @var \Drupal\commerce_product\ProductAttributeFieldManagerInterface
   */
  protected $attributeFieldManager;

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * Constructs a new ProductAttributesOverview 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 \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity|EntityDisplayRepositoryInterface $entity_display_repository
   *   The entity display repository.
   * @param \Drupal\commerce_product\ProductAttributeFieldManagerInterface $attribute_field_manager
   *   The attribute field manager.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityTypeManagerInterface $entity_type_manager, EntityDisplayRepositoryInterface $entity_display_repository, ProductAttributeFieldManagerInterface $attribute_field_manager, RendererInterface $renderer) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->entityTypeManager = $entity_type_manager;
    $this->entityDisplayRepository = $entity_display_repository;
    $this->attributeFieldManager = $attribute_field_manager;
    $this->renderer = $renderer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('entity_type.manager'), $container
      ->get('entity_display.repository'), $container
      ->get('commerce_product.attribute_field_manager'), $container
      ->get('renderer'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $product_type_storage = $this->entityTypeManager
      ->getStorage('commerce_product_type');
    $attribute_storage = $this->entityTypeManager
      ->getStorage('commerce_product_attribute');

    /** @var \Drupal\commerce_product\Entity\ProductTypeInterface $product_bundle */
    $product_bundle = $product_type_storage
      ->load($this->fieldDefinition
      ->getTargetBundle());
    $attribute_map = $this->attributeFieldManager
      ->getFieldMap($product_bundle
      ->getVariationTypeId());
    $used_attributes = [];
    foreach (array_column($attribute_map, 'attribute_id') as $item) {
      $attribute = $attribute_storage
        ->load($item);
      $used_attributes[$attribute
        ->id()] = $attribute
        ->label();
    }
    $view_modes = $this->entityDisplayRepository
      ->getViewModes('commerce_product_attribute_value');
    $view_mode_labels = array_map(function ($view_mode) {
      return $view_mode['label'];
    }, $view_modes);
    $form['attributes'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Display the following attributes'),
      '#default_value' => $this
        ->getSetting('attributes'),
      '#options' => $used_attributes,
    ];
    $form['view_mode'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Attribute value display mode'),
      '#default_value' => $this
        ->getSetting('view_mode'),
      '#options' => [
        'default' => $this
          ->t('Default'),
      ] + $view_mode_labels,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $attribute_storage = $this->entityTypeManager
      ->getStorage('commerce_product_attribute');
    $attributes = [];
    if (empty($this
      ->getSetting('attributes'))) {
      $attributes[] = $this
        ->t('None');
    }
    else {
      $attributes = $attribute_storage
        ->loadMultiple(array_filter($this
        ->getSetting('attributes')));
      $attributes = EntityHelper::extractLabels($attributes);
    }
    $summary[] = $this
      ->t('Displaying the following attributes: @attributes', [
      '@attributes' => implode(', ', $attributes),
    ]);
    $summary[] = $this
      ->t('Attribute value display mode: @mode', [
      '@mode' => $this
        ->getSetting('view_mode'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $attribute_storage = $this->entityTypeManager
      ->getStorage('commerce_product_attribute');
    $elements = [];

    /** @var \Drupal\commerce_product\Entity\ProductAttributeInterface[] $attributes */
    $attributes = $attribute_storage
      ->loadMultiple(array_filter($this
      ->getSetting('attributes')));
    foreach ($attributes as $attribute) {
      $elements[] = $this
        ->getAttributeItemList($items, $attribute);
    }
    return $elements;
  }

  /**
   * Gets the renderable item list of attributes.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $variation_items
   *   The item list of variation entities.
   * @param \Drupal\commerce_product\Entity\ProductAttributeInterface $attribute
   *   The product attribute.
   *
   * @return array
   *   The render array.
   */
  protected function getAttributeItemList(FieldItemListInterface $variation_items, ProductAttributeInterface $attribute) {
    $build = [
      '#theme' => 'item_list',
      '#title' => $attribute
        ->label(),
      '#items' => [],
    ];
    $view_builder = $this->entityTypeManager
      ->getViewBuilder('commerce_product_attribute_value');

    /** @var \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem $variation */
    foreach ($variation_items as $variation) {

      /** @var \Drupal\commerce_product\Entity\ProductAttributeValueInterface $attribute_value */
      $attribute_value = $variation->entity
        ->getAttributeValue('attribute_' . $attribute
        ->id());

      // If this attribute value has already been added, skip.
      if (isset($build['#items'][$attribute_value
        ->id()])) {
        continue;
      }
      $attribute_render_array = $view_builder
        ->view($attribute_value, $this
        ->getSetting('view_mode'));
      $attribute_build = $this->renderer
        ->render($attribute_render_array);
      $attribute_build = Link::fromTextAndUrl($attribute_build, $variation_items
        ->getEntity()
        ->toUrl())
        ->toRenderable();
      $build['#items'][$attribute_value
        ->id()] = $attribute_build;
    }
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    $entity_type = $field_definition
      ->getTargetEntityTypeId();
    $field_name = $field_definition
      ->getName();
    return $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
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
ProductAttributesOverview::$attributeFieldManager protected property The attribute field manager.
ProductAttributesOverview::$entityDisplayRepository protected property The entity display repository.
ProductAttributesOverview::$entityTypeManager protected property The entity type manager.
ProductAttributesOverview::$renderer protected property The renderer.
ProductAttributesOverview::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
ProductAttributesOverview::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
ProductAttributesOverview::getAttributeItemList protected function Gets the renderable item list of attributes.
ProductAttributesOverview::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
ProductAttributesOverview::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
ProductAttributesOverview::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
ProductAttributesOverview::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
ProductAttributesOverview::__construct public function Constructs a new ProductAttributesOverview object. Overrides FormatterBase::__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.