You are here

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

abstract class PurchasedEntityConditionBase in Commerce Core 8.2

Hierarchy

Expanded class hierarchy of PurchasedEntityConditionBase

File

modules/order/src/Plugin/Commerce/Condition/PurchasedEntityConditionBase.php, line 14

Namespace

Drupal\commerce_order\Plugin\Commerce\Condition
View source 
abstract class PurchasedEntityConditionBase extends ConditionBase implements PurchasableEntityConditionInterface, ContainerFactoryPluginInterface {

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

  /**
   * The entity UUID mapper.
   *
   * @var \Drupal\commerce\EntityUuidMapperInterface
   */
  protected $entityUuidMapper;

  /**
   * Constructs a new PurchasedEntityConditionBase object.
   *
   * @param array $configuration
   *   The plugin configuration, i.e. an array with configuration values keyed
   *   by configuration option name.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\commerce\EntityUuidMapperInterface $entity_uuid_mapper
   *   The entity UUID mapper.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EntityUuidMapperInterface $entity_uuid_mapper) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
    $this->entityUuidMapper = $entity_uuid_mapper;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('commerce.entity_uuid_mapper'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'entities' => [],
    ] + parent::defaultConfiguration();
  }

  /**
   * Gets the purchasable entity type.
   *
   * @return string
   *   The purchasable entity type.
   */
  protected function getPurchasableEntityType() : string {
    return $this->pluginDefinition['purchasable_entity_type'];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $purchasable_entity_type = $this->entityTypeManager
      ->getDefinition($this
      ->getPurchasableEntityType());
    assert($purchasable_entity_type !== NULL);
    $entities = NULL;
    $entity_ids = $this->entityUuidMapper
      ->mapToIds($this
      ->getPurchasableEntityType(), $this->configuration['entities']);
    if (count($entity_ids) > 0) {
      $variation_storage = $this->entityTypeManager
        ->getStorage($purchasable_entity_type
        ->id());
      $entities = $variation_storage
        ->loadMultiple($entity_ids);
    }
    $form['entities'] = [
      '#type' => 'entity_autocomplete',
      '#title' => $purchasable_entity_type
        ->getCollectionLabel(),
      '#default_value' => $entities,
      '#target_type' => $purchasable_entity_type
        ->id(),
      '#tags' => TRUE,
      '#required' => TRUE,
      '#maxlength' => NULL,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);

    // Convert selected IDs into UUIDs, and store them.
    $values = $form_state
      ->getValue($form['#parents']);
    $variation_ids = array_column($values['entities'], 'target_id');
    $this->configuration['entities'] = $this->entityUuidMapper
      ->mapFromIds($this
      ->getPurchasableEntityType(), $variation_ids);
  }

  /**
   * Determines whether the given purchasable entity is "valid".
   *
   * @param \Drupal\commerce\PurchasableEntityInterface|null $purchasable_entity
   *   The purchasable entity.
   *
   * @return bool
   *   Whether the given purchasable entity is "valid".
   */
  protected function isValid(PurchasableEntityInterface $purchasable_entity = NULL) : bool {
    return $purchasable_entity !== NULL && $purchasable_entity
      ->getEntityTypeId() === $this
      ->getPurchasableEntityType() && in_array($purchasable_entity
      ->uuid(), $this->configuration['entities'], TRUE);
  }

  /**
   * {@inheritdoc}
   */
  public function getPurchasableEntityIds() {
    return $this->entityUuidMapper
      ->mapToIds($this
      ->getPurchasableEntityType(), $this->configuration['entities']);
  }

  /**
   * {@inheritdoc}
   */
  public function getPurchasableEntities() {
    if ($entity_ids = $this
      ->getPurchasableEntityIds()) {
      $storage = $this->entityTypeManager
        ->getStorage($this
        ->getPurchasableEntityType());
      $entities = $storage
        ->loadMultiple($entity_ids);
    }
    return $entities ?? [];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConditionBase::assertEntity protected function Asserts that the given entity is of the expected type.
ConditionBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ConditionBase::getComparisonOperators protected function Gets the comparison operators.
ConditionBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConditionBase::getDisplayLabel public function Gets the condition display label. Overrides ConditionInterface::getDisplayLabel
ConditionBase::getEntityTypeId public function Gets the condition entity type ID. Overrides ConditionInterface::getEntityTypeId
ConditionBase::getLabel public function Gets the condition label. Overrides ConditionInterface::getLabel
ConditionBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConditionBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ConditionInterface::evaluate public function Evaluates the condition. 20
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
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.
PurchasedEntityConditionBase::$entityTypeManager protected property The entity type manager.
PurchasedEntityConditionBase::$entityUuidMapper protected property The entity UUID mapper.
PurchasedEntityConditionBase::buildConfigurationForm public function Form constructor. Overrides ConditionBase::buildConfigurationForm
PurchasedEntityConditionBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PurchasedEntityConditionBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConditionBase::defaultConfiguration
PurchasedEntityConditionBase::getPurchasableEntities public function Gets the configured purchasable entities. Overrides PurchasableEntityConditionInterface::getPurchasableEntities
PurchasedEntityConditionBase::getPurchasableEntityIds public function Gets the configured purchasable entity IDS. Overrides PurchasableEntityConditionInterface::getPurchasableEntityIds
PurchasedEntityConditionBase::getPurchasableEntityType protected function Gets the purchasable entity type.
PurchasedEntityConditionBase::isValid protected function Determines whether the given purchasable entity is "valid".
PurchasedEntityConditionBase::submitConfigurationForm public function Form submission handler. Overrides ConditionBase::submitConfigurationForm
PurchasedEntityConditionBase::__construct public function Constructs a new PurchasedEntityConditionBase object. Overrides ConditionBase::__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.