# 機能設計書 63-Vec\keys

## 概要

本ドキュメントは、Hack Standard Library（HSL）の`Vec\keys`関数の機能設計を記載する。この関数は、KeyedTraversable（キー付きトラバース可能オブジェクト）からすべてのキーを抽出し、新しいvecとして返す。

### 本機能の処理概要

**業務上の目的・背景**：
連想配列やMapなどのキー付きコレクションを操作する際、キーの一覧を取得したい場面は多い。例えば、設定ファイルの項目名一覧の取得、データベースのカラム名抽出、オブジェクトのプロパティ名列挙などに使用される。この関数は、コレクションの走査順序を保持しながら、すべてのキーをvecとして返す。

**機能の利用シーン**：
- dictやMapのキー一覧を取得
- 設定項目名の列挙
- フォームフィールド名の抽出
- JSONオブジェクトのプロパティ名取得
- ループインデックスの生成（Vector等の場合）

**主要な処理内容**：
1. KeyedTraversableを受け取り、foreachでキーと値のペアを反復処理
2. 各反復でキーのみを結果vecに追加
3. 値は無視される
4. キーの順序は元のコレクションの走査順序が保持される

**関連システム・外部連携**：
外部システムとの連携はない。純粋な関数型ユーティリティとして動作する。

**権限による制御**：
権限による制御は存在しない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 本ライブラリはUIを持たないため該当なし |

## 機能種別

計算処理 / データ抽出

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $traversable | KeyedTraversable<Tk, Tv> | Yes | キーを抽出する対象のキー付きコレクション | なし（空コレクションも許容） |

### 入力データソース

プログラムコードからの直接呼び出し。dict、Map、Vector、KeyedIteratorなど、KeyedTraversableを実装する任意の型を受け付ける。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | vec<Tk> | 入力コレクションのすべてのキーを含むvec。順序は元のコレクションの走査順序が保持される |

### 出力先

呼び出し元への戻り値として返却。

## 処理フロー

### 処理シーケンス

```
1. 空の結果vec（$result）を初期化
   └─ $result = vec[]

2. 入力のKeyedTraversableをforeachで反復
   └─ foreach ($traversable as $key => $_)

3. 各反復でキーを結果vecに追加
   └─ $result[] = $key

4. 反復完了後、結果vecを返却
   └─ return $result
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[結果vec初期化]
    B --> C{traversableに次の要素があるか}
    C -->|Yes| D[キーを取得]
    D --> E[キーを結果vecに追加]
    E --> C
    C -->|No| F[結果vecを返却]
    F --> G[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 順序保持 | 元のコレクションの走査順序が結果vecでも保持される | 常時 |
| BR-02 | 値の無視 | 値は処理に使用されず、キーのみが抽出される | 常時 |
| BR-03 | 型保持 | 元のキーの型（intまたはstring）が結果vecの要素型として保持される | 常時 |

### 計算ロジック

単純なキー抽出のため、計算ロジックは存在しない。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | データベース操作なし |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | - | エラーは発生しない |

### リトライ仕様

リトライは不要（純粋関数であり、同じ入力に対して常に同じ結果を返す）。

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

トランザクション管理は不要（メモリ内処理のみ）。

## パフォーマンス要件

- 時間計算量: O(n)、nは入力コレクションのサイズ
- 空間計算量: O(n)、すべてのキーを新しいvecに格納

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

- 純粋関数であり、外部リソースへのアクセスは行わない
- キーに機密情報が含まれる場合、結果の取り扱いに注意が必要

## 備考

- Keyset\keys関数も存在し、結果をkeysetとして返す（重複キーがある場合の動作が異なる）
- Vectorなどの場合、キーは0から始まる連続した整数インデックスとなる

---

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

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

### 推奨読解順序

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

KeyedTraversableインターフェースとvec型の関係を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | select.php | `src/vec/select.php` | keys関数の定義場所と型シグネチャ |

**読解のコツ**: `KeyedTraversable<Tk, Tv>`は、キー型Tkと値型Tvを持つ反復可能なコレクションを表す。vecのキー型はint、dictのキー型はarraykey（int | string）となる。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | select.php | `src/vec/select.php` | keys関数の実装（190-196行目） |

**主要処理フロー**:
1. **190行目**: 関数シグネチャ - KeyedTraversableを受け取りvec<Tk>を返す
2. **191行目**: 空の結果vec初期化
3. **192-194行目**: foreachループでキーを反復し、結果vecに追加
4. **195行目**: 結果vecを返却

#### Step 3: 類似関数との比較

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | - | Keyset\keys | 結果をkeysetで返す類似関数 |
| 3-2 | - | Dict\from_keys | キーからdictを生成する逆操作 |

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

```
Vec\keys()
    │
    └─ foreach反復
           └─ キーを結果vecに追加
```

### データフロー図

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

KeyedTraversable    ───▶  foreach反復処理  ───────────▶   vec<Tk>
  <Tk, Tv>                      │
                                ▼
                         キーのみ抽出
                         ($key => $_)
                                │
                                ▼
                         結果vecに追加
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| select.php | `src/vec/select.php` | ソース | keys関数の実装 |
| VecSelectTest.php | `tests/vec/VecSelectTest.php` | テスト | keysのユニットテスト（326-372行目） |
