# 機能設計書 25-is_empty

## 概要

本ドキュメントは、Hack Standard Library（HSL）の `Str\is_empty` 関数の機能設計書です。文字列がnullまたは空文字列かどうかを判定する機能を提供します。

### 本機能の処理概要

`Str\is_empty` 関数は、与えられた文字列がnullまたは空文字列（`''`）かどうかを判定してブール値で返す関数です。null安全な文字列判定を提供します。

**業務上の目的・背景**：アプリケーション開発において、ユーザー入力やデータベースから取得した値が「空」かどうかを判定する処理は非常に頻繁に発生します。Hack言語ではnull許容型（`?string`）が存在するため、単純な `=== ''` 比較だけでは不十分な場合があります。この関数は、nullと空文字列の両方を「空」として扱う統一的な判定方法を提供し、コードの可読性と保守性を向上させます。

**機能の利用シーン**：
- フォーム入力値のバリデーション（必須項目のチェック）
- データベースから取得した値の空チェック
- 設定値やパラメータの有無確認
- オプショナルな文字列フィールドの処理
- APIレスポンスの空値判定

**主要な処理内容**：
1. 入力値 `$string`（null許容string）を受け取る
2. 値が `null` の場合は `true` を返す
3. 値が空文字列 `''` の場合は `true` を返す
4. それ以外の場合は `false` を返す

**関連システム・外部連携**：外部システムとの連携はありません。純粋な文字列判定関数です。

**権限による制御**：特に権限による制御はありません。純粋関数（Pure function）として実装されており、副作用はありません。

## 関連画面

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

## 機能種別

バリデーション / 文字列判定処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $string | ?string | Yes | 検査対象の文字列（null許容） | なし |

### 入力データソース

関数呼び出し時の引数として直接渡される文字列データまたはnull。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | bool | 文字列がnullまたは空文字列の場合は `true`、それ以外は `false` |

### 出力先

関数の戻り値として呼び出し元に返却。

## 処理フロー

### 処理シーケンス

```
1. 関数呼び出し
   └─ $string を引数として受け取る
2. null判定
   └─ $string === null の場合 true を返す
3. 空文字列判定
   └─ $string === '' の場合 true を返す
4. 結果の返却
   └─ 上記以外は false を返す
```

### フローチャート

```mermaid
flowchart TD
    A[開始: is_empty呼び出し] --> B{$string === null?}
    B -->|Yes| C[true を返す]
    B -->|No| D{$string === ''?}
    D -->|Yes| C
    D -->|No| E[false を返す]
    C --> F[終了]
    E --> F
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | null判定 | nullは空として扱う | $string === null |
| BR-02 | 空文字列判定 | 空文字列は空として扱う | $string === '' |
| BR-03 | ゼロ文字列 | "0" は空ではない | $string === '0' |
| BR-04 | ヌル文字 | "\0" は空ではない | $string === "\0" |

### 計算ロジック

`$string === null || $string === ''` という単純な比較式。

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

### 操作別データベース影響一覧

本機能はデータベース操作を行いません。

## エラー処理

### エラーケース一覧

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

### リトライ仕様

該当なし。

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

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

## パフォーマンス要件

- 計算量: O(1)（定数時間）
- 純粋関数として実装されており、キャッシュや状態を持たない
- コンテキスト係数 `[]:` が指定されており、副作用なしで実行可能
- 非常に軽量な処理

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

- 純粋関数のため、セキュリティ上の懸念は最小限
- 入力値のサニタイズ処理とは別の機能であることに注意

## 備考

- PHPの `empty()` 関数とは異なり、"0" は空として扱われない
- コンテナの空判定には `C\is_empty()` を使用すること

---

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

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

### 推奨読解順序

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

まず、外部から呼び出される公開関数のインターフェースを理解します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | introspect.php | `src/str/introspect.php` | 公開関数 `is_empty` の定義とドキュメントコメント |

**主要処理フロー**:
- **140-145行目**: 関数のドキュメントコメント。nullと空文字列の両方でtrueを返すことを明記
- **146-150行目**: 関数シグネチャと実装
- **146行目**: 引数の型が `?string`（null許容string）であることに注目
- **149行目**: `$string === null || $string === ''` という実装。シンプルな比較式

**読解のコツ**: Hackの `?string` はnull許容型を表し、`string | null` と同義です。この関数は外部ライブラリに依存せず、インラインで実装されています。

#### Step 2: テストケースを理解する

テストコードから具体的な動作仕様を確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | StrIntrospectTest.php | `tests/str/StrIntrospectTest.php` | テストケースから具体的な入出力パターンを理解 |

**主要処理フロー**:
- **223-230行目**: `provideIsEmpty` メソッドでテストデータを定義
- **224行目**: `null` は `true`
- **225行目**: `''`（空文字列）は `true`
- **226行目**: `'0'`（ゼロ文字列）は `false`
- **227行目**: `"\0"`（ヌル文字）は `false`
- **228行目**: `'anything else'` は `false`
- **233-238行目**: テスト実行メソッド

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

```
Str\is_empty($string)
    │
    └─ [インライン実装]
           └─ $string === null || $string === ''
```

### データフロー図

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

$string (?string) ───▶ is_empty() ───▶ bool (true/false)
                            │
                            ├─ null判定
                            │
                            └─ 空文字列判定
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| introspect.php | `src/str/introspect.php` | ソース | 公開API定義と実装 |
| StrIntrospectTest.php | `tests/str/StrIntrospectTest.php` | テスト | ユニットテスト |
