class ArrayHelper in Helper 7

Hierarchy

• class \ArrayHelper

1 string reference to 'ArrayHelper'

ArrayHelperTest::getInfo in tests/ArrayHelperTest.test

File

lib/ArrayHelper.php, line 3

class ArrayHelper {
  public static function getNestedValue($item, array $parents, &$key_exists = NULL) {
    $ref = $item;
    foreach ($parents as $parent) {
      if (is_array($ref) && array_key_exists($parent, $ref)) {
        $ref =& $ref[$parent];
      }
      elseif (is_object($ref) && property_exists($ref, $parent)) {
        $ref = $ref->{$parent};
      }
      elseif (is_object($ref) && method_exists($ref, '__get') && $ref
        ->__get($parent) !== NULL) {

        // Support objects that override the __get magic method.
        // This also doesn't support if $ref->$parent exists but is set to NULL.
        $ref = $ref->{$parent};
      }
      else {
        $key_exists = FALSE;
        return NULL;
      }
    }
    $key_exists = TRUE;
    return $ref;
  }
  public static function filterByNestedValue(array $items, array $parents, $value) {
    $return = array();
    foreach ($items as $key => $item) {
      $key_exists = FALSE;
      $found_value = static::getNestedValue($item, $parents, $key_exists);
      if ($key_exists) {
        if (is_array($value) && in_array($found_value, $value)) {
          $return[$key] = $item;
        }
        elseif ($found_value == $value) {
          $return[$key] = $item;
        }
      }
    }
    return $return;
  }
  public static function extractNestedValuesToArray(array $items, array $value_parents, array $key_parents = NULL) {
    $return = array();
    foreach ($items as $index => $item) {
      $key_exists = FALSE;
      $value = static::getNestedValue($item, $value_parents, $key_exists);
      if ($key_exists) {
        $key = isset($key_parents) ? static::getNestedValue($item, $key_parents, $key_exists) : $index;
        if (!$key_exists || !isset($key)) {
          $key = $index;
        }
        $return[$key] = $value;
      }
    }
    return $return;
  }

  /**
   * Applies the callback to the keys of the given array.
   *
   * @param callable $callback
   *   Callback function to run for each key in the array.
   * @param array $array
   *   An array to run through the callback function.
   *
   * @return array
   *   Returns an array containing all the elements of $array after applying
   *   the callback function to each key.
   */
  public static function mapKeys($callback, array $array) {
    return array_combine(array_map($callback, array_combine(array_keys($array), array_keys($array))), $array);
  }

  /**
   * Filters keys of an array using a callback function.
   *
   * @param callable $callback
   *   The callback function to use. If no callback is supplied, all keys of
   *   array equal to FALSE will be removed.
   * @param array $array
   *   The array to iterate over.
   *
   * @return array
   *   Returns the filtered array.
   */
  public static function filterKeys(array $array, $callback) {
    return array_intersect_key($array, array_flip(array_filter(array_keys($array), $callback)));
  }
  public static function spliceAssociativeValues(array $array, array $values, $offset, $length = 0) {
    return array_slice($array, 0, $offset, TRUE) + $values + array_slice($array, $offset + $length, NULL, TRUE);
  }
  public static function transformAssociativeValues(array $array1, array $array2, $value_if_not_exists = NULL) {
    $return = array();
    foreach ($array1 as $key => $value) {
      $return[$key] = array_key_exists($value, $array2) ? $array2[$value] : $value_if_not_exists;
    }
    return $return;
  }

  /**
   * Split an array into chunks more evenly then array_chunk().
   *
   * @param array $array
   *   An array of data to split up.
   * @param int $num
   *   The amount of chunks to create.
   * @param bool $preserve_keys
   *   When set to TRUE keys will be preserved. Default is FALSE which will
   *   reindex the chunk numerically
   *
   * @return array
   *   Returns a multidimensional numerically indexed array, starting with
   *   zero, with each dimension containing size elements.
   *
   * @see http://php.net/manual/en/function.array-chunk.php#75022
   * @throws \InvalidArgumentException
   */
  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;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ArrayHelper::chunkEvenly	public static	function	Split an array into chunks more evenly then array_chunk().
ArrayHelper::extractNestedValuesToArray	public static	function
ArrayHelper::filterByNestedValue	public static	function
ArrayHelper::filterKeys	public static	function	Filters keys of an array using a callback function.
ArrayHelper::getNestedValue	public static	function
ArrayHelper::mapKeys	public static	function	Applies the callback to the keys of the given array.
ArrayHelper::spliceAssociativeValues	public static	function
ArrayHelper::transformAssociativeValues	public static	function