# 機能設計書 94-Keyset\filter_nulls

## 概要

本ドキュメントは、Hack Standard Library (HSL) の `HH\Lib\Keyset\filter_nulls` 関数の機能設計について記述する。この関数は、Traversableからnull値を除外し、非null要素のみを含む新しいkeysetを返す機能を提供する。

### 本機能の処理概要

**業務上の目的・背景**：
nullを含む可能性のあるデータから、有効な値のみを抽出する処理は、データ処理において頻繁に必要とされる。本機能は、nullable型のコレクションからnullを除外し、型レベルでnullが除去されたkeysetを返す。これにより、後続の処理でnullチェックを省略でき、型安全なコードを記述できる。Hackの型システムと連携し、コンパイル時にnull安全性を保証する。

**機能の利用シーン**：
- データベースクエリ結果からNULL値を除外する際
- オプショナルな設定値からnullを除いて有効値のみ取得する際
- 外部APIレスポンスからnullをフィルタリングする際
- 部分的に失敗した処理の成功分のみを抽出する際

**主要な処理内容**：
1. Traversableを走査
2. 各要素がnullでないかチェック
3. null以外の要素をkeysetに追加
4. 型レベルでnullが除去されたkeysetを返却

**関連システム・外部連携**：
- `Keyset\filter`の特殊化版として位置づけられる
- 型システムと連携し、戻り値の型から?（nullable）を除去

**権限による制御**：
特になし。純粋な計算処理のため、権限による制御は行わない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 画面なし | - | 本プロジェクトはUIを持たないライブラリ |

## 機能種別

計算処理（フィルタリング）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $traversable | Traversable<?Tv> | Yes | フィルタリング対象のコレクション | Tvはarraykey制約 |

### 入力データソース

関数呼び出し時の引数として渡されるTraversableインスタンス。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | keyset<Tv> | null以外の要素のkeyset（Tvはnon-nullable） |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. 結果用keysetを初期化
2. Traversableを走査
   └─ 各要素がnullでないかチェック
   └─ null以外の場合、結果keysetに追加
3. 結果返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[result = keyset[]]
    B --> C{traversable走査}
    C --> D[value = 現在の要素]
    D --> E{value !== null?}
    E -->|Yes| F[result[] = value]
    E -->|No| G[次の要素へ]
    F --> G
    G --> C
    C -->|完了| H[resultを返却]
    H --> I[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 厳密null比較 | `!== null`による厳密比較でnullのみを除外 | 全ての要素 |
| BR-02 | 型レベル保証 | 戻り値の型からnullableが除去される | 常時 |
| BR-03 | 重複排除 | keysetの特性により、結果に重複は含まれない | 常時 |

### 計算ロジック

- 時間計算量: O(n)
- 空間計算量: O(n)

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

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

該当なし。本機能はインメモリでのコレクション操作のみを行う。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | TypeError | arraykeyでない型の要素を含むTraversableを渡した場合 | int/string型のみ使用 |

### リトライ仕様

該当なし。純粋関数であり、同じ入力に対しては常に同じ結果を返す。

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

該当なし。インメモリ操作のみ。

## パフォーマンス要件

- 時間計算量: O(n)
- 空間計算量: O(n)

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

特になし。純粋なデータ変換処理であり、外部リソースへのアクセスは行わない。

## 備考

- `Keyset\filter`と異なり、述語関数を取らないシンプルな実装
- 戻り値の型が`keyset<Tv>`（non-nullable）となるため、型チェッカーがnull安全性を保証
- 0、空文字列、falseなどのfalsy値は除外されない（nullのみ除外）

---

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

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

### 推奨読解順序

#### Step 1: データ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | (Hack言語仕様) | - | ?Tvはnullable型を表し、Tvはnon-nullable型を表す |

**読解のコツ**: Hackの型システムでは、`?Tv`（nullable）から`Tv`（non-nullable）への変換は型チェッカーによって追跡される。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | select.php | `src/keyset/select.php` | filter_nulls関数の実装本体 |

**主要処理フロー**:
1. **106-112行目**: ドキュメントコメント - 機能の説明
2. **113-115行目**: 関数シグネチャ - 入力は?Tv、出力はTv
3. **116行目**: 空のkeyset初期化
4. **117-120行目**: foreachで走査、null以外を追加
5. **121行目**: 結果を返却

#### Step 3: 関連関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | select.php | `src/keyset/select.php` | filter関数との比較 |

**主要処理フロー**:
- **92-104行目**: filter関数 - 述語を使用する一般的なフィルタリング

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

```
Keyset\filter_nulls($traversable)
    │
    └─ foreach ($traversable as $value)  [要素走査]
           │
           ├─ $value !== null  [nullチェック]
           │
           └─ $result[] = $value  [keyset追加]
```

### データフロー図

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

Traversable<?Tv> ─────────▶ nullチェック ──▶ keyset<Tv>
                            (null除外)        (non-nullable)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| select.php | `src/keyset/select.php` | ソース | filter_nulls関数の実装 |
| KeysetSelectTest.php | `tests/keyset/KeysetSelectTest.php` | テスト | filter_nulls関数のユニットテスト |
