Orders" page
*/
class OrderController extends PrestaShopAdminController
{
/**
* Default number of products per page (in case invalid value is used)
*/
public const DEFAULT_PRODUCTS_NUMBER = 8;
/**
* Options used for the number of products per page
*/
public const PRODUCTS_PAGINATION_OPTIONS = [8, 20, 50, 100];
public function __construct(private readonly FormFactoryInterface $formFactory)
{
}
/**
* Shows list of orders
*
* @param Request $request
* @param OrderFilters $filters
*
* @return Response
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))")]
public function indexAction(
Request $request,
OrderFilters $filters,
#[Autowire(service: 'prestashop.core.kpi_row.factory.orders')] KpiRowFactoryInterface $orderKpiFactory,
#[Autowire(service: 'prestashop.core.grid.factory.order')] GridFactory $orderGridFactory,
) {
$orderGrid = $orderGridFactory->getGrid($filters);
$changeOrderStatusesForm = $this->createForm(ChangeOrdersStatusType::class);
return $this->render(
'@PrestaShop/Admin/Sell/Order/Order/index.html.twig',
[
'orderGrid' => $this->presentGrid($orderGrid),
'help_link' => $this->generateSidebarLink($request->attributes->get('_legacy_controller')),
'enableSidebar' => true,
'changeOrderStatusesForm' => $changeOrderStatusesForm->createView(),
'orderKpi' => $orderKpiFactory->build(),
'layoutHeaderToolbarBtn' => $this->getOrderToolbarButtons(),
]
);
}
/**
* @return array
*/
private function getOrderToolbarButtons(): array
{
$toolbarButtons = [];
$isSingleShopContext = $this->getShopContext()->getShopConstraint()->isSingleShopContext();
$toolbarButtons['add'] = [
'href' => $this->generateUrl('admin_orders_create'),
'desc' => $this->trans('Add new order', [], 'Admin.Orderscustomers.Feature'),
'icon' => 'add_circle_outline',
'disabled' => !$isSingleShopContext,
];
if (!$isSingleShopContext) {
$toolbarButtons['add']['help'] = $this->trans(
'You can use this feature in a single-store context only. Switch contexts to enable it.',
[],
'Admin.Orderscustomers.Feature'
);
$toolbarButtons['add']['href'] = '#';
}
return $toolbarButtons;
}
/**
* Places an order from BO
*
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('create', request.get('_legacy_controller'))")]
public function placeAction(
Request $request,
#[Autowire(service: 'prestashop.core.form.identifiable_object.handler.cart_summary_form_handler')] FormHandlerInterface $formHandler
) {
$summaryForm = $this->createForm(CartSummaryType::class);
$summaryForm->handleRequest($request);
try {
$result = $formHandler->handle($summaryForm);
if ($result->getIdentifiableObjectId() instanceof OrderId) {
/** @var OrderId $orderId */
$orderId = $result->getIdentifiableObjectId();
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId->getValue(),
]);
}
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
return $this->redirectToRoute('admin_orders_create');
}
/**
* Renders create order page.
* Whole page dynamics are on javascript side.
* To load specific cart pass cartId to url query params (handled by javascript)
*
* @param Request $request
*
* @return Response
*/
#[AdminSecurity("is_granted('create', request.get('_legacy_controller'))")]
public function createAction(
Request $request,
LanguageByIdChoiceProvider $languageChoiceProvider,
#[Autowire(service: 'prestashop.core.form.choice_provider.currency_by_id')] FormChoiceProviderInterface $currencyChoiceProvider,
) {
$isSingleShopContext = $this->getShopContext()->getShopConstraint()->isSingleShopContext();
if (!$isSingleShopContext) {
$this->addFlash('error', $this->trans(
'You have to select a shop before creating new orders.',
[],
'Admin.Orderscustomers.Notification'
));
return $this->redirectToRoute('admin_orders_index');
}
$summaryForm = $this->createForm(CartSummaryType::class);
$languages = $languageChoiceProvider->getChoices(
[
'shop_id' => $this->getShopContext()->getShopConstraint()->getShopId()?->getValue(),
]
);
$configuration = $this->getConfiguration();
return $this->render('@PrestaShop/Admin/Sell/Order/Order/create.html.twig', [
'currencies' => $currencyChoiceProvider->getChoices(),
'languages' => $languages,
'summaryForm' => $summaryForm->createView(),
'help_link' => $this->generateSidebarLink($request->attributes->get('_legacy_controller')),
'enableSidebar' => true,
'recycledPackagingEnabled' => (bool) $configuration->get('PS_RECYCLABLE_PACK'),
'giftSettingsEnabled' => (bool) $configuration->get('PS_GIFT_WRAPPING'),
'stockManagementEnabled' => (bool) $configuration->get('PS_STOCK_MANAGEMENT'),
'isB2BEnabled' => (bool) $configuration->get('PS_B2B_ENABLE'),
'layoutTitle' => $this->trans('New order', [], 'Admin.Navigation.Menu'),
]);
}
/**
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function searchAction(
Request $request,
#[Autowire(service: 'prestashop.core.grid.definition.factory.order')] OrderGridDefinitionFactory $orderGridDefinitionFactory,
) {
return $this->buildSearchResponse(
$orderGridDefinitionFactory,
$request,
OrderGridDefinitionFactory::GRID_ID,
'admin_orders_index'
);
}
/**
* Generates invoice PDF for given order
*
* @param int $orderId
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function generateInvoicePdfAction(
int $orderId,
#[Autowire(service: 'prestashop.adapter.pdf.order_invoice_pdf_generator')] OrderInvoicePdfGenerator $invoicePdfGenerator,
): Response {
$generatedPdf = $invoicePdfGenerator->generatePDFForResponse([$orderId]);
$response = new Response($generatedPdf->getContent());
$disposition = HeaderUtils::makeDisposition(
HeaderUtils::DISPOSITION_ATTACHMENT,
$generatedPdf->getFileName()
);
$response->headers->set('Content-Type', 'application/pdf');
$response->headers->set('Content-Disposition', $disposition);
return $response;
}
/**
* Generates delivery slip PDF for given order
*
* @param int $orderId
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function generateDeliverySlipPdfAction(
int $orderId,
#[Autowire(service: 'prestashop.adapter.pdf.delivery_slip_pdf_generator')] DeliverySlipPdfGenerator $deliverySlipPdfGenerator,
): Response {
$generatedPdf = $deliverySlipPdfGenerator->generatePDFForResponse([$orderId]);
$response = new Response($generatedPdf->getContent());
$disposition = HeaderUtils::makeDisposition(
HeaderUtils::DISPOSITION_ATTACHMENT,
$generatedPdf->getFileName()
);
$response->headers->set('Content-Type', 'application/pdf');
$response->headers->set('Content-Disposition', $disposition);
return $response;
}
/**
* Generate delivery slip PDF for a specific shipment
*/
#[AdminSecurity("is_granted('read', 'AdminOrders')", message: 'You do not have permission to view this.', redirectRoute: 'admin_orders_index')]
public function generateShipmentDeliverySlipPdfAction(
int $shipmentId,
#[Autowire(service: 'prestashop.adapter.pdf.shipment_delivery_slip_pdf_generator')] PDFGeneratorInterface $shipmentDeliverySlipPdfGenerator,
): BinaryFileResponse {
return new BinaryFileResponse($shipmentDeliverySlipPdfGenerator->generatePDF([$shipmentId]));
}
/**
* Generate delivery slip PDF for multiple shipments or all shipments of an order
*
* @return BinaryFileResponse|RedirectResponse
*/
#[AdminSecurity("is_granted('read', 'AdminOrders')", message: 'You do not have permission to view this.', redirectRoute: 'admin_orders_index')]
public function generateShipmentsDeliverySlipPdfAction(
Request $request,
int $orderId,
#[Autowire(service: 'prestashop.adapter.pdf.shipment_delivery_slip_pdf_generator')] PDFGeneratorInterface $shipmentDeliverySlipPdfGenerator,
) {
$shipmentIds = $request->isMethod('POST')
? $request->request->all('shipmentIds')
: $request->query->all('shipmentIds');
if (empty($shipmentIds)) {
/** @var OrderShipment[] $orderShipments */
$orderShipments = $this->dispatchQuery(new GetOrderShipments($orderId));
$shipmentIds = [];
foreach ($orderShipments as $shipment) {
if ($shipment->getTrackingNumber() !== null && $shipment->getPackedAt() !== null) {
$shipmentIds[] = $shipment->getId();
}
}
}
$shipmentIds = array_map('intval', (array) $shipmentIds);
if (empty($shipmentIds)) {
$this->addFlash('error', $this->trans('There is no fulfilled shipment to download', [], 'Admin.Notifications.Error'));
return $this->redirectToRoute('admin_orders_view');
}
return new BinaryFileResponse($shipmentDeliverySlipPdfGenerator->generatePDF($shipmentIds));
}
/**
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function changeOrdersStatusAction(Request $request)
{
$changeOrdersStatusForm = $this->createForm(ChangeOrdersStatusType::class);
$changeOrdersStatusForm->handleRequest($request);
$data = $changeOrdersStatusForm->getData();
try {
$this->dispatchCommand(
new BulkChangeOrderStatusCommand($data['order_ids'], (int) $data['new_order_status_id'])
);
$this->addFlash('success', $this->trans('Successful update', [], 'Admin.Notifications.Success'));
} catch (ChangeOrderStatusException $e) {
$this->handleChangeOrderStatusException($e);
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
return $this->redirectToRoute('admin_orders_index');
}
/**
* @param OrderFilters $filters
*
* @return CsvResponse
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function exportAction(
OrderFilters $filters,
#[Autowire(service: 'prestashop.core.grid.factory.order')] GridFactory $orderGridFactory,
) {
$isB2bEnabled = $this->getConfiguration()->get('PS_B2B_ENABLE');
$filters = new OrderFilters(['limit' => null] + $filters->all());
$orderGrid = $orderGridFactory->getGrid($filters);
$headers = [
'id_order' => $this->trans('ID', [], 'Admin.Global'),
'reference' => $this->trans('Reference', [], 'Admin.Global'),
'new' => $this->trans('New client', [], 'Admin.Orderscustomers.Feature'),
'country_name' => $this->trans('Delivery', [], 'Admin.Global'),
'customer' => $this->trans('Customer', [], 'Admin.Global'),
'total_paid_tax_incl' => $this->trans('Total', [], 'Admin.Global'),
'payment' => $this->trans('Payment', [], 'Admin.Global'),
'osname' => $this->trans('Status', [], 'Admin.Global'),
'date_add' => $this->trans('Date', [], 'Admin.Global'),
];
if ($isB2bEnabled) {
$headers['company'] = $this->trans('Company', [], 'Admin.Global');
}
$data = [];
foreach ($orderGrid->getData()->getRecords()->all() as $record) {
$item = [
'id_order' => $record['id_order'],
'reference' => $record['reference'],
'new' => $record['new'],
'country_name' => $record['country_name'],
'customer' => $record['customer'],
'total_paid_tax_incl' => $record['total_paid_tax_incl'],
'payment' => $record['payment'],
'osname' => $record['osname'],
'date_add' => $record['date_add'],
];
if ($isB2bEnabled) {
$item['company'] = $record['company'];
}
$data[] = $item;
}
return (new CsvResponse())
->setData($data)
->setHeadersData($headers)
->setFileName('order_' . date('Y-m-d_His') . '.csv');
}
/**
* @param int $orderId
* @param Request $request
*
* @return Response
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))")]
public function viewAction(
int $orderId,
Request $request,
#[Autowire(service: 'prestashop.core.form.identifiable_object.builder.cancel_product_form_builder')] FormBuilderInterface $formBuilder,
#[Autowire(service: 'prestashop.adapter.order.order_sibling_provider')] OrderSiblingProviderInterface $orderSiblingProvider,
CurrencyDataProvider $currencyDataProvider,
FeatureFlagStateCheckerInterface $featureFlagStateChecker,
#[Autowire(service: 'PrestaShop\PrestaShop\Core\Grid\Factory\ShipmentFactory')] GridFactoryInterface $shipmentGridFactory,
#[Autowire(service: 'prestashop.core.form.identifiable_object.builder.add_product_form_builder')] FormBuilderInterface $addProductFormBuilder,
#[Autowire(service: 'prestashop.core.form.identifiable_object.builder.edit_order_product_form_builder')] FormBuilderInterface $editProductFormBuilder,
ShipmentFilters $filters,
Tools $tools,
): Response {
try {
/** @var OrderForViewing $orderForViewing */
$orderForViewing = $this->dispatchQuery(new GetOrderForViewing($orderId, QuerySorting::DESC));
} catch (OrderException $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
return $this->redirectToRoute('admin_orders_index');
}
$filters = new ShipmentFilters(['filters' => ['order_id' => $orderId]] + $filters->all());
$shipmentsGrid = $shipmentGridFactory->getGrid($filters);
$updateOrderStatusForm = $this->formFactory->createNamed(
'update_order_status',
UpdateOrderStatusType::class,
[
'new_order_status_id' => $orderForViewing->getHistory()->getCurrentOrderStatusId(),
]
);
$updateOrderStatusActionBarForm = $this->formFactory->createNamed(
'update_order_status_action_bar',
UpdateOrderStatusType::class,
[
'new_order_status_id' => $orderForViewing->getHistory()->getCurrentOrderStatusId(),
]
);
$addOrderCartRuleForm = $this->createForm(AddOrderCartRuleType::class, [], [
'order_id' => $orderId,
]);
$addOrderPaymentForm = $this->createForm(OrderPaymentType::class, [
'id_currency' => $orderForViewing->getCurrencyId(),
], [
'id_order' => $orderId,
]);
$orderMessageForm = $this->createForm(OrderMessageType::class, [
'lang_id' => $orderForViewing->getCustomer()->getLanguageId(),
], [
'action' => $this->generateUrl('admin_orders_send_message', ['orderId' => $orderId]),
]);
$orderMessageForm->handleRequest($request);
$changeOrderCurrencyForm = $this->createForm(ChangeOrderCurrencyType::class, [], [
'current_currency_id' => $orderForViewing->getCurrencyId(),
]);
$changeOrderAddressForm = null;
$privateNoteForm = null;
if (null !== $orderForViewing->getCustomer() && $orderForViewing->getCustomer()->getId() !== 0) {
$changeOrderAddressForm = $this->createForm(ChangeOrderAddressType::class, [], [
'customer_id' => $orderForViewing->getCustomer()->getId(),
]);
$privateNoteForm = $this->createForm(PrivateNoteType::class, [
'note' => $orderForViewing->getCustomer()->getPrivateNote(),
]);
}
$updateOrderShippingForm = $this->createForm(UpdateOrderShippingType::class, [
'new_carrier_id' => $orderForViewing->getCarrierId(),
], [
'order_id' => $orderId,
]);
// @todo: Fix me. Should not rely on legacy object model - Currency
$orderCurrency = $currencyDataProvider->getCurrencyById($orderForViewing->getCurrencyId());
$addProductForm = $addProductFormBuilder->getFormFor($orderId);
$editProductRowForm = $editProductFormBuilder->getFormFor($orderId);
$internalNoteForm = $this->createForm(InternalNoteType::class, [
'note' => $orderForViewing->getNote(),
]);
$backOfficeOrderButtons = new ActionsBarButtonsCollection();
try {
$this->dispatchHookWithParameters(
'actionGetAdminOrderButtons',
[
'controller' => $this,
'id_order' => $orderId,
'actions_bar_buttons_collection' => $backOfficeOrderButtons,
]
);
$cancelProductForm = $formBuilder->getFormFor($orderId);
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
return $this->redirectToRoute('admin_orders_index');
}
$this->handleOutOfStockProduct($orderForViewing);
$merchandiseReturnEnabled = (bool) $this->getConfiguration()->get('PS_ORDER_RETURN');
$paginationNum = ($this->getConfiguration()->get('PS_ORDER_PRODUCTS_NB_PER_PAGE') ?? self::DEFAULT_PRODUCTS_NUMBER);
$paginationNumOptions = self::PRODUCTS_PAGINATION_OPTIONS;
if (!in_array($paginationNum, $paginationNumOptions)) {
$paginationNumOptions[] = $paginationNum;
}
sort($paginationNumOptions);
$metatitle = sprintf(
'%s %s %s',
$this->trans('Orders', [], 'Admin.Orderscustomers.Feature'),
$this->getConfiguration()->get('PS_NAVIGATION_PIPE') ?? '>',
$this->trans(
'Order %reference% from %firstname% %lastname%',
[
'%reference%' => $orderForViewing->getReference(),
'%firstname%' => $orderForViewing->getCustomer()->getFirstName(),
'%lastname%' => $orderForViewing->getCustomer()->getLastName(),
],
'Admin.Orderscustomers.Feature',
)
);
$shipmentsLabel = $this->trans(
'Shipments ([1]%shipment_count%[/1])',
[
'%shipment_count%' => $shipmentsGrid->getData()->getRecordsTotal(),
'[1]' => '',
'[/1]' => '',
],
'Admin.Shipping.Feature'
);
$carriersLabel = $this->trans(
'Carriers ([1]%carriers_count%[/1])',
[
'%carriers_count%' => count($orderForViewing->getShipping()->getCarriers()),
'[1]' => '',
'[/1]' => '',
],
'Admin.Shipping.Feature'
);
return $this->render('@PrestaShop/Admin/Sell/Order/Order/view.html.twig', [
'showContentHeader' => true,
'enableSidebar' => true,
'orderCurrency' => $orderCurrency,
'meta_title' => $metatitle,
'help_link' => $this->generateSidebarLink($request->attributes->get('_legacy_controller')),
'orderForViewing' => $orderForViewing,
'addOrderCartRuleForm' => $addOrderCartRuleForm->createView(),
'updateOrderStatusForm' => $updateOrderStatusForm->createView(),
'updateOrderStatusActionBarForm' => $updateOrderStatusActionBarForm->createView(),
'addOrderPaymentForm' => $addOrderPaymentForm->createView(),
'changeOrderCurrencyForm' => $changeOrderCurrencyForm->createView(),
'privateNoteForm' => $privateNoteForm?->createView(),
'updateOrderShippingForm' => $updateOrderShippingForm->createView(),
'cancelProductForm' => $cancelProductForm->createView(),
'invoiceManagementIsEnabled' => $orderForViewing->isInvoiceManagementIsEnabled(),
'changeOrderAddressForm' => $changeOrderAddressForm?->createView(),
'orderMessageForm' => $orderMessageForm->createView(),
'addProductRowForm' => $addProductForm->createView(),
'editProductRowForm' => $editProductRowForm->createView(),
'backOfficeOrderButtons' => $backOfficeOrderButtons,
'merchandiseReturnEnabled' => $merchandiseReturnEnabled,
'priceSpecification' => $this->getLanguageContext()->getPriceSpecification($orderCurrency->iso_code)->toArray(),
'previousOrderId' => $orderSiblingProvider->getPreviousOrderId($orderId),
'nextOrderId' => $orderSiblingProvider->getNextOrderId($orderId),
'paginationNum' => $paginationNum,
'paginationNumOptions' => $paginationNumOptions,
'isAvailableQuantityDisplayed' => (bool) $this->getConfiguration()->get('PS_STOCK_MANAGEMENT'),
'internalNoteForm' => $internalNoteForm->createView(),
'isImprovedShipmentFeatureFlagEnabled' => $featureFlagStateChecker->isEnabled(FeatureFlagSettings::FEATURE_FLAG_IMPROVED_SHIPMENT),
'orderHasShipment' => $this->orderHasShipment($orderForViewing->getId()),
'shipmentsGrid' => $this->presentGrid($shipmentsGrid),
'shipmentsLabel' => $tools->purifyHTML($shipmentsLabel),
'carriersLabel' => $tools->purifyHTML($carriersLabel),
]);
}
#[AdminSecurity("is_granted('update', 'AdminOrders')", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function getMergeShipmentForm(int $orderId, int $shipmentId, Request $request, #[Autowire(service: 'prestashop.core.form.identifiable_object.builder.merge_shipment_form_builder')] FormBuilderInterface $formBuilder): Response
{
$form = $formBuilder->getFormFor($orderId);
$data = $form->getData();
return $this->render('@PrestaShop/Admin/Sell/Order/Order/Blocks/View/merge_shipment_form.html.twig', [
'mergeShipmentForm' => $form->createView(),
'orderId' => $orderId,
'shipmentId' => $shipmentId,
'products' => $data['products'],
'isShipped' => $data['is_shipped'],
]);
}
#[AdminSecurity("is_granted('update', 'AdminOrders')", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function getAddProductForm(
int $orderId,
#[Autowire(service: 'prestashop.core.form.identifiable_object.builder.add_product_form_builder')] FormBuilderInterface $addProductFormBuilder,
FeatureFlagStateCheckerInterface $featureFlagStateChecker
): Response {
$orderForViewing = $this->dispatchQuery(new GetOrderForViewing($orderId, QuerySorting::DESC));
$form = $addProductFormBuilder->getFormFor($orderId);
return $this->render('@PrestaShop/Admin/Sell/Order/Order/Blocks/View/add_product_form.html.twig', [
'addProductForm' => $form->createView(),
'orderForViewing' => $orderForViewing,
'orderHasShipment' => $this->orderHasShipment($orderForViewing->getId()),
'isMultishipmentIsEnabled' => $featureFlagStateChecker->isEnabled(FeatureFlagSettings::FEATURE_FLAG_IMPROVED_SHIPMENT),
'orderId' => $orderId,
]);
}
#[AdminSecurity("is_granted('update', 'AdminOrders')", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function getEditProductForm(
int $orderId,
int $orderDetailId,
#[Autowire(service: 'prestashop.core.form.identifiable_object.builder.edit_order_product_form_builder')] FormBuilderInterface $orderProductFormBuilder,
FeatureFlagStateCheckerInterface $featureFlagStateChecker,
CurrencyDataProvider $currencyDataProvider
): Response {
$orderForViewing = $this->dispatchQuery(new GetOrderForViewing($orderId, QuerySorting::DESC));
$form = $orderProductFormBuilder->getFormFor($orderId);
$orderCurrency = $currencyDataProvider->getCurrencyById($orderForViewing->getCurrencyId());
$shipments = $this->dispatchQuery(new GetShipmentsForOrderDetail($orderId, $orderDetailId));
return $this->render('@PrestaShop/Admin/Sell/Order/Order/Blocks/View/edit_product_form.html.twig', [
'editProductForm' => $form->createView(),
'orderForViewing' => $orderForViewing,
'orderHasShipment' => $this->orderHasShipment($orderForViewing->getId()),
'isMultishipmentIsEnabled' => $featureFlagStateChecker->isEnabled(FeatureFlagSettings::FEATURE_FLAG_IMPROVED_SHIPMENT),
'orderId' => $orderId,
'currencySymbol' => $orderCurrency->symbol,
'shipments' => $shipments,
]);
}
#[AdminSecurity("is_granted('update', 'AdminOrders')", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function getEditShipmentForm(int $orderId, int $shipmentId, Request $request, #[Autowire(service: 'prestashop.core.form.identifiable_object.builder.edit_shipment_form_builder')] FormBuilderInterface $formBuilder): Response
{
$form = $formBuilder->getFormFor($orderId);
return $this->render('@PrestaShop/Admin/Sell/Order/Order/Blocks/View/edit_shipment_form.html.twig', [
'editShipmentForm' => $form->createView(),
'orderId' => $orderId,
'shipmentId' => $shipmentId,
]);
}
/**
* @param int $orderId
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', 'AdminOrders')", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function mergeShipmentAction(int $orderId, Request $request, #[Autowire(service: 'prestashop.core.form.identifiable_object.builder.merge_shipment_form_builder')] FormBuilderInterface $formBuilder): RedirectResponse
{
try {
$shipmentId = (int) $request->attributes->get('shipmentId');
$form = $formBuilder->getFormFor($orderId);
$form->handleRequest($request);
if (!$form->isSubmitted() || !$form->isValid()) {
$this->addFlash('error', 'Invalid merge shipment form.');
return $this->redirectToRoute('admin_orders_view', ['orderId' => $orderId]);
}
$data = $form->getData();
/** @var OrderShipment $targetShipment */
$targetShipment = $form->get('merge_to_shipment')->getData();
$targetShipmentId = $targetShipment->getId();
if ($data['is_shipped']) {
$this->addFlash('error', $this->trans('This shipment can\'t be merged because a tracking number has already been assigned, indicating that it has already been shipped.', [], 'Admin.Orderscustomers.Notification'));
return $this->redirectToRoute('admin_orders_view', ['orderId' => $orderId]);
}
$submittedData = $request->request->all('merge_shipment');
$selectedProducts = [];
foreach ($submittedData as $key => $value) {
if (str_starts_with($key, 'product_') && $value) {
$orderDetailId = (int) str_replace('product_', '', $key);
$quantityKey = 'quantity_' . $orderDetailId;
$selectedProducts[] = [
'id_order_detail' => $orderDetailId,
'quantity' => (int) $submittedData[$quantityKey],
];
}
}
$command = new MergeProductsToShipment(
$shipmentId,
$targetShipmentId,
$selectedProducts
);
$this->dispatchCommand($command);
} catch (Exception $e) {
if ((new ReflectionClass($e))->getName() === CannotEditShipmentShippedException::class) {
$this->addFlash('error', $this->trans('You cannot merge shipment when is already shipped.', [], 'Admin.Orderscustomers.Notification'));
} else {
throw $e;
}
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* @param int $orderId
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', 'AdminOrders')", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function editShipmentAction(int $orderId, int $shipmentId, Request $request, #[Autowire(service: 'prestashop.core.form.identifiable_object.builder.edit_shipment_form_builder')] FormBuilderInterface $formBuilder): RedirectResponse
{
$form = $formBuilder->getFormFor($orderId, [], ['method' => 'PUT']);
$form->handleRequest($request);
$submittedData = $request->request->all('edit_shipment');
if (!$form->isSubmitted() || !$form->isValid()) {
$this->addFlash('error', 'An error occurred while editing shipment');
return $this->redirectToRoute('admin_orders_view', ['orderId' => $orderId]);
}
$command = new EditShipment(
$shipmentId,
$submittedData['carrier']
);
$this->dispatchCommand($command);
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
#[AdminSecurity("is_granted('update', 'AdminOrders')", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function getFulfillShipmentForm(
int $orderId,
int $shipmentId,
#[Autowire(service: 'prestashop.core.form.identifiable_object.builder.fulfill_shipment_form_builder')] FormBuilderInterface $formBuilder,
): Response {
$form = $formBuilder->getFormFor($orderId);
return $this->render('@PrestaShop/Admin/Sell/Order/Order/Blocks/View/fulfill_shipment_form.html.twig', [
'fulfillShipmentForm' => $form->createView(),
'shipmentInformation' => $form->getData(),
'orderId' => $orderId,
'shipmentId' => $shipmentId,
]);
}
/**
* @param int $orderId
* @param Request $request
*/
#[AdminSecurity("is_granted('update', 'AdminOrders')", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function fulfillShipmentAction(int $orderId, int $shipmentId, Request $request, #[Autowire(service: 'prestashop.core.form.identifiable_object.builder.fulfill_shipment_form_builder')] FormBuilderInterface $formBuilder): RedirectResponse
{
$form = $formBuilder->getFormFor($orderId);
$form->handleRequest($request);
$submittedData = $request->request->all('fulfill_shipment');
if (!$form->isSubmitted() || !$form->isValid()) {
$this->addFlash('error', $this->trans('An error occured while fulfilling shipment', [], 'Admin.Orderscustomers.Notification'));
return $this->redirectToRoute('admin_orders_view', ['orderId' => $orderId]);
}
$command = new FulfillShipmentCommand(
$shipmentId,
$submittedData['tracking_number'],
);
$this->dispatchCommand($command);
$this->addFlash('success', $this->trans('The shipment was successfully fulfilled.', [], 'Admin.Orderscustomers.Notification'));
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
#[AdminSecurity("is_granted('update', 'AdminOrders')", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function splitShipmentAction(int $orderId, int $shipmentId, Request $request): RedirectResponse
{
try {
$data = $request->get('split_shipment', []);
$carrier = isset($data['carrier']) ? (int) $data['carrier'] : null;
$productsRaw = $data['products'] ?? [];
$products = [];
foreach ($productsRaw as $prod) {
if (isset($prod['selected']) && (int) $prod['selected'] === 1) {
$products[] = [
'id_order_detail' => (int) $prod['order_detail_id'],
'quantity' => (int) $prod['selected_quantity'],
];
}
}
$this->dispatchQuery(new SplitShipment($shipmentId, $products, $carrier));
} catch (Exception $e) {
if ((new ReflectionClass($e))->getName() === CannotEditShipmentShippedException::class) {
$this->addFlash('error', $this->trans('You cannot split shipment when is already shipped.', [], 'Admin.Orderscustomers.Notification'));
} else {
throw $e;
}
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
'shipmentId' => $shipmentId,
]);
}
/**
* @throws CoreException
* @throws Exception
*/
#[AdminSecurity("is_granted('update', 'AdminOrders')", message: 'You do not have permission to show this.')]
public function getSplitShipmentForm(
int $orderId,
int $shipmentId,
#[Autowire(service: 'prestashop.core.form.identifiable_object.builder.split_shipment_form_builder')] FormBuilderInterface $formBuilder,
): Response {
$form = $formBuilder->getFormFor($orderId);
$data = $form->getData();
return $this->render('@PrestaShop/Admin/Sell/Order/Order/Blocks/View/split_shipment_form.html.twig', [
'splitShipmentForm' => $form->createView(),
'orderId' => $orderId,
'shipmentId' => $shipmentId,
'formIsValid' => $data['form_is_valid'],
'isShipped' => $data['is_shipped'],
]);
}
#[AdminSecurity("is_granted('update', 'AdminOrders')", message: 'You do not have permission to show this.')]
public function getShipmentsForProduct(
int $orderId,
int $productId,
): Response {
$shipments = $this->dispatchCommand(new ListAvailableShipmentsForProduct($orderId, $productId));
$shipments[] = [
'id' => 0,
'name' => $this->trans('Create a shipment', [], 'Admin.Orderscustomers.Feature'),
];
return $this->json(
['shipments' => $shipments],
Response::HTTP_OK
);
}
#[AdminSecurity("is_granted('update', 'AdminOrders')", message: 'You do not have permission to show this.')]
public function getCarriersForProduct(
int $productId,
): Response {
if (empty($productId)) {
return $this->json(
['error' => 'missing productId'],
Response::HTTP_BAD_REQUEST
);
}
$carriers = $this->dispatchQuery(new GetCarriersForProduct($productId));
return $this->json(
['carriers' => $carriers],
Response::HTTP_OK
);
}
/**
* @param int $orderId
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', request.get('_legacy_controller')) && is_granted('delete', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function partialRefundAction(
int $orderId,
Request $request,
#[Autowire(service: 'prestashop.core.form.identifiable_object.builder.cancel_product_form_builder')] FormBuilderInterface $formBuilder,
#[Autowire(service: 'prestashop.core.form.identifiable_object.partial_refund_form_handler')] FormHandlerInterface $formHandler,
) {
$form = $formBuilder->getFormFor($orderId);
try {
$form->handleRequest($request);
$result = $formHandler->handleFor($orderId, $form);
if ($result->isSubmitted()) {
if ($result->isValid()) {
$this->addFlash('success', $this->trans('A partial refund was successfully created.', [], 'Admin.Orderscustomers.Notification'));
} else {
$this->addFlashFormErrors($form);
}
}
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* @param int $orderId
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', request.get('_legacy_controller')) && is_granted('delete', request.get('_legacy_controller'))")]
public function standardRefundAction(
int $orderId,
Request $request,
#[Autowire(service: 'prestashop.core.form.identifiable_object.builder.cancel_product_form_builder')] FormBuilderInterface $formBuilder,
#[Autowire(service: 'prestashop.core.form.identifiable_object.standard_refund_form_handler')] FormHandlerInterface $formHandler,
) {
$form = $formBuilder->getFormFor($orderId);
try {
$form->handleRequest($request);
$result = $formHandler->handleFor($orderId, $form);
if ($result->isSubmitted()) {
if ($result->isValid()) {
$this->addFlash('success', $this->trans('A standard refund was successfully created.', [], 'Admin.Orderscustomers.Notification'));
} else {
$this->addFlashFormErrors($form);
}
}
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* @param int $orderId
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', request.get('_legacy_controller')) && is_granted('delete', request.get('_legacy_controller'))")]
public function returnProductAction(
int $orderId,
Request $request,
#[Autowire(service: 'prestashop.core.form.identifiable_object.builder.cancel_product_form_builder')] FormBuilderInterface $formBuilder,
#[Autowire(service: 'prestashop.core.form.identifiable_object.return_product_form_handler')] FormHandlerInterface $formHandler,
) {
$form = $formBuilder->getFormFor($orderId);
try {
$form->handleRequest($request);
$result = $formHandler->handleFor($orderId, $form);
if ($result->isSubmitted()) {
if ($result->isValid()) {
$this->addFlash('success', $this->trans('The product was successfully returned.', [], 'Admin.Orderscustomers.Notification'));
} else {
$this->addFlashFormErrors($form);
}
}
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* @param OrderForViewing $orderForViewing
*/
private function handleOutOfStockProduct(OrderForViewing $orderForViewing)
{
$isStockManagementEnabled = (bool) $this->getConfiguration()->get('PS_STOCK_MANAGEMENT');
if (!$isStockManagementEnabled || $orderForViewing->isDelivered() || $orderForViewing->isShipped()) {
return;
}
foreach ($orderForViewing->getProducts()->getProducts() as $product) {
if ($product->getAvailableQuantity() <= 0) {
$this->addFlash(
'warning',
$this->trans('This product is out of stock:', [], 'Admin.Orderscustomers.Notification') . ' ' . $product->getName()
);
}
}
}
/**
* @param int $orderId
* @param Request $request
*
* @return Response
*/
#[AdminSecurity("is_granted('create', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function addProductAction(
int $orderId,
Request $request,
#[Autowire(service: 'prestashop.core.form.identifiable_object.builder.cancel_product_form_builder')] FormBuilderInterface $formBuilder,
CurrencyDataProvider $currencyDataProvider,
FeatureFlagStateCheckerInterface $featureFlagStateChecker,
): Response {
/** @var OrderForViewing $orderForViewing */
$orderForViewing = $this->dispatchQuery(new GetOrderForViewing($orderId, QuerySorting::DESC));
$previousProducts = [];
foreach ($orderForViewing->getProducts()->getProducts() as $orderProductForViewing) {
$previousProducts[$orderProductForViewing->getOrderDetailId()] = $orderProductForViewing;
}
$invoiceId = (int) $request->get('invoice_id');
$productId = (int) $request->get('product_id');
$combinationId = (int) $request->get('combination_id');
$shipmentId = (int) $request->get('shipment_id', null);
$carrierId = (int) $request->get('carrier_id', null);
$isVirtual = (bool) $request->get('virtual', false);
try {
if ($invoiceId > 0) {
$addProductCommand = AddProductToOrderCommand::toExistingInvoice(
$orderId,
$invoiceId,
$productId,
$combinationId,
$request->get('price_tax_incl'),
$request->get('price_tax_excl'),
(int) $request->get('quantity'),
$shipmentId,
$carrierId,
$isVirtual
);
} else {
$hasFreeShipping = null;
if ($request->request->has('free_shipping')) {
$hasFreeShipping = (bool) filter_var($request->get('free_shipping'), FILTER_VALIDATE_BOOLEAN);
}
$addProductCommand = AddProductToOrderCommand::withNewInvoice(
$orderId,
$productId,
$combinationId,
$request->get('price_tax_incl'),
$request->get('price_tax_excl'),
(int) $request->get('quantity'),
$hasFreeShipping,
$shipmentId,
$carrierId,
$isVirtual
);
}
$this->dispatchCommand($addProductCommand);
} catch (Exception $e) {
return $this->json(
['message' => $this->getErrorMessageForException($e, $this->getErrorMessages($e))],
Response::HTTP_BAD_REQUEST
);
}
/**
* Returning the products list view is not required since we reload the whole list
* We keep it for now to avoid Breaking Change
*/
/** @var OrderForViewing $orderForViewing */
$orderForViewing = $this->dispatchQuery(new GetOrderForViewing($orderId, QuerySorting::DESC));
$updatedProducts = [];
foreach ($orderForViewing->getProducts()->getProducts() as $orderProductForViewing) {
$updatedProducts[$orderProductForViewing->getOrderDetailId()] = $orderProductForViewing;
}
$newProducts = array_diff_key($updatedProducts, $previousProducts);
$cancelProductForm = $formBuilder->getFormFor($orderId);
$orderCurrency = $currencyDataProvider->getCurrencyById($orderForViewing->getCurrencyId());
$addedGridRows = '';
foreach ($newProducts as $newProduct) {
$addedGridRows .= $this->renderView('@PrestaShop/Admin/Sell/Order/Order/Blocks/View/product.html.twig', [
'orderForViewing' => $orderForViewing,
'product' => $newProduct,
'isColumnLocationDisplayed' => $newProduct->getLocation() !== '',
'isColumnRefundedDisplayed' => $newProduct->getQuantityRefunded() > 0,
'isAvailableQuantityDisplayed' => (bool) $this->getConfiguration()->get('PS_STOCK_MANAGEMENT'),
'cancelProductForm' => $cancelProductForm->createView(),
'orderCurrency' => $orderCurrency,
'isImprovedShipmentFeatureFlagEnabled' => $featureFlagStateChecker->isEnabled(FeatureFlagSettings::FEATURE_FLAG_IMPROVED_SHIPMENT),
'orderHasShipment' => $this->orderHasShipment($orderForViewing->getId()),
]);
}
return new Response($addedGridRows);
}
/**
* @param int $orderId
*
* @return Response
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function getProductPricesAction(int $orderId): Response
{
try {
$orderForViewing = $this->dispatchQuery(new GetOrderForViewing($orderId));
$productsForViewing = $orderForViewing->getProducts();
$productList = $productsForViewing->getProducts();
$result = [];
foreach ($productList as $product) {
$result[] = [
'orderDetailId' => $product->getOrderDetailId(),
'unitPrice' => $product->getUnitPrice(),
'unitPriceTaxExclRaw' => $product->getUnitPriceTaxExclRaw(),
'unitPriceTaxInclRaw' => $product->getUnitPriceTaxInclRaw(),
'quantity' => $product->getQuantity(),
'availableQuantity' => $product->getAvailableQuantity(),
'totalPrice' => $product->getTotalPrice(),
];
}
} catch (Exception $e) {
return $this->json(
['message' => $this->getErrorMessageForException($e, $this->getErrorMessages($e))],
Response::HTTP_INTERNAL_SERVER_ERROR
);
}
return $this->json($result);
}
/**
* @param int $orderId
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function getInvoicesAction(
int $orderId,
#[Autowire(service: 'prestashop.adapter.form.choice_provider.order_invoice_by_id')] ConfigurableFormChoiceProviderInterface $choiceProvider,
) {
$choices = $choiceProvider->getChoices([
'id_order' => $orderId,
'id_lang' => $this->getLanguageContext()->getId(),
'display_total' => true,
]);
return $this->json([
'invoices' => $choices,
]);
}
/**
* @param int $orderId
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function getDocumentsAction(int $orderId)
{
/** @var OrderForViewing $orderForViewing */
$orderForViewing = $this->dispatchQuery(new GetOrderForViewing($orderId));
return $this->json([
'total' => count($orderForViewing->getDocuments()->getDocuments()),
'html' => $this->render('@PrestaShop/Admin/Sell/Order/Order/Blocks/View/documents.html.twig', [
'orderForViewing' => $orderForViewing,
])->getContent(),
]);
}
/**
* @param int $orderId
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function getShippingAction(int $orderId)
{
/** @var OrderForViewing $orderForViewing */
$orderForViewing = $this->dispatchQuery(new GetOrderForViewing($orderId));
return $this->json([
'total' => count($orderForViewing->getShipping()->getCarriers()),
'html' => $this->render('@PrestaShop/Admin/Sell/Order/Order/Blocks/View/shipping.html.twig', [
'orderForViewing' => $orderForViewing,
])->getContent(),
]);
}
#[AdminSecurity("is_granted('read', 'AdminOrders')", message: 'You do not have permission to show this.')]
public function getShipmentsAction(
int $orderId,
#[Autowire(service: 'PrestaShop\PrestaShop\Core\Grid\Factory\ShipmentFactory')] GridFactoryInterface $shipmentGridFactory,
ShipmentFilters $filters
) {
$filters = new ShipmentFilters(['filters' => ['order_id' => $orderId]] + $filters->all());
$shipmentsGrid = $shipmentGridFactory->getGrid($filters);
return $this->json([
'total' => $shipmentsGrid->getData()->getRecordsTotal(),
'html' => $this->render('@PrestaShop/Admin/Common/Grid/grid.html.twig', [
'grid' => $this->presentGrid($shipmentsGrid),
])->getContent(),
]);
}
/**
* @param int $orderId
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function updateShippingAction(int $orderId, Request $request): RedirectResponse
{
$form = $this->createForm(UpdateOrderShippingType::class, [], [
'order_id' => $orderId,
]);
$form->handleRequest($request);
if ($form->isSubmitted() && $form->isValid()) {
$data = $form->getData();
try {
$this->dispatchCommand(
new UpdateOrderShippingDetailsCommand(
$orderId,
(int) $data['current_order_carrier_id'],
(int) $data['new_carrier_id'],
$data['tracking_number']
)
);
$this->addFlash('success', $this->trans('Successful update', [], 'Admin.Notifications.Success'));
} catch (TransistEmailSendingException) {
$this->addFlash(
'error',
$this->trans(
'An error occurred while sending an email to the customer.',
[],
'Admin.Orderscustomers.Notification'
)
);
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* @param int $orderId
* @param int $orderCartRuleId
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', 'AdminOrders')", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function removeCartRuleAction(int $orderId, int $orderCartRuleId): RedirectResponse
{
$this->dispatchCommand(
new DeleteCartRuleFromOrderCommand($orderId, $orderCartRuleId)
);
$this->addFlash('success', $this->trans('Successful update', [], 'Admin.Notifications.Success'));
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* @param int $orderId
* @param int $orderInvoiceId
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', 'AdminOrders')", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function updateInvoiceNoteAction(int $orderId, int $orderInvoiceId, Request $request): RedirectResponse
{
try {
$this->dispatchCommand(new UpdateInvoiceNoteCommand(
$orderInvoiceId,
$request->request->get('invoice_note')
));
$this->addFlash('success', $this->trans('Update successful', [], 'Admin.Notifications.Success'));
} catch (InvoiceException $e) {
$this->addFlash(
'error',
$this->getErrorMessageForException($e, $this->getErrorMessages($e))
);
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* @param int $orderId
* @param int $orderDetailId
* @param Request $request
*
* @return Response
*/
#[AdminSecurity("is_granted('update', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function updateProductAction(
int $orderId,
int $orderDetailId,
Request $request,
#[Autowire(service: 'prestashop.core.form.identifiable_object.builder.cancel_product_form_builder')] FormBuilderInterface $formBuilder,
CurrencyDataProvider $currencyDataProvider,
FeatureFlagStateCheckerInterface $featureFlagStateChecker,
): Response {
try {
$data = json_decode($request->getContent(), true);
$this->dispatchCommand(
new UpdateProductInOrderCommand(
$orderId,
$orderDetailId,
$data['price_tax_incl'],
$data['price_tax_excl'],
(int) $data['quantity'],
(int) $data['invoice'],
$data['shipmentProducts'] ?? null
)
);
} catch (Exception $e) {
return $this->json(
['message' => $this->getErrorMessageForException($e, $this->getErrorMessages($e))],
Response::HTTP_BAD_REQUEST
);
}
/** @var OrderForViewing $orderForViewing */
$orderForViewing = $this->dispatchQuery(new GetOrderForViewing($orderId, QuerySorting::DESC));
$products = $orderForViewing->getProducts()->getProducts();
$product = array_reduce($products, function ($result, OrderProductForViewing $item) use ($orderDetailId) {
return $item->getOrderDetailId() == $orderDetailId ? $item : $result;
});
// The whole product row has been removed so we return an empty response
if (null === $product) {
return new Response('');
}
$cancelProductForm = $formBuilder->getFormFor($orderId);
$orderCurrency = $currencyDataProvider->getCurrencyById($orderForViewing->getCurrencyId());
return $this->render('@PrestaShop/Admin/Sell/Order/Order/Blocks/View/product.html.twig', [
'cancelProductForm' => $cancelProductForm->createView(),
'isColumnLocationDisplayed' => $product->getLocation() !== '',
'isColumnRefundedDisplayed' => $product->getQuantityRefunded() > 0,
'isAvailableQuantityDisplayed' => (bool) $this->getConfiguration()->get('PS_STOCK_MANAGEMENT'),
'orderCurrency' => $orderCurrency,
'orderForViewing' => $orderForViewing,
'product' => $product,
'orderHasShipment' => $this->orderHasShipment($orderId),
'isImprovedShipmentFeatureFlagEnabled' => $featureFlagStateChecker->isEnabled(FeatureFlagSettings::FEATURE_FLAG_IMPROVED_SHIPMENT),
]);
}
#[AdminSecurity("is_granted('update', 'AdminOrders')", message: 'You do not have permission to edit this.')]
public function getCarriersAction(int $orderId): Response
{
try {
/** @var OrderForViewing $orderForViewing */
$orderForViewing = $this->dispatchQuery(new GetOrderForViewing($orderId));
$carriers = $orderForViewing->getShipping()->getCarriers();
$carrierList = [];
foreach ($carriers as $carrier) {
$carrierList[] = [
'id' => $carrier->getCarrierId(),
'name' => $carrier->getName(),
];
}
return $this->json(['carriers' => $carrierList]);
} catch (OrderNotFoundException $e) {
return $this->json(['message' => 'Order not found'], Response::HTTP_NOT_FOUND);
} catch (Exception $e) {
return $this->json(['message' => 'An error occurred'], Response::HTTP_INTERNAL_SERVER_ERROR);
}
}
/**
* @param int $orderId
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', 'AdminOrders')", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function addCartRuleAction(int $orderId, Request $request): RedirectResponse
{
$addOrderCartRuleForm = $this->createForm(AddOrderCartRuleType::class, [], [
'order_id' => $orderId,
]);
$addOrderCartRuleForm->handleRequest($request);
if ($addOrderCartRuleForm->isSubmitted()) {
if ($addOrderCartRuleForm->isValid()) {
$data = $addOrderCartRuleForm->getData();
try {
$this->dispatchCommand(
new AddCartRuleToOrderCommand(
$orderId,
$data['name'],
$data['type'],
$data['value'] ?? null,
empty($data['invoice_id']) ? null : (int) $data['invoice_id']
)
);
$this->addFlash('success', $this->trans('Successful update', [], 'Admin.Notifications.Success'));
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
} else {
foreach ($addOrderCartRuleForm->getErrors(true) as $error) {
$this->addFlash('error', $error->getMessage());
}
}
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* @param int $orderId
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function updateStatusAction(int $orderId, Request $request): RedirectResponse
{
$form = $this->formFactory->createNamed(
'update_order_status',
UpdateOrderStatusType::class
);
$form->handleRequest($request);
if (!$form->isSubmitted() || !$form->isValid()) {
// Check if the form is submit from the action bar
$form = $this->formFactory->createNamed(
'update_order_status_action_bar',
UpdateOrderStatusType::class
);
$form->handleRequest($request);
}
if ($form->isSubmitted() && $form->isValid()) {
$this->handleOrderStatusUpdate($orderId, (int) $form->getData()['new_order_status_id']);
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* Updates order status directly from list page.
*
* @param int $orderId
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function updateStatusFromListAction(int $orderId, Request $request): RedirectResponse
{
$this->handleOrderStatusUpdate($orderId, $request->request->getInt('value'));
return $this->redirectToRoute('admin_orders_index');
}
/**
* @param int $orderId
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', 'AdminOrders')", message: 'You do not have permission to edit this.', redirectQueryParamsToKeep: ['orderId'], redirectRoute: 'admin_orders_view')]
public function addPaymentAction(
int $orderId,
Request $request,
): RedirectResponse {
$form = $this->createForm(OrderPaymentType::class, [], [
'id_order' => $orderId,
]);
$form->handleRequest($request);
if ($form->isSubmitted()) {
if ($form->isValid()) {
$data = $form->getData();
try {
$this->dispatchCommand(
new AddPaymentCommand(
$orderId,
$data['date'],
$data['payment_method'],
$data['amount'],
$data['id_currency'],
$this->getEmployeeContext()->getEmployee()->getId(),
$data['id_invoice'],
$data['transaction_id']
)
);
$this->addFlash('success', $this->trans('Successful update', [], 'Admin.Notifications.Success'));
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getPaymentErrorMessages($e)));
}
} else {
foreach ($form->getErrors(true) as $error) {
$this->addFlash('error', $error->getMessage());
}
}
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* @param int $orderId
*
* @return JsonResponse
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))")]
public function previewAction(int $orderId): JsonResponse
{
try {
/** @var OrderPreview $orderPreview */
$orderPreview = $this->dispatchQuery(new GetOrderPreview($orderId));
return $this->json([
'preview' => $this->renderView('@PrestaShop/Admin/Sell/Order/Order/preview.html.twig', [
'orderPreview' => $orderPreview,
'productsPreviewLimit' => OrderConstraints::PRODUCTS_PREVIEW_LIMIT,
'orderId' => $orderId,
]),
]);
} catch (Exception $e) {
return $this->json(
['message' => $this->getErrorMessageForException($e, $this->getErrorMessages($e))],
Response::HTTP_BAD_REQUEST
);
}
}
/**
* Duplicates cart from specified order
*
* @param int $orderId
*
* @return JsonResponse
*/
#[AdminSecurity("is_granted('update', request.get('_legacy_controller')) || is_granted('create', 'AdminOrders')")]
public function duplicateOrderCartAction(int $orderId)
{
$cartId = $this->dispatchCommand(new DuplicateOrderCartCommand($orderId))->getValue();
return $this->json(
$this->dispatchQuery(
(new GetCartForOrderCreation($cartId))
->setHideDiscounts(true)
)
);
}
/**
* @param Request $request
* @param int $orderId
*
* @return Response
*/
#[DemoRestricted(redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'])]
#[AdminSecurity("is_granted('update', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function sendMessageAction(
Request $request,
int $orderId,
RouterInterface $router
): Response {
$orderMessageForm = $this->createForm(OrderMessageType::class);
$orderMessageForm->handleRequest($request);
if ($orderMessageForm->isSubmitted() && $orderMessageForm->isValid()) {
$data = $orderMessageForm->getData();
try {
$this->dispatchCommand(new AddOrderCustomerMessageCommand(
$orderId,
$data['message'],
!$data['is_displayed_to_customer']
));
$this->addFlash(
'success',
$this->trans('Comment successfully added.', [], 'Admin.Notifications.Success')
);
} catch (CannotSendEmailException) {
$this->addFlash(
'success',
$this->trans('Comment successfully added.', [], 'Admin.Notifications.Success')
);
$this->addFlash(
'error',
$this->trans(
'An error occurred while sending an email to the customer.',
[],
'Admin.Orderscustomers.Notification'
)
);
} catch (Exception $exception) {
$this->addFlash(
'error',
$this->getErrorMessageForException($exception, $this->getCustomerMessageErrorMapping($exception))
);
}
}
$routesCollection = $router->getRouteCollection();
if (
!$orderMessageForm->isValid()
&& $viewRoute = $routesCollection->get('admin_orders_view')
) {
$attributes = $viewRoute->getDefaults();
$attributes['orderId'] = $orderId;
return $this->forward(
$viewRoute->getDefault('_controller'),
$attributes
);
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', 'AdminOrders')", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function changeCustomerAddressAction(Request $request): RedirectResponse
{
$orderId = $request->query->get('orderId');
if (!$orderId) {
return $this->redirectToRoute('admin_orders_index');
}
$customerId = $request->query->get('customerId');
if (!$customerId) {
return $this->redirectToRoute('admin_orders_index');
}
$changeOrderAddressForm = $this->createForm(ChangeOrderAddressType::class, [], [
'customer_id' => (int) $request->query->get('customerId'),
]);
$changeOrderAddressForm->handleRequest($request);
if (!$changeOrderAddressForm->isSubmitted() || !$changeOrderAddressForm->isValid()) {
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
$data = $changeOrderAddressForm->getData();
try {
if ($data['address_type'] === ChangeOrderAddressType::SHIPPING_TYPE) {
$command = new ChangeOrderDeliveryAddressCommand((int) $orderId, (int) $data['new_address_id']);
} else {
$command = new ChangeOrderInvoiceAddressCommand((int) $orderId, (int) $data['new_address_id']);
}
$this->dispatchCommand($command);
$this->addFlash('success', $this->trans('Successful update', [], 'Admin.Notifications.Success'));
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* @param int $orderId
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function changeCurrencyAction(int $orderId, Request $request): RedirectResponse
{
$changeOrderCurrencyForm = $this->createForm(ChangeOrderCurrencyType::class);
$changeOrderCurrencyForm->handleRequest($request);
if (!$changeOrderCurrencyForm->isSubmitted() || !$changeOrderCurrencyForm->isValid()) {
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
$data = $changeOrderCurrencyForm->getData();
try {
$this->dispatchCommand(
new ChangeOrderCurrencyCommand($orderId, (int) $data['new_currency_id'])
);
$this->addFlash('success', $this->trans('Successful update', [], 'Admin.Notifications.Success'));
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* @param int $orderId
* @param int $orderStatusId
* @param int $orderHistoryId
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', 'AdminOrders')", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function resendEmailAction(int $orderId, int $orderStatusId, int $orderHistoryId): RedirectResponse
{
try {
$this->dispatchCommand(
new ResendOrderEmailCommand($orderId, $orderStatusId, $orderHistoryId)
);
$this->addFlash(
'success',
$this->trans('The message was successfully sent to the customer.', [], 'Admin.Orderscustomers.Notification')
);
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* @param int $orderId
* @param int $orderDetailId
*
* @return JsonResponse
*/
#[AdminSecurity("is_granted('delete', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function deleteProductAction(int $orderId, int $orderDetailId): JsonResponse
{
try {
$this->dispatchCommand(
new DeleteProductFromOrderCommand($orderId, $orderDetailId)
);
return $this->json(null, Response::HTTP_NO_CONTENT);
} catch (Exception $e) {
return $this->json(
['message' => $this->getErrorMessageForException($e, $this->getErrorMessages($e))],
Response::HTTP_BAD_REQUEST
);
}
}
/**
* @param int $orderId
*
* @return Response
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function getDiscountsAction(int $orderId): Response
{
/** @var OrderForViewing $orderForViewing */
$orderForViewing = $this->dispatchQuery(new GetOrderForViewing($orderId));
return $this->render('@PrestaShop/Admin/Sell/Order/Order/Blocks/View/discount_list.html.twig', [
'discounts' => $orderForViewing->getDiscounts()->getDiscounts(),
'orderId' => $orderId,
]);
}
/**
* @param int $orderId
*
* @return JsonResponse
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function getPricesAction(int $orderId): JsonResponse
{
/** @var OrderForViewing $orderForViewing */
$orderForViewing = $this->dispatchQuery(new GetOrderForViewing($orderId));
$orderForViewingPrices = $orderForViewing->getPrices();
return $this->json([
'orderTotalFormatted' => $orderForViewingPrices->getTotalAmountFormatted(),
'discountsAmountFormatted' => $orderForViewingPrices->getDiscountsAmountFormatted(),
'discountsAmountDisplayed' => $orderForViewingPrices->getDiscountsAmountRaw()->isGreaterThanZero(),
'productsTotalFormatted' => $orderForViewingPrices->getProductsPriceFormatted(),
'shippingTotalFormatted' => $orderForViewingPrices->getShippingPriceFormatted(),
'shippingTotalDisplayed' => $orderForViewingPrices->getShippingPriceRaw()->isGreaterThanZero(),
'taxesTotalFormatted' => $orderForViewingPrices->getTaxesAmountFormatted(),
]);
}
/**
* @param int $orderId
*
* @return Response
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function getPaymentsAction(int $orderId): Response
{
try {
/** @var OrderForViewing $orderForViewing */
$orderForViewing = $this->dispatchQuery(new GetOrderForViewing($orderId));
return $this->render('@PrestaShop/Admin/Sell/Order/Order/Blocks/View/payments_alert.html.twig', [
'payments' => $orderForViewing->getPayments(),
'linkedOrders' => $orderForViewing->getLinkedOrders(),
]);
} catch (Exception $e) {
return $this->json(
['message' => $this->getErrorMessageForException($e, $this->getErrorMessages($e))],
Response::HTTP_BAD_REQUEST
);
}
}
/**
* @param int $orderId
*
* @return Response
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function getProductsListAction(
int $orderId,
#[Autowire(service: 'prestashop.core.form.identifiable_object.builder.cancel_product_form_builder')] FormBuilderInterface $formBuilder,
CurrencyDataProvider $currencyDataProvider,
FeatureFlagStateCheckerInterface $featureFlagStateChecker,
): Response {
/** @var OrderForViewing $orderForViewing */
$orderForViewing = $this->dispatchQuery(new GetOrderForViewing($orderId, QuerySorting::DESC));
$orderCurrency = $currencyDataProvider->getCurrencyById($orderForViewing->getCurrencyId());
$cancelProductForm = $formBuilder->getFormFor($orderId);
$paginationNum = ($this->getConfiguration()->get('PS_ORDER_PRODUCTS_NB_PER_PAGE') ?? self::DEFAULT_PRODUCTS_NUMBER);
$paginationNumOptions = self::PRODUCTS_PAGINATION_OPTIONS;
if (!in_array($paginationNum, $paginationNumOptions)) {
$paginationNumOptions[] = $paginationNum;
}
sort($paginationNumOptions);
$isColumnLocationDisplayed = false;
$isColumnRefundedDisplayed = false;
foreach (array_slice($orderForViewing->getProducts()->getProducts(), $paginationNum) as $product) {
if (!empty($product->getLocation())) {
$isColumnLocationDisplayed = true;
}
if ($product->getQuantityRefunded() > 0) {
$isColumnRefundedDisplayed = true;
}
}
return $this->render('@PrestaShop/Admin/Sell/Order/Order/Blocks/View/product_list.html.twig', [
'orderForViewing' => $orderForViewing,
'cancelProductForm' => $cancelProductForm->createView(),
'orderCurrency' => $orderCurrency,
'paginationNum' => $paginationNum,
'isColumnLocationDisplayed' => $isColumnLocationDisplayed,
'isColumnRefundedDisplayed' => $isColumnRefundedDisplayed,
'isAvailableQuantityDisplayed' => (bool) $this->getConfiguration()->get('PS_STOCK_MANAGEMENT'),
'isImprovedShipmentFeatureFlagEnabled' => $featureFlagStateChecker->isEnabled(FeatureFlagSettings::FEATURE_FLAG_IMPROVED_SHIPMENT),
'orderHasShipment' => $this->orderHasShipment($orderForViewing->getId()),
]);
}
/**
* Generates invoice for given order
*
* @param int $orderId
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', request.get('_legacy_controller'))", message: 'You do not have permission to generate this.')]
public function generateInvoiceAction(int $orderId): RedirectResponse
{
try {
$this->dispatchCommand(new GenerateInvoiceCommand($orderId));
$this->addFlash('success', $this->trans('Successful update', [], 'Admin.Notifications.Success'));
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* Sends email with process order link to customer
*
* @param Request $request
*
* @return JsonResponse
*/
#[AdminSecurity("is_granted('update', request.get('_legacy_controller')) || is_granted('create', 'AdminOrders')")]
public function sendProcessOrderEmailAction(Request $request): JsonResponse
{
try {
$this->dispatchCommand(new SendProcessOrderEmailCommand($request->request->getInt('cartId')));
return $this->json([
'message' => $this->trans('The email was sent to your customer.', [], 'Admin.Orderscustomers.Notification'),
]);
} catch (Exception $e) {
return $this->json(
['message' => $this->getErrorMessageForException($e, $this->getErrorMessages($e))],
Response::HTTP_INTERNAL_SERVER_ERROR
);
}
}
/**
* @param int $orderId
* @param Request $request
*
* @return RedirectResponse
*/
#[AdminSecurity("is_granted('update', request.get('_legacy_controller')) && is_granted('delete', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_view', redirectQueryParamsToKeep: ['orderId'], message: 'You do not have permission to edit this.')]
public function cancellationAction(
int $orderId,
Request $request,
#[Autowire(service: 'prestashop.core.form.identifiable_object.builder.cancel_product_form_builder')] FormBuilderInterface $formBuilder,
#[Autowire(service: 'prestashop.core.form.identifiable_object.cancellation_form_handler')] FormHandlerInterface $formHandler,
) {
$form = $formBuilder->getFormFor($orderId);
try {
$form->handleRequest($request);
$result = $formHandler->handleFor($orderId, $form);
if ($result->isSubmitted()) {
if ($result->isValid()) {
$this->addFlash('success', $this->trans('Selected products were successfully canceled.', [], 'Admin.Catalog.Notification'));
} else {
$this->addFlashFormErrors($form);
}
}
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* @param Request $request
*
* @return JsonResponse
*/
#[AdminSecurity("is_granted('update', request.get('_legacy_controller'))")]
public function configureProductPaginationAction(Request $request): JsonResponse
{
$numPerPage = (int) $request->request->get('numPerPage');
if ($numPerPage < 1) {
$numPerPage = self::DEFAULT_PRODUCTS_NUMBER;
}
try {
$this->getConfiguration()->set('PS_ORDER_PRODUCTS_NB_PER_PAGE', $numPerPage);
} catch (Exception $e) {
return $this->json(
['message' => $this->getErrorMessageForException($e, $this->getErrorMessages($e))],
Response::HTTP_BAD_REQUEST
);
}
return $this->json(null, Response::HTTP_NO_CONTENT);
}
/**
* Method for downloading customization picture
*
* @param int $orderId
* @param string $value
*
* @return BinaryFileResponse|RedirectResponse
*/
#[AdminSecurity("is_granted('read', request.get('_legacy_controller'))")]
public function displayCustomizationImageAction(
int $orderId,
string $value,
LegacyContext $context
) {
$uploadDir = $context->getUploadDirectory();
$filePath = $uploadDir . $value;
$filesystem = new Filesystem();
try {
if (!$filesystem->exists($filePath)) {
$this->addFlash('error', $this->trans('The product customization picture could not be found.', [], 'Admin.Notifications.Error'));
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
$imageFile = new File($filePath);
$fileName = sprintf('%s-customization-%s.%s', $orderId, $value, $imageFile->guessExtension() ?? 'jpg');
return $this->file($filePath, $fileName);
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* Set order internal note.
*
* @param mixed $orderId
* @param Request $request
*
* @return Response
*/
#[AdminSecurity("is_granted('update', request.get('_legacy_controller')) && is_granted('create', request.get('_legacy_controller'))", redirectRoute: 'admin_orders_index')]
public function setInternalNoteAction($orderId, Request $request)
{
$internalNoteForm = $this->createForm(InternalNoteType::class);
$internalNoteForm->handleRequest($request);
if ($internalNoteForm->isSubmitted() && $internalNoteForm->isValid()) {
$data = $internalNoteForm->getData();
try {
$this->dispatchCommand(new SetInternalOrderNoteCommand(
(int) $orderId,
$data['note']
));
if ($request->isXmlHttpRequest()) {
return $this->json([
'success' => true,
'message' => $this->trans('Update successful', [], 'Admin.Notifications.Success'),
]);
}
$this->addFlash('success', $this->trans('Update successful', [], 'Admin.Notifications.Success'));
} catch (OrderException $e) {
$this->addFlash(
'error',
$this->getErrorMessageForException($e, $this->getErrorMessages($e))
);
}
} else {
foreach ($internalNoteForm->getErrors(true) as $error) {
$this->addFlash('error', htmlentities($error->getMessage()));
}
}
return $this->redirectToRoute('admin_orders_view', [
'orderId' => $orderId,
]);
}
/**
* @param Request $request
*
* @return JsonResponse
*/
#[AdminSecurity("is_granted('create', request.get('_legacy_controller')) || is_granted('update', request.get('_legacy_controller'))", message: 'You do not have permission to perform this search.')]
public function searchProductsAction(Request $request): JsonResponse
{
try {
$defaultCurrencyId = (int) $this->getConfiguration()->get('PS_CURRENCY_DEFAULT');
$searchPhrase = $request->query->get('search_phrase');
$currencyId = $request->query->get('currency_id');
$currencyIsoCode = $currencyId !== null
? Currency::getIsoCodeById((int) $currencyId)
: Currency::getIsoCodeById($defaultCurrencyId);
$orderId = null;
if ($request->query->has('order_id')) {
$orderId = (int) $request->query->get('order_id');
}
/** @var FoundProduct[] $foundProducts */
$foundProducts = $this->dispatchQuery(new SearchProducts($searchPhrase, 10, $currencyIsoCode, $orderId));
return $this->json([
'products' => $foundProducts,
]);
} catch (ProductSearchEmptyPhraseException $e) {
return $this->json(
['message' => $this->getErrorMessageForException($e, $this->getErrorMessages($e))],
Response::HTTP_BAD_REQUEST
);
} catch (Exception $e) {
return $this->json(
['message' => $this->getErrorMessageForException($e, [])],
Response::HTTP_INTERNAL_SERVER_ERROR
);
}
}
/**
* Initializes order status update
*
* @param int $orderId
* @param int $orderStatusId
*/
private function handleOrderStatusUpdate(int $orderId, int $orderStatusId): void
{
try {
$this->dispatchCommand(
new UpdateOrderStatusCommand(
$orderId,
$orderStatusId
)
);
$this->addFlash('success', $this->trans('Successful update', [], 'Admin.Notifications.Success'));
} catch (ChangeOrderStatusException $e) {
$this->handleChangeOrderStatusException($e);
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, $this->getErrorMessages($e)));
}
}
/**
* @param Exception $e
*
* @return array
*/
private function getErrorMessages(Exception $e)
{
$refundableQuantity = 0;
if ($e instanceof InvalidCancelProductException) {
$refundableQuantity = $e->getRefundableQuantity();
}
$orderInvoiceNumber = '#unknown';
if ($e instanceof DuplicateProductInOrderInvoiceException) {
$orderInvoiceNumber = $e->getOrderInvoiceNumber();
}
return [
ProductSearchEmptyPhraseException::class => $this->trans(
'Product search phrase must not be an empty string.',
[],
'Admin.Orderscustomers.Notification'
),
CannotEditDeliveredOrderProductException::class => $this->trans(
'You cannot edit the cart once the order delivered.',
[],
'Admin.Orderscustomers.Notification'
),
OrderNotFoundException::class => $e instanceof OrderNotFoundException ?
$this->trans(
'Order #%d cannot be loaded.',
['#%d' => $e->getOrderId()->getValue()],
'Admin.Orderscustomers.Notification',
) : '',
OrderEmailSendException::class => $this->trans(
'An error occurred while sending the e-mail to the customer.',
[],
'Admin.Orderscustomers.Notification'
),
OrderException::class => $this->trans(
$e->getMessage(),
[],
'Admin.Orderscustomers.Notification'
),
InvoiceException::class => $this->trans(
$e->getMessage(),
[],
'Admin.Orderscustomers.Notification'
),
InvalidAmountException::class => $this->trans(
'Only numbers and decimal points (".") are allowed in the amount fields, e.g. 10.50 or 1050.',
[],
'Admin.Orderscustomers.Notification'
),
InvalidCartRuleDiscountValueException::class => [
InvalidCartRuleDiscountValueException::INVALID_MIN_PERCENT => $this->trans(
'Percent value must be greater than 0.',
[],
'Admin.Orderscustomers.Notification'
),
InvalidCartRuleDiscountValueException::INVALID_MAX_PERCENT => $this->trans(
'Percent value cannot exceed 100.',
[],
'Admin.Orderscustomers.Notification'
),
InvalidCartRuleDiscountValueException::INVALID_MIN_AMOUNT => $this->trans(
'Amount value must be greater than 0.',
[],
'Admin.Orderscustomers.Notification'
),
InvalidCartRuleDiscountValueException::INVALID_MAX_AMOUNT => $this->trans(
'Discount value cannot exceed the total price of this order.',
[],
'Admin.Orderscustomers.Notification'
),
InvalidCartRuleDiscountValueException::INVALID_FREE_SHIPPING => $this->trans(
'Shipping discount value cannot exceed the total price of this order.',
[],
'Admin.Orderscustomers.Notification'
),
InvalidCartRuleDiscountValueException::DUPLICATE_FREE_SHIPPING => $this->trans(
'This order already has a free shipping discount.',
[],
'Admin.Orderscustomers.Notification'
),
],
InvalidCancelProductException::class => [
InvalidCancelProductException::INVALID_QUANTITY => $this->trans(
'Positive product quantity is required.',
[],
'Admin.Notifications.Error'
),
InvalidCancelProductException::QUANTITY_TOO_HIGH => $this->trans(
'Please enter a maximum quantity of [1].',
['[1]' => $refundableQuantity],
'Admin.Orderscustomers.Notification'
),
InvalidCancelProductException::NO_REFUNDS => $this->trans(
'Please select at least one product.',
[],
'Admin.Orderscustomers.Notification'
),
InvalidCancelProductException::INVALID_AMOUNT => $this->trans(
'Please enter a positive amount.',
[],
'Admin.Orderscustomers.Notification'
),
InvalidCancelProductException::NO_GENERATION => $this->trans(
'Please generate at least one credit slip or voucher.',
[],
'Admin.Orderscustomers.Notification'
),
],
InvalidModuleException::class => $this->trans(
'You must choose a payment module to create the order.',
[],
'Admin.Orderscustomers.Notification'
),
ProductOutOfStockException::class => $this->trans(
'There are not enough products in stock.',
[],
'Admin.Catalog.Notification'
),
NegativePaymentAmountException::class => $this->trans(
'Invalid value: the payment must be a positive amount.',
[],
'Admin.Notifications.Error'
),
InvalidOrderStateException::class => [
InvalidOrderStateException::ALREADY_PAID => $this->trans(
'Invalid action: this order has already been paid.',
[],
'Admin.Notifications.Error'
),
InvalidOrderStateException::DELIVERY_NOT_FOUND => $this->trans(
'Invalid action: this order has not been delivered.',
[],
'Admin.Notifications.Error'
),
InvalidOrderStateException::UNEXPECTED_DELIVERY => $this->trans(
'Invalid action: this order has already been delivered.',
[],
'Admin.Notifications.Error'
),
InvalidOrderStateException::NOT_PAID => $this->trans(
'Invalid action: this order has not been paid.',
[],
'Admin.Notifications.Error'
),
InvalidOrderStateException::INVALID_ID => $this->trans(
'You must choose an order status to create the order.',
[],
'Admin.Orderscustomers.Notification'
),
],
OrderConstraintException::class => [
OrderConstraintException::INVALID_CUSTOMER_MESSAGE => $this->trans(
'The order message given is invalid.',
[],
'Admin.Orderscustomers.Notification'
),
],
InvalidProductQuantityException::class => $this->trans(
'Positive product quantity is required.',
[],
'Admin.Notifications.Error'
),
DuplicateProductInOrderException::class => $this->trans(
'This product is already in your order, please edit the quantity instead.',
[],
'Admin.Notifications.Error'
),
DuplicateProductInOrderInvoiceException::class => $this->trans(
'This product is already in the invoice [1], please edit the quantity instead.',
['[1]' => $orderInvoiceNumber],
'Admin.Notifications.Error'
),
CannotFindProductInOrderException::class => $this->trans(
'You cannot edit the price of a product that no longer exists in your catalog.',
[],
'Admin.Notifications.Error'
),
];
}
private function getPaymentErrorMessages(Exception $e)
{
return array_merge($this->getErrorMessages($e), [
InvalidArgumentException::class => $this->trans(
'Only numbers and decimal points (".") are allowed in the amount fields of the payment block, e.g. 10.50 or 1050.',
[],
'Admin.Orderscustomers.Notification'
),
OrderConstraintException::class => [
OrderConstraintException::INVALID_PAYMENT_METHOD => sprintf(
'%s %s %s',
$this->trans(
'The selected payment method is invalid.',
[],
'Admin.Orderscustomers.Notification'
),
$this->trans(
'Invalid characters:',
[],
'Admin.Notifications.Info'
),
AddPaymentCommand::INVALID_CHARACTERS_NAME
),
],
]);
}
/**
* @param ChangeOrderStatusException $e
*/
private function handleChangeOrderStatusException(ChangeOrderStatusException $e)
{
$orderIds = array_merge(
$e->getOrdersWithFailedToUpdateStatus(),
$e->getOrdersWithFailedToSendEmail()
);
/** @var OrderId $orderId */
foreach ($orderIds as $orderId) {
$this->addFlash(
'error',
$this->trans(
'An error occurred while changing the status for order #%d, or we were unable to send an email to the customer.',
['#%d' => $orderId->getValue()],
'Admin.Orderscustomers.Notification'
)
);
}
foreach ($e->getOrdersWithAssignedStatus() as $orderId) {
$this->addFlash(
'error',
$this->trans(
'Order #%d has already been assigned this status.',
['#%d' => $orderId->getValue()],
'Admin.Orderscustomers.Notification'
)
);
}
}
private function getCustomerMessageErrorMapping(Exception $exception): array
{
return [
OrderNotFoundException::class => $exception instanceof OrderNotFoundException ?
$this->trans(
'Order #%d cannot be loaded.',
['#%d' => $exception->getOrderId()->getValue()],
'Admin.Orderscustomers.Notification'
) : '',
CustomerMessageConstraintException::class => [
CustomerMessageConstraintException::MISSING_MESSAGE => $this->trans(
'The %s field is not valid',
[
sprintf('"%s"', $this->trans('Message', [], 'Admin.Global')),
],
'Admin.Notifications.Error'
),
CustomerMessageConstraintException::INVALID_MESSAGE => $this->trans(
'The %s field is not valid',
[
sprintf('"%s"', $this->trans('Message', [], 'Admin.Global')),
],
'Admin.Notifications.Error'
),
],
];
}
private function orderHasShipment(int $orderId): bool
{
/** @var OrderShipment[] $shipments */
$shipments = $this->dispatchQuery(new GetOrderShipments($orderId, true));
return count($shipments) > 0;
}
}