# 機能設計書 96-Keyset\keys

## 概要

本ドキュメントは、Hack Standard Library (HSL) の `HH\Lib\Keyset\keys` 関数の機能設計について記述する。この関数は、KeyedTraversableのキーを抽出し、新しいkeysetとして返す機能を提供する。

### 本機能の処理概要

**業務上の目的・背景**：
連想配列やMapなどのキー付きコレクションから、キーのみを取得する処理は、キーの一覧表示、キーの重複チェック、キーベースの処理などで頻繁に必要とされる。本機能は、KeyedTraversableからキーを抽出し、一意なキーの集合としてkeysetを返す。これにより、利用可能なキーの確認、キーの集合演算などが容易に実装できる。

**機能の利用シーン**：
- 辞書形式データからキー一覧を取得する際
- 設定ファイルの有効なキーを列挙する際
- 複数のMapのキーを比較する際
- キーベースのバリデーションを行う際

**主要な処理内容**：
1. KeyedTraversableを走査
2. 各要素のキーをkeysetに追加
3. 結果のkeysetを返却（キーは自動的に一意になる）

**関連システム・外部連携**：
- `Vec\keys`（vecで返す版）との違いを理解しておく
- KeyedTraversableインターフェースを実装したコレクションに対応

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

## 関連画面

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

## 機能種別

計算処理（コレクション変換）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $traversable | KeyedTraversable<Tk, Tv> | Yes | キーを抽出する対象のコレクション | Tkはarraykey制約 |

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | keyset<Tk> | 入力のキーを含むkeyset |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. 結果用keysetを初期化
2. KeyedTraversableを走査
   └─ 各要素のキーをkeysetに追加
3. 結果返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[result = keyset[]]
    B --> C{KeyedTraversable走査}
    C --> D[key = 現在のキー]
    D --> E[result[] = key]
    E --> C
    C -->|完了| F[resultを返却]
    F --> G[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | キー抽出 | 値は無視され、キーのみが収集される | 常時 |
| BR-02 | 順序保持 | イテレーション順序は保持される | 常時 |
| BR-03 | 重複排除 | keysetの特性により、重複キーは自動的に排除される | 常時 |

### 計算ロジック

- 時間計算量: O(n) - nはTraversableのサイズ
- 空間計算量: O(n)

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

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

## パフォーマンス要件

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

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

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

## 備考

- KeyedTraversableの値は完全に無視される
- ドキュメントコメントには計算量の記載がないが、実装から明らかにO(n)
- PHPのarray_keysに類似した機能だが、結果がkeysetになる点が異なる

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | (Hack言語仕様) | - | KeyedTraversableはキーと値のペアを持つコレクションインターフェース |

**読解のコツ**: keysetはキーと値が同一の集合型。この関数では入力のキーが出力の要素（かつキー）となる。

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

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

**主要処理フロー**:
1. **147-150行目**: ドキュメントコメント - 機能の説明
2. **151-153行目**: 関数シグネチャ - TkとTvのジェネリクス
3. **154行目**: 空のkeyset初期化
4. **155-157行目**: foreachで走査、キーのみを追加
5. **158行目**: 結果を返却

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | select.php | `src/vec/select.php` | Vec\keys関数との比較（戻り値がvec） |

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

```
Keyset\keys($traversable)
    │
    └─ foreach ($traversable as $key => $_)  [要素走査]
           │
           └─ $result[] = $key  [keyset追加]
```

### データフロー図

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

KeyedTraversable<Tk, Tv> ───▶ 走査 ──▶ キー抽出 ──▶ keyset<Tk>
                              │
                              └─ 値は無視
```

### 関連ファイル一覧

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