HH\Vector::take

Returns a Vector containing the first $n values of the current Vector.

Description

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

Returns a Vector containing the first $n values of the current Vector.

The returned Vector will always be a subset (but not necessarily a proper subset) of the current Vector. If $n is greater than the length of the current Vector, the returned Vector will contain all elements of the current Vector.

$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 Vector.

Return Values

Examples

<?hh

namespace Hack\UserDocumentation\API\Examples\Vector\Take;

$v = Vector {'red', 'green', 'blue', 'yellow'};

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

var_dump($take2);
Output
object(HH\Vector)#2 (2) {
  [0]=>
  string(3) "red"
  [1]=>
  string(5) "green"
}