EC-CUBE4 APIドキュメント

CartService

Table of Contents

$carts \Eccube\Entity\Cart[]
$session SessionInterface
$entityManager EntityManagerInterface
$cart ItemHolderInterface
$productClassRepository ProductClassRepository
$cartRepository CartRepository
$cartItemComparator CartItemComparator
$cartItemAllocator CartItemAllocator
$orderRepository OrderRepository
$tokenStorage TokenStorageInterface
$authorizationChecker AuthorizationCheckerInterface
__construct() CartService constructor. mixed
getCarts() 現在のカートの配列を取得する. \Eccube\Entity\Cart[]
getPersistedCarts() 永続化されたカートを返す \Eccube\Entity\Cart[]
getSessionCarts() セッションにあるカートを返す \Eccube\Entity\Cart[]
mergeFromPersistedCart() 会員が保持する永続化されたカートと、非会員時のカートをマージする. mixed
getCart() Cart|null
mergeAllCartItems() \Eccube\Entity\CartItem[]
mergeCartItems() array
restoreCarts() mixed
addProduct() カートに商品を追加します. bool
removeProduct() mixed
save() mixed
setPreOrderId() CartService
getPreOrderId() null|string
clear() CartService
setCartItemComparator() mixed
setPrimary() カートキーで指定したインデックスにあるカートを優先にする mixed
getUser() mixed
createCartKey() mixed

Properties

$entityManager

protected EntityManagerInterface $entityManager

$tokenStorage

protected TokenStorageInterface $tokenStorage

$authorizationChecker

protected AuthorizationCheckerInterface $authorizationChecker

Methods

__construct()

CartService constructor.

public __construct( $session : SessionInterface , $entityManager : EntityManagerInterface , $productClassRepository : ProductClassRepository , $cartRepository : CartRepository , $cartItemComparator : CartItemComparator , $cartItemAllocator : CartItemAllocator , $orderRepository : OrderRepository , $tokenStorage : TokenStorageInterface , $authorizationChecker : AuthorizationCheckerInterface ) : mixed
Parameters
$session : SessionInterface
$entityManager : EntityManagerInterface
$productClassRepository : ProductClassRepository
$cartRepository : CartRepository
$cartItemComparator : CartItemComparator
$cartItemAllocator : CartItemAllocator
$orderRepository : OrderRepository
$tokenStorage : TokenStorageInterface
$authorizationChecker : AuthorizationCheckerInterface
Return values
mixed

getCarts()

現在のカートの配列を取得する.

public getCarts( [ $empty_delete : bool = false ] ) : \Eccube\Entity\Cart[]

本サービスのインスタンスのメンバーが空の場合は、DBまたはセッションからカートを取得する

Parameters
$empty_delete : bool = false

true の場合、商品明細が空のカートが存在した場合は削除する

Return values
\Eccube\Entity\Cart[]

getPersistedCarts()

永続化されたカートを返す

public getPersistedCarts( ) : \Eccube\Entity\Cart[]
Return values
\Eccube\Entity\Cart[]

getSessionCarts()

セッションにあるカートを返す

public getSessionCarts( ) : \Eccube\Entity\Cart[]
Return values
\Eccube\Entity\Cart[]

mergeFromPersistedCart()

会員が保持する永続化されたカートと、非会員時のカートをマージする.

public mergeFromPersistedCart( ) : mixed
Return values
mixed

mergeAllCartItems()

protected mergeAllCartItems( [ $cartItems : \Eccube\Entity\CartItem[] = [] ] ) : \Eccube\Entity\CartItem[]
Parameters
$cartItems : \Eccube\Entity\CartItem[] = []
Return values
\Eccube\Entity\CartItem[]

mergeCartItems()

protected mergeCartItems( $cartItems : , $allCartItems : ) : array
Parameters
$cartItems :
$allCartItems :
Return values
array

restoreCarts()

protected restoreCarts( $cartItems : mixed ) : mixed
Parameters
$cartItems : mixed
Return values
mixed

addProduct()

カートに商品を追加します.

public addProduct( $ProductClass : [, $quantity : = 1 ] ) : bool
Parameters
$ProductClass :

商品規格

$quantity : = 1

数量

Return values
bool —

商品を追加できた場合はtrue

removeProduct()

public removeProduct( $ProductClass : mixed ) : mixed
Parameters
$ProductClass : mixed
Return values
mixed

getPreOrderId()

public getPreOrderId( ) : null|string
Return values
null|string

setPrimary()

カートキーで指定したインデックスにあるカートを優先にする

public setPrimary( $cartKey : string ) : mixed
Parameters
$cartKey : string

カートキー

Return values
mixed

getUser()

protected getUser( ) : mixed
Return values
mixed

createCartKey()

protected createCartKey( $allocatedId : string [, $Customer : Customer = null ] ) : mixed
Parameters
$allocatedId : string
$Customer : Customer = null
Return values
mixed

Search results