Util

クラス: Peach_Util_ArrayMap

定義: /Peach/Util/ArrayMap.php

PHP の配列機能を使った Map の実装です.

このマップはキーに整数または文字列しか使えないという制限があります.

すべての実装されたインタフェース

メソッド

メソッド 詳細

constructor __construct

line 42

Peach_Util_ArrayMap __construct([Peach_Util_Map|array $var = null])

新しいインスタンスを構築します.

Tags

  • access : public

引数

Peach_Util_Map|array   $var   指定された配列またはマッピングでこのマップを初期化します.

asArray

line 196

array asArray()

このマップに登録されているエントリーを配列として返します.

返される配列に対する操作はこのマップには反映されません.

Tags

  • return : このマップの配列表現
  • access : public

clear

line 141

void clear()

このマップを空にします.

Tags

  • access : public

定義

Peach_Util_Map::clear()
このマップを空にします.

containsKey

line 122

bool containsKey(string $name)

指定されたキー名によるマッピングが存在するかどうかを調べます.

マッピングが存在する場合に TRUE を返します.

Tags

  • return : マッピングが存在する場合に TRUE
  • access : public

引数

string   $name   キー名

定義

Peach_Util_Map::containsKey()
指定されたキーによるマッピングが存在するかどうかを調べます.

entryList

line 181

array entryList()

このマップに含まれるすべてのエントリーを返します.

Tags

定義

Peach_Util_Map::entryList()
このマップのすべてのエントリーを Peach_Util_MapEntry オブジェクトの配列で返します.

get

line 77

mixed get(string $name, [mixed $defaultValue = null])

指定されたキー名にマッピングされている値を返します.

マッピングが存在しない場合は代替値 (デフォルトは NULL) を返します. このメソッドの返り値が NULL (または指定した代替値) の場合, 必ずしもマッピングが存在しないとは限りません. マッピングが存在するかどうかを調べる場合は Peach_Util_ArrayMap::containsKey() を使用してください.

Tags

  • return : 指定したキーに関連づけられた値. 存在しない場合は $defaultValue を返す
  • access : public

引数

string   $name   キー名
mixed   $defaultValue   デフォルト値

定義

Peach_Util_Map::get()
指定されたキーにマッピングされている値を返します.

keys

line 161

array keys()

このマップに登録されているすべてのキーを配列で返します.

返される配列に対する操作はこのマップには反映されません.

Tags

  • access : public

定義

Peach_Util_Map::keys()
このマップに登録されているすべてのキーを配列で返します.

put

line 92

void put(string $key, mixed $value)

指定されたキー名と値を関連づけます.

この実装では, 内部に保存されている配列に対して

  1. $arr[$key$value;

を実行するのと同等の操作を行います. もしも $key に非スカラー値 (オブジェクトや配列など) が指定された場合は, Peach_Util_Values::stringValue() で string 型に変換した結果をキーとします.

Tags

  • access : public

引数

string   $key   キー名
mixed   $value   指定されたキーに関連づける値

定義

Peach_Util_Map::put()
指定されたキーと値を関連づけます.

putAll

line 107

void putAll(Peach_Util_Map $map)

指定された Map のマッピングをすべて登録します.

Tags

  • see : Peach_Util_Map::putAll($map)
  • access : public

引数

Peach_Util_Map   $map  

定義

Peach_Util_Map::putAll()
指定されたマップのマッピングすべてを登録します.

remove

line 131

void remove(string $key)

指定されたキー名によるマッピングが存在する場合に, そのマッピングを削除します.

Tags

  • access : public

引数

string   $key   キー名

定義

Peach_Util_Map::remove()
指定されたキー名によるマッピングが存在する場合に, そのマッピングを削除します.

size

line 150

int size()

登録されているマッピングの個数を返します.

Tags

  • access : public

定義

Peach_Util_Map::size()
登録されているマッピングの個数を返します.

values

line 171

array values()

このマップに登録されているすべての値を配列で返します.

返される配列に対する操作はこのマップには反映されません.

Tags

  • access : public

定義

Peach_Util_Map::values()
このマップに登録されているすべての値を配列で返します.