インタフェース: Peach_Util_Map
定義: /Peach/Util/Map.php
キーと値のマッピングを管理するインタフェースです. API は java.util.Map を参考にして作られています.
このインタフェースを使うと, 今まで配列を使って
- $value = isset($arr[$name]) ? $arr[$name] : NULL;
と書かなければならなかったコードが
に簡略化できます. (※ E_NOTICE を無視する場合はこの限りではありません)
PHP の配列機能との違いはその他に以下のものがあります.
- 実装クラスによっては Java の Map のように任意のオブジェクトをキーとして利用できる. (Peach_Util_HashMap など)
- 値を取得する際, マッピングが存在しない場合にデフォルト値を適用できる.
- 配列の操作に多態性 (ポリモーフィズム) を持たせることが出来る.
原則として, キーに可変オブジェクトを使わないでください. キーに設定した可変オブジェクトが外部から変更された場合の動作は保証されません.
メソッド 詳細
clear
line 96
void clear()
このマップを空にします.
containsKey
line 85
bool containsKey(mixed $key)
指定されたキーによるマッピングが存在するかどうかを調べます.
マッピングが存在する場合に TRUE を返します.
entryList
line 124
array entryList()
このマップのすべてのエントリーを Peach_Util_MapEntry オブジェクトの配列で返します.
get
line 62
mixed get(mixed $key, [mixed $defaultValue = null])
指定されたキーにマッピングされている値を返します.
マッピングが存在しない場合は $defaultValue を返します.
keys
line 116
array keys()
このマップに登録されているすべてのキーを配列で返します.
返される配列に対する操作はこのオブジェクトに反映されません.
put
line 69
void put(mixed $key, mixed $value)
指定されたキーと値を関連づけます.
putAll
line 76
void putAll(Peach_Util_Map $map)
指定されたマップのマッピングすべてを登録します.
remove
line 91
void remove(mixed $key)
指定されたキー名によるマッピングが存在する場合に, そのマッピングを削除します.
size
line 102
int size()
登録されているマッピングの個数を返します.
values
line 109
array values()
このマップに登録されているすべての値を配列で返します.
返される配列に対する操作はこのオブジェクトに反映されません.