ArrayUtil.php

<?php


class ArrayUtil
{

	/**
	 * take an array and split into the given number of arrays with equal number of elements
	 * if an uneven number of elements one (or more) arrays may have more elements then the others
	 *
	 * @param array The array we want to split
	 * @param int The number of sections we want
	 * @return array The resulting split array
	 */
	public static function splitArray($array, $sections)
	{
		if(count($array) < $sections) {

			$chunkSize = 1;
		} else {

			$chunkSize = (count($array) / $sections);
		}

		return array_chunk($array, $chunkSize, true);
	}

	/**
	 * Add new elements to the given array after the element with the supplied key
	 *
	 * @param array The array we want to add to
	 * @param string|int The key we wish to add our new elements after.
	 * @param array The elements we wish to add
	 * @return array The resulting array with new elements
	 */
	public static function addAfter($array, $key, $new_elements)
	{
		$offset = self::getOffsetByKey($array, $key);

		if ($offset >= 0) {

			// increment cause we want to actually splice in from the element AFTER the one we found
			$offset++;

			// get the slice, and insert the new elements and rebuild the array
			$array_items = array_splice($array, $offset);
			$new_elements += $array_items;
			$array += $new_elements;
		}

		return $array;
	}

	/**
	 * get the offset of an element within an array based on the key
	 * useful for associative arrays
	 *
	 * @param array The containing array
	 * @param string The key to search for
	 * @return int|null The offset within an array | null if not found
	 */
	public static function getOffsetByKey($array, $needle)
	{
		$offset = 0;

		foreach ($array as $key => $value) {

			if ($key === $needle) {

				return $offset;
			}

			$offset++;
		}

		return null;
	}

	/**
	 * get the offset of an element within an array based on the element value
	 * useful for associative arrays
	 *
	 * @param array The containing array
	 * @param string The value to search for
	 * @return int|null The offset within an array | null if not found
	 */
	public static function getOffsetByValue($array, $needle)
	{
		$offset = 0;

		foreach ($array as $key => $value) {

			if ($value === $needle) {

				return $offset;
			}

			$offset++;
		}

		return null;
	}

}