# 機能設計書 46-chunk

## 概要

本ドキュメントは、Hack Standard Library (HSL) の `Str\chunk` 関数の機能設計を記載する。この関数は文字列を指定サイズのチャンク（断片）に分割し、vec配列として返す機能を提供する。

### 本機能の処理概要

**業務上の目的・背景**：文字列を固定長のチャンクに分割することは、データのバッチ処理、フォーマット出力、暗号化処理、通信プロトコルの実装など多くの場面で必要とされる。本機能は、文字列を等しいサイズ（最後のチャンクを除く）のvecに効率的に分割する。

**機能の利用シーン**：
- 長い文字列を一定長で改行して表示
- バイナリデータの固定長ブロック分割
- クレジットカード番号などの桁区切り表示
- Base64エンコードデータの行分割
- データのページネーション処理

**主要な処理内容**：
1. 入力文字列とチャンクサイズを受け取る
2. 文字列をチャンクサイズごとに分割
3. 最後のチャンクはサイズ未満になる可能性がある
4. 結果をvec<string>として返す

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

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

## 関連画面

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

## 機能種別

文字列分割処理（Divide）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $string | string | Yes | 分割対象の文字列 | なし |
| $chunk_size | int | No（デフォルト: 1） | 各チャンクのバイト数 | 正の整数のみ |

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (戻り値) | vec<string> | チャンクに分割された文字列の配列 |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. 引数の受け取り
   └─ $string（対象文字列）と$chunk_size（チャンクサイズ）を受け取る
2. 内部関数への委譲
   └─ _Str\chunk_lを呼び出し
3. 結果の返却
   └─ vec<string>を返す
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[引数を受け取る]
    B --> C{chunk_size > 0?}
    C -->|No| D[エラー]
    C -->|Yes| E[_Str\chunk_l呼び出し]
    E --> F[vec<string>を返却]
    F --> G[終了]
    D --> H[異常終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-46-01 | バイト単位分割 | 分割はバイト単位で行われる | 常時 |
| BR-46-02 | デフォルトサイズ | chunk_sizeを省略した場合は1バイトずつ分割 | chunk_size省略時 |
| BR-46-03 | 最終チャンク | 最後のチャンクはchunk_size未満になる可能性がある | 文字列長がchunk_sizeで割り切れない場合 |
| BR-46-04 | 空文字列 | 空文字列を分割すると空のvecを返す可能性 | 入力が空の場合 |

### 計算ロジック

- チャンク数 = ceil(strlen($string) / $chunk_size)
- 各チャンク = $string[$i * $chunk_size .. ($i + 1) * $chunk_size - 1]

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | InvalidArgumentException | chunk_sizeが0以下の場合 | 正の整数を指定 |

### リトライ仕様

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

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

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

## パフォーマンス要件

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

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

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

## 備考

- デリミタで分割する場合は `Str\split` を使用すること
- 文字単位（マルチバイト対応）で分割する場合は `Str\chunk_l` を使用すること

---

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

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

### 推奨読解順序

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

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

**主要処理フロー**:
1. **22-27行目**: chunk関数の定義
2. **26行目**: _Str\chunk_lへの委譲

**読解のコツ**: $chunk_sizeのデフォルト値は1で、省略すると1バイトずつの配列になる。

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

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

**主要処理フロー**:
- **17行目**: splitとの使い分けの説明

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

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

**主要処理フロー**:
- **17-44行目**: provideChunkとtestChunkで様々な入力パターンと期待結果を確認
- **19-33行目**: サイズ1、10、2の各ケースのテスト

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

```
Str\chunk($string, $chunk_size)
    │
    └─ _Str\chunk_l($string, $chunk_size)
           │
           └─ [HHVM内部実装]
```

### データフロー図

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

$string (string) ────┐
                     ├──▶ _Str\chunk_l ──▶ vec<string>
$chunk_size (int) ───┘

例: "hello", 2 ──▶ vec["he", "ll", "o"]
```

### 関連ファイル一覧

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