OrderHasProductClassCondition.php in Ubercart 8.4

Namespace

Drupal\uc_order\Plugin\Condition

File

uc_order/src/Plugin/Condition/OrderHasProductClassCondition.php

<?php

namespace Drupal\uc_order\Plugin\Condition;

use Drupal\Core\Entity\EntityTypeBundleInfoInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\rules\Core\RulesConditionBase;
use Drupal\uc_order\OrderInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides 'Order has a product with a selected product classes' condition.
 *
 * @Condition(
 *   id = "uc_order_condition_has_product_class",
 *   label = @Translation("Check an order's product classes"),
 *   category = @Translation("Order: Product"),
 *   context_definitions = {
 *     "order" = @ContextDefinition("entity:uc_order",
 *       label = @Translation("Order")
 *     ),
 *     "product_classes" = @ContextDefinition("string",
 *       label = @Translation("Product Classes"),
 *       list_options_callback = "productClassOptions",
 *       multiple = TRUE,
 *       assignment_restriction = "input"
 *     ),
 *     "required" = @ContextDefinition("boolean",
 *       label = @Translation("Require all selected product classes"),
 *       description = @Translation("Select to require that order must contain all selected product classes. Otherwise, order must contain at least one of the selected product classes."),
 *       list_options_callback = "booleanOptions"
 *     ),
 *     "forbidden" = @ContextDefinition("boolean",
 *       label = @Translation("Forbid other product classes"),
 *       list_options_callback = "booleanOptions"
 *     )
 *   }
 * )
 */
class OrderHasProductClassCondition extends RulesConditionBase implements ContainerFactoryPluginInterface {

  /**
   * The entity_type.bundle.info service.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityTypeBundleInfo;

  /**
   * {@inheritdoc}
   */
  public function summary() {
    return $this
      ->t("Check an order's product classes");
  }

  /**
   * Constructs a OrderHasProductClassCondition object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
   *   The core entity_type.bundle.info service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeBundleInfoInterface $entity_type_bundle_info) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeBundleInfo = $entity_type_bundle_info;
  }

  /**
   * {@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.bundle.info'));
  }

  /**
   * Options callback.
   *
   * @return array
   *   Associative array of all Ubercart product classes indexed by class ID.
   */
  public function productClassOptions() {
    $types = uc_product_types();
    $bundle_info = $this->entityTypeBundleInfo
      ->getAllBundleInfo();
    $options = [];
    foreach ($types as $machine_id) {
      $options[$machine_id] = $bundle_info['node'][$machine_id]['label'];
    }
    return $options;
  }

  /**
   * Returns a TRUE/FALSE option set for boolean types.
   *
   * @return array
   *   A TRUE/FALSE options array.
   */
  public function booleanOptions() {
    return [
      0 => $this
        ->t('False'),
      1 => $this
        ->t('True'),
    ];
  }

  /**
   * Checks that the order has the selected combination of product classes.
   *
   * @param \Drupal\uc_order\OrderInterface $order
   *   The order to check.
   * @param array $product_classes
   *   An array of strings containing the product classes (node content
   *   types) to check against.
   * @param bool $required
   *   TRUE to require all product classes be present in the order. FALSE
   *   to require at least one be present.
   * @param bool $forbidden
   *   TRUE to require that only the listed product classes be present. FALSE
   *   to allow products with other classes.
   *
   * @return bool
   *   TRUE if the order meets the specified conditions.
   */
  protected function doEvaluate(OrderInterface $order, array $product_classes = [], $required = FALSE, $forbidden = FALSE) {
    $order_product_classes = [];
    foreach ($order->products as $product) {
      if (!empty($product->type)) {

        // If present, use the product type from {uc_order_products}.data.type.
        $order_product_classes[] = $product->type;
      }
      else {

        // Otherwise, use the node type. If the node can't be loaded, ignore
        // this product.
        $node = Node::load($product->nid);
        if (!empty($node)) {
          $order_product_classes[] = $node->type;
        }
      }
    }
    $required_product_classes = array_intersect($product_classes, $order_product_classes);
    if ($required) {
      $required_check = $required_product_classes == $product_classes;
    }
    else {
      $required_check = (bool) count($required_product_classes);
    }
    if ($forbidden) {
      $forbidden_product_classes = array_diff($order_product_classes, $product_classes);
      $forbidden_check = (bool) count($forbidden_product_classes);
    }
    else {
      $forbidden_check = FALSE;
    }
    return $required_check && !$forbidden_check;
  }

}

Classes

Name	Description
OrderHasProductClassCondition	Provides 'Order has a product with a selected product classes' condition.