alkemann\h2l\util\ArrayManipulations

Complexity

Total Complexity

7

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getFromArrayByKey()	0	7	2
B	getArrayValueByKeys()	0	13	5

<?php

namespace alkemann\h2l\util;

use OutOfBoundsException;

/**
 * Class Util
 *
 * @package alkemann\h2l
 */
class ArrayManipulations
{
    /**
     * Look for a deeo value in a nested data array.
     *
     * Given $data = ['one' => ['two' => ['three' => 55]], 'four' => []];
     *
     * ```php
     *  getFromArrayByKey('one.two.three', $data) -> 55
     *  getFromArrayByKey('one|two', $data, '|') -> ['three' => 55]
     *  getFromArrayByKey('four.five', $data) -> throws OutOfBoundsException
     * ```
     *
     * @param string $key
     * @param array $data
     * @param string $delimiter
     * @return mixed|null
     */
    public static function getFromArrayByKey(string $key, array $data, string $delimiter = '.')
    {
        $keys = explode($delimiter, $key);
        try {
            return self::getArrayValueByKeys($keys, $data);
        } catch (\OutOfBoundsException $e) {
            return null;
        }
    }

    /**
     * Look for a deep value in a data array.
     *
     * Given $data = ['one' => ['two' => ['three' => 55]], 'four' => []];
     *
     * ```php
     *  getArrayValueByKeys(['one','two','three'], $data) will return 55
     *  getArrayValueByKeys(['four','five'], $data) will throw OutOfBoundsException
     * ```
     *
     * @param  mixed $keys
     * @param  mixed $data passed by reference
     * @return mixed
     * @throws OutOfBoundsException if the key does not exist in data
     */
    public static function getArrayValueByKeys(array $keys, &$data)
    {
        $key = array_shift($keys);
        if (!is_array($data) || empty($key)) {
            return $data;
        }
        if (array_key_exists($key, $data) === false) {
            throw new OutOfBoundsException("Key [" . join('.', $keys) . ".$key] not set in " . print_r($data, 1));
        }
        if (empty($keys)) {
            return $data[$key];
        } else {
            return self::getArrayValueByKeys($keys, $data[$key]);
        }
    }
}