Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • ApiV2Controllers
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Classes

  • OrderListGenerator
  • OrderObjectService
  • OrderReadService
  • OrderWriteService

Interfaces

  • OrderItemAttributeFactoryInterface

Class OrderReadService

Class OrderReadService

OrderReadService implements OrderReadServiceInterface
Package: Order
Category: System
Located at CoreServices/Order/OrderReadService.inc.php

Methods summary

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

OrderReadService Constructor

OrderReadService Constructor

Parameters

$orderRepository
$orderItemRepository
$orderListGenerator
public OrderInterface
# getOrderById( IdType $orderId )

Get Order by ID

Get Order by ID

Returns an order, depending on the provided order ID.

Parameters

$orderId
Order ID of the wanted order

Returns

OrderInterface

Implementation of

OrderReadServiceInterface::getOrderById()
public StoredOrderItemInterface
# getOrderItemById( IdType $orderItemId )

Get a stored order item by ID.

Get a stored order item by ID.

Returns a stored order item, depending on the provided order item ID.

Parameters

$orderItemId

Returns

StoredOrderItemInterface

Implementation of

OrderReadServiceInterface::getOrderItemById()
public OrderListItemCollection
# getOrderList( IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )

Get Order List

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 OrderListItemCollection
# getOrderListByCustomerId( IdType $customerId, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )

Get Order List by Customer ID

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 OrderListItemCollection
# getOrderListByOrderStatusId( IdType $orderStatusId, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )

Get Order List by Order Status ID

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 OrderListItemCollection
# getOrderListByKeyword( StringType $keyword, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )

Filter the order list by a string keyword.

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()

Properties summary

protected OrderRepositoryInterface $orderRepository
#
protected OrderItemRepositoryInterface $orderItemRepository
#
protected OrderListGenerator $orderListGenerator
#
API documentation generated by ApiGen