Class OrderReadService

OrderReadService implements OrderReadServiceInterface

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

Methods summary


				
				 public 
				
				

				__construct( OrderRepositoryInterface $orderRepository, OrderItemRepositoryInterface $orderItemRepository, OrderListGeneratorInterface $orderListGenerator )

OrderReadService Constructor


				
				 public 
				
				

				getOrderById( IdType $orderId )
				

				: OrderInterface

Get Order by ID


				
				 public 
				
				

				getOrderItemById( IdType $orderItemId )
				

				: StoredOrderItemInterface

Get a stored order item by ID.


				
				 public 
				
				

				getOrderList( IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
				

				: OrderListItemCollection

Get Order List

Returns an OrderListItemCollection depending on the provided arguments.

Parameters

$startIndex: Start index of order list item collections which should be returned.
$maxCount: Maximum amount of collections.
$orderBy: Argument to specify the order.

Returns

OrderListItemCollection

Implementation of

OrderReadServiceInterface::getOrderList()


				
				 public 
				
				

				filterOrderList( array $filterParameters, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
				

				: OrderListItemCollection

Filter the order records with specific conditions.

Provide the filtering values in the conditions array in order to fetch a filtered result set.

Parameters

$filterParameters: Contains an array of the GET parameters to be used for filtering the order records.
$startIndex: Start index of order list item collections which should be returned.
$maxCount: Maximum amount of collections.
$orderBy: Argument to specify the order.

Returns

OrderListItemCollection

Implementation of

OrderReadServiceInterface::filterOrderList()


				
				 public 
				
				

				filterOrderListCount( array $filterParameters )
				

				: integer

Get the filtered orders count.


				
				 public 
				
				

				getOrderListByCustomerId( IdType $customerId, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
				

				: OrderListItemCollection

Get Order List by Customer ID

Returns an OrderListItemCollection depending on the provided customer ID.

Parameters

$customerId: Customer ID
$startIndex: Start index of order list item collections which should be returned.
$maxCount: Maximum amount of collections.
$orderBy: Argument to specify the order.

Returns

OrderListItemCollection

Implementation of

OrderReadServiceInterface::getOrderListByCustomerId()


				
				 public 
				
				

				getOrderListByOrderStatusId( IntType $orderStatusId, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
				

				: OrderListItemCollection

Get Order List by Order Status ID

Returns an OrderListItemCollection depending on the provided order status ID.

Parameters

$orderStatusId: Order status ID
$startIndex: Start index of order list item collections which should be returned.
$maxCount: Maximum amount of collections.
$orderBy: Argument to specify the order.

Returns

OrderListItemCollection

Implementation of

OrderReadServiceInterface::getOrderListByOrderStatusId()


				
				 public 
				
				

				getOrderListByKeyword( StringType $keyword, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
				

				: OrderListItemCollection

Filter the order list by a string keyword.

Parameters

$keyword: Keyword to be used for searching the order list items.
$startIndex: Start index of order list item collections which should be returned.
$maxCount: Maximum amount of collections.
$orderBy: Argument to specify the order.

Returns

OrderListItemCollection

Implementation of

OrderReadServiceInterface::getOrderListByKeyword()


				
				 public 
				
				

				getOrderListByKeywordCount( StringType $keyword )
				

				: integer

Get Count of orders filtered by keyword


				
				 public 
				
				

				getOrderListCount( void )
				

				: integer

Get the total count of all orders

Properties summary


				
				protected  
				

				
					$orderRepository
				

				: OrderRepositoryInterface


				
				protected  
				

				
					$orderItemRepository
				

				: OrderItemRepositoryInterface


				
				protected  
				

				
					$orderListGenerator
				

				: OrderListGenerator

Class OrderReadService

Methods summary

Parameters

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Properties summary