arrayutils
Search
⌃K

chunk()

The chunk() method split an array into chunks
Example.php
<?php use kim\present\utils\arrays\ArrayUtils;
​
$arrayUtils = ArrayUtils::from(range(1, 20));
​
$arrayUtils->chunk(4);
// expected output: [
// [ 1, 2, 3, 4],
// [ 5, 6, 7, 8],
// [ 9, 10, 11, 12],
// [13, 14, 15, 16],
// [17, 18, 19, 20]
//]
​
$arrayUtils->chunk(4, true);
// expected output: [
// [ 0 => 1, 1 => 2, 2 => 3, 3 => 4],
// [ 4 => 5, 5 => 6, 6 => 7, 7 => 8],
// [ 8 => 9, 9 => 10, 10 => 11, 11 => 12],
// [12 => 13, 13 => 14, 14 => 15, 15 => 16],
// [16 => 17, 17 => 18, 18 => 19, 19 => 20]
//]

Syntax

$arrayUtils->chunk(int $size, bool $preserveKeys = FALSE) : ArrayUtils;

Parameter

  • $size
    The size of each chunk
  • $preserveKeys
    When set to TRUE keys will be preserved. Default is FALSE which will re-index the chunk numerically

Return value

  • A multidimensional numerically indexed array, starting with zero, with each dimension containing size elements.

Prefixing

$arrayUtils->chunkAs(int $size, bool $preserveKeys = FALSE) : array;
ArrayUtils::chunkFrom(iterable $from, int $size, bool $preserveKeys = FALSE) : ArrayUtils;
ArrayUtils::chunkFromAs(iterable $from, int $size, bool $preserveKeys = FALSE) : array;

References

​