# 機能設計書 69-国・州取得

## 概要

本ドキュメントは、Shopware Storefrontにおける住所入力時の国・州リストを取得する機能について、その処理内容、入出力仕様、およびコード構造を記述した機能設計書である。

### 本機能の処理概要

本機能は、住所入力フォームで国を選択した際に、その国に対応する州（都道府県、地域など）のリストを動的に取得するAPI機能を提供する。

**業務上の目的・背景**：ECサイトにおいて、住所入力は注文や会員登録の重要なステップである。国によって行政区画（州、県、地域等）の構造が異なるため、選択された国に応じて適切な州リストを動的に表示する必要がある。これにより、ユーザーは正確な住所を簡単に入力でき、配送時のエラーを防止できる。

**機能の利用シーン**：
- チェックアウト時の配送先住所入力
- 会員登録時の住所入力
- アカウント設定での住所編集
- 住所帳への新規住所追加

**主要な処理内容**：
1. countryIdパラメータを受け取る
2. Store API経由で国に紐付く州リストを取得
3. CountryStateDataPageletオブジェクトを生成
4. JSON形式でレスポンスを返却

**関連システム・外部連携**：Store APIのCountryStateRoute

**権限による制御**：特別な権限制御なし（公開領域）

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 50 | 国設定 | 主機能 | 配送可能国・地域の設定 |

## 機能種別

データ連携 / API

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| countryId | string | Yes | 国のUUID | 有効なUUID形式、必須 |
| request | Request | Yes | HTTPリクエストオブジェクト | - |
| context | SalesChannelContext | Yes | 販売チャネルコンテキスト | - |

### 入力データソース

- リクエストパラメータ: countryId（GET/POSTどちらでも可）
- Store API: AbstractCountryStateRoute

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| states | CountryStateCollection | 州・地域のコレクション |

### 出力先

JSON形式のHTTPレスポンス:
```json
{
  "states": [
    {
      "id": "...",
      "name": "...",
      "shortCode": "...",
      ...
    }
  ]
}
```

## 処理フロー

### 処理シーケンス

```
1. CountryStateController::getCountryData() がリクエストを受信
   └─ ルート: /country/country-state-data (GET/POST)

2. countryIdパラメータの取得と検証
   └─ countryIdが空の場合はRoutingExceptionを発生

3. CountryStateDataPageletLoader::load() を呼び出し
   ├─ Criteriaオブジェクトを生成
   ├─ CountryStateDataPageletCriteriaEventをディスパッチ
   ├─ CountryStateRoute::load() で州データを取得
   └─ CountryStateDataPageletに州データをセット

4. CountryStateDataPageletLoadedHookを実行
   └─ App Scriptsによる拡張ポイント

5. JSON形式でレスポンスを返却
   └─ states: 州のコレクション
```

### フローチャート

```mermaid
flowchart TD
    A[リクエスト受信] --> B[countryId取得]
    B --> C{countryIdあり?}
    C -->|No| D[RoutingException]
    C -->|Yes| E[CountryStateDataPageletLoader::load]
    E --> F[Criteria生成]
    F --> G[CountryStateDataPageletCriteriaEvent]
    G --> H[CountryStateRoute::load]
    H --> I[CountryStateDataPagelet生成]
    I --> J[statesをセット]
    J --> K[CountryStateDataPageletLoadedEvent]
    K --> L[CountryStateDataPageletLoadedHook]
    L --> M[JsonResponse]
    M --> N[レスポンス返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | countryId必須 | countryIdパラメータは必須 | 常時 |
| BR-002 | アクティブな州のみ | アクティブな州のみ返却される | 常時 |
| BR-003 | 翻訳対応 | 州名は現在の言語で翻訳される | 常時 |
| BR-004 | HTTPキャッシュ | レスポンスはHTTPキャッシュ対象 | 常時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 州取得 | country_state | SELECT | 指定国に紐付く州を取得 |
| 翻訳取得 | country_state_translation | SELECT | 州名の翻訳を取得 |

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

#### country_state

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | id, name, short_code等 | country_id = {指定されたcountryId}, active = true | アクティブなもののみ |

#### country_state_translation

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | name | country_state_id + language_id | 現在の言語で取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| FRAMEWORK__ROUTING_MISSING_REQUEST_PARAMETER | RoutingException | countryIdパラメータ未指定 | パラメータを指定する |

### リトライ仕様

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

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

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

## パフォーマンス要件

- HTTPキャッシュ対応（`PlatformRequest::ATTRIBUTE_HTTP_CACHE => true`）
- レスポンス時間：50ms以内推奨（軽量なAPI）

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

- 認証不要（公開領域）
- XmlHttpRequest対応（Ajaxリクエスト用）

## 備考

- v6.8.0でPOSTリクエストは非推奨となり、GETリクエストのみ推奨
- 住所入力フォームのJavaScriptから呼び出される
- CountryStateDataPageletCriteriaEventで検索条件をカスタマイズ可能

---

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

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

### 推奨読解順序

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

国・州データのデータ構造を理解することが重要である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | CountryStateDataPagelet.php | `src/Storefront/Pagelet/Country/CountryStateDataPagelet.php` | ページレットの構造（states: CountryStateCollection） |
| 1-2 | CountryStateCollection.php | `src/Core/System/Country/Aggregate/CountryState/CountryStateCollection.php` | 州コレクションの構造 |

**読解のコツ**: CountryStateDataPageletはCountryStateCollectionを保持するシンプルな構造。各CountryStateEntityには id, name, shortCode などが含まれる。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | CountryStateController.php | `src/Storefront/Controller/CountryStateController.php` | getCountryData()メソッド（35-59行目） |

**主要処理フロー**:
1. **35-43行目**: ルート定義 - `/country/country-state-data`、HTTPキャッシュ対応
2. **44行目**: getCountryData()メソッド
3. **46行目**: countryIdの取得
4. **48-50行目**: countryIdがない場合は例外
5. **52行目**: CountryStateDataPageletLoader::load()を呼び出し
6. **54行目**: CountryStateDataPageletLoadedHookを実行
7. **56-58行目**: JsonResponseを返却

#### Step 3: ページレットローダーを理解する

州データの読み込み処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | CountryStateDataPageletLoader.php | `src/Storefront/Pagelet/Country/CountryStateDataPageletLoader.php` | load()メソッド（27-42行目） |

**主要処理フロー**:
- **29行目**: CountryStateDataPageletを生成
- **31行目**: Criteriaを生成
- **33行目**: CountryStateDataPageletCriteriaEventをディスパッチ
- **35行目**: CountryStateRoute::load()で州データを取得
- **37行目**: statesをセット
- **39行目**: CountryStateDataPageletLoadedEventをディスパッチ

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

州データの取得処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | AbstractCountryStateRoute.php | `src/Core/System/Country/SalesChannel/AbstractCountryStateRoute.php` | 抽象クラスの定義 |
| 4-2 | CountryStateRoute.php | `src/Core/System/Country/SalesChannel/CountryStateRoute.php` | 具体的な実装 |

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

```
CountryStateController::getCountryData()
    │
    ├─ countryIdの検証
    │
    ├─ CountryStateDataPageletLoader::load()
    │      ├─ CountryStateDataPagelet生成
    │      ├─ Criteria生成
    │      ├─ CountryStateDataPageletCriteriaEvent
    │      ├─ AbstractCountryStateRoute::load()
    │      │      └─ CountryStateCollection
    │      └─ CountryStateDataPageletLoadedEvent
    │
    ├─ hook(CountryStateDataPageletLoadedHook)
    │
    └─ JsonResponse
           └─ { "states": [...] }
```

### データフロー図

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

Request (countryId) ────────────┐
                                ▼
SalesChannelContext ──────▶ CountryStateController ──────▶ JsonResponse
                                │                              │
                                ▼                              │
                         countryId検証                         │
                                │                              │
                                ▼                              │
                  CountryStateDataPageletLoader                │
                                │                              │
                                ├─ Criteria生成                │
                                │                              │
                                ├─ CriteriaEvent               │
                                │                              │
                                ▼                              │
                         CountryStateRoute::load()             │
                                │                              │
                                ▼                              ▼
                         CountryStateCollection ───▶ { "states": [...] }
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| CountryStateController.php | `src/Storefront/Controller/CountryStateController.php` | コントローラー | 国・州取得のエントリーポイント |
| CountryStateDataPageletLoader.php | `src/Storefront/Pagelet/Country/CountryStateDataPageletLoader.php` | ローダー | 州データの読み込み |
| CountryStateDataPagelet.php | `src/Storefront/Pagelet/Country/CountryStateDataPagelet.php` | ページレット | 州データのデータ構造 |
| CountryStateDataPageletCriteriaEvent.php | `src/Storefront/Pagelet/Country/CountryStateDataPageletCriteriaEvent.php` | イベント | 検索条件カスタマイズ用イベント |
| CountryStateDataPageletLoadedEvent.php | `src/Storefront/Pagelet/Country/CountryStateDataPageletLoadedEvent.php` | イベント | 読み込み完了イベント |
| CountryStateDataPageletLoadedHook.php | `src/Storefront/Pagelet/Country/CountryStateDataPageletLoadedHook.php` | フック | App Scripts用拡張ポイント |
| AbstractCountryStateRoute.php | `src/Core/System/Country/SalesChannel/AbstractCountryStateRoute.php` | Store API | 州取得の抽象クラス |
