# 通知設計書 11-Customer Group Registration Accepted

## 概要

本ドキュメントは、Shopwareにおける顧客グループ登録承認通知（Customer Group Registration Accepted）の設計仕様を記載したものです。管理者が顧客の顧客グループ登録申請を承認した際に、申請した顧客に対して承認完了を通知するメール機能について定義します。

### 本通知の処理概要

この通知は、B2B（企業間取引）向け機能の一部として、顧客が特定の顧客グループ（卸売、VIP、ディーラーなど）への参加を申請し、管理者がその申請を承認した際に送信されるメール通知です。

**業務上の目的・背景**：ECサイトにおいて、特定の顧客グループに所属することで特別な価格設定や割引を受けられる仕組みがあります。顧客が自らグループへの参加を申請し、管理者が審査・承認するワークフローにおいて、承認結果を迅速に顧客へ通知することで、顧客体験の向上と業務の透明性を確保します。

**通知の送信タイミング**：管理者が管理画面（Administration）から顧客グループ登録申請を承認（Accept）した際に、`CustomerGroupRegistrationAccepted`イベントがディスパッチされ、Flowビルダーで設定されたメール送信アクションがトリガーされます。

**通知の受信者**：申請を行った顧客本人。顧客のメールアドレス（`customer.email`）に対して送信されます。

**通知内容の概要**：承認された顧客グループ名、新しい条件での買い物が可能になった旨、問い合わせ先情報が含まれます。

**期待されるアクション**：顧客は通知を受け取った後、新しい顧客グループの条件（価格、割引など）でショッピングを開始できます。再ログインが必要な場合もあります。

## 通知種別

メール通知

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（Flow経由） |
| 優先度 | 中 |
| リトライ | Flowの設定に依存（デフォルト: なし） |

### 送信先決定ロジック

イベント発生時に`MailRecipientStruct`が構築され、顧客のメールアドレスと氏名が設定されます。

```php
// CustomerGroupRegistrationAccepted.php 行49-60
public function getMailStruct(): MailRecipientStruct
{
    if ($this->mailRecipientStruct) {
        return $this->mailRecipientStruct;
    }

    return new MailRecipientStruct(
        [
            $this->customer->getEmail() => $this->customer->getFirstName() . ' ' . $this->customer->getLastName(),
        ]
    );
}
```

## 通知テンプレート

### メール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元アドレス | ショップ設定に依存 |
| 送信元名称 | `Shop`（デフォルト） |
| 件名 | `Customer Group Registration Accepted`（EN）/ `Kunden Gruppen Registrierung Akzeptiert`（DE） |
| 形式 | HTML/テキスト |

### 本文テンプレート

**英語版（HTML）**:
```html
<div style="font-family:arial; font-size:12px;">
    <br/>
    <p>
        {{ customer.salutation.letterName }} {{ customer.lastName }},<br/>
        <br/>
        Your account has been activated for the customer group {{ customerGroup.translated.name }}.<br/>
        From now on you can shop at the new conditions of this customer group.<br/><br/>

        Please do not hesitate to contact us at any time if you have any questions.
    </p>
</div>
```

**ドイツ語版（HTML）**:
```html
<div style="font-family:arial; font-size:12px;">
    <br/>
    <p>
        {{ customer.salutation.letterName }} {{ customer.lastName }},<br/>
        <br/>
        Ihr Account wurde für die Kundengruppe {{ customerGroup.translated.name }} freigeschaltet.<br/>
        Ab sofort kaufen Sie zu den neuen Konditionen dieser Kundengruppe ein.<br/>

        Für Rückfragen stehen wir Ihnen jederzeit gerne zur Verfügung.
    </p>
</div>
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | 本通知には添付ファイルなし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| `customer` | 顧客エンティティ | CustomerEntity | Yes |
| `customer.salutation.letterName` | 敬称の書面用名称 | customer.salutation | No |
| `customer.lastName` | 顧客の姓 | customer.last_name | Yes |
| `customer.firstName` | 顧客の名 | customer.first_name | Yes |
| `customer.email` | 顧客のメールアドレス | customer.email | Yes |
| `customerGroup` | 顧客グループエンティティ | CustomerGroupEntity | Yes |
| `customerGroup.translated.name` | 顧客グループの翻訳済み名称 | customer_group_translation.name | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API操作 | `customer.group.registration.accepted` | 管理者が承認APIを呼び出した時 | `POST /api/_action/customer-group-registration/accept` |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| Flowが設定されていない | Flowビルダーでメール送信アクションが設定されていない場合 |
| 顧客が非アクティブ | `customer.active = false`の場合、承認処理自体が失敗する |
| メールテンプレートが存在しない | 対応するメールテンプレートが削除されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[管理者が承認APIを呼び出す] --> B[CustomerGroupRegistrationActionController::accept]
    B --> C[顧客データ取得・検証]
    C -->|検証OK| D[顧客グループ変更]
    C -->|検証NG| E[エラーレスポンス]
    D --> F[CustomerGroupRegistrationAcceptedイベント発火]
    F --> G[Flowエンジンがイベントを検知]
    G --> H[SendMailAction実行]
    H --> I[メールテンプレート取得]
    I --> J[テンプレート変数展開]
    J --> K[メール送信]
    K --> L[終了]
    E --> L
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| customer | 顧客情報の取得 | メール宛先、テンプレート変数 |
| customer_group | 顧客グループ情報の取得 | テンプレート変数 |
| customer_group_translation | グループ名の翻訳取得 | 多言語対応 |
| mail_template | メールテンプレート本文取得 | - |
| mail_template_type | テンプレートタイプの識別 | technical_name = 'customer.group.registration.accepted' |

### テーブル別参照項目詳細

#### customer

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | 顧客識別 | リクエストで指定されたcustomerIds |
| email | メール送信先 | - |
| first_name | テンプレート変数 | - |
| last_name | テンプレート変数 | - |
| salutation_id | 敬称取得 | JOIN salutation |
| requested_group_id | 申請先グループ | 承認対象の確認 |
| group_id | 現在のグループ | 更新対象 |
| active | アクティブ状態 | 承認可否判定 |
| sales_channel_id | 販売チャネル | コンテキスト復元 |

#### customer_group

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | グループ識別 | customer.requested_group_id |
| translated.name | グループ名（翻訳済み） | テンプレート変数 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| customer | UPDATE | group_idの更新、requested_group_idのクリア |

#### customerテーブル更新

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| UPDATE | group_id | requested_group_id の値 | 新しいグループに移動 |
| UPDATE | requested_group_id | null | 申請をクリア |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 顧客未発見 | 指定されたcustomerIdが存在しない | CustomerException::customersNotFound |
| グループ申請なし | requested_group_idがnull | CustomerException::groupRequestNotFound |
| 顧客非アクティブ | customer.active = false | CustomerException::inactive |
| 顧客グループ未発見 | 申請先グループが存在しない | CustomerException::customerGroupNotFound |
| メール送信失敗 | SMTPエラー等 | ログ記録、例外は抑止 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | Flowの設定に依存 |
| リトライ間隔 | Flowの設定に依存 |
| リトライ対象エラー | 一時的なネットワークエラー |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | システム設定に依存 |
| 1日あたり上限 | システム設定に依存 |

### 配信時間帯

制限なし（管理者操作時に即座に送信）

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

- 管理者権限（API認証）が必要なエンドポイントからのみイベントが発火される
- 顧客のメールアドレスは個人情報として適切に取り扱う
- テンプレート内で機密情報を含めないこと

## 備考

- このイベントは`FlowEventAware`インターフェースを実装しており、Flowビルダーで柔軟にアクションを設定可能
- `MailAware`インターフェースにより、メール送信に必要な情報（受信者、販売チャネルID等）が提供される
- `CustomerAware`および`CustomerGroupAware`インターフェースにより、関連エンティティへのアクセスが可能

---

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

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

### 推奨読解順序

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

まず、イベントで扱われるデータ構造を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | CustomerGroupRegistrationAccepted.php | `src/Core/Checkout/Customer/Event/CustomerGroupRegistrationAccepted.php` | イベントクラスの構造、提供されるデータ、実装インターフェース |
| 1-2 | CustomerEntity.php | `src/Core/Checkout/Customer/CustomerEntity.php` | 顧客エンティティの構造、requestedGroupIdフィールド |
| 1-3 | CustomerGroupEntity.php | `src/Core/Checkout/Customer/Aggregate/CustomerGroup/CustomerGroupEntity.php` | 顧客グループエンティティの構造 |

**読解のコツ**: イベントクラスが実装する`MailAware`、`CustomerAware`、`CustomerGroupAware`インターフェースにより、Flowアクションで利用可能なデータが決まります。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | CustomerGroupRegistrationActionController.php | `src/Core/Checkout/Customer/Api/CustomerGroupRegistrationActionController.php` | APIエンドポイント、承認処理の流れ |

**主要処理フロー**:
1. **行48-49**: `accept`メソッドのルート定義（`/api/_action/customer-group-registration/accept`）
2. **行51-55**: リクエストから顧客IDを取得し、顧客データをフェッチ
3. **行59-69**: 顧客のグループIDを更新するデータを構築
4. **行71**: customerRepositoryでバッチ更新
5. **行73-93**: 各顧客に対してイベントをディスパッチ

#### Step 3: イベント処理を理解する

イベントがどのように処理されるかを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | SendMailAction.php | `src/Core/Content/Flow/Dispatching/Action/SendMailAction.php` | Flowでのメール送信アクション |
| 3-2 | MailTemplateTypes.php | `src/Core/Content/MailTemplate/MailTemplateTypes.php` | テンプレートタイプの定数定義 |

**主要処理フロー**:
- **SendMailAction.php 行86-176**: `handleFlow`メソッドでメール送信処理を実行
- **行113**: メールテンプレートを取得
- **行126-134**: 受信者を決定
- **行159**: メール送信イベントをディスパッチ
- **行175**: メールを送信

#### Step 4: テンプレートを理解する

メールテンプレートの内容を確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | MailTemplateContent.php | `src/Core/Migration/Fixtures/MailTemplateContent.php` | デフォルトのメールテンプレート内容（行1129-1204） |
| 4-2 | Migration1596441551CustomerGroupRegistration.php | `src/Core/Migration/V6_3/Migration1596441551CustomerGroupRegistration.php` | テンプレート登録のマイグレーション |

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

```
CustomerGroupRegistrationActionController::accept()
    │
    ├─ fetchCustomers()
    │      └─ customerRepository->search()
    │
    ├─ customerRepository->update()
    │
    └─ eventDispatcher->dispatch(CustomerGroupRegistrationAccepted)
           │
           └─ FlowExecutor (Subscriber)
                  │
                  └─ SendMailAction::handleFlow()
                         │
                         ├─ getMailTemplate()
                         │      └─ mailTemplateRepository->search()
                         │
                         ├─ getRecipients()
                         │
                         └─ emailService->send()
```

### データフロー図

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

Request                     CustomerGroupRegistration
(customerIds) ─────────────▶ ActionController::accept()
                                   │
                                   ▼
                            顧客データ取得
                            (customerRepository)
                                   │
                                   ▼
                            グループID更新
                            (group_id = requested_group_id)
                                   │
                                   ▼
CustomerGroupRegistration   イベントディスパッチ
AcceptedEvent ◀────────────────────┘
      │
      ▼
Flow Engine                 SendMailAction
      │                           │
      ▼                           ▼
MailTemplate               メール送信
(DBから取得) ────────────▶ (emailService)
                                   │
                                   ▼
                            顧客のメールボックス
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| CustomerGroupRegistrationAccepted.php | `src/Core/Checkout/Customer/Event/CustomerGroupRegistrationAccepted.php` | ソース | イベントクラス定義 |
| CustomerGroupRegistrationActionController.php | `src/Core/Checkout/Customer/Api/CustomerGroupRegistrationActionController.php` | ソース | API コントローラー |
| SendMailAction.php | `src/Core/Content/Flow/Dispatching/Action/SendMailAction.php` | ソース | メール送信アクション |
| MailTemplateTypes.php | `src/Core/Content/MailTemplate/MailTemplateTypes.php` | ソース | テンプレートタイプ定数 |
| MailTemplateContent.php | `src/Core/Migration/Fixtures/MailTemplateContent.php` | フィクスチャ | デフォルトテンプレート内容 |
| Migration1596441551CustomerGroupRegistration.php | `src/Core/Migration/V6_3/Migration1596441551CustomerGroupRegistration.php` | マイグレーション | テンプレート・タイプ登録 |
| order.xml | `src/Core/Checkout/DependencyInjection/order.xml` | 設定 | サービス定義 |
