# 機能設計書 39-エンジンリゾルバ

## 概要

本ドキュメントは、Laravel Frameworkにおけるエンジンリゾルバ（Engine Resolver）機能の設計書である。ファイル拡張子やエンジン名に基づいて適切なテンプレートエンジンを解決・提供するコンポーネントであり、Blade、PHP、ファイルなど複数のエンジンを管理する。

### 本機能の処理概要

**業務上の目的・背景**：
Laravelのビューシステムは、複数のテンプレートエンジンをサポートしている。ビューファイルの拡張子に応じて、Bladeテンプレート（.blade.php）、プレーンPHP（.php）、静的ファイル（.css, .html）などを異なるエンジンで処理する必要がある。エンジンリゾルバは、エンジン名とファクトリクロージャのマッピングを管理し、必要に応じてエンジンインスタンスを遅延生成する。

**機能の利用シーン**：
- ビューレンダリング時のエンジン選択
- カスタムテンプレートエンジンの登録
- エンジンインスタンスの再利用

**主要な処理内容**：
1. エンジン登録（`register`メソッドによるクロージャ登録）
2. エンジン解決（`resolve`メソッドによるインスタンス取得）
3. エンジン忘却（`forget`メソッドによるキャッシュクリア）

**関連システム・外部連携**：
- CompilerEngine: Bladeテンプレート用エンジン
- PhpEngine: プレーンPHP用エンジン
- FileEngine: 静的ファイル用エンジン
- ViewFactory: エンジン選択と利用

**権限による制御**：
本機能自体は権限制御を行わない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 全ビュー画面 | 主処理 | 全てのビューレンダリングで使用 |

## 機能種別

エンジン管理 / ファクトリパターン

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| engine | string | Yes | エンジン名（'blade', 'php', 'file'等） | - |
| resolver | Closure | Yes（登録時） | エンジンを生成するクロージャ | - |

### 入力データソース

- ViewServiceProviderでの初期登録
- カスタムエンジン登録

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| engine | Engine | エンジンインスタンス |

### 出力先

- 戻り値として呼び出し元に返却

## 処理フロー

### 処理シーケンス

```
1. エンジン解決（resolve呼び出し）
   └─ エンジン名を受け取る
   └─ 解決済みキャッシュを確認

2. キャッシュ確認
   └─ 既に解決済みならキャッシュから返却

3. リゾルバ実行
   └─ 登録済みクロージャを取得
   └─ クロージャを実行してエンジン生成

4. キャッシュ保存
   └─ 生成したエンジンをキャッシュに保存
   └─ エンジンインスタンスを返却
```

### フローチャート

```mermaid
flowchart TD
    A[resolve呼び出し] --> B{resolvedに存在?}
    B -->|Yes| C[キャッシュから返却]
    B -->|No| D{resolversに存在?}
    D -->|Yes| E[クロージャ実行]
    D -->|No| F[InvalidArgumentException]
    E --> G[resolvedに保存]
    G --> H[エンジン返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-39-01 | 遅延生成 | エンジンは初回resolve時に生成される | 常時 |
| BR-39-02 | シングルトン | 同一エンジンは一度だけ生成される | 常時 |
| BR-39-03 | 上書き登録 | 同名エンジンの再登録は既存キャッシュをクリア | register時 |

### 計算ロジック

該当なし

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

本機能はデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | InvalidArgumentException | 未登録のエンジン名指定 | registerで登録 |

### リトライ仕様

本機能にリトライ機能は含まれない。

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

該当なし

## パフォーマンス要件

- エンジンインスタンスは`$resolved`配列にキャッシュされ、リクエスト内で再利用
- クロージャ実行は初回のみ

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

- エンジン登録はアプリケーション起動時のみ
- 動的なエンジン登録は信頼できるコードからのみ

## 備考

- ViewServiceProviderで`file`, `php`, `blade`の3つのエンジンがデフォルト登録
- `forget`メソッドで特定エンジンのキャッシュをクリア可能

---

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

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

### 推奨読解順序

#### Step 1: EngineResolverクラスを理解する

シンプルなクラスなので直接実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | EngineResolver.php | `src/Illuminate/View/Engines/EngineResolver.php` | エンジンリゾルバ主実装 |

**主要処理フロー**:
- **15行目**: `$resolvers` - エンジン名→クロージャのマップ
- **22行目**: `$resolved` - エンジン名→インスタンスのキャッシュ
- **33-38行目**: `register()` - エンジン登録
- **48-59行目**: `resolve()` - エンジン解決
- **67-70行目**: `forget()` - キャッシュクリア

**読解のコツ**: 非常にシンプルなファクトリパターン実装。`$resolvers`にクロージャを保存し、`$resolved`にインスタンスをキャッシュする。

#### Step 2: 各エンジンの実装を理解する

エンジンインターフェースと各実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Engine.php | `src/Illuminate/Contracts/View/Engine.php` | エンジン契約 |
| 2-2 | FileEngine.php | `src/Illuminate/View/Engines/FileEngine.php` | ファイルエンジン |
| 2-3 | PhpEngine.php | `src/Illuminate/View/Engines/PhpEngine.php` | PHPエンジン |
| 2-4 | CompilerEngine.php | `src/Illuminate/View/Engines/CompilerEngine.php` | コンパイラエンジン |

#### Step 3: サービスプロバイダーでの登録を理解する

エンジンの初期登録を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ViewServiceProvider.php | `src/Illuminate/View/ViewServiceProvider.php` | エンジン登録 |

**主要処理フロー**:
- **115-129行目**: `registerEngineResolver()` - リゾルバ登録
- **137-142行目**: `registerFileEngine()` - FileEngine登録
- **150-155行目**: `registerPhpEngine()` - PhpEngine登録
- **163-179行目**: `registerBladeEngine()` - CompilerEngine登録

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

```
ViewFactory::getEngineFromPath($path)
    │
    └─ EngineResolver::resolve('blade')
           │
           ├─ resolved['blade']確認 ... キャッシュ
           │      └─ 存在すれば返却
           │
           └─ resolvers['blade']()実行
                  │
                  └─ ViewServiceProvider::registerBladeEngine
                         │
                         └─ new CompilerEngine($bladeCompiler, $files)
                                │
                                └─ resolved['blade'] = $engine
                                       └─ $engine返却
```

### データフロー図

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

エンジン名 ──────────────▶ EngineResolver::resolve()
                               │
                         キャッシュ確認
                               │
                         ┌─────┴─────┐
                         │           │
                    キャッシュHit  キャッシュMiss
                         │           │
                         │      クロージャ取得
                         │           │
                         │      クロージャ実行
                         │           │
                         │      キャッシュ保存
                         │           │
                         └─────┬─────┘
                               │
                    Engineインスタンス ◀──┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| EngineResolver.php | `src/Illuminate/View/Engines/EngineResolver.php` | ソース | エンジンリゾルバ |
| Engine.php | `src/Illuminate/Contracts/View/Engine.php` | インターフェース | エンジン契約 |
| FileEngine.php | `src/Illuminate/View/Engines/FileEngine.php` | ソース | 静的ファイルエンジン |
| PhpEngine.php | `src/Illuminate/View/Engines/PhpEngine.php` | ソース | PHPエンジン |
| CompilerEngine.php | `src/Illuminate/View/Engines/CompilerEngine.php` | ソース | コンパイラエンジン（Blade） |
| ViewServiceProvider.php | `src/Illuminate/View/ViewServiceProvider.php` | ソース | エンジン登録 |
