
| Current Path : /var/www/html/store/web/modules/contrib/commerce_shipping/src/EventSubscriber/ |
Linux ift1.ift-informatik.de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 |
| Current File : /var/www/html/store/web/modules/contrib/commerce_shipping/src/EventSubscriber/OrderSubscriber.php |
<?php
namespace Drupal\commerce_shipping\EventSubscriber;
use Drupal\commerce_shipping\ShippingOrderManagerInterface;
use Drupal\state_machine\Event\WorkflowTransitionEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
class OrderSubscriber implements EventSubscriberInterface {
/**
* The shipping order manager.
*
* @var \Drupal\commerce_shipping\ShippingOrderManagerInterface
*/
protected $shippingOrderManager;
/**
* Constructs a new OrderSubscriber object.
*
* @param \Drupal\commerce_shipping\ShippingOrderManagerInterface $shipping_order_manager
* The shipping order manager.
*/
public function __construct(ShippingOrderManagerInterface $shipping_order_manager) {
$this->shippingOrderManager = $shipping_order_manager;
}
/**
* {@inheritdoc}
*/
public static function getSubscribedEvents() {
return [
'commerce_order.cancel.post_transition' => ['onCancel'],
'commerce_order.place.post_transition' => ['onPlace'],
// @todo Remove onValidate/onFulfill once there is a Shipments admin UI.
'commerce_order.validate.post_transition' => ['onValidate'],
'commerce_order.fulfill.post_transition' => ['onFulfill'],
];
}
/**
* Cancels the order's shipments when the order is canceled.
*
* @param \Drupal\state_machine\Event\WorkflowTransitionEvent $event
* The transition event.
*/
public function onCancel(WorkflowTransitionEvent $event) {
/** @var \Drupal\commerce_order\Entity\OrderInterface $order */
$order = $event->getEntity();
if (!$this->shippingOrderManager->hasShipments($order)) {
return;
}
/** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment */
foreach ($order->get('shipments')->referencedEntities() as $shipment) {
if (!$shipment->getState()->isTransitionAllowed('cancel')) {
continue;
}
$shipment->getState()->applyTransitionById('cancel');
$shipment->save();
}
}
/**
* Finalizes the order's shipments when the order is placed.
*
* Only used if the workflow does not have a validation step.
* Otherwise the same logic is handled by onValidate().
*
* @param \Drupal\state_machine\Event\WorkflowTransitionEvent $event
* The transition event.
*/
public function onPlace(WorkflowTransitionEvent $event) {
/** @var \Drupal\commerce_order\Entity\OrderInterface $order */
$order = $event->getEntity();
$to_state = $event->getTransition()->getToState();
if ($to_state->getId() != 'fulfillment' || !$this->shippingOrderManager->hasShipments($order)) {
return;
}
/** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment */
foreach ($order->get('shipments')->referencedEntities() as $shipment) {
if (!$shipment->getState()->isTransitionAllowed('finalize')) {
continue;
}
$shipment->getState()->applyTransitionById('finalize');
$shipment->save();
}
}
/**
* Finalizes the order's shipments when the order is validated.
*
* @param \Drupal\state_machine\Event\WorkflowTransitionEvent $event
* The transition event.
*/
public function onValidate(WorkflowTransitionEvent $event) {
/** @var \Drupal\commerce_order\Entity\OrderInterface $order */
$order = $event->getEntity();
if (!$this->shippingOrderManager->hasShipments($order)) {
return;
}
/** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment */
foreach ($order->get('shipments')->referencedEntities() as $shipment) {
if (!$shipment->getState()->isTransitionAllowed('finalize')) {
continue;
}
$shipment->getState()->applyTransitionById('finalize');
$shipment->save();
}
}
/**
* Ships the order's shipments when the order is fulfilled.
*
* @param \Drupal\state_machine\Event\WorkflowTransitionEvent $event
* The transition event.
*/
public function onFulfill(WorkflowTransitionEvent $event) {
/** @var \Drupal\commerce_order\Entity\OrderInterface $order */
$order = $event->getEntity();
if (!$this->shippingOrderManager->hasShipments($order)) {
return;
}
/** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment */
foreach ($order->get('shipments')->referencedEntities() as $shipment) {
if (!$shipment->getState()->isTransitionAllowed('ship')) {
continue;
}
$shipment->getState()->applyTransitionById('ship');
$shipment->save();
}
}
}