API Documentation
Back to top  

OrderStatusHistoryStorage

Implements \OrderStatusHistoryReaderInterface, \OrderStatusHistoryWriterInterface

Class OrderStatusHistoryStorage

category

System
package

Order
subpackage

Storages

Methods

OrderStatusHistoryStorage constructor.

__construct(\CI_DB_query_builder $db)

Arguments

$db

\CI_DB_query_builder

Adds an order status history item.

addStatusUpdate(\IdType $orderId, \IntType $newOrderStatusId, \StringType $comment, \BoolType $customerNotified, \IdType $customerId = null)

Arguments

$orderId

\IdType

Order ID.

$newOrderStatusId

\IntType

New order status ID.

$comment

\StringType

Comment.

$customerNotified

\BoolType

Is customer notified?

$customerId

\IdType

Customer ID of the admin account.

Deletes all order status history items which are associated with the given order item id.

deleteHistory(\IdType $orderId)

Arguments

$orderId

\IdType

Order ID.

Returns a collection of order status history items by the given order item id.

getStatusHistory(\IdType $orderId) : \OrderStatusHistoryListItemCollection

Arguments

$orderId

\IdType

Id of order item.

Response

\OrderStatusHistoryListItemCollection

Properties

db

db : \CI_DB_query_builder
var

Type(s)

\CI_DB_query_builder