# 機能設計書 47-split

## 概要

本ドキュメントは、Hack Standard Library (HSL) の `Str\split` 関数の機能設計を記載する。この関数は文字列をデリミタ（区切り文字）で分割し、vec配列として返す機能を提供する。PHPの`explode`に相当する機能である。

### 本機能の処理概要

**業務上の目的・背景**：文字列をデリミタで分割することは、CSVデータの解析、パス文字列の分解、タグやキーワードの抽出など、データ処理において最も頻繁に使用される操作の一つである。本機能は、PHPの`explode`関数に相当する型安全な実装を提供する。

**機能の利用シーン**：
- CSV形式のデータをフィールドに分割
- URLパスをセグメントに分割
- タグやキーワードの分割（カンマ区切りなど）
- ログファイルの行分割
- 設定ファイルの値の分割

**主要な処理内容**：
1. 入力文字列とデリミタを受け取る
2. デリミタで文字列を分割
3. オプションでlimit（最大分割数）を指定可能
4. 結果をvec<string>として返す

**関連システム・外部連携**：HSL内部の `_Private\_Str\split_l` 関数に処理を委譲。

**権限による制御**：本機能は純粋関数であり、権限による制御は行わない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | 画面なし | - | 本プロジェクト（Hack Standard Library）はUIを持たないライブラリプロジェクトのため、画面機能マッピングは該当しません。 |

## 機能種別

文字列分割処理（Divide）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $string | string | Yes | 分割対象の文字列 | なし |
| $delimiter | string | Yes | 区切り文字（空文字列の場合は1文字ずつ分割） | なし |
| $limit | ?int | No（デフォルト: null） | 最大分割数（nullで無制限） | なし |

### 入力データソース

関数呼び出し時の引数として直接渡される。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (戻り値) | vec<string> | デリミタで分割された文字列の配列 |

### 出力先

関数の戻り値として返却される。

## 処理フロー

### 処理シーケンス

```
1. 引数の受け取り
   └─ $string, $delimiter, $limitを受け取る
2. 内部関数への委譲
   └─ _Str\split_lを呼び出し
3. vec変換
   └─ 結果をvecにラップ
4. 結果の返却
   └─ vec<string>を返す
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[引数を受け取る]
    B --> C{delimiterが空文字列?}
    C -->|Yes| D[1文字ずつ分割]
    C -->|No| E[デリミタで分割]
    D --> F{limitが指定されている?}
    E --> F
    F -->|Yes| G[limit数まで分割、残りは最後の要素に]
    F -->|No| H[すべて分割]
    G --> I[vec<string>を返却]
    H --> I
    I --> J[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-47-01 | 空デリミタ | デリミタが空文字列の場合、1文字ずつ分割 | delimiter === '' |
| BR-47-02 | デリミタ不含 | デリミタが見つからない場合、元の文字列を含む1要素のvecを返す | デリミタ不在時 |
| BR-47-03 | limit動作 | limit指定時、最後の要素に残りの文字列すべてが含まれる | limit > 0 |
| BR-47-04 | 先頭デリミタ | デリミタが先頭にある場合、最初の要素は空文字列 | 先頭にデリミタ |
| BR-47-05 | 末尾デリミタ | デリミタが末尾にある場合、最後の要素は空文字列 | 末尾にデリミタ |

### 計算ロジック

- デリミタが空文字列の場合: 文字列を1文字ずつ配列に分割
- デリミタが指定されている場合: デリミタで分割し、各部分を配列の要素とする
- limitが指定されている場合: 最大limit個の要素に分割し、残りは最後の要素に含める

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | 本関数は通常エラーをスローしない | - |

### リトライ仕様

該当なし（同期的な純粋関数）

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

該当なし（データベース操作なし）

## パフォーマンス要件

- 時間計算量: O(n)、n = 文字列長
- 空間計算量: O(n)、結果vecのサイズ

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

- 入力文字列のサニタイズは呼び出し側の責任
- 本関数自体は副作用を持たない純粋関数

## 備考

- PHPの`explode`に相当
- 固定長で分割する場合は `Str\chunk` を使用すること
- 正規表現で分割する場合は `Regex\split` を使用すること

---

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

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

### 推奨読解順序

#### Step 1: 公開API関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | divide.php | `src/str/divide.php` | 公開関数splitの定義とドキュメンテーション |

**主要処理フロー**:
1. **43-49行目**: split関数の定義
2. **48行目**: _Str\split_lへの委譲とvecへのラップ

**読解のコツ**: 内部関数の結果を`vec()`でラップしてvec型として返している。

#### Step 2: ドキュメンテーションコメントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | divide.php | `src/str/divide.php` | 29-42行目のドキュメンテーション |

**主要処理フロー**:
- **36行目**: chunkとの使い分けの説明
- **37行目**: Regex\splitとの使い分けの説明
- **39行目**: PHPのexplodeとの関連の記載

#### Step 3: テストケースで挙動を確認する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | StrDivideTest.php | `tests/str/StrDivideTest.php` | splitのテストケースを確認 |

**主要処理フロー**:
- **46-120行目**: provideSplitとtestSplitで様々な入力パターンと期待結果を確認
- **56-77行目**: 空デリミタによる1文字分割のテスト
- **79-107行目**: limit指定時の動作テスト

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

```
Str\split($string, $delimiter, $limit)
    │
    └─ vec(_Str\split_l($string, $delimiter, $limit))
           │
           └─ [HHVM内部実装]
```

### データフロー図

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

$string (string) ────────┐
$delimiter (string) ─────┼──▶ _Str\split_l ──▶ vec<string>
$limit (?int) ───────────┘

例: "the quick brown", " " ──▶ vec["the", "quick", "brown"]
例: "hello", "" ──▶ vec["h", "e", "l", "l", "o"]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| divide.php | `src/str/divide.php` | ソース | 公開API関数の定義 |
| divide_l.php | `src/str/divide_l.php` | ソース | ロケール対応版の定義 |
| StrDivideTest.php | `tests/str/StrDivideTest.php` | テスト | 単体テスト |
