OrderReadService
in package
implements
OrderReadServiceInterface
Class OrderReadService
Tags
Interfaces, Classes and Traits
- OrderReadServiceInterface
- Interface OrderReadServiceInterface
Table of Contents
- $orderItemRepository : OrderItemRepositoryInterface
- $orderListGenerator : OrderListGenerator
- $orderRepository : OrderRepositoryInterface
- __construct() : mixed
- OrderReadService Constructor
- filterOrderList() : OrderListItemCollection
- Filter the order records with specific conditions.
- filterOrderListCount() : int
- Get the filtered orders count.
- getOrderById() : OrderInterface
- Get Order by ID
- getOrderItemById() : StoredOrderItemInterface
- Get a stored order item by ID.
- getOrderList() : OrderListItemCollection
- Get Order List
- getOrderListByCustomerId() : OrderListItemCollection
- Returns an OrderListItemCollection depending on the provided customer ID.
- getOrderListByKeyword() : OrderListItemCollection
- Filter the order list by a string keyword.
- getOrderListByKeywordCount() : int
- Get Count of orders filtered by keyword
- getOrderListByOrderStatusId() : OrderListItemCollection
- Returns an OrderListItemCollection depending on the provided order status ID.
- getOrderListCount() : int
- Get the total count of all orders
- searchOrders() : mixed
Properties
$orderItemRepository
protected
OrderItemRepositoryInterface
$orderItemRepository
$orderListGenerator
protected
OrderListGenerator
$orderListGenerator
$orderRepository
protected
OrderRepositoryInterface
$orderRepository
Methods
__construct()
OrderReadService Constructor
public
__construct(OrderRepositoryInterface $orderRepository, OrderItemRepositoryInterface $orderItemRepository, OrderListGeneratorInterface $orderListGenerator) : mixed
Parameters
- $orderRepository : OrderRepositoryInterface
- $orderItemRepository : OrderItemRepositoryInterface
- $orderListGenerator : OrderListGeneratorInterface
Return values
mixed —filterOrderList()
Filter the order records with specific conditions.
public
filterOrderList(array<string|int, mixed> $filterParameters[, Pager|null $pager = null ][, array<string|int, mixed> $sorters = [] ]) : OrderListItemCollection
Provide the filtering values in the conditions array in order to fetch a filtered result set.
Parameters
- $filterParameters : array<string|int, mixed>
-
Contains an array of the GET parameters to be used for filtering the order records.
- $pager : Pager|null = null
-
(Optional) Pager object with pagination information
- $sorters : array<string|int, mixed> = []
-
(Optional) array of Sorter objects with data sorting information
Return values
OrderListItemCollection —filterOrderListCount()
Get the filtered orders count.
public
filterOrderListCount(array<string|int, mixed> $filterParameters) : int
Parameters
- $filterParameters : array<string|int, mixed>
Tags
Return values
int —getOrderById()
Get Order by ID
public
getOrderById(IdType $orderId) : OrderInterface
Returns an order, depending on the provided order ID.
Parameters
- $orderId : IdType
-
Order ID of the wanted order
Return values
OrderInterface —getOrderItemById()
Get a stored order item by ID.
public
getOrderItemById(IdType $orderItemId) : StoredOrderItemInterface
Returns a stored order item, depending on the provided order item ID.
Parameters
- $orderItemId : IdType
Return values
StoredOrderItemInterface —getOrderList()
Get Order List
public
getOrderList([Pager|null $pager = null ][, array<string|int, mixed> $sorters = [] ]) : OrderListItemCollection
Returns an OrderListItemCollection depending on the provided arguments.
Parameters
- $pager : Pager|null = null
-
(Optional) Pager object with pagination information
- $sorters : array<string|int, mixed> = []
-
(Optional) array of Sorter objects with data sorting information
Return values
OrderListItemCollection —Order list item collection.
getOrderListByCustomerId()
Returns an OrderListItemCollection depending on the provided customer ID.
public
getOrderListByCustomerId(IdType $customerId[, Pager|null $pager = null ][, array<string|int, mixed> $sorters = [] ]) : OrderListItemCollection
Parameters
- $customerId : IdType
-
Customer ID
- $pager : Pager|null = null
-
(Optional) Pager object with pagination information
- $sorters : array<string|int, mixed> = []
-
(Optional) array of Sorter objects with data sorting information
Return values
OrderListItemCollection —Order list item collection.
getOrderListByKeyword()
Filter the order list by a string keyword.
public
getOrderListByKeyword(StringType $keyword[, Pager|null $pager = null ][, array<string|int, mixed> $sorters = [] ]) : OrderListItemCollection
Parameters
- $keyword : StringType
-
Keyword to be used for searching the order list items.
- $pager : Pager|null = null
-
(Optional) Pager object with pagination information
- $sorters : array<string|int, mixed> = []
-
(Optional) array of Sorter objects with data sorting information
Return values
OrderListItemCollection —Order list item collection.
getOrderListByKeywordCount()
Get Count of orders filtered by keyword
public
getOrderListByKeywordCount(StringType $keyword) : int
Parameters
- $keyword : StringType
-
Keyword to be used for searching in orders list items.
Return values
int —getOrderListByOrderStatusId()
Returns an OrderListItemCollection depending on the provided order status ID.
public
getOrderListByOrderStatusId(IntType $orderStatusId[, Pager|null $pager = null ][, array<string|int, mixed> $sorters = [] ]) : OrderListItemCollection
Parameters
- $orderStatusId : IntType
-
Order status ID
- $pager : Pager|null = null
-
(Optional) Pager object with pagination information
- $sorters : array<string|int, mixed> = []
-
(Optional) array of Sorter objects with data sorting information
Return values
OrderListItemCollection —Order list item collection.
getOrderListCount()
Get the total count of all orders
public
getOrderListCount() : int
Return values
int —searchOrders()
public
searchOrders(OrderSearchCondition $searchCondition[, Pager|null $pager = null ][, array<string|int, mixed> $sorters = [] ]) : mixed
Parameters
- $searchCondition : OrderSearchCondition
- $pager : Pager|null = null
-
(Optional) Pager object with pagination information
- $sorters : array<string|int, mixed> = []
-
(Optional) array of Sorter objects with data sorting information