Interface Map

キーと値のマッピングを管理するインタフェースです. API は java.util.Map を参考にして作られています.

このインタフェースを使うと, 今まで配列を使って

$value = isset($arr[$name]) ? $arr[$name] : NULL;

と書かなければならなかったコードが

$value = $map->get($name);

に簡略化できます. (※ E_NOTICE を無視する場合はこの限りではありません)

PHP の配列機能との違いはその他に以下のものがあります.

実装クラスによっては Java の Map のように任意のオブジェクトをキーとして利用できる. (Peach\Util\HashMap など)
値を取得する際, マッピングが存在しない場合にデフォルト値を適用できる.
配列の操作に多態性 (ポリモーフィズム) を持たせることが出来る.

原則として, キーに可変オブジェクトを使わないでください. キーに設定した可変オブジェクトが外部から変更された場合の動作は保証されません.

Direct known implementers

Peach\Util\ArrayMap, Peach\Util\HashMap

Namespace: Peach\Util
Located at Peach/Util/Map.php

Methods summary
`public mixed`	# `get( mixed $key, mixed $defaultValue = null )` 指定されたキーにマッピングされている値を返します. マッピングが存在しない場合は $defaultValue を返します. 指定されたキーにマッピングされている値を返します. マッピングが存在しない場合は $defaultValue を返します. Parameters `$key` キー `$defaultValue` マッピングが存在しない場合の代替値 (デフォルトは NULL) Returns mixed 指定したキーに関連づけられた値. 存在しない場合は引数のデフォルト値.
`public`	# `put( mixed $key, mixed $value )` 指定されたキーと値を関連づけます. 指定されたキーと値を関連づけます. Parameters `$key` キー `$value` 指定されたキーに関連づける値
`public`	# `putAll( Peach\Util\Map $map )` 指定されたマップのマッピングすべてを登録します. 指定されたマップのマッピングすべてを登録します. Parameters `$map` 登録対象のマップ
`public boolean`	# `containsKey( mixed $key )` 指定されたキーによるマッピングが存在するかどうかを調べます. マッピングが存在する場合に TRUE を返します. 指定されたキーによるマッピングが存在するかどうかを調べます. マッピングが存在する場合に TRUE を返します. Parameters `$key` キー Returns boolean マッピングが存在する場合に TRUE
`public`	# `remove( mixed $key )` 指定されたキー名によるマッピングが存在する場合に, そのマッピングを削除します. 指定されたキー名によるマッピングが存在する場合に, そのマッピングを削除します. Parameters `$key` キー
`public`	# `clear( )` このマップを空にします. このマップを空にします.
`public integer`	# `size( )` 登録されているマッピングの個数を返します. 登録されているマッピングの個数を返します. Returns integer
`public array`	# `values( )` このマップに登録されているすべての値を配列で返します. 返される配列に対する操作はこのオブジェクトに反映されません. このマップに登録されているすべての値を配列で返します. 返される配列に対する操作はこのオブジェクトに反映されません. Returns array
`public array`	# `keys( )` このマップに登録されているすべてのキーを配列で返します. 返される配列に対する操作はこのオブジェクトに反映されません. このマップに登録されているすべてのキーを配列で返します. 返される配列に対する操作はこのオブジェクトに反映されません. Returns array
`public array`	# `entryList( )` このマップのすべてのエントリーを `Peach\Util\MapEntry` オブジェクトの配列で返します. このマップのすべてのエントリーを `Peach\Util\MapEntry` オブジェクトの配列で返します. Returns array See `Peach\Util\MapEntry`

Namespaces

Classes

Interfaces

Interface Map

Direct known implementers

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

See