1. interface
  2. Alligator
  3. \
  4. Model
  5. \
  6. OrderBundle
  7. \
  8. Entity
  9. \
  10. OrderInterface

OrderInterface

interface OrderInterface implements TimestampableInterface

Interface OrderInterface

Constants

STATE_ADD_TO_CART

ORDER STATES
STATE_SHIPPING

STATE_ADDRESS

PENDING

PAYMENT

STATE_CARD_PAYMENT

DELIVERED

CANCELED

FINISHED

FINISHED_PARTIAL

PROCESSING

ON_BACK_ORDER_PAYED

TODO start delete
AWAITING_PAY_PAL_PAYMENT

PAYMENT_ERROR

ON_BACK_ORDER_NOT_PAYED

JQ_GRID_ANONYMOUS

end delete
JQ_GRID_NO_SHIPPING

JQ_GRID_NO_COUNTRY

JQ_GRID_NO_COMPANY

FINISHED_ORDER_STATES

These two constants must match, first one is for SQL 'IN' statement, second one is for iterations and usage in twig
FINISHED_ORDER_STATES_ARRAY

APPROVED_ORDER_STATES

APPROVED_ORDER_STATES_ARRAY

NOT_FINISHED_ORDER_STATES_STRING

NOT_FINISHED_ORDER_STATES_ARRAY

CAN_CONTINUE_STATES_STRING

CAN_CONTINUE_STATES_ARRAY

Methods

mixed
getCreatedAt()

No description

from TimestampableInterface
mixed
getUpdatedAt()

No description

from TimestampableInterface
mixed
setCreatedAt(DateTime $createdAt)

No description

from TimestampableInterface
mixed
setUpdatedAt(DateTime $updatedAt)

No description

from TimestampableInterface
bool
isCompleted()

Has the order been completed by user and can be handled.

complete()

Mark the order as completed.

DateTime
getCompletedAt()

Return completion date.

setCompletedAt(DateTime $completedAt = null)

Set completion time.

Collection|OrderItemInterface[]
getItems()

Get order items.

setItems(Collection $items)

Set items.

integer
countItems()

Returns number of order items.

addItem(OrderItemInterface $item, float $price, float $qty)

Adds item to order.

removeItem(OrderItemInterface $item)

Remove item from order.

Boolean
hasItem(OrderItemInterface $item)

Has item in order?

integer
getItemsTotal()

Get items total.

calculateItemsTotal()

Calculate items total based on the items unit prices and quantities.

integer
getTotal()

Get order total.

setTotal(integer $total)

Set total.

calculateTotal()

Calculate total.

getTotalItems() deprecated

Alias of {@link countItems()}.

integer
getTotalQuantity()

Returns total quantity of items in cart.

Boolean
isEmpty()

Checks whether the cart is empty or not.

clearItems()

Clears all items in cart.

string
getState()

Get order state.

setState(string $state)

Set order state.

User
getUser()

Get user.

setUser(User $user)

Set user.

mixed
removeItemQty(OrderItemInterface $item)

No description

ShippingProvider
getShipping()

No description

setShipping(ShippingProvider|null $shipping)

No description

mixed
getPaymentType()

No description

setPaymentType(string $paymentType)

No description

mixed
getAddress()

No description

setAddress(mixed $address)

No description

Details

in TimestampableInterface at line 21
mixed getCreatedAt()

Return Value

mixed

in TimestampableInterface at line 26
mixed getUpdatedAt()

Return Value

mixed

in TimestampableInterface at line 33
mixed setCreatedAt(DateTime $createdAt)

Parameters

DateTime $createdAt

Return Value

mixed

in TimestampableInterface at line 40
mixed setUpdatedAt(DateTime $updatedAt)

Parameters

DateTime $updatedAt

Return Value

mixed

at line 66
bool isCompleted()

Has the order been completed by user and can be handled.

Return Value

bool

at line 71
complete()

Mark the order as completed.

at line 78
DateTime getCompletedAt()

Return completion date.

Return Value

DateTime

at line 85
setCompletedAt(DateTime $completedAt = null)

Set completion time.

Parameters

DateTime $completedAt

at line 92
Collection|OrderItemInterface[] getItems()

Get order items.

Return Value

Collection|OrderItemInterface[] An array or collection of OrderItemInterface

at line 99
setItems(Collection $items)

Set items.

Parameters

Collection $items

at line 106
integer countItems()

Returns number of order items.

Return Value

integer

at line 115
addItem(OrderItemInterface $item, float $price, float $qty)

Adds item to order.

Parameters

OrderItemInterface $item
float $price
float $qty

at line 122
removeItem(OrderItemInterface $item)

Remove item from order.

Parameters

OrderItemInterface $item

at line 131
Boolean hasItem(OrderItemInterface $item)

Has item in order?

Parameters

OrderItemInterface $item

Return Value

Boolean

at line 138
integer getItemsTotal()

Get items total.

Return Value

integer

at line 144
calculateItemsTotal()

Calculate items total based on the items unit prices and quantities.

at line 151
integer getTotal()

Get order total.

Return Value

integer

at line 158
setTotal(integer $total)

Set total.

Parameters

integer $total

at line 164
calculateTotal()

Calculate total.

Items total + Adjustments total.

at line 171
getTotalItems() deprecated

deprecated To be removed in 1.0. Use {@link countItems()} instead.

Alias of {@link countItems()}.

at line 178
integer getTotalQuantity()

Returns total quantity of items in cart.

Return Value

integer

at line 185
Boolean isEmpty()

Checks whether the cart is empty or not.

Return Value

Boolean

at line 190
clearItems()

Clears all items in cart.

at line 197
string getState()

Get order state.

Return Value

string

at line 204
setState(string $state)

Set order state.

Parameters

string $state

at line 211
User getUser()

Get user.

Return Value

User

at line 218
setUser(User $user)

Set user.

Parameters

User $user

at line 225
mixed removeItemQty(OrderItemInterface $item)

Parameters

OrderItemInterface $item

Return Value

mixed

at line 230
ShippingProvider getShipping()

Return Value

ShippingProvider

at line 235
setShipping(ShippingProvider|null $shipping)

Parameters

ShippingProvider|null $shipping

at line 240
mixed getPaymentType()

Return Value

mixed

at line 245
setPaymentType(string $paymentType)

Parameters

string $paymentType

at line 250
mixed getAddress()

Return Value

mixed

at line 255
setAddress(mixed $address)

Parameters

mixed $address