# 機能設計書 54-お気に入りリスト取得

## 概要

本ドキュメントは、Shopware Storefrontにおける「お気に入りリスト取得」機能の設計仕様を定義する。ログイン済み顧客のウィッシュリストに登録されている商品IDの一覧をJSON形式で取得するAjax APIを提供する。

### 本機能の処理概要

**業務上の目的・背景**：ECサイトのフロントエンドでは、商品一覧ページや商品詳細ページにおいて、どの商品がお気に入りに追加済みかを視覚的に表示する必要がある（例：ハートアイコンの塗りつぶし状態）。本機能は、ログイン済み顧客のお気に入り商品IDリストを取得し、フロントエンドJavaScriptがUI状態を更新するためのデータを提供する。

**機能の利用シーン**：顧客がページを開いた際に、フロントエンドJavaScriptが本APIを呼び出してお気に入り商品IDリストを取得する。取得したリストをもとに、各商品のお気に入りボタンの表示状態（追加済み/未追加）を更新する。

**主要な処理内容**：
1. ログイン状態およびウィッシュリスト機能有効化の確認
2. 顧客のウィッシュリスト取得
3. ウィッシュリストに紐付く商品ID一覧の取得
4. 商品IDリストのJSONレスポンス返却

**関連システム・外部連携**：本機能は Store API (`/store-api/customer/wishlist`) を内部的に利用し、データベースから商品リストを取得する。イベント`WishListPageProductCriteriaEvent`を発火し、検索条件のカスタマイズを可能にする。

**権限による制御**：本機能はログイン必須（`LOGIN_REQUIRED`属性）であり、未認証ユーザーはアクセスできない。自分のウィッシュリスト情報のみ取得可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 23 | ウィッシュリストページ | 主画面 | お気に入り商品一覧の表示 |
| 3 | 商品詳細ページ | 参照画面 | お気に入り状態の表示更新 |
| 2 | カテゴリページ | 参照画面 | 商品一覧のお気に入り状態表示 |
| 5 | 検索結果ページ | 参照画面 | 検索結果商品のお気に入り状態表示 |

## 機能種別

CRUD操作（Read）/ Ajax API

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| - | - | - | URLパスパラメータなし | - |

### 入力データソース

- SalesChannelContext: 顧客情報、販売チャネル情報を含む
- CustomerEntity: ログイン済み顧客情報

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (root) | array | 商品IDの配列 |

### 出力先

- HTTPレスポンス: JSON形式 `["product-uuid-1", "product-uuid-2", ...]` または `[]`

## 処理フロー

### 処理シーケンス

```
1. リクエスト受信
   └─ WishlistController::ajaxList が呼び出される

2. 検索条件イベント発火
   └─ WishListPageProductCriteriaEvent をディスパッチ
   └─ プラグインが検索条件をカスタマイズ可能

3. Store API呼び出し
   └─ LoadWishlistRoute::load を実行

4. ウィッシュリスト機能有効性チェック
   └─ core.cart.wishlistEnabled システム設定を確認
   └─ 無効の場合は CustomerException::customerWishlistNotActivated をスロー

5. ウィッシュリスト取得
   └─ 顧客ID + 販売チャネルIDでウィッシュリストを検索
   └─ 存在しない場合は CustomerWishlistNotFoundException をスロー

6. 商品リスト取得
   └─ ウィッシュリストに紐付く商品を検索
   └─ 在庫切れ非表示設定に応じてフィルタ

7. レスポンス返却
   └─ 商品IDリストをJSON配列で返却
   └─ ウィッシュリストがない場合は空配列を返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始: ajaxList呼び出し] --> B[Criteria作成]
    B --> C[WishListPageProductCriteriaEvent発火]
    C --> D{ウィッシュリスト存在?}
    D -->|No| E[空配列返却]
    D -->|Yes| F[LoadWishlistRoute::load呼び出し]
    F --> G{ウィッシュリスト機能有効?}
    G -->|No| H[例外: WishlistNotActivated]
    G -->|Yes| I[ウィッシュリスト取得]
    I --> J{ウィッシュリスト存在?}
    J -->|No| K[例外: WishlistNotFound]
    J -->|Yes| L[商品リスト取得]
    L --> M[商品ID配列を返却]
    E --> N[終了]
    M --> N
    H --> O[例外キャッチ]
    K --> O
    O --> E
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-54-01 | ログイン必須 | ログイン済み顧客のみが利用可能 | 全リクエスト |
| BR-54-02 | ウィッシュリスト有効化 | システム設定でウィッシュリストが有効である必要がある | 全リクエスト |
| BR-54-03 | 所有権制限 | 自分のウィッシュリストのみ取得可能 | 全リクエスト |
| BR-54-04 | 販売チャネル分離 | 販売チャネル毎にウィッシュリストは分離管理 | 全リクエスト |
| BR-54-05 | 空リスト許容 | ウィッシュリストがない場合は空配列を返却 | ウィッシュリスト未作成時 |
| BR-54-06 | 在庫切れ商品 | システム設定に応じて在庫切れ商品を非表示 | 商品取得時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ウィッシュリスト取得 | customer_wishlist | SELECT | 顧客のウィッシュリストを検索 |
| 商品リスト取得 | product | SELECT | ウィッシュリストに紐付く商品を検索 |

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

#### customer_wishlist

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | id | customer_id = ? AND sales_channel_id = ? | ウィッシュリスト存在確認 |

#### product (SalesChannelRepository経由)

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | id | wishlists.wishlistId = ? | ウィッシュリストに紐付く商品を取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| CUSTOMER_WISHLIST_NOT_ACTIVATED | 機能無効 | core.cart.wishlistEnabled が false | システム設定を有効化 |
| CUSTOMER_WISHLIST_NOT_FOUND | ウィッシュリスト未存在 | 顧客のウィッシュリストが存在しない | Controller側で空配列に変換 |
| - | 認証エラー | 未ログイン状態でアクセス | ログインが必要 |

### リトライ仕様

特になし（同期処理のため）

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

- 読み取り専用のため、トランザクション管理は不要
- SELECTクエリのみ実行

## パフォーマンス要件

- レスポンス時間: 300ms以内
- キャッシュ: HTTPキャッシュは無効（ユーザー固有データ）

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

- ログイン必須（`LOGIN_REQUIRED`属性による認証チェック）
- 他顧客のウィッシュリストへのアクセス不可（顧客ID紐付け）
- XmlHttpRequestヘッダー検証

## 備考

- 取得する情報は商品IDのみ（軽量レスポンス）
- 商品詳細情報は別途商品APIで取得する設計
- ページ初期表示時のUI状態更新に使用

---

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

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

### 推奨読解順序

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

まず、ウィッシュリストのデータ構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | CustomerWishlistDefinition.php | `src/Core/Checkout/Customer/Aggregate/CustomerWishlist/CustomerWishlistDefinition.php` | ウィッシュリストエンティティ定義 |
| 1-2 | LoadWishlistRouteResponse.php | `src/Core/Checkout/Customer/SalesChannel/LoadWishlistRouteResponse.php` | レスポンス構造 |

**読解のコツ**: LoadWishlistRouteResponseには、ウィッシュリストエンティティと商品リスト（ProductListing）が含まれる。getIds()で商品IDの配列を取得できる。

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

処理の起点となるコントローラーを確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | WishlistController.php | `src/Storefront/Controller/WishlistController.php` | Storefront側のエントリーポイント。ajaxListメソッドがリスト取得の入口 |

**主要処理フロー**:
1. **126-149行目**: ajaxListメソッドの定義。Request、SalesChannelContext、CustomerEntityを受け取る
2. **138-139行目**: Criteriaを作成し、WishListPageProductCriteriaEventを発火
3. **140行目**: プラグインによる検索条件カスタマイズが可能
4. **142-146行目**: try-catchブロック内でwishlistLoadRouteを呼び出し
5. **144-146行目**: CustomerWishlistNotFoundExceptionの場合は空配列を返却
6. **148行目**: 成功時は商品ID配列をJSONで返却

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

実際のビジネスロジックはStore APIルートに実装されている。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | LoadWishlistRoute.php | `src/Core/Checkout/Customer/SalesChannel/LoadWishlistRoute.php` | リスト取得の核心ロジック |

**主要処理フロー**:
- **64-78行目**: loadメソッドの実装
- **66-68行目**: Criteriaのタイトル設定（デバッグ用）
- **70-72行目**: ウィッシュリスト機能の有効性チェック
- **74行目**: ウィッシュリスト取得（loadWishlist）
- **75行目**: 商品リスト取得（loadProducts）
- **77行目**: LoadWishlistRouteResponseを返却

#### Step 4: 商品取得処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | LoadWishlistRoute.php | `src/Core/Checkout/Customer/SalesChannel/LoadWishlistRoute.php` | loadWishlist、loadProductsメソッド |

**主要処理フロー**:
- **80-95行目**: loadWishlistメソッド。顧客ID+販売チャネルIDでウィッシュリストを検索
- **100-123行目**: loadProductsメソッド
  - **102-105行目**: Criteriaにフィルタとソートを追加
  - **107-112行目**: 在庫切れ商品の非表示設定をチェック
  - **114-115行目**: CustomerWishlistLoaderCriteriaEventを発火
  - **117行目**: SalesChannelRepositoryで商品を検索
  - **119-120行目**: CustomerWishlistProductListingResultEventを発火

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

```
WishlistController::ajaxList (Storefront)
    │
    ├─ EventDispatcher::dispatch (検索条件カスタマイズ)
    │      └─ WishListPageProductCriteriaEvent
    │
    └─ LoadWishlistRoute::load (Store API)
           │
           ├─ SystemConfigService::get (設定確認)
           │
           ├─ loadWishlist (ウィッシュリスト取得)
           │      └─ EntityRepository::search
           │             └─ 例外: CustomerWishlistNotFound
           │
           └─ loadProducts (商品リスト取得)
                  ├─ ProductCloseoutFilterFactory::create (在庫切れフィルタ)
                  ├─ EventDispatcher::dispatch
                  │      └─ CustomerWishlistLoaderCriteriaEvent
                  ├─ SalesChannelRepository::search
                  └─ EventDispatcher::dispatch
                         └─ CustomerWishlistProductListingResultEvent
```

### データフロー図

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

SalesChannelContext ───▶ WishlistController::ajaxList
                              │
CustomerEntity ────────────▶ │
                              ▼
                         LoadWishlistRoute::load
                              │
                              ├─▶ customer_wishlist テーブル (SELECT)
                              │
                              └─▶ product テーブル (SELECT via SalesChannel)
                                          │
                                          ▼
                                   JsonResponse ──────▶ ["uuid1", "uuid2", ...]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| WishlistController.php | `src/Storefront/Controller/WishlistController.php` | ソース | Storefrontコントローラー、エントリーポイント |
| LoadWishlistRoute.php | `src/Core/Checkout/Customer/SalesChannel/LoadWishlistRoute.php` | ソース | Store APIルート、ビジネスロジック |
| AbstractLoadWishlistRoute.php | `src/Core/Checkout/Customer/SalesChannel/AbstractLoadWishlistRoute.php` | ソース | 抽象クラス、デコレーションパターン用 |
| LoadWishlistRouteResponse.php | `src/Core/Checkout/Customer/SalesChannel/LoadWishlistRouteResponse.php` | ソース | レスポンスクラス |
| CustomerWishlistDefinition.php | `src/Core/Checkout/Customer/Aggregate/CustomerWishlist/CustomerWishlistDefinition.php` | ソース | ウィッシュリストエンティティ定義 |
| WishListPageProductCriteriaEvent.php | `src/Storefront/Page/Wishlist/WishListPageProductCriteriaEvent.php` | ソース | 検索条件カスタマイズイベント |
| CustomerWishlistLoaderCriteriaEvent.php | `src/Core/Checkout/Customer/Event/CustomerWishlistLoaderCriteriaEvent.php` | ソース | ローダー検索条件イベント |
