OrderActions
in package
Class OrderActions
Tags
Table of Contents
- bulkPdfInvoices() : mixed
- Outputs the concatenated invoice PDFs.
- bulkPdfPackingSlips() : mixed
- Outputs the concatenated packing-slip PDFs.
- cancelOrder() : mixed
- Cancels an order.
- changeOrderStatus() : mixed
- removeOrderById() : mixed
- Removes an order.
- _createBulkPdf() : mixed
- Outputs a bulk PDF file through the use of mPDF.
- _getOrderStatusName() : string
- Gets the Name of an order status by status ID and language ID
- _getPdfPermissions() : array<string|int, mixed>
- Generate the PDF permissions depending the shop configuration.
Methods
bulkPdfInvoices()
Outputs the concatenated invoice PDFs.
public
bulkPdfInvoices(array<string|int, mixed> $orderIds) : mixed
Parameters
- $orderIds : array<string|int, mixed>
-
The order IDs to be included in the concatenated file.
Tags
Return values
mixed —bulkPdfPackingSlips()
Outputs the concatenated packing-slip PDFs.
public
bulkPdfPackingSlips(array<string|int, mixed> $orderIds) : mixed
Parameters
- $orderIds : array<string|int, mixed>
-
The order IDs to be included in the concatenated file.
Tags
Return values
mixed —cancelOrder()
Cancels an order.
public
cancelOrder(array<string|int, mixed> $orderIds, BoolType $restockQuantity, BoolType $recalculateShippingStatus, BoolType $resetArticleStatus, BoolType $notifyCustomer, BoolType $sendComment[, StringType|null $comment = null ][, IdType|null $customerId = null ]) : mixed
The method use the old logic of the gm_send_orders.php file and will be refactored soon.
Parameters
- $orderIds : array<string|int, mixed>
- $restockQuantity : BoolType
- $recalculateShippingStatus : BoolType
- $resetArticleStatus : BoolType
- $notifyCustomer : BoolType
- $sendComment : BoolType
- $comment : StringType|null = null
- $customerId : IdType|null = null
Return values
mixed —changeOrderStatus()
public
changeOrderStatus(IdType $orderId, IdType $statusId, StringType $comment, BoolType $notifyCustomer, BoolType $sendParcelTrackingCode, BoolType $sendComment[, IdType $customerId = null ]) : mixed
Parameters
- $orderId : IdType
- $statusId : IdType
- $comment : StringType
- $notifyCustomer : BoolType
- $sendParcelTrackingCode : BoolType
- $sendComment : BoolType
- $customerId : IdType = null
Return values
mixed —removeOrderById()
Removes an order.
public
removeOrderById(IdType $orderId[, BoolType|null $restockQuantity = null ][, BoolType|null $recalculateShippingStatus = null ][, BoolType|null $resetProductStatus = null ]) : mixed
The method use the old logic of the xtc_remove_order function and will be refactored soon.
Parameters
- $orderId : IdType
- $restockQuantity : BoolType|null = null
- $recalculateShippingStatus : BoolType|null = null
- $resetProductStatus : BoolType|null = null
Return values
mixed —_createBulkPdf()
Outputs a bulk PDF file through the use of mPDF.
protected
_createBulkPdf(array<string|int, mixed> $orderIds, string $type) : mixed
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 : array<string|int, mixed>
-
The selected order IDs.
- $type : string
-
Bulk PDF type ('invoice' or 'packingslip').
Tags
Return values
mixed —_getOrderStatusName()
Gets the Name of an order status by status ID and language ID
protected
_getOrderStatusName(IdType $orderStatusId, IdType $languageId) : string
Parameters
Return values
string —The name of the status
_getPdfPermissions()
Generate the PDF permissions depending the shop configuration.
protected
_getPdfPermissions() : array<string|int, mixed>