# 機能設計書 36-カートJSON取得

## 概要

本ドキュメントは、ShopwareストアフロントにおけるカートデータのJSON形式取得機能の設計について記述する。

### 本機能の処理概要

本機能は、現在のショッピングカートの内容をJSON形式で取得するAPIエンドポイントを提供する。JavaScriptによるカート操作や、外部システムとの連携に使用される。

**業務上の目的・背景**：SPA（Single Page Application）やPWA（Progressive Web App）など、フロントエンドJavaScriptからカート情報を取得する必要がある場合に使用する。また、サードパーティのアプリケーションや拡張機能がカート情報にアクセスする際のAPIエンドポイントとしても機能する。

**機能の利用シーン**：
- JavaScriptでカート情報を動的に取得する際
- カート操作後のデータ同期
- 外部アプリケーションからのカート参照
- カスタムフロントエンド実装でのカートデータ取得

**主要な処理内容**：
1. リクエストの受け取り
2. CartLoadRouteを通じたカートデータ取得
3. JSON形式でのレスポンス返却

**関連システム・外部連携**：
- Store-API（CartLoadRoute）
- 外部システムとのAPI連携

**権限による制御**：特になし（セッショントークンによるカート分離）

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 7 | カートページ | 関連画面 | カートデータのJSON取得 |
| 8 | オフキャンバスカート | 関連画面 | カートデータの取得 |

## 機能種別

データ取得（Read操作 / API）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| token | string | No | カートトークン（クエリパラメータ） | - |
| taxed | bool | No | 税込み計算済みフラグ | true/false |

### 入力データソース

- クエリパラメータ
- SalesChannelContext（セッショントークン）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| token | string | カートトークン |
| name | string | カート名 |
| errors | array | カートエラー一覧 |
| deliveries | array | 配送情報 |
| transactions | array | トランザクション情報 |
| modified | bool | 変更フラグ |
| customerComment | string | 顧客コメント |
| affiliateCode | string | アフィリエイトコード |
| campaignCode | string | キャンペーンコード |
| lineItems | array | カート明細一覧 |
| price | object | 価格情報 |

### 出力先

- JSON形式のHTTPレスポンス（CartResponse）

## 処理フロー

### 処理シーケンス

```
1. リクエスト受信（Ajax）
   └─ CheckoutController::cartJson()がリクエストを受信
2. CartLoadRoute呼び出し
   └─ Store-APIのカート取得ルートに委譲
3. カートデータ取得
   └─ セッショントークンに基づきカートを取得
4. レスポンス返却
   └─ CartResponseをそのまま返却（JSON形式）
```

### フローチャート

```mermaid
flowchart TD
    A[開始: cartJson Ajax] --> B[CartLoadRoute::load]
    B --> C[カートデータ取得]
    C --> D[CartResponse生成]
    D --> E[JSONレスポンス返却]
    E --> F[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-36-01 | SEOインデックス除外 | seo: false属性により検索エンジン除外 | 常時 |
| BR-36-02 | Ajax専用 | XmlHttpRequestのみ対応 | 常時 |
| BR-36-03 | セッション分離 | セッショントークンによりカートを分離 | 常時 |
| BR-36-04 | Store-API委譲 | 処理はCartLoadRouteに完全委譲 | 常時 |

### 計算ロジック

特になし（データ取得のみ）

## データベース操作仕様

### 操作別データベース影響一覧

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| カート取得 | cart | SELECT | セッショントークンに紐づくカートを取得 |

### テーブル別操作詳細

#### cart

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | token, payload, price, line_items | token = {セッショントークン} | Redis使用時はRedisから取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| (なし) | - | カートが存在しない場合 | 空のカートを返却 |

### リトライ仕様

特になし（読み取り専用処理のためリトライ不要）

## トランザクション仕様

読み取り専用処理のため、トランザクション制御なし

## パフォーマンス要件

- レスポンス時間: 200ms以内（API応答）
- カートデータはRedis等でキャッシュ（設定による）

## セキュリティ考慮事項

- セッショントークンによるカート分離
- JSON形式のレスポンスのためXSS対策はクライアント側で必要
- CORS設定による外部アクセス制御

## 備考

- Store-APIのCartLoadRouteを直接返却するシンプルな実装
- カスタマイズが必要な場合はCartLoadRouteをデコレート

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

まず、カートJSON取得で使用されるデータ構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | CartResponse.php | `src/Core/Checkout/Cart/SalesChannel/CartResponse.php` | レスポンスの構造 |
| 1-2 | Cart.php | `src/Core/Checkout/Cart/Cart.php` | カートエンティティの構造 |

**読解のコツ**: CartResponseはStoreApiResponseを継承し、getCart()メソッドでCartオブジェクトを返す。JSON変換時はCartのjsonSerialize()メソッドが使用される。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | CheckoutController.php | `src/Storefront/Controller/CheckoutController.php` | cartJsonメソッドがエントリーポイント |

**主要処理フロー**:
1. **105-111行目**: ルート定義（/checkout/cart.json, XmlHttpRequest専用）
2. **112行目**: cartJsonメソッドの開始
3. **114行目**: CartLoadRouteのloadメソッドを呼び出し、結果をそのまま返却

#### Step 3: Store-APIルートを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | AbstractCartLoadRoute.php | `src/Core/Checkout/Cart/SalesChannel/AbstractCartLoadRoute.php` | 抽象クラスの契約 |
| 3-2 | CartLoadRoute.php | `src/Core/Checkout/Cart/SalesChannel/CartLoadRoute.php` | 実際のカート取得処理 |

**読解のコツ**: CartLoadRouteはStore-APIルートとして設計されており、認証・認可やバリデーションはルート側で処理される。

### プログラム呼び出し階層図

```
CheckoutController::cartJson()
    │
    └─ AbstractCartLoadRoute::load()
           │
           └─ CartLoadRoute::load()
                  │
                  ├─ CartPersister::load() [カート読み込み]
                  │      └─ cart テーブル / Redis
                  │
                  └─ CartResponse [レスポンス生成]
                         └─ Cart::jsonSerialize()
```

### データフロー図

```
[入力]                    [処理]                         [出力]

Request ─────────────▶ CartLoadRoute::load ────────▶ CartResponse
   │                         │                           │
   └─ token (optional)       ▼                          │
   └─ taxed (optional)   cart テーブル                  ├─ token
                         (Redis)                        ├─ name
                              │                         ├─ lineItems
                              ▼                         ├─ price
                           Cart                         ├─ deliveries
                              │                         ├─ errors
                              ▼                         └─ ...
                        jsonSerialize()                      │
                              │                              ▼
                              └────────────────────▶ JSON Response
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| CheckoutController.php | `src/Storefront/Controller/CheckoutController.php` | コントローラー | HTTPリクエスト処理 |
| AbstractCartLoadRoute.php | `src/Core/Checkout/Cart/SalesChannel/AbstractCartLoadRoute.php` | 抽象クラス | Store-APIカート取得契約 |
| CartLoadRoute.php | `src/Core/Checkout/Cart/SalesChannel/CartLoadRoute.php` | Store-APIルート | カート取得処理 |
| CartResponse.php | `src/Core/Checkout/Cart/SalesChannel/CartResponse.php` | レスポンス | JSONレスポンス構造 |
| Cart.php | `src/Core/Checkout/Cart/Cart.php` | エンティティ | カートデータ |
