DocumentationHackReferenceClassHH\Maptake

HH\Map::take

Returns a Map containing the first n key/values of the current Map

public function take(
  int $n,
): Map<Tk, Tv>;

The returned Map will always be a proper subset of the current Map.

n is 1-based. So the first element is 1, the second 2, etc.

Parameters

int $n - The last element that will be included in the Map.

Returns

Map<Tk, Tv> - A Map that is a proper subset of this Map up to n elements.

Examples

$m = Map {
  'red' => '#ff0000',
  'green' => '#00ff00',
  'blue' => '#0000ff',
  'yellow' => '#ffff00',
  'purple' => '#663399',
};

// Take the first two elements
$take2 = $m->take(2);

var_dump($take2);

Output

object(HH\Map)#2 (2) {
  ["red"]=>
  string(7) "#ff0000"
  ["green"]=>
  string(7) "#00ff00"
}