API Documentation
\

\OrderStateCore

Summary

Methods
Properties
Constants
getOrderStates()
invoiceAvailable()
isRemovable()
$name
$template
$send_email
$module_name
$invoice
$color
$unremovable
$logable
$delivery
$hidden
$shipped
$paid
$pdf_invoice
$pdf_delivery
$deleted
$definition
FLAG_NO_HIDDEN
FLAG_LOGABLE
FLAG_DELIVERY
FLAG_SHIPPED
FLAG_PAID
No protected methods found
$webserviceParameters
N/A
No private methods found
No private properties found
N/A

Constants

FLAG_NO_HIDDEN

FLAG_NO_HIDDEN

FLAG_LOGABLE

FLAG_LOGABLE

FLAG_DELIVERY

FLAG_DELIVERY

FLAG_SHIPPED

FLAG_SHIPPED

FLAG_PAID

FLAG_PAID

Properties

$name

$name : string

Type

string — Name

$template

$template : string

Type

string — Template name if there is any e-mail to send

$send_email

$send_email : boolean

Type

boolean — Send an e-mail to customer ?

$module_name

$module_name :

Type

$invoice

$invoice : boolean

Type

boolean — Allow customer to view and download invoice when order is at this state

$color

$color : string

Type

string — Display state in the specified color

$unremovable

$unremovable :

Type

$logable

$logable : boolean

Type

boolean — Log authorization

$delivery

$delivery : boolean

Type

boolean — Delivery

$hidden

$hidden : boolean

Type

boolean — Hidden

$shipped

$shipped : boolean

Type

boolean — Shipped

$paid

$paid : boolean

Type

boolean — Paid

$pdf_invoice

$pdf_invoice : boolean

Type

boolean — Attach PDF Invoice

$pdf_delivery

$pdf_delivery : boolean

Type

boolean — Attach PDF Delivery Slip

$deleted

$deleted : boolean

Type

boolean — True if carrier has been deleted (staying in database as deleted)

$definition

$definition :

Type

$webserviceParameters

$webserviceParameters :

Type

Methods

getOrderStates()

getOrderStates(integer  $id_lang) : array

Get all available order statuses

Parameters

integer $id_lang

Language id for status name

Returns

array —

Order statuses

invoiceAvailable()

invoiceAvailable(integer  $id_order_state) : boolean

Check if we can make a invoice when order is in this state

Parameters

integer $id_order_state

State ID

Returns

boolean —

availability

isRemovable()

isRemovable()