# 通知設計書 17-Order State Changed (In Progress)

## 概要

本ドキュメントは、Shopwareにおける注文処理中通知（Order State Changed - In Progress）の設計仕様を記載したものです。注文のステータスが「処理中」に変更された際に顧客に送信されるメール通知について定義します。

### 本通知の処理概要

この通知は、注文のステートマシン状態が「in_progress」に遷移した際に送信されるメール通知です。管理者が注文の処理を開始した場合や、倉庫での出荷準備が始まった際に発火します。

**業務上の目的・背景**：注文が処理中であることを顧客に通知することで、注文が忘れられていないことを確認させ、顧客の不安を軽減します。特に処理に時間がかかる場合や、カスタム商品の製造が必要な場合に有効です。

**通知の送信タイミング**：注文のステートマシン状態が`in_progress`に遷移した際に、`state_machine.order.state_changed`イベントが発火し、`OrderStateMachineStateChangeEvent`がディスパッチされます。イベント名は`state_enter.order.state.in_progress`となります。

**通知の受信者**：注文を行った顧客のメールアドレス（`order.orderCustomer.email`）。

**通知内容の概要**：注文番号、注文日時、新しいステータス（処理中）、注文状況確認用リンクが含まれます。

**期待されるアクション**：顧客は注文が処理されていることを確認し、安心して出荷を待ちます。

## 通知種別

メール通知

## 送信仕様

### 基本情報

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

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

イベント発生時に`MailRecipientStruct`が構築されます。`OrderStateMachineStateChangeEvent`クラスの`getMailStruct()`メソッドを使用します。

## 通知テンプレート

### メール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元アドレス | ショップ設定に依存 |
| 送信元名称 | ショップ設定に依存 |
| 件名 | `Order In Progress`（EN）/ `Bestellung in Bearbeitung`（DE） |
| 形式 | HTML/テキスト |

### 本文テンプレート

**英語版（HTML）**:
```html
<div style="font-family:arial; font-size:12px;">
    <br/>
    {{order.orderCustomer.salutation.letterName }} {{order.orderCustomer.firstName}} {{order.orderCustomer.lastName}},<br/>
    <br/>
    the status of your order at {{ salesChannel.name }} (Number: {{order.orderNumber}}) on {{ order.orderDateTime|date }} has changed.<br/>
    <strong>The new status is as follows: {{order.stateMachineState.name}}.</strong><br/>
    <br/>
    You can check the current status of your order on our website under "My account" - "My orders" anytime: {{ rawUrl('frontend.account.order.single.page', { 'deepLinkCode': order.deepLinkCode}, salesChannel.domains|first.url) }}
    </br>
    However, in case you have purchased without a registration or a customer account, you do not have this option.
    </p>
</div>
```

**ドイツ語版（HTML）**:
```html
<div style="font-family:arial; font-size:12px;">
    <br/>
    <p>
        {{order.orderCustomer.salutation.letterName }} {{order.orderCustomer.firstName}} {{order.orderCustomer.lastName}},<br/>
        <br/>
        der Bestellstatus für Ihre Bestellung bei {{ salesChannel.name }} (Number: {{order.orderNumber}}) vom {{ order.orderDateTime|date }} hat sich geändert.<br/>
        <strong>Die Bestellung hat jetzt den Bestellstatus: {{order.stateMachineState.name}}.</strong><br/>
        <br/>
        Den aktuellen Status Ihrer Bestellung können Sie auch jederzeit auf unserer Webseite im Bereich "Mein Konto" - "Meine Bestellungen" abrufen: {{ rawUrl('frontend.account.order.single.page', { 'deepLinkCode': order.deepLinkCode}, salesChannel.domains|first.url) }}
        </br>
        Sollten Sie allerdings den Kauf ohne Registrierung, also ohne Anlage eines Kundenkontos, gewählt haben, steht Ihnen diese Möglichkeit nicht zur Verfügung.
    </p>
</div>
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| `order` | 注文エンティティ | OrderEntity | Yes |
| `order.orderNumber` | 注文番号 | order.order_number | Yes |
| `order.orderDateTime` | 注文日時 | order.order_date_time | Yes |
| `order.orderCustomer` | 注文顧客情報 | order_customer | Yes |
| `order.stateMachineState` | 現在のステータス | state_machine_state | Yes |
| `order.stateMachineState.name` | ステータス名 | state_machine_state_translation.name | Yes |
| `order.deepLinkCode` | 注文詳細へのディープリンクコード | order.deep_link_code | Yes |
| `salesChannel` | 販売チャネル | SalesChannelContext | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ステートマシン遷移 | `state_enter.order.state.in_progress` | 注文ステータスがin_progressに遷移 | OrderStateChangeEventListener経由 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| Flowが設定されていない | Flowビルダーでメール送信アクションが設定されていない場合 |
| 注文顧客情報なし | orderCustomerがnullの場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[注文ステータス変更リクエスト] --> B[StateMachine::transition]
    B --> C{遷移先 = in_progress?}
    C -->|Yes| D[state_machine.order.state_changed発火]
    C -->|No| E[他のステータス処理]
    D --> F[OrderStateChangeEventListener::onOrderStateChange]
    F --> G[OrderStateMachineStateChangeEvent作成]
    G --> H[state_enter.order.state.in_progressイベント発火]
    H --> I[Flowエンジンがイベントを検知]
    I --> J[SendMailAction実行]
    J --> K[メール送信]
    K --> L[終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| `order` | 注文基本情報 | 主要データソース |
| order_customer | 注文顧客情報 | メール宛先 |
| state_machine_state | ステータス情報 | 現在のステータス |
| state_machine_state_translation | ステータス翻訳 | ステータス名表示 |
| sales_channel | 販売チャネル | コンテキスト |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| `order` | UPDATE | state_idの更新（イベント発火のトリガー） |
| state_machine_history | INSERT | 遷移履歴の記録 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 注文顧客なし | orderCustomerがnull | MailEventConfigurationException |
| メール送信失敗 | SMTPエラー等 | ログ記録、リトライ |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- 注文情報には個人情報が含まれるため、適切な取り扱いが必要

## 備考

- このイベントは`OrderStateMachineStateChangeEvent`クラスを使用し、他の注文ステータス変更と同じ仕組みで動作
- ステートマシンの遷移パターンにより、`open` → `in_progress` → `completed`の流れが一般的

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | OrderStateMachineStateChangeEvent.php | `src/Core/Checkout/Order/Event/OrderStateMachineStateChangeEvent.php` | イベントクラス、動的イベント名 |

#### Step 2: イベント発火の仕組みを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | OrderStateChangeEventListener.php | `src/Core/Checkout/Order/Listener/OrderStateChangeEventListener.php` | ステートマシンイベントのリスナー |

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | MailTemplateContent.php | `src/Core/Migration/Fixtures/MailTemplateContent.php` | OrderInProgressテンプレート（行406-455） |
| 3-2 | MailTemplateTypes.php | `src/Core/Content/MailTemplate/MailTemplateTypes.php` | テンプレートタイプ定数（行86） |

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

```
StateMachine::transition()
    │
    ▼
state_machine.order.state_changed イベント
    │
    ▼
OrderStateChangeEventListener::onOrderStateChange()
    │
    └─ eventDispatcher->dispatch(OrderStateMachineStateChangeEvent)
           │
           └─ FlowExecutor (Subscriber)
                  │
                  └─ SendMailAction::handleFlow()
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| OrderStateMachineStateChangeEvent.php | `src/Core/Checkout/Order/Event/OrderStateMachineStateChangeEvent.php` | ソース | イベントクラス定義 |
| OrderStateChangeEventListener.php | `src/Core/Checkout/Order/Listener/OrderStateChangeEventListener.php` | ソース | イベントリスナー |
| MailTemplateContent.php | `src/Core/Migration/Fixtures/MailTemplateContent.php` | フィクスチャ | テンプレート内容 |
| MailTemplateTypes.php | `src/Core/Content/MailTemplate/MailTemplateTypes.php` | ソース | テンプレートタイプ定数 |
