Class OrderActions

Class OrderActions

Package: Extensions\Orders
Category: System
Located at Extensions/Orders/OrderActions.inc.php

Methods summary

`public`	# `cancelOrder( array $orderIds, BoolType $restockQuantity, BoolType $recalculateShippingStatus, BoolType $resetArticleStatus, BoolType $notifyCustomer, BoolType $sendComment, StringType $comment = null )` Cancels an order. The method use the old logic of the gm_send_orders.php file and will be refactored soon. Cancels an order. The method use the old logic of the gm_send_orders.php file and will be refactored soon. Parameters `$orderIds` `$restockQuantity` `$recalculateShippingStatus` `$resetArticleStatus` `$notifyCustomer` `$sendComment` `$comment`
`public`	# `removeOrderById( IdType $orderId, BoolType $restockQuantity = null, BoolType $recalculateShippingStatus = null, BoolType $resetProductStatus = null )` Removes an order. The method use the old logic of the xtc_remove_order function and will be refactored soon. Removes an order. The method use the old logic of the xtc_remove_order function and will be refactored soon. Parameters `$orderId` `$restockQuantity` `$recalculateShippingStatus` `$resetProductStatus`
`public`	# `bulkPdfInvoices( array $orderIds )` Outputs the concatenated invoice PDFs. Outputs the concatenated invoice PDFs. Parameters `$orderIds` The order IDs to be included in the concatenated file. Throws InvalidArgumentException
`public`	# `bulkPdfPackingSlips( array $orderIds )` Outputs the concatenated packing-slip PDFs. Outputs the concatenated packing-slip PDFs. Parameters `$orderIds` The order IDs to be included in the concatenated file. Throws InvalidArgumentException
`protected`	# `_createBulkPdf( array $orderIds, string $type )` Outputs a bulk PDF file through the use of mPDF. Outputs a bulk PDF file through the use of mPDF. This method will parse the latest generated PDFs of the provided orders and will concatenate them into a single file. This file will be then outputted directly so that browsers download it immediately. Parameters `$orderIds` The selected order IDs. `$type` Bulk PDF type ('invoice' or 'packingslip'). Throws InvalidArgumentException If $type argument is not valid, and See mPDF
`public`	# `changeOrderStatus( IdType $orderId, IdType $statusId, StringType $comment, BoolType $notifyCustomer, BoolType $sendParcelTrackingCode, BoolType $sendComment )` Parameters `$orderId` `$statusId` `$comment` `$notifyCustomer` `$sendParcelTrackingCode` `$sendComment`
`protected string`	# `_getOrderStatusName( IdType $orderStatusId, IdType $languageId )` Gets the Name of an order status by status ID and language ID Gets the Name of an order status by status ID and language ID Parameters `$orderStatusId` The status ID `$languageId` The language ID Returns string The name of the status
`protected array`	# `_getPdfPermissions( )` Generate the PDF permissions depending the shop configuration. Generate the PDF permissions depending the shop configuration. Returns array Link https://mpdf.github.io/reference/mpdf-functions/setprotection.html