API Documentation
Back to top  

OrderTotal

Implements \OrderTotalInterface

Class OrderTotal

category

System
package

Order
subpackage

Entities

Methods

OrderTotal constructor.

__construct(\StringType $title, \DecimalType $value, \StringType $valueText = null, \StringType $class = null, \IntType $sortOrder = null)

Arguments

$title

\StringType

Order total title.

$value

\DecimalType

Order total value

$valueText

\StringType

Order total value text.

$class

\StringType

Class name.

$sortOrder

\IntType

Sort order.

Returns the class of the order total.

getClass() : string

Response

string

Class of the order total.

Returns the sort order of the order total.

getSortOrder() : integer

Response

integer

Sort order of the order total.

Returns the title of the order total.

getTitle() : string

Response

string

Title of the order total.

Returns the value of the order total.

getValue() : float

Response

float

Value of the order total.

Returns the value text of the order total.

getValueText() : string

Response

string

Value text of the order total.

Sets class of the order total.

setClass(\StringType $class) : \OrderTotal

Arguments

$class

\StringType

Class of the order total.

Response

\OrderTotal

Same instance for method chaining.

Sets sort order of the order total.

setSortOrder(\IntType $sortOrder) : \OrderTotal

Arguments

$sortOrder

\IntType

Sort order of the order total.

Response

\OrderTotal

Same instance for method chaining.

Sets title of the order total.

setTitle(\StringType $title) : \OrderTotal

Arguments

$title

\StringType

Title of the order total.

Response

\OrderTotal

Same instance for method chaining.

Sets value of the order total.

setValue(\DecimalType $value) : \OrderTotal

Arguments

$value

\DecimalType

Value of the order total.

Response

\OrderTotal

Same instance for method chaining.

Sets value text of the order total.

setValueText(\StringType $valueText) : \OrderTotal

Arguments

$valueText

\StringType

Value text of the order total.

Response

\OrderTotal

Same instance for method chaining.

Properties

Title.

title : string
var

Type(s)

string

Value.

value : float
var

Type(s)

float

Value text.

valueText : string
var

Type(s)

string

Class name.

class : string
var

Type(s)

string

Sort order.

sortOrder : integer
var

Type(s)

integer