# 機能設計書 48-slice

## 概要

本ドキュメントは、Hack Standard Library (HSL) の `Str\slice` 関数の機能設計を記載する。この関数は文字列から指定位置・指定長の部分文字列を取得する機能を提供する。PHPの`substr`に相当する機能である。

### 本機能の処理概要

**業務上の目的・背景**：文字列から部分文字列を抽出することは、テキスト処理、データ解析、フォーマット変換など、ほぼすべてのアプリケーションで必要とされる基本操作である。本機能は、オフセットと長さを指定して効率的に部分文字列を取得する型安全な実装を提供する。

**機能の利用シーン**：
- ファイルパスから拡張子を抽出
- 固定長レコードからフィールドを抽出
- 文字列の先頭または末尾のN文字を取得
- テキストの切り詰め処理
- IDや識別子の一部抽出

**主要な処理内容**：
1. 対象文字列、オフセット、長さ（オプション）を受け取る
2. オフセットを正規化（負の値は末尾からの位置として解釈）
3. 範囲外のオフセットは例外をスロー
4. 指定された部分文字列を返す

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

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

## 関連画面

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

## 機能種別

文字列選択処理（Select）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $string | string | Yes | 操作対象の文字列 | なし |
| $offset | int | Yes | 抽出開始位置（負の値は末尾からの位置） | 範囲外は例外 |
| $length | ?int | No（デフォルト: null） | 抽出する長さ（nullで末尾まで） | 負の値は例外 |

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (戻り値) | string | 抽出された部分文字列 |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. 引数の受け取り
   └─ $string, $offset, $lengthを受け取る
2. オフセットの検証
   └─ 範囲外の場合はInvalidArgumentExceptionをスロー
3. 長さの検証
   └─ 負の値の場合はInvalidArgumentExceptionをスロー
4. 内部関数への委譲
   └─ _Str\slice_lを呼び出し（lengthがnullの場合はPHP_INT_MAXを渡す）
5. 結果の返却
   └─ 部分文字列を返す
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[引数を受け取る]
    B --> C{offsetが範囲内?}
    C -->|No| D[InvalidArgumentExceptionをスロー]
    C -->|Yes| E{lengthが負?}
    E -->|Yes| F[InvalidArgumentExceptionをスロー]
    E -->|No| G[_Str\slice_l呼び出し]
    G --> H[部分文字列を返却]
    H --> I[終了]
    D --> J[異常終了]
    F --> J
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-48-01 | 正オフセット | 正の値は文字列の先頭からの位置 | $offset >= 0 |
| BR-48-02 | 負オフセット | 負の値は文字列の末尾からの位置 | $offset < 0 |
| BR-48-03 | 長さ省略 | $lengthがnullの場合、$offsetから末尾までを返す | $length === null |
| BR-48-04 | 長さゼロ | $length === 0の場合、空文字列を返す | $length === 0 |
| BR-48-05 | 範囲外エラー | $offsetが文字列長を超える場合は例外 | $offset > strlen |
| BR-48-06 | 長さ超過 | 指定長が残り長を超える場合は残り全てを返す | $offset + $length > strlen |

### 計算ロジック

- 結果 = string[$offset .. $offset + $length - 1]
- 負のオフセット: 実際の位置 = strlen($string) + $offset

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | InvalidArgumentException | $offsetが文字列長を超える場合 | 有効な範囲のオフセットを指定 |
| - | InvalidArgumentException | 負の$offsetの絶対値が文字列長を超える場合 | 有効な範囲のオフセットを指定 |
| - | InvalidArgumentException | $lengthが負の値の場合 | 0以上の値を指定 |

### リトライ仕様

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

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

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

## パフォーマンス要件

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

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

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

## 備考

- PHPの`substr`に相当
- 文字単位（マルチバイト対応）で操作する場合は `Str\slice_l` を使用すること

---

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

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

### 推奨読解順序

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

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

**主要処理フロー**:
1. **28-30行目**: slice関数の定義
2. **29行目**: _Str\slice_lへの委譲（length ?? PHP_INT_MAXで無制限を表現）

**読解のコツ**: `$length ?? \PHP_INT_MAX`という式は、$lengthがnullの場合にPHP_INT_MAXを使用することで「末尾まで」を表現している。

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

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

**主要処理フロー**:
- **20-22行目**: 長さ省略時、長さゼロ時、範囲外時の動作説明
- **24行目**: PHPのsubstrとの関連の記載

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

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

**主要処理フロー**:
- **17-87行目**: provideSlice、testSlice、testSliceExceptionsで様々な入力パターンと期待結果を確認
- **80-86行目**: 例外発生ケースのテスト（負のlength、範囲外offset）

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

```
Str\slice($string, $offset, $length)
    │
    └─ _Str\slice_l($string, $offset, $length ?? PHP_INT_MAX)
           │
           └─ [HHVM内部実装]
```

### データフロー図

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

$string (string) ────────┐
$offset (int) ───────────┼──▶ _Str\slice_l ──▶ 部分文字列
$length (?int) ──────────┘

例: "hello world", 3, 3 ──▶ "lo "
例: "hello world", -5, null ──▶ "world"
```

### 関連ファイル一覧

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