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

Interfaces

  • OrderFactoryInterface
  • OrderInterface
  • OrderItemAttributeInterface
  • OrderItemAttributeRepositoryDeleterInterface
  • OrderItemAttributeRepositoryFactoryInterface
  • OrderItemAttributeRepositoryInterface
  • OrderItemAttributeRepositoryReaderInterface
  • OrderItemAttributeRepositoryWriterInterface
  • OrderItemFactoryInterface
  • OrderItemInterface
  • OrderItemPropertyFactoryInterface
  • OrderItemPropertyRepositoryDeleterInterface
  • OrderItemPropertyRepositoryReaderInterface
  • OrderItemPropertyRepositoryWriterInterface
  • OrderItemRepositoryDeleterInterface
  • OrderItemRepositoryInterface
  • OrderItemRepositoryReaderInterface
  • OrderItemRepositoryWriterInterface
  • OrderListGeneratorInterface
  • OrderObjectServiceInterface
  • OrderPaymentTypeInterface
  • OrderReadServiceInterface
  • OrderRepositoryDeleterInterface
  • OrderRepositoryInterface
  • OrderRepositoryReaderInterface
  • OrderRepositoryWriterInterface
  • OrderServiceSettingsInterface
  • OrderShippingTypeInterface
  • OrderStatusHistoryReaderInterface
  • OrderStatusHistoryWriterInterface
  • OrderTotalFactoryInterface
  • OrderTotalInterface
  • OrderTotalRepositoryDeleterInterface
  • OrderTotalRepositoryInterface
  • OrderTotalRepositoryReaderInterface
  • OrderTotalRepositoryWriterInterface
  • OrderWriteServiceInterface
  • StoredOrderItemAttributeInterface
  • StoredOrderItemInterface
  • StoredOrderTotalInterface

Interface OrderReadServiceInterface

Interface OrderReadServiceInterface

Direct known implementers

OrderReadService

Package: Order\Interfaces
Category: System
Located at CoreServices/Order/Interfaces/OrderReadServiceInterface.inc.php

Methods summary

public Order
# getOrderById( IdType $orderId )

Returns an order, depending on the provided order ID.

Returns an order, depending on the provided order ID.

Parameters

$orderId
Order ID.

Returns

Order
Found order.
public StoredOrderItemInterface
# getOrderItemById( IdType $orderItemId )

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

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

Parameters

$orderItemId
Order item ID.

Returns

StoredOrderItemInterface
Found stored order item interface.
public OrderListItemCollection
# getOrderList( IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )

Returns an OrderListItemCollection depending on the provided arguments.

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

Returns an OrderListItemCollection depending on the provided 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
Order list item collection.
public OrderListItemCollection
# getOrderListByOrderStatusId( IdType $orderStatusId, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )

Returns an OrderListItemCollection depending on the provided 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
Order list item collection.
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
Order list item collection.
API documentation generated by ApiGen