HH\Map::skip

Returns a Map containing the values after the n-th element of the current Map

Description

public function skip(
  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

  • $n - The last element to be skipped; the $n+1 element will be the first one in the returned Map.

Return Values

  • Map<Tk, Tv> - A Map that is a proper subset of the current Map containing values after the specified n-th element.

Examples

<?hh

namespace Hack\UserDocumentation\API\Examples\Map\Skip;

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

// Create a new Map after skipping the first two elements ('red' and 'green')
$skip2 = $m->skip(2);

var_dump($skip2);
Output
object(HH\Map)#2 (2) {
  ["blue"]=>
  string(7) "#0000ff"
  ["yellow"]=>
  string(7) "#ffff00"
}