DocumentationHackReferenceClassHH\MapfromItems

HH\Map::fromItems

Creates a Map from the given Traversable, or an empty Map if null is passed

public static function fromItems(
  ?Traversable<Pair<Tk, Tv>> $iterable,
): Map<Tk, Tv>;

This is the static method version of the Map::__construct() constructor.

Parameters

?Traversable<Pair<Tk,Tv>> $iterable

Returns

Map<Tk,Tv> - A Map with the key/value pairs from the Traversable; or an empty Map if the Traversable is null.

Examples

This example shows that a Map can be created from any Traversable of key-value pairs:

// Create a new Map from an array of key-value pairs
$m = Map::fromItems(varray[
  Pair {'red', '#ff0000'},
  Pair {'green', '#00ff00'},
  Pair {'blue', '#0000ff'},
  Pair {'yellow', '#ffff00'},
]);
\var_dump($m);

// Create a new Map from a Vector of key-value pairs
$m = Map::fromItems(Vector {
  Pair {'red', '#ff0000'},
  Pair {'green', '#00ff00'},
  Pair {'blue', '#0000ff'},
  Pair {'yellow', '#ffff00'},
});
\var_dump($m);

// An empty Map is created if null is provided
$m = Map::fromItems(null);
\var_dump($m);