OrderStatus
in package
implements
OrderStatusInterface
Class OrderStatus
Tags
Interfaces, Classes and Traits
- OrderStatusInterface
- Interface OrderStatusInterface
Table of Contents
- $color : string
- $id : int|null
- $names : array<string|int, mixed>
- __construct() : mixed
- OrderStatus constructor.
- getColor() : string
- Returns the order status label-color.
- getId() : int|null
- Returns the order status id.
- getName() : string
- Returns the order status name by the given language id.
- getNames() : array<string|int, mixed>
- Returns the order status names.
- setColor() : $this|OrderStatus
- Sets the order status label-color.
- setName() : $this|OrderStatus
- Sets the order status name.
Properties
$color
protected
string
$color
$id
protected
int|null
$id
$names
protected
array<string|int, mixed>
$names
= []
Methods
__construct()
OrderStatus constructor.
public
__construct([IntType|null $id = null ]) : mixed
Parameters
- $id : IntType|null = null
Return values
mixed —getColor()
Returns the order status label-color.
public
getColor() : string
Return values
string —Color of order status label.
getId()
Returns the order status id.
public
getId() : int|null
Return values
int|null —getName()
Returns the order status name by the given language id.
public
getName(LanguageCode $languageCode) : string
Parameters
- $languageCode : LanguageCode
-
Expected language code.
Tags
Return values
string —Expected status name by given language id.
getNames()
Returns the order status names.
public
getNames() : array<string|int, mixed>
Return values
array<string|int, mixed> —Order status names.
setColor()
Sets the order status label-color.
public
setColor(StringType $color) : $this|OrderStatus
Parameters
- $color : StringType
-
New color of order status label.
Return values
$this|OrderStatus —Same instance for chained method calls.
setName()
Sets the order status name.
public
setName(LanguageCode $languageCode, StringType $name) : $this|OrderStatus
Parameters
- $languageCode : LanguageCode
-
Language code of order status name.
- $name : StringType
-
Order status name.
Return values
$this|OrderStatus —Same instance for chained method calls.