public static function ArrayHelper::chunkEvenly in Helper 7

Split an array into chunks more evenly then array_chunk().

Parameters

array $array: An array of data to split up.

int $num: The amount of chunks to create.

bool $preserve_keys: When set to TRUE keys will be preserved. Default is FALSE which will reindex the chunk numerically

Return value

array Returns a multidimensional numerically indexed array, starting with zero, with each dimension containing size elements.

Throws

\InvalidArgumentException

See also

http://php.net/manual/en/function.array-chunk.php#75022

1 call to ArrayHelper::chunkEvenly()

ArrayHelperTest::testChunkEvenly in tests/ArrayHelperTest.test

File

lib/ArrayHelper.php, line 123

Class

ArrayHelper

Code

public static function chunkEvenly(array $array, $num, $preserve_keys = FALSE) {
  if (!is_numeric($num) || $num < 1) {
    throw new InvalidArgumentException("Cannot use ArrayHelper::chunkEqually() with \$num being less than one, or not a number.");
  }
  $size = count($array);
  if ($size === 0) {
    return array();
  }
  if ($num > $size) {
    $num = $size;
  }
  $chunk_size = floor($size / $num);
  $remainder = $size % $num;
  $chunks = array();
  $mark = 0;
  for ($i = 0; $i < $num; $i++) {
    $incr = $i < $remainder ? $chunk_size + 1 : $chunk_size;
    $chunks[$i] = array_slice($array, $mark, $incr, $preserve_keys);
    $mark += $incr;
  }
  return $chunks;
}