class InitialOrderProcessor in Commerce Recurring Framework 8

Modifies the price of order items which start subscriptions.

Hierarchy

• class \Drupal\commerce_recurring\InitialOrderProcessor implements OrderProcessorInterface

1 string reference to 'InitialOrderProcessor'

commerce_recurring.services.yml in ./commerce_recurring.services.yml

commerce_recurring.services.yml

1 service uses InitialOrderProcessor

commerce_recurring.initial_order_processor in ./commerce_recurring.services.yml

Drupal\commerce_recurring\InitialOrderProcessor

File

src/InitialOrderProcessor.php, line 15

Namespace

Drupal\commerce_recurring

class InitialOrderProcessor implements OrderProcessorInterface {

  /**
   * The time.
   *
   * @var \Drupal\Component\Datetime\TimeInterface
   */
  protected $time;

  /**
   * Constructs a new InitialOrderProcessor object.
   *
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The time.
   */
  public function __construct(TimeInterface $time) {
    $this->time = $time;
  }

  /**
   * {@inheritdoc}
   */
  public function process(OrderInterface $order) {
    if ($order
      ->bundle() == 'recurring') {
      return;
    }
    $start_date = DrupalDateTime::createFromTimestamp($this->time
      ->getRequestTime());
    foreach ($order
      ->getItems() as $order_item) {
      $purchased_entity = $order_item
        ->getPurchasedEntity();
      if (!$purchased_entity || !$purchased_entity
        ->hasField('billing_schedule')) {
        continue;
      }

      /** @var \Drupal\commerce_recurring\Entity\BillingScheduleInterface $billing_schedule */
      $billing_schedule = $purchased_entity
        ->get('billing_schedule')->entity;
      if (!$billing_schedule) {
        continue;
      }
      $allow_trials = $billing_schedule
        ->getPlugin()
        ->allowTrials();

      // Price differences are added as adjustments, to preserve the original
      // price, for both display purposes and for being able to transfer the
      // unit price to the subscription when the order is placed.
      // It's assumed that the customer won't see the actual adjustment,
      // because the cart/order summary was hidden or restyled.
      if ($billing_schedule
        ->getBillingType() == BillingScheduleInterface::BILLING_TYPE_PREPAID) {
        if ($allow_trials) {
          $order_item
            ->addAdjustment(new Adjustment([
            'type' => 'subscription',
            'label' => t('Free trial'),
            'amount' => $order_item
              ->getTotalPrice()
              ->multiply('-1'),
            'source_id' => $billing_schedule
              ->id(),
          ]));
        }
        else {

          // Prepaid subscriptions need to be prorated so that the customer
          // pays only for the portion of the period that they'll get.
          $unit_price = $order_item
            ->getUnitPrice();
          $billing_period = $billing_schedule
            ->getPlugin()
            ->generateFirstBillingPeriod($start_date);
          $partial_billing_period = new BillingPeriod($start_date, $billing_period
            ->getEndDate());
          $prorater = $billing_schedule
            ->getProrater();
          $prorated_unit_price = $prorater
            ->prorateOrderItem($order_item, $partial_billing_period, $billing_period);
          if (!$prorated_unit_price
            ->equals($unit_price)) {
            $adjustment_amount = $unit_price
              ->subtract($prorated_unit_price);
            $adjustment_amount = $adjustment_amount
              ->multiply($order_item
              ->getQuantity());
            $order_item
              ->addAdjustment(new Adjustment([
              'type' => 'subscription',
              'label' => t('Proration'),
              'amount' => $adjustment_amount
                ->multiply('-1'),
              'source_id' => $billing_schedule
                ->id(),
            ]));
          }
        }
      }
      else {
        $label = $allow_trials ? t('Free trial') : t('Pay later');

        // A postpaid purchased entity is free in the initial order.
        $order_item
          ->addAdjustment(new Adjustment([
          'type' => 'subscription',
          'label' => $label,
          'amount' => $order_item
            ->getTotalPrice()
            ->multiply('-1'),
          'source_id' => $billing_schedule
            ->id(),
        ]));
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
InitialOrderProcessor::$time	protected	property	The time.
InitialOrderProcessor::process	public	function	Processes an order. Overrides OrderProcessorInterface::process
InitialOrderProcessor::__construct	public	function	Constructs a new InitialOrderProcessor object.