Class ArrayMap

PHP の配列機能を使った Map の実装です. このマップはキーに整数または文字列しか使えないという制限があります.

このクラスは foreach で各マッピングのキーと値を取り出すことが出来ます.

Peach\Util\ArrayMap implements Peach\Util\Map, IteratorAggregate

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

Methods summary
`public`	# `__construct( Peach\Util\Map\|array $var = null )` 新しいインスタンスを構築します. 新しいインスタンスを構築します. Parameters `$var` 指定された配列またはマッピングでこのマップを初期化します.
`public mixed`	# `get( string $name, mixed $defaultValue = null )` 指定されたキー名にマッピングされている値を返します. マッピングが存在しない場合は代替値 (デフォルトは NULL) を返します. このメソッドの返り値が NULL (または指定した代替値) の場合, 必ずしもマッピングが存在しないとは限りません. マッピングが存在するかどうかを調べる場合は ArrayMap::containsKey を使用してください. 指定されたキー名にマッピングされている値を返します. マッピングが存在しない場合は代替値 (デフォルトは NULL) を返します. このメソッドの返り値が NULL (または指定した代替値) の場合, 必ずしもマッピングが存在しないとは限りません. マッピングが存在するかどうかを調べる場合は ArrayMap::containsKey を使用してください. Parameters `$name` キー名 `$defaultValue` デフォルト値 Returns mixed 指定したキーに関連づけられた値. 存在しない場合は $defaultValue を返す Implementation of `Peach\Util\Map::get()`
`public`	# `put( string $key, mixed $value )` 指定されたキー名と値を関連づけます. この実装では, 内部に保存されている配列に対して $arr[$key] = $value; を実行するのと同等の操作を行います. もしも $key に非スカラー値 (オブジェクトや配列など) が指定された場合は, Values::stringValue で string 型に変換した結果をキーとします. 指定されたキー名と値を関連づけます. この実装では, 内部に保存されている配列に対して $arr[$key] = $value; を実行するのと同等の操作を行います. もしも $key に非スカラー値 (オブジェクトや配列など) が指定された場合は, Values::stringValue で string 型に変換した結果をキーとします. Parameters `$key` キー名 `$value` 指定されたキーに関連づける値 Implementation of `Peach\Util\Map::put()`
`public`	# `putAll( Peach\Util\Map $map )` 指定された Map のマッピングをすべて登録します. 指定された Map のマッピングをすべて登録します. Parameters `$map` See `Peach\Util\Map::putAll()` Implementation of `Peach\Util\Map::putAll()`
`public boolean`	# `containsKey( string $name )` 指定されたキー名によるマッピングが存在するかどうかを調べます. マッピングが存在する場合に TRUE を返します. 指定されたキー名によるマッピングが存在するかどうかを調べます. マッピングが存在する場合に TRUE を返します. Parameters `$name` キー名 Returns boolean マッピングが存在する場合に TRUE Implementation of `Peach\Util\Map::containsKey()`
`public`	# `remove( string $key )` 指定されたキー名によるマッピングが存在する場合に, そのマッピングを削除します. 指定されたキー名によるマッピングが存在する場合に, そのマッピングを削除します. Parameters `$key` キー名 Implementation of `Peach\Util\Map::remove()`
`public`	# `clear( )` このマップを空にします. このマップを空にします. Implementation of `Peach\Util\Map::clear()`
`public integer`	# `size( )` 登録されているマッピングの個数を返します. 登録されているマッピングの個数を返します. Returns integer Implementation of `Peach\Util\Map::size()`
`public array`	# `keys( )` このマップに登録されているすべてのキーを配列で返します. 返される配列に対する操作はこのマップには反映されません. このマップに登録されているすべてのキーを配列で返します. 返される配列に対する操作はこのマップには反映されません. Returns array Implementation of `Peach\Util\Map::keys()`
`public array`	# `values( )` このマップに登録されているすべての値を配列で返します. 返される配列に対する操作はこのマップには反映されません. このマップに登録されているすべての値を配列で返します. 返される配列に対する操作はこのマップには反映されません. Returns array Implementation of `Peach\Util\Map::values()`
`public array`	# `entryList( )` このマップに含まれるすべてのエントリーを返します. このマップに含まれるすべてのエントリーを返します. Returns array `Peach\Util\MapEntry` の配列 Implementation of `Peach\Util\Map::entryList()`
`public array`	# `asArray( )` このマップに登録されているエントリーを配列として返します. 返される配列に対する操作はこのマップには反映されません. このマップに登録されているエントリーを配列として返します. 返される配列に対する操作はこのマップには反映されません. Returns array このマップの配列表現
`public Iterator`	# `getIterator( )` このマップに登録されているマッピングを取り出す Iterator を返します. このマップに登録されているマッピングを取り出す Iterator を返します. Returns Iterator Implementation of `IteratorAggregate::getIterator()`