EC-CUBE4 APIドキュメント

OrderController extends AbstractController

Table of Contents

$purchaseFlow PurchaseFlow
$csvExportService CsvExportService
$customerRepository CustomerRepository
$paymentRepository PaymentRepository
$sexRepository SexRepository
$orderStatusRepository OrderStatusRepository
$pageMaxRepository PageMaxRepository
$productStatusRepository ProductStatusRepository
$orderRepository OrderRepository
$orderPdfRepository OrderPdfRepository
$productStockRepository ProductStockRepository
$orderPdfService OrderPdfService
$validator ValidatorInterface
$orderStateMachine OrderStateMachine
$mailService MailService
$eccubeConfig EccubeConfig
$entityManager EntityManagerInterface
$translator TranslatorInterface
$formFactory FormFactoryInterface
$eventDispatcher EventDispatcherInterface
$session Session
__construct() OrderController constructor. mixed
index() 受注一覧画面. mixed
bulkDelete() mixed
exportOrder() 受注CSVの出力. StreamedResponse
exportShipping() 配送CSVの出力. StreamedResponse
exportCsv() StreamedResponse
updateOrderStatus() Update to order status JsonResponse
updateTrackingNumber() Update to Tracking number. Response
exportPdf() array|RedirectResponse
exportPdfDownload() Response
setEccubeConfig() mixed
setEntityManager() mixed
setTranslator() mixed
setSession() mixed
setFormFactory() mixed
setEventDispatcher() mixed
addSuccess() mixed
addError() mixed
addDanger() mixed
addWarning() mixed
addInfo() mixed
addRequestError() mixed
clearMessage() mixed
deleteMessage() mixed
setLoginTargetPath() mixed
forwardToRoute() Forwards the request to another controller. Response
isTokenValid() Checks the validity of a CSRF token. bool

Properties

Methods

__construct()

OrderController constructor.

public __construct( $orderPurchaseFlow : PurchaseFlow , $csvExportService : CsvExportService , $customerRepository : CustomerRepository , $paymentRepository : PaymentRepository , $sexRepository : SexRepository , $orderStatusRepository : OrderStatusRepository , $pageMaxRepository : PageMaxRepository , $productStatusRepository : ProductStatusRepository , $productStockRepository : ProductStockRepository , $orderRepository : OrderRepository , $orderPdfRepository : OrderPdfRepository , $validator : ValidatorInterface , $orderStateMachine : OrderStateMachine , $mailService : MailService ) : mixed
Parameters
$orderPurchaseFlow : PurchaseFlow
$csvExportService : CsvExportService
$customerRepository : CustomerRepository
$paymentRepository : PaymentRepository
$sexRepository : SexRepository
$orderStatusRepository : OrderStatusRepository
$pageMaxRepository : PageMaxRepository
$productStatusRepository : ProductStatusRepository
$productStockRepository : ProductStockRepository
$orderRepository : OrderRepository
$orderPdfRepository : OrderPdfRepository
$validator : ValidatorInterface
$orderStateMachine : OrderStateMachine

;

$mailService : MailService
Return values
mixed

index()

受注一覧画面.

public index( $request : Request [, $page_no : mixed = null ] , $paginator : PaginatorInterface ) : mixed
  • 検索条件, ページ番号, 表示件数はセッションに保持されます.
  • クエリパラメータでresume=1が指定された場合、検索条件, ページ番号, 表示件数をセッションから復旧します.
  • 各データの, セッションに保持するアクションは以下の通りです.
    • 検索ボタン押下時
      • 検索条件をセッションに保存します
      • ページ番号は1で初期化し、セッションに保存します。
    • 表示件数変更時
      • クエリパラメータpage_countをセッションに保存します。
      • ただし, mtb_page_maxと一致しない場合, eccube_default_page_countが保存されます.
    • ページング時
      • URLパラメータpage_noをセッションに保存します.
    • 初期表示
      • 検索条件は空配列, ページ番号は1で初期化し, セッションに保存します.
Parameters
$request : Request
$page_no : mixed = null
$paginator : PaginatorInterface
Tags
Route

("/%eccube_admin_route%/order", name="admin_order")

Route

("/%eccube_admin_route%/order/page/{page_no}", requirements={"page_no" = "\d+"}, name="admin_order_page")

Template

("@admin/Order/index.twig")

Return values
mixed

bulkDelete()

public bulkDelete( $request : Request ) : mixed
Parameters
$request : Request
Tags
Route

("/%eccube_admin_route%/order/bulk_delete", name="admin_order_bulk_delete", methods={"POST"})

Return values
mixed

exportOrder()

受注CSVの出力.

public exportOrder( $request : Request ) : StreamedResponse
Parameters
$request : Request
Tags
Route

("/%eccube_admin_route%/order/export/order", name="admin_order_export_order")

Return values
StreamedResponse

exportShipping()

配送CSVの出力.

public exportShipping( $request : Request ) : StreamedResponse
Parameters
$request : Request
Tags
Route

("/%eccube_admin_route%/order/export/shipping", name="admin_order_export_shipping")

Return values
StreamedResponse

exportCsv()

protected exportCsv( $request : Request , $csvTypeId : , $fileName : string ) : StreamedResponse
Parameters
$request : Request
$csvTypeId :
$fileName : string
Return values
StreamedResponse

updateOrderStatus()

Update to order status

public updateOrderStatus( $request : Request , $Shipping : Shipping ) : JsonResponse
Parameters
$request : Request
$Shipping : Shipping
Tags
Route

("/%eccube_admin_route%/shipping/{id}/order_status", requirements={"id" = "\d+"}, name="admin_shipping_update_order_status", methods={"PUT"})

Return values
JsonResponse

updateTrackingNumber()

Update to Tracking number.

public updateTrackingNumber( $request : Request , $shipping : Shipping ) : Response
Parameters
$request : Request
$shipping : Shipping
Tags
Route

("/%eccube_admin_route%/shipping/{id}/tracking_number", requirements={"id" = "\d+"}, name="admin_shipping_update_tracking_number", methods={"PUT"})

Return values
Response

exportPdf()

public exportPdf( $request : Request ) : array|RedirectResponse
Parameters
$request : Request
Tags
Route

("/%eccube_admin_route%/order/export/pdf", name="admin_order_export_pdf")

Template

("@admin/Order/order_pdf.twig")

Return values
array|RedirectResponse

exportPdfDownload()

public exportPdfDownload( $request : Request , $orderPdfService : OrderPdfService ) : Response
Parameters
$request : Request
$orderPdfService : OrderPdfService
Tags
Route

("/%eccube_admin_route%/order/export/pdf/download", name="admin_order_pdf_download")

Template

("@admin/Order/order_pdf.twig")

Return values
Response

setEntityManager()

public setEntityManager( $entityManager : EntityManagerInterface ) : mixed
Parameters
$entityManager : EntityManagerInterface
Tags
required
Return values
mixed

setTranslator()

public setTranslator( $translator : TranslatorInterface ) : mixed
Parameters
$translator : TranslatorInterface
Tags
required
Return values
mixed

setSession()

public setSession( $session : SessionInterface ) : mixed
Parameters
$session : SessionInterface
Tags
required
Return values
mixed

setFormFactory()

public setFormFactory( $formFactory : FormFactoryInterface ) : mixed
Parameters
$formFactory : FormFactoryInterface
Tags
required
Return values
mixed

setEventDispatcher()

public setEventDispatcher( $eventDispatcher : EventDispatcherInterface ) : mixed
Parameters
$eventDispatcher : EventDispatcherInterface
Tags
required
Return values
mixed

addSuccess()

public addSuccess( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

addError()

public addError( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

addDanger()

public addDanger( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

addWarning()

public addWarning( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

addInfo()

public addInfo( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

addRequestError()

public addRequestError( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

setLoginTargetPath()

public setLoginTargetPath( $targetPath : string [, $namespace : mixed = null ] ) : mixed
Parameters
$targetPath : string
$namespace : mixed = null
Return values
mixed

forwardToRoute()

Forwards the request to another controller.

public forwardToRoute( $route : string [, $path : array = [] ] [, $query : array = [] ] ) : Response
Parameters
$route : string

The name of the route

$path : array = []

An array of path parameters

$query : array = []

An array of query parameters

Return values
Response —

A Response instance

isTokenValid()

Checks the validity of a CSRF token.

protected isTokenValid( ) : bool

if token is invalid, throws AccessDeniedHttpException.

Tags
throws
AccessDeniedHttpException
Return values
bool

Search results