OrderStatusHistoryListItem
in package
Class OrderStatusHistoryListItem
Tags
Table of Contents
- $comment : string
- Optional comment of the order status history item.
- $customerId : int
- Customer ID of the admin account.
- $customerNotified : bool
- Customer notified flag.
- $dateAdded : DateTime
- Order status history item creation date time.
- $orderStatusHistoryId : int
- ID of the order status history item.
- $orderStatusId : int
- ID of the order status.
- __construct() : mixed
- OrderStatusHistoryListItem constructor.
- getComment() : string
- Returns the comment of the order status history item.
- getCustomerId() : int
- Returns the customer ID of the admin account.
- getDateAdded() : DateTime
- Returns the order status history item creation date time.
- getOrderStatusHistoryId() : int
- Returns the ID of the order status history item.
- getOrderStatusId() : int
- Returns the ID of the order status.
- isCustomerNotified() : bool
- Returns the value of customer notified flag.
Properties
$comment
Optional comment of the order status history item.
protected
string
$comment
= ''
$customerId
Customer ID of the admin account.
protected
int
$customerId
= 0
$customerNotified
Customer notified flag.
protected
bool
$customerNotified
= alse
$dateAdded
Order status history item creation date time.
protected
DateTime
$dateAdded
$orderStatusHistoryId
ID of the order status history item.
protected
int
$orderStatusHistoryId
= 0
$orderStatusId
ID of the order status.
protected
int
$orderStatusId
= 0
Methods
__construct()
OrderStatusHistoryListItem constructor.
public
__construct(IdType $orderStatusHistoryId, IdType $orderStatusId, DateTime $dateAdded, StringType $comment, BoolType $customerNotified[, IdType $customerId = null ]) : mixed
Parameters
- $orderStatusHistoryId : IdType
-
Order status history ID.
- $orderStatusId : IdType
-
Order status ID.
- $dateAdded : DateTime
-
Order status history item creation date time.
- $comment : StringType
-
Optional comment of the order status history item.
- $customerNotified : BoolType
-
Customer notified flag.
- $customerId : IdType = null
-
Customer ID of the admin account.
Return values
mixed —getComment()
Returns the comment of the order status history item.
public
getComment() : string
Return values
string —Comment of the order status history item.
getCustomerId()
Returns the customer ID of the admin account.
public
getCustomerId() : int
Return values
int —Customer ID of admin account.
getDateAdded()
Returns the order status history item creation date time.
public
getDateAdded() : DateTime
Return values
DateTime —Order status history item creation date time.
getOrderStatusHistoryId()
Returns the ID of the order status history item.
public
getOrderStatusHistoryId() : int
Return values
int —Order status history item ID.
getOrderStatusId()
Returns the ID of the order status.
public
getOrderStatusId() : int
Return values
int —Order status ID.
isCustomerNotified()
Returns the value of customer notified flag.
public
isCustomerNotified() : bool
Return values
bool —Customer is notified?