README

Map 允许你使用类似数组的对象，与默认的整数或字符串类型不同，键可以是任何类型。

安装

使用以下方式安装

$ composer require carlosv2/map

使用方法

要使用 Map，你只需要创建一个实例，然后就像使用常规数组一样使用它

$foo = new Foo();

$map = new Map();
$map[$foo] = 'bar';

你可以使用任何你想要的类型作为键。如果你愿意，甚至可以混合使用它们

$map = new Map();

$map[null] = 'null';
$map[[]] = 'array';
$map['string'] = 'string';
$map[1] = 'integer';
$map[true] = 'boolean';
$map[new \stdClass()] = 'object';

foreach ($map as $key => $value) {
    var_dump($key, $value);
}

API

Map 类中提供了以下函数。

has

检查键是否存在

$obj = new \stdClass();

$map = new Map();
$map[$obj] = 'value';

$map->has($obj); // true
$map->has([]); // false

get

返回与给定键关联的值

$obj = new \stdClass();

$map = new Map();
$map[$obj] = 'value';

$map->get($obj); // 'value'
$map->get([]); // null

可选地，如果给定的键不存在，可以返回一个回退值

$map = new Map();
$map->get([], 'default'); // 'default'

set

将给定的值分配给给定的键

$map = new Map();

$map->set($key, $value); // Equivalent to: $map[$key] = $value;

keys

返回该实例的键数组

$map = new Map();

$map[null] = 'null';
$map[[]] = 'array';
$map[true] = 'boolean';

$map->keys(); // [null, [], true]

values

返回该实例的值数组

$map = new Map();

$map[null] = 'null';
$map[[]] = 'array';
$map[true] = 'boolean';

$map->values(); // ['null', 'array', 'boolean']

map

类似于 array_map，但返回另一个 Map 实例。可调用的函数可能将键作为第二个参数

$map = new Map();

$map[null] = 'null';
$map[[]] = 'array';
$map[true] = 'boolean';

$newMap = $map->map(function ($value, $key) { return json_encode($key) . '_' . $value; });
$newMap->keys(); // [null, [], true]
$newMap->values(); // ['null_null', '[]_array', 'true_boolean']

接口

Map 类实现了以下接口。

• ArrayAccess
• Countable
• IteratorAggregate