EC-CUBE4 APIドキュメント

ShoppingController extends AbstractShoppingController

Table of Contents

$cartService CartService
$mailService MailService
$orderHelper OrderHelper
$orderRepository OrderRepository
$purchaseFlow PurchaseFlow
$eccubeConfig EccubeConfig
$entityManager EntityManagerInterface
$translator TranslatorInterface
$formFactory FormFactoryInterface
$eventDispatcher EventDispatcherInterface
$session Session
__construct() mixed
index() 注文手続き画面を表示する mixed
redirectTo() 他画面への遷移を行う. mixed
confirm() 注文確認画面を表示する. mixed
checkout() 注文処理を行う. mixed
complete() 購入完了画面を表示する. mixed
shipping() お届け先選択画面. mixed
shippingEdit() お届け先の新規作成または編集画面. mixed
login() ログイン画面. mixed
error() 購入エラー画面. mixed
createPaymentMethod() PaymentMethodをコンテナから取得する. PaymentMethodInterface
executeApply() PaymentMethod::applyを実行する. RedirectResponse|Response
executeCheckout() PaymentMethod::checkoutを実行する. RedirectResponse|Response
setPurchaseFlow() mixed
executePurchaseFlow() PurchaseFlowResult|RedirectResponse
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

index()

注文手続き画面を表示する

public index( $cartPurchaseFlow : PurchaseFlow ) : mixed

未ログインまたはRememberMeログインの場合はログイン画面に遷移させる. ただし、非会員でお客様情報を入力済の場合は遷移させない.

カート情報から受注データを生成し, pre_order_idでカートと受注の紐付けを行う. 既に受注が生成されている場合(pre_order_idで取得できる場合)は, 受注の生成を行わずに画面を表示する.

purchaseFlowの集計処理実行後, warningがある場合はカートど同期をとるため, カートのPurchaseFlowを実行する.

Parameters
$cartPurchaseFlow : PurchaseFlow
Tags
Route

("/shopping", name="shopping")

Template

("Shopping/index.twig")

Return values
mixed

redirectTo()

他画面への遷移を行う.

public redirectTo( $request : Request , $router : RouterInterface ) : mixed

お届け先編集画面など, 他画面へ遷移する際に, フォームの値をDBに保存してからリダイレクトさせる. フォームのredirect_toパラメータの値にリダイレクトを行う. redirect_toパラメータはpath('遷移先のルーティング')が渡される必要がある.

外部のURLやPathを渡された場合($router->matchで展開出来ない場合)は, 購入エラーとする.

プラグインやカスタマイズでこの機能を使う場合は, twig側で以下のように記述してください.

<button data-trigger="click" data-path="path('ルーティング')">更新する</button>

data-triggerは, click/change/blur等のイベント名を指定してください。 data-pathは任意のパラメータです. 指定しない場合, 注文手続き画面へリダイレクトします.

Parameters
$request : Request
$router : RouterInterface
Tags
Route

("/shopping/redirect_to", name="shopping_redirect_to", methods={"POST"})

Template

("Shopping/index.twig")

Return values
mixed

confirm()

注文確認画面を表示する.

public confirm( $request : Request ) : mixed

ここではPaymentMethod::verifyがコールされます. PaymentMethod::verifyではクレジットカードの有効性チェック等, 注文手続きを進められるかどうかのチェック処理を行う事を想定しています. PaymentMethod::verifyでエラーが発生した場合は, 注文手続き画面へリダイレクトします.

Parameters
$request : Request
Tags
Route

("/shopping/confirm", name="shopping_confirm", methods={"POST"})

Template

("Shopping/confirm.twig")

Return values
mixed

checkout()

注文処理を行う.

public checkout( $request : Request ) : mixed

決済プラグインによる決済処理および注文の確定処理を行います.

Parameters
$request : Request
Tags
Route

("/shopping/checkout", name="shopping_checkout", methods={"POST"})

Template

("Shopping/confirm.twig")

Return values
mixed

complete()

購入完了画面を表示する.

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

("/shopping/complete", name="shopping_complete")

Template

("Shopping/complete.twig")

Return values
mixed

shipping()

お届け先選択画面.

public shipping( $request : Request , $Shipping : Shipping ) : mixed

会員ログイン時, お届け先を選択する画面を表示する 非会員の場合はこの画面は使用しない。

Parameters
$request : Request
$Shipping : Shipping
Tags
Route

("/shopping/shipping/{id}", name="shopping_shipping", requirements={"id" = "\d+"})

Template

("Shopping/shipping.twig")

Return values
mixed

shippingEdit()

お届け先の新規作成または編集画面.

public shippingEdit( $request : Request , $Shipping : Shipping ) : mixed

会員時は新しいお届け先を作成し, 作成したお届け先を選択状態にして注文手続き画面へ遷移する. 非会員時は選択されたお届け先の編集を行う.

Parameters
$request : Request
$Shipping : Shipping
Tags
Route

("/shopping/shipping_edit/{id}", name="shopping_shipping_edit", requirements={"id" = "\d+"})

Template

("Shopping/shipping_edit.twig")

Return values
mixed

login()

ログイン画面.

public login( $request : Request , $authenticationUtils : AuthenticationUtils ) : mixed
Parameters
$request : Request
$authenticationUtils : AuthenticationUtils
Tags
Route

("/shopping/login", name="shopping_login")

Template

("Shopping/login.twig")

Return values
mixed

error()

購入エラー画面.

public error( $request : Request , $cartPurchaseFlow : PurchaseFlow ) : mixed
Parameters
$request : Request
$cartPurchaseFlow : PurchaseFlow
Tags
Route

("/shopping/error", name="shopping_error")

Template

("Shopping/shopping_error.twig")

Return values
mixed

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