# 機能設計書 31-レビュー表示

## 概要

本ドキュメントは、Shopwareストアフロントにおける商品レビュー一覧表示機能の設計について記述する。

### 本機能の処理概要

本機能は、商品詳細ページにおいて顧客が投稿したレビューを一覧表示するための機能である。ページネーション、ソート、フィルタリング機能を備え、レビュー評価の分布（マトリックス）も表示する。

**業務上の目的・背景**：ECサイトにおいて、商品レビューは購入意思決定に大きな影響を与える重要な要素である。顧客が他の購入者の評価や感想を確認することで、商品への信頼性を高め、購入率の向上に寄与する。また、レビューの集計情報（評価分布）を表示することで、商品の総合的な評価を一目で把握できるようにする。

**機能の利用シーン**：
- 商品詳細ページでレビュータブをクリックした際
- 商品詳細ページ内のレビューセクションを閲覧する際
- レビューのソート順や言語フィルターを変更した際
- ページネーションでレビューの別ページを表示する際

**主要な処理内容**：
1. 商品IDに基づくレビューデータの取得
2. ページネーション処理（ページ番号、表示件数の制御）
3. ソート処理（作成日時順、評価点順）
4. 言語フィルター処理（現在の言語のレビューのみ表示）
5. 評価点フィルター処理（特定の評価点のレビューのみ表示）
6. レビュー評価マトリックスの集計と表示
7. ログインユーザーの場合、自身のレビュー情報の取得

**関連システム・外部連携**：特になし（内部データベースのみ参照）

**権限による制御**：
- 匿名ユーザー：公開されたレビューの閲覧のみ可能
- ログインユーザー：自身が投稿したレビューがある場合、その情報も取得される

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 3 | 商品詳細ページ | 主画面 | 商品レビュー一覧の表示（ProductController::loadReviews） |
| 37 | レビュー管理 | 管理画面 | レビュー一覧の表示と管理 |

## 機能種別

データ取得・表示（Read操作）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| productId | string | Yes | 対象商品のID（UUIDv4形式） | UUID形式であること |
| parentId | string | No | 親商品のID（バリアント商品の場合） | UUID形式であること |
| p | int | No | ページ番号（デフォルト: 1） | 正の整数 |
| sort | string | No | ソート順（createdAt/points） | createdAt または points |
| language | string | No | 言語フィルター（filter-language） | filter-language または空 |
| points | array | No | 評価点フィルター（1-5の配列） | 1〜5の整数配列 |

### 入力データソース

- URLパラメータ（productId）
- クエリパラメータ（p, sort, language, points, parentId）
- SalesChannelContext（ログインユーザー情報、言語設定）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| reviews | ProductReviewResult | レビュー一覧オブジェクト |
| reviews.elements | ProductReviewCollection | レビューエンティティの配列 |
| reviews.total | int | 総レビュー数 |
| reviews.matrix | RatingMatrix | 評価分布マトリックス |
| reviews.customerReview | ProductReviewEntity\|null | ログインユーザーのレビュー |
| reviews.totalReviewsInCurrentLanguage | int | 現在の言語でのレビュー数 |
| reviews.productId | string | 対象商品ID |
| reviews.parentId | string | 親商品ID |
| ratingSuccess | int\|null | レビュー投稿結果（1: 新規成功, 2: 更新成功, -1: エラー） |

### 出力先

- HTMLテンプレート（storefront/component/review/review.html.twig）
- Ajax通信の場合はHTMLフラグメント

## 処理フロー

### 処理シーケンス

```
1. リクエスト受信
   └─ ProductController::loadReviews()がリクエストを受信
2. parentIdパラメータの取得
   └─ RequestParamHelperでparentIdを抽出
3. レビュー機能有効チェック（v6.8.0.0未満）
   └─ ReviewNotActiveExeptionの場合はStorefrontExceptionをスロー
4. レビューデータ取得
   └─ ProductReviewLoader::load()を呼び出し
5. 検索条件の構築
   └─ ページネーション、ソート、フィルター条件を設定
6. レビューデータの取得
   └─ ProductReviewRouteからデータを取得
7. 評価マトリックスの計算
   └─ 集計結果からRatingMatrixを生成
8. 現在の言語でのレビュー数取得
   └─ languageMatrix集計から件数を取得
9. 顧客レビューの取得（ログイン時）
   └─ ログインユーザーの既存レビューを検索
10. イベントディスパッチ
    └─ ProductReviewsLoadedEventを発行
11. フック実行
    └─ ProductReviewsWidgetLoadedHookを実行
12. テンプレートレンダリング
    └─ review.html.twigをレンダリングして返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始: loadReviews] --> B[parentIdパラメータ取得]
    B --> C{Feature v6.8.0.0?}
    C -->|No| D{レビュー機能有効?}
    D -->|No| E[StorefrontException: reviewNotActive]
    D -->|Yes| F[ProductReviewLoader::load]
    C -->|Yes| F
    F --> G[検索条件構築]
    G --> H[ページネーション設定]
    H --> I[ソート条件設定]
    I --> J[言語フィルター設定]
    J --> K[評価点フィルター設定]
    K --> L[ProductReviewRoute::load]
    L --> M[ProductReviewResult生成]
    M --> N[評価マトリックス計算]
    N --> O[顧客レビュー取得]
    O --> P[イベントディスパッチ]
    P --> Q[フック実行]
    Q --> R[テンプレートレンダリング]
    R --> S[終了]
    E --> S
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-31-01 | ページ表示件数 | システム設定 core.listing.reviewsPerPage に基づく件数を表示 | 常時 |
| BR-31-02 | デフォルトソート | 作成日時の降順（新しい順）がデフォルト | ソートパラメータ未指定時 |
| BR-31-03 | 評価点ソート | 評価点の降順でソート可能 | sort=points指定時 |
| BR-31-04 | 言語フィルター | 現在の言語のレビューのみ表示可能 | language=filter-language指定時 |
| BR-31-05 | 評価点フィルター | 指定した評価点（±0.5範囲）のレビューを表示 | points配列指定時 |
| BR-31-06 | 公開レビュー条件 | status=trueのレビューのみ表示 | 常時 |
| BR-31-07 | 顧客レビュー例外 | ログインユーザーは自身の未公開レビューも閲覧可 | ログイン時 |

### 計算ロジック

**評価マトリックス計算**:
- TermsAggregationを使用して評価点別の件数を集計
- 各評価点（1〜5）ごとのレビュー数をBucketとして取得
- RatingMatrixクラスで表示用のデータ構造に変換

**評価点フィルター範囲計算**:
- 指定評価点 - 0.5 <= points < 指定評価点 + 0.5
- 例: points=4の場合、3.5 <= points < 4.5

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| レビュー一覧取得 | product_review | SELECT | 商品に紐づくレビューを取得 |
| 顧客レビュー取得 | product_review | SELECT | ログインユーザーのレビューを取得 |

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

#### product_review

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | id, product_id, customer_id, sales_channel_id, language_id, title, content, points, status, created_at, updated_at | product_id = {指定商品ID} AND (status = true OR customer_id = {ログインユーザーID}) | 言語・評価点フィルター適用 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| PRODUCT_REVIEW_NOT_ACTIVE | 機能無効エラー | レビュー機能が無効の場合（v6.8.0.0未満） | エラーページ表示 |

### リトライ仕様

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

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

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

## パフォーマンス要件

- レスポンス時間: 500ms以内（通常時）
- ページネーションによる件数制限でクエリ負荷を軽減
- 集計クエリはFilterAggregationを使用して効率化

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

- 未公開レビュー（status=false）は投稿者本人以外には非表示
- XSS対策としてテンプレート側でエスケープ処理
- SQLインジェクション対策としてDAL（Data Abstraction Layer）を使用

## 備考

- バリアント商品の場合、parentIdを使用して親商品のレビューを取得
- レビュー投稿後のリダイレクト時は success パラメータで結果を通知

---

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

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

### 推奨読解順序

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

まず、レビュー機能で使用されるデータ構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | ProductReviewResult.php | `src/Core/Content/Product/SalesChannel/Review/ProductReviewResult.php` | レビュー結果の構造（matrix, customerReview, totalReviewsInCurrentLanguage） |
| 1-2 | RatingMatrix.php | `src/Core/Content/Product/SalesChannel/Review/RatingMatrix.php` | 評価分布マトリックスの構造 |
| 1-3 | ProductReviewEntity.php | `src/Core/Content/Product/Aggregate/ProductReview/ProductReviewEntity.php` | レビューエンティティの構造 |

**読解のコツ**: ProductReviewResultはEntitySearchResultを継承しており、追加フィールドとしてmatrix、customerReview、totalReviewsInCurrentLanguageを持つ。

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

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

**主要処理フロー**:
1. **196-200行目**: ルート定義（/product/{productId}/reviews）
2. **202行目**: loadReviewsメソッドの開始
3. **204行目**: parentIdパラメータの取得
4. **205-213行目**: Feature flagによる分岐とレビューデータ取得
5. **215行目**: ProductReviewsWidgetLoadedHookの実行
6. **217-228行目**: テンプレートレンダリングと結果返却

#### Step 3: レビューローダーを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | AbstractProductReviewLoader.php | `src/Core/Content/Product/SalesChannel/Review/AbstractProductReviewLoader.php` | 抽象クラスの契約 |
| 3-2 | ProductReviewLoader.php | `src/Core/Content/Product/SalesChannel/Review/ProductReviewLoader.php` | 実装クラス |

**主要処理フロー**:
- **48-69行目**: load()メソッド - レビュー取得のメイン処理
- **101-129行目**: createReviewCriteria() - 検索条件の構築
- **132-151行目**: getCustomerReview() - ログインユーザーのレビュー取得
- **153-192行目**: handlePointsAggregation() - 評価点集計の処理

#### Step 4: レビュールートを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | AbstractProductReviewRoute.php | `src/Core/Content/Product/SalesChannel/Review/AbstractProductReviewRoute.php` | Store-APIルートの契約 |
| 4-2 | ProductReviewRoute.php | `src/Core/Content/Product/SalesChannel/Review/ProductReviewRoute.php` | 実際のデータ取得処理 |

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

```
ProductController::loadReviews()
    │
    ├─ RequestParamHelper::get() [parentId取得]
    │
    ├─ ProductReviewLoader::load()
    │      │
    │      ├─ createReviewCriteria() [検索条件構築]
    │      │
    │      ├─ ProductReviewRoute::load() [レビューデータ取得]
    │      │      └─ ProductReviewRepository::search()
    │      │
    │      ├─ getReviewRatingMatrix() [評価マトリックス計算]
    │      │
    │      ├─ getCustomerReview() [顧客レビュー取得]
    │      │      └─ ProductReviewRoute::load()
    │      │
    │      └─ EventDispatcher::dispatch() [ProductReviewsLoadedEvent]
    │
    ├─ hook() [ProductReviewsWidgetLoadedHook]
    │
    └─ renderStorefront() [テンプレートレンダリング]
```

### データフロー図

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

productId ─────────┐
parentId ─────────┼──▶ ProductReviewLoader ──────▶ ProductReviewResult
p (page) ─────────┤         │                          │
sort ─────────────┤         ▼                          ├─ reviews
language ─────────┤    ProductReviewRoute              ├─ matrix
points[] ─────────┘         │                          ├─ customerReview
                           ▼                          └─ totalReviewsInCurrentLanguage
                    product_review                          │
                       テーブル                              ▼
                                                    review.html.twig
                                                          │
                                                          ▼
                                                    HTMLレスポンス
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| ProductController.php | `src/Storefront/Controller/ProductController.php` | コントローラー | HTTPリクエスト処理 |
| ProductReviewLoader.php | `src/Core/Content/Product/SalesChannel/Review/ProductReviewLoader.php` | サービス | レビューデータ取得・加工 |
| ProductReviewRoute.php | `src/Core/Content/Product/SalesChannel/Review/ProductReviewRoute.php` | Store-APIルート | データアクセス |
| ProductReviewResult.php | `src/Core/Content/Product/SalesChannel/Review/ProductReviewResult.php` | DTO | レビュー結果データ構造 |
| RatingMatrix.php | `src/Core/Content/Product/SalesChannel/Review/RatingMatrix.php` | DTO | 評価分布データ構造 |
| review.html.twig | `src/Storefront/Resources/views/storefront/component/review/review.html.twig` | テンプレート | レビュー表示用ビュー |
| ProductReviewsWidgetLoadedHook.php | `src/Core/Content/Product/SalesChannel/Review/ProductReviewsWidgetLoadedHook.php` | フック | 拡張ポイント |
| ProductReviewsLoadedEvent.php | `src/Core/Content/Product/SalesChannel/Review/Event/ProductReviewsLoadedEvent.php` | イベント | イベント通知 |
