array_replace_recursive
(PHP 5 >= 5.3.0)
array_replace_recursive — Рекурсивно заменяет элементы первого массива элементами переданных массивов
Описание
$array
, array $array1
[, array $...
] )
array_replace_recursive() заменяет значения первого массива
array на соответствующие по ключам
значения из всех следующих массивов.
Если ключ из первого массива есть во втором, его значение будет заменено
на значение из второго массива. Если ключ есть во втором массиве, но отсутствует в первом,
он будет создан в первом массиве. Если ключ есть только в первом массиве, то он остается как есть.
Если передано несколько массивов, они будут обработаны по порядку, последующие перезаписывают
предыдущие значения.
array_replace_recursive() - рекурсивная функция: она будет рекурсивно углубляться в массивы и применять к всем внутренним значениям один и тот же процесс.
Если значение, переданное в array является
скалярным, оно будет заменено значением в array1,
которое может быть как скалярным так и массивом.
Если оба значения, переданные в array и array1 -
массивы, array_replace_recursive() будет заменять их значения рекурсивно.
Список параметров
-
array -
Массив, элементы которого будут заменены.
-
array1 -
Массив, из которого будут взяты элементы для замены.
-
... -
Дополнительные массивы, из которых будут браться элементы для замены.
Возвращаемые значения
Возвращает array, или NULL, если произошла ошибка.
Примеры
Пример #1 Пример использования array_replace_recursive()
<?php
$base = array('citrus' => array( "orange") , 'berries' => array("blackberry", "raspberry"), );
$replacements = array('citrus' => array('pineapple'), 'berries' => array('blueberry'));
$basket = array_replace_recursive($base, $replacements);
print_r($basket);
$basket = array_replace($base, $replacements);
print_r($basket);
?>
Результат выполнения данного примера:
Array
(
[citrus] => Array
(
[0] => pineapple
)
[berries] => Array
(
[0] => blueberry
[1] => raspberry
)
)
Array
(
[citrus] => Array
(
[0] => pineapple
)
[berries] => Array
(
[0] => blueberry
)
)
Пример #2 array_replace_recursive() and recursive behavior
<?php
$base = array('citrus' => array("orange") , 'berries' => array("blackberry", "raspberry"), 'others' => 'banana' );
$replacements = array('citrus' => 'pineapple', 'berries' => array('blueberry'), 'others' => array('litchis'));
$replacements2 = array('citrus' => array('pineapple'), 'berries' => array('blueberry'), 'others' => 'litchis');
$basket = array_replace_recursive($base, $replacements, $replacements2);
print_r($basket);
?>
Результат выполнения данного примера:
Array
(
[citrus] => Array
(
[0] => pineapple
)
[berries] => Array
(
[0] => blueberry
[1] => raspberry
)
[others] => litchis
)
Смотрите также
- array_replace() - Замена элементов массива элементами других переданных массивов
- array_merge_recursive() - Рекурсивное слияние двух или более массивов
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Расширения, относящиеся к переменным и типам
- Массивы
- array_change_key_case
- array_chunk
- array_column
- array_combine
- array_count_values
- array_diff_assoc
- array_diff_key
- array_diff_uassoc
- array_diff_ukey
- array_diff
- array_fill_keys
- array_fill
- array_filter
- array_flip
- array_intersect_assoc
- array_intersect_key
- array_intersect_uassoc
- array_intersect_ukey
- array_intersect
- array_key_exists
- array_keys
- array_map
- array_merge_recursive
- array_merge
- array_multisort
- array_pad
- array_pop
- array_product
- array_push
- array_rand
- array_reduce
- array_replace_recursive
- array_replace
- array_reverse
- array_search
- array_shift
- array_slice
- array_splice
- array_sum
- array_udiff_assoc
- array_udiff_uassoc
- array_udiff
- array_uintersect_assoc
- array_uintersect_uassoc
- array_uintersect
- array_unique
- array_unshift
- array_values
- array_walk_recursive
- array_walk
- array
- arsort
- asort
- compact
- count
- current
- each
- end
- extract
- in_array
- key_exists
- key
- krsort
- ksort
- list
- natcasesort
- natsort
- next
- pos
- prev
- range
- reset
- rsort
- shuffle
- sizeof
- sort
- uasort
- uksort
- usort
Коментарии
This might help out people who don't have 5.3 running:
<?php
// Joins two or more arrays together recursively; key/value pairs of the first
// array are replaced with key/value pairs from the subsequent arrays. Any
// key/value pair not present in the first array is added to the final array
function array_join()
{
// Get array arguments
$arrays = func_get_args();
// Define the original array
$original = array_shift($arrays);
// Loop through arrays
foreach ($arrays as $array)
{
// Loop through array key/value pairs
foreach ($array as $key => $value)
{
// Value is an array
if (is_array($value))
{
// Traverse the array; replace or add result to original array
$original[$key] = array_join($original[$key], $array[$key]);
}
// Value is not an array
else
{
// Replace or add current value to original array
$original[$key] = $value;
}
}
}
// Return the joined array
return $original;
}
?>
Nice that this function finally found its was to the PHP core! If you want to use it also with older PHP versions before 5.3.0, you can define it this way:
<?php
if (!function_exists('array_replace_recursive'))
{
function array_replace_recursive($array, $array1)
{
function recurse($array, $array1)
{
foreach ($array1 as $key => $value)
{
// create new key in $array, if it is empty or not an array
if (!isset($array[$key]) || (isset($array[$key]) && !is_array($array[$key])))
{
$array[$key] = array();
}
// overwrite the value in the base array
if (is_array($value))
{
$value = recurse($array[$key], $value);
}
$array[$key] = $value;
}
return $array;
}
// handle the arguments, merge one by one
$args = func_get_args();
$array = $args[0];
if (!is_array($array))
{
return $array;
}
for ($i = 1; $i < count($args); $i++)
{
if (is_array($args[$i]))
{
$array = recurse($array, $args[$i]);
}
}
return $array;
}
}
?>
I called this function array_merge_recursive_overwrite() in my older projects, but array_replace_recursive() sounds quite better while they do the same.
If you implemented such a compatible function before and don't want to refactor all your code, you can update it with the following snippet to use the native (and hopefully faster) implementation of PHP 5.3.0, if available. Just start your function with these lines:
<?php
// as of PHP 5.3.0 array_replace_recursive() does the work for us
if (function_exists('array_replace_recursive'))
{
return call_user_func_array('array_replace_recursive', func_get_args());
}
?>
This is a fairly concise version which does not rely on traditional recursion:
<?php
function array_replace_recursive($base, $replacements)
{
foreach (array_slice(func_get_args(), 1) as $replacements) {
$bref_stack = array(&$base);
$head_stack = array($replacements);
do {
end($bref_stack);
$bref = &$bref_stack[key($bref_stack)];
$head = array_pop($head_stack);
unset($bref_stack[key($bref_stack)]);
foreach (array_keys($head) as $key) {
if (isset($key, $bref) && is_array($bref[$key]) && is_array($head[$key])) {
$bref_stack[] = &$bref[$key];
$head_stack[] = $head[$key];
} else {
$bref[$key] = $head[$key];
}
}
} while(count($head_stack));
}
return $base;
}
?>
If you came here looking for a function to recursively find and replace (scalar) values in an array (also recurses through objects):
<?php
define('RECURSIVE_REPLACE_MARKER', 'recursive_replace_r47yr74yr7623t74r3645236rtvghdcbnsgxbt67g5e21873891');
/**
* Recursively replaces scalar values in objects and arrays. The passed array or object is altered in place.
* @param mixed $data An object or array.
* @param mixed $find The scalar value to find.
* @param mixed $replace The value to replace with (need not be a scalar).
*/
function recursive_replace(&$data, $find, $replace){
if(is_array($data)) {
if (!isset($data[RECURSIVE_REPLACE_MARKER])) {
$data[RECURSIVE_REPLACE_MARKER] = TRUE;
foreach($data as $key=>$val) {
if(is_array($data[$key]) || is_object($data[$key])) {
recursive_replace($data[$key], $find, $replace);
}
else{
if($data[$key] === $find) {
$data[$key] = $replace;
}
}
}
unset($data[RECURSIVE_REPLACE_MARKER]);
}
}
elseif (is_object($data)) {
if (!isset($data->RECURSIVE_REPLACE_MARKER)) {
$data->RECURSIVE_REPLACE_MARKER = TRUE;
foreach($data as $key=>$val) {
if(is_array($data->$key) || is_object($data->$key)){
recursive_replace($data->$key, $find, $replace);
}else{
if($data->$key === $find) {
$data->$key = $replace;
}
}
}
unset($data->RECURSIVE_REPLACE_MARKER);
}
}
}
?>
Note that the use of the word "replace" in the function's description is a bit misleading... as none of the parameters are passed by reference, it does not actually replace anything... this simply describes from which parameter the resulting values come.Note that function will NOT replace a sub-tree from you $array1 if its value in $array2 is an empty array.
Even tho the key for this dimension is technically 'set'.
(I suppose it treats it as just another recursive level to dive in, finding no key to compare, backtracking while leaving this sub-tree alone)
For example:
$array1 = ['first' => ['second' => 'hello']];
$array2 = ['first' => []];
$result = array_replace_recursive($array1, $array2);
$result is still: ['first' => ['second' => 'hello']].
It seemed to me that the first argument is passed by reference, so it will contain the results of this operation, but experiment shows that this is not true. The array value from the first argument is modified by each succeeding argument, and the result is returned to the caller. The array passed as the first argument is not modified.