Class OrderWriteService

OrderWriteService implements OrderWriteServiceInterface

Package: Order
Category: System
Located at Services/Core/Order/OrderWriteService.inc.php

Methods summary


				
				 public 
				
				

				__construct( OrderRepositoryInterface $orderRepository, OrderItemRepositoryInterface $orderItemRepository, OrderItemAttributeRepositoryFactoryInterface $orderItemAttributeRepositoryFactory, OrderTotalRepository $orderTotalRepository, OrderStatusHistoryStorage $orderStatusHistoryWriter, OrderServiceSettingsInterface $orderServiceSetting )

Class Constructor


				
				 public 
				
				

				createNewCustomerOrder( IdType $customerId, CustomerStatusInformation $customerStatusInfo, StringType $customerNumber, EmailStringType $customerEmail, StringType $customerTelephone, StringType $vatIdNumber, AddressBlockInterface $customerAddress, AddressBlockInterface $billingAddress, AddressBlockInterface $deliveryAddress, OrderItemCollection $orderItemCollection, OrderTotalCollection $orderTotalCollection, OrderShippingType $shippingType, OrderPaymentType $paymentType, CurrencyCode $currencyCode, LanguageCode $languageCode, DecimalType $totalWeight, StringType $comment = null, IntType $orderStatusId = null, KeyValueCollection $addonValues = null )
				

				: integer

Create New Customer Order

Creates a new customer order and returns the order ID as an integer.

Parameters

$customerId: Customer ID
$customerStatusInfo: Customer Status Information
$customerNumber: Customer Number
$customerEmail: Customer Email
$customerTelephone: Customer Telephone
$vatIdNumber: VAT ID Number
$customerAddress: Address of the customer
$billingAddress: Billing address of the customer
$deliveryAddress: Delivery address of the customer
$orderItemCollection: Collection of the order items
$orderTotalCollection: Total collection of the order
$shippingType: Shipping type of the order
$paymentType: Payment type of the order
$currencyCode: Currency code of the order
$languageCode: Language code of the order
$totalWeight: Total weight of the order in kilo gram
$comment: Optional comment of the order (default = null)
$orderStatusId: Optional id of the initial order status (default = null)
$addonValues: Optional key => value collection of addon values - e.g. cookies (default = null)

Returns

integer

Implementation of

OrderWriteServiceInterface::createNewCustomerOrder()


				
				 public 
				
				

				createNewStandaloneOrder( StringType $customerNumber, EmailStringType $customerEmail, StringType $customerTelephone, StringType $vatIdNumber, AddressBlockInterface $customerAddress, AddressBlockInterface $billingAddress, AddressBlockInterface $deliveryAddress, OrderItemCollection $orderItemCollection, OrderTotalCollection $orderTotalCollection, OrderShippingType $shippingType, OrderPaymentType $paymentType, CurrencyCode $currencyCode, LanguageCode $languageCode, DecimalType $totalWeight, StringType $comment = null, IntType $orderStatusId = null, KeyValueCollection $addonValues = null )
				

				: integer

Create New Standalone Order

Creates a new standalone order (e.g. for guests) and returns the order ID as an integer.

Parameters

$customerNumber: Customer Number
$customerEmail: Customer Email
$customerTelephone: Customer Telephone
$vatIdNumber: VAT ID number of the customer.
$customerAddress: Address of the customer
$billingAddress: Billing address of the customer
$deliveryAddress: Delivery address of the customer
$orderItemCollection: Collection of the order items
$orderTotalCollection: Total collection of the order
$shippingType: Shipping type of the order
$paymentType: Payment type of the order
$currencyCode: Currency code of the order
$languageCode: Language code of the order
$totalWeight: Total weight of the order in kg.
$comment: Optional comment of the order (default = null)
$orderStatusId: Optional id of the initial order status (default = null)
$addonValues: Optional key => value collection of addon values - e.g. cookies (default = null)

Returns

integer

Implementation of

OrderWriteServiceInterface::createNewStandaloneOrder()


				
				 public 
				
				

				updateCustomerAddress( IdType $orderId, AddressBlockInterface $newAddress )

Update Customer Address


				
				 public 
				
				

				updateBillingAddress( IdType $orderId, AddressBlockInterface $newAddress )

Update Billing Address


				
				 public 
				
				

				updateDeliveryAddress( IdType $orderId, AddressBlockInterface $newAddress )

Update Delivery Address


				
				 public 
				
				

				addOrderItem( IdType $orderId, OrderItemInterface $orderItem )
				

				: integer

Add Order Item

Adds an item to the order.

Parameters

$orderId: Order ID of the order to add the item
$orderItem: The order item to add

Returns

integer
Id of the StoredOrderItem

Implementation of

OrderWriteServiceInterface::addOrderItem()


				
				 public 
				
				

				updateOrderItem( StoredOrderItemInterface $orderItem )

Update Order Item


				
				 public 
				
				

				removeOrderItem( StoredOrderItemInterface $orderItem )

Remove Order Item


				
				 public 
				
				

				addOrderItemAttribute( IdType $orderItemId, OrderItemAttributeInterface $orderItemAttribute )
				

				: integer

Add Order Item Attribute

Adds an order item attribute to the order

Parameters

$orderItemId: Order ID of the order item to add the attribute.
$orderItemAttribute: The order item attribute to add

Returns

integer
Id of stored order item attribute.

Implementation of

OrderWriteServiceInterface::addOrderItemAttribute()


				
				 public 
				
				

				updateOrderItemAttribute( StoredOrderItemAttributeInterface $orderItemAttribute )

Update Order Item Attribute


				
				 public 
				
				

				removeOrderItemAttribute( StoredOrderItemAttributeInterface $orderItemAttribute )

Remove Order Item Attribute


				
				 public 
				
				

				addOrderTotal( IdType $orderId, OrderTotalInterface $orderTotal )
				

				: integer

Add Order Total

Adds a total price to an order.

Parameters

$orderId: Order Id of the order to add the total price
$orderTotal: Total price to add to the order

Returns

integer
Id of stored order total.

Implementation of

OrderWriteServiceInterface::addOrderTotal()


				
				 public 
				
				

				updateOrderTotal( StoredOrderTotalInterface $orderTotal )

Update Order Total


				
				 public 
				
				

				removeOrderTotal( StoredOrderTotalInterface $orderTotal )

Remove Order Total


				
				 public 
				
				

				updateShippingType( IdType $orderId, OrderShippingType $newShippingType )

Update Shipping Type


				
				 public 
				
				

				updatePaymentType( IdType $orderId, OrderPaymentType $newPaymentType )

Update Payment Type


				
				 public 
				
				

				updateComment( IdType $orderId, StringType $newComment )

Update Comment


				
				 public 
				
				

				updateOrderStatus( IdType $orderId, IntType $newOrderStatusId, StringType $comment, BoolType $customerNotified, IdType $customerId = null )

Update Order Status

Updates the order status of an order.

Parameters

$orderId: Order ID of the order to update
$newOrderStatusId: The new status Id
$comment: Comment of the order status history item
$customerNotified: Customer notified flag
$customerId: Customer ID of the admin account

Implementation of

OrderWriteServiceInterface::updateOrderStatus()


				
				 public 
				
				

				addOrderStatusHistoryEntry( IdType $orderId, StringType $comment, IdType $customerId )

Add Order Status History Entry

Add an order status history entry to an order, without changing the status or notifying the customer.

Parameters

$orderId: Order ID of the order to update
$comment: Comment of the order status history item
$customerId: Customer ID of the admin

Implementation of

OrderWriteServiceInterface::addOrderStatusHistoryEntry()


				
				 public 
				
				

				updateOrder( OrderInterface $order )
				

				: OrderWriteService

Update Order


				
				 public 
				
				

				removeOrderById( IdType $orderId )

Remove Order by ID

Properties summary


				
				protected  
				

				
					$orderRepository
				

				: OrderRepository


				
				protected  
				

				
					$orderItemRepository
				

				: OrderItemRepository


				
				protected  
				

				
					$orderItemAttributeRepositoryFactory
				

				: OrderItemAttributeRepositoryFactory


				
				protected  
				

				
					$orderTotalRepository
				

				: OrderTotalRepository


				
				protected  
				

				
					$orderStatusHistoryStorage
				

				: OrderStatusHistoryStorage


				
				protected  
				

				
					$orderServiceSettings
				

				: OrderServiceSettingsInterface