/www/libs/nette-dev/ArrayTools.php
PHP | 157 lines | 65 code | 27 blank | 65 comment | 9 complexity | bd27caff6c9fd70e33ac6dabb7c884b6 MD5 | raw file
Possible License(s): BSD-3-Clause, MIT
- <?php
- /**
- * Nette Framework
- *
- * @copyright Copyright (c) 2004, 2010 David Grudl
- * @license http://nettephp.com/license Nette license
- * @link http://nettephp.com
- * @category Nette
- * @package Nette
- */
- /**
- * Array tools library.
- *
- * @copyright Copyright (c) 2004, 2010 David Grudl
- * @package Nette
- */
- final class ArrayTools
- {
- /**
- * Static class - cannot be instantiated.
- */
- final public function __construct()
- {
- throw new LogicException("Cannot instantiate static class " . get_class($this));
- }
- /**
- * Returns array item or $default if item is not set.
- * Example: $val = ArrayTools::get($arr, 'i', 123);
- * @param mixed array
- * @param mixed key
- * @param mixed default value
- * @return mixed
- */
- public static function get(array $arr, $key, $default = NULL)
- {
- foreach (is_array($key) ? $key : array($key) as $k) {
- if (is_array($arr) && array_key_exists($k, $arr)) {
- $arr = $arr[$k];
- } else {
- return $default;
- }
- }
- return $arr;
- }
- /**
- * Returns reference to array item or $default if item is not set.
- * @param mixed array
- * @param mixed key
- * @return mixed
- */
- public static function & getRef(& $arr, $key)
- {
- foreach (is_array($key) ? $key : array($key) as $k) {
- if (is_array($arr) || $arr === NULL) {
- $arr = & $arr[$k];
- } else {
- throw new InvalidArgumentException('Traversed item is not an array.');
- }
- }
- return $arr;
- }
- /**
- * Recursively appends elements of remaining keys from the second array to the first.
- * @param array
- * @param array
- * @return array
- */
- public static function mergeTree($arr1, $arr2)
- {
- $res = $arr1 + $arr2;
- foreach (array_intersect_key($arr1, $arr2) as $k => $v) {
- if (is_array($v) && is_array($arr2[$k])) {
- $res[$k] = self::mergeTree($v, $arr2[$k]);
- }
- }
- return $res;
- }
- /**
- * Searches the array for a given key and returns the offset if successful.
- * @param array input array
- * @param mixed key
- * @return int offset if it is found, FALSE otherwise
- */
- public static function searchKey($arr, $key)
- {
- $foo = array($key => NULL);
- return array_search(key($foo), array_keys($arr), TRUE);
- }
- /**
- * Inserts new array before item specified by key.
- * @param array input array
- * @param mixed key
- * @param array inserted array
- * @return void
- */
- public static function insertBefore(array &$arr, $key, array $inserted)
- {
- $offset = self::searchKey($arr, $key);
- $arr = array_slice($arr, 0, $offset, TRUE) + $inserted + array_slice($arr, $offset, count($arr), TRUE);
- }
- /**
- * Inserts new array after item specified by key.
- * @param array input array
- * @param mixed key
- * @param array inserted array
- * @return void
- */
- public static function insertAfter(array &$arr, $key, array $inserted)
- {
- $offset = self::searchKey($arr, $key);
- $offset = $offset === FALSE ? count($arr) : $offset + 1;
- $arr = array_slice($arr, 0, $offset, TRUE) + $inserted + array_slice($arr, $offset, count($arr), TRUE);
- }
- /**
- * Renames key in array.
- * @param array
- * @param mixed old key
- * @param mixed new key
- * @return void
- */
- public static function renameKey(array &$arr, $oldKey, $newKey)
- {
- $offset = self::searchKey($arr, $oldKey);
- if ($offset !== FALSE) {
- $keys = array_keys($arr);
- $keys[$offset] = $newKey;
- $arr = array_combine($keys, $arr);
- }
- }
- }