HH\KeyedIterable::take

Returns a KeyedIterable containing the first n values of the current KeyedIterable.

Description

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

Returns a KeyedIterable containing the first n values of the current KeyedIterable.

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

$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 returned KeyedIterable.

Return Values

  • KeyedIterable<Tk,Tv> - A KeyedIterable that is a proper subset of the current KeyedIterableup ton` elements.