DataStructure

Namespace Chevere\DataStructure

The DataStructure component provides typed immutable-like data structures.

Map

A Map is a sequential collection of key-value pairs. Keys can be of type integer and string.

Creating Map

Create a Map by passing named arguments of any type.

use Chevere\DataStructure\Map;

$map = new Map(
    foo: $foo,
    bar: $bar
);

Putting values

The withPut method is used to put value(s) to the Map.

$map = $map->withPut(
    foo: $foo,
    bar: $bar
);

Counting keys

The count method returns the number of keys mapped.

$integer = $map->count();

Accessing keys

The keys method is used to retrieve the map keys as an array.

$array = $map->keys();

Checking keys

The has method is used to check if the Map contains the given key(s).

$true = $map->has('foo');
$false = $map->has('notFound');

Asserting keys

The assertHas method is used to assert if the Map contains the given key(s). It throws a Throwable when failing to assert.

$map->assertHas('foo');
$map->assertHas('notFound');

Get value

The get method is used to retrieve the Map value for the given key.

$foo = $map->get('foo');
$bar = $map->get('bar');