#3216713:Add formatter and static caching

Closes #3216713

Let's implement a hook_ENTITY_TYPE_load() for both promotions and coupons. This way you don't have to test the entity type.

That isn't what I meant by static caching.

The static caching needs to happen in the PromotionUsage service.

Using two properties on the service.

$couponUsage and $promotionUsage;

The usage should be cleared on register().

$couponUsage and $promotionUsage should be two arrays keyed. $couponUsage needs to be keyed by coupon id and promotion usage by promotion ID.

There's no need for that fake property on the entity. Populating the usage on the service should be sufficient.

We should inject the usage service and use it, instead of the fake property.

added 1 commit

• eba27cc7 - Issue #3216713: Add formatter and static caching

Compare with previous version

Clearing is not setting the usage to 0.

Clearing means unsetting the cache key.

unset($this->promotionUsage[$promotion->id]).

Same with couponUsage.

changed this line in version 3 of the diff

The static cache is $this->promotionUsage, there's no need to call &drupal_static() inside a class.

That is how I think loadMultiple() should look like:

  public function loadMultiple(array $promotions, $mail = NULL) {
    if (empty($promotions)) {
      return [];
    }
    $promotion_ids = EntityHelper::extractIds($promotions);
    $usage_to_load = $promotion_ids;

    // When not specifying an email, filter out the promotion IDS for which we
    // already fetched the usage.
    if (!$mail) {
      $usage_to_load = array_diff_key($promotion_ids, $this->promotionUsage);
    }

    if ($usage_to_load) {
      $query = $this->connection->select('commerce_promotion_usage', 'cpu');
      $query->addField('cpu', 'promotion_id');
      $query->addExpression('COUNT(promotion_id)', 'count');
      $query->condition('promotion_id', $usage_to_load, 'IN');
      if (!empty($mail)) {
        $query->condition('mail', $mail);
      }
      $query->groupBy('promotion_id');
      $this->promotionUsage += $query->execute()->fetchAllAssoc('promotion_id', \PDO::FETCH_ASSOC);
    }
    // Ensure that each promotion ID gets a count, even if it's not present
    // in the query due to non-existent usage.
    $counts = [];
    foreach ($promotion_ids as $promotion_id) {
      $counts[$promotion_id] = 0;
      if (isset($this->promotionUsage[$promotion_id])) {
        $counts[$promotion_id] = $this->promotionUsage[$promotion_id]['count'];
      }
    }

    return $counts;
  }

This will get the usage from the static cache if present, but only when the email is not specified.

Static cache for when the email is specified is probably unnecessary as this is done only once per request.

changed this line in version 3 of the diff

Let's do the following instead.

$instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
$instance->usage = $container->get('commerce_promotion.usage');
return $instance;

See PaymentMethodProfileFormatter for an example. (That removes the need of overriding the __construct().

changed this line in version 3 of the diff

The static cache is $this->couponUsage, there's no need to call &drupal_static() inside a class.

changed this line in version 3 of the diff

added 1 commit

• af1fa6dc - Issue #3216713: Add formatter and static caching

Compare with previous version

added 1 commit

• 4173a7ac - Issue #3216713: Add formatter and static caching

Compare with previous version