Вложенные циклы — PHP: Массивы

Во многих языках программирования есть очень полезная функция flatten. В определённых задачах она сильно упрощает жизнь и сокращает количество кода. flatten принимает на вход массив и выправляет его: если элементами массива являются массивы, то flatten сводит все к одному массиву, раскрывая каждый вложенный.

Посмотрим на пример:

<?php

flatten([[3, 2], 5, 3, [3, [4, 2]], 10]);
// [3, 2, 5, 3, 3, 4, 2, 10]

Давайте напишем функцию flatten(). В общем случае эта функция раскрывает массивы на всех уровнях вложенности. Но мы для простоты сделаем вариант функции, в котором происходит раскрытие только до первого уровня. То есть, если элемент основного массива — массив, то он раскрывается без просмотра его внутренностей (там тоже могут быть массивы).

Логика работы функции выглядит так:

1. Инициализируем массив-результат, в который запишутся все значения.
2. Итерируем (проходим) по основному массиву и проверяем текущий элемент.
3. Если текущий элемент — не массив, то добавляем его в массив-результат и идём дальше.
4. Если текущий элемент — массив, то начинаем вложенный цикл, внутри которого идём по массиву и добавляем каждый его элемент в массив-результат.
5. Возвращаем массив-результат.

<?php

function flatten($coll)
{
    $result = [];
    foreach ($coll as $item) {
        // is_array - функция (предикат) стандартной библиотеки
        // которая проверяет, является ли значение массивом.
        if (is_array($item)) {
            // Если значение массив, то проходим по всем его элементам
            // Здесь появился вложенный цикл
            foreach ($item as $subitem) {
                // и добавляем их в результирующий массив
                $result[] = $subitem;
            }
        } else {
            // Если значение не массив, то сразу добавляем его в результирующий массив
            $result[] = $item;
        }
    }

    return $result;
}

print_r(flatten([3, 2, [], [3, 4, 2], 3, [123, 3]]));
// => Array
// => (
// =>     [0] => 3
// =>     [1] => 2
// =>     [2] => 3
// =>     [3] => 4
// =>     [4] => 2
// =>     [5] => 3
// =>     [6] => 123
// =>     [7] => 3
// => )

https://repl.it/@hexlet/php-arrays-nested-loops-flatten

Обратите внимание, что вложенный цикл запускается, только если текущий элемент — массив. Чисто технически во вложенных циклах нет ничего особенного. Их можно вкладывать внутрь любого блока и друг в друга сколько угодно раз. Но прямой связи между внешним и вложенным нет. Внутренний цикл может использовать результаты внешнего, а может и работать по своей собственной логике независимо.

Вложенные циклы коварны. Их наличие может резко увеличить сложность кода, так как появляется множество постоянно изменяющихся переменных. Становится тяжело уследить за происходящими внутри процессами. Кроме того, вложенные циклы могут указывать на использования не эффективного алгоритма решения задачи. Это не всегда так, но вероятность такая есть.

Как избавиться от вложенных циклов? Есть два варианта. Первый – переписать алгоритм так, чтобы вложенного цикла не осталось вообще, даже в вызываемых функциях. Когда это невозможно – использовать второй вариант. Вынести вложенный цикл в функцию, либо заменить на встроенную функцию. Например в PHP есть функция array_search, которая внутри себя представляет, ни что иное, как обход массива в цикле.

<?php

// Эта функция заменяет собой цикл
// Но не забывайте что внутри все равно остается полный обход массива
array_search(10, [1, 10, 3]); // 1

Пример выноса в отдельную функцию кода на flatten:

<?php

function concat($result, $items)
{
    foreach ($items as $item) {
        $result[] = $item;
    }
    return $result;
}

function flatten($coll)
{
    $result = [];
    foreach ($coll as $item) {
        if (is_array($item)) {
            $result = concat($result, $item);
        } else {
            $result[] = $item;
        }
    }

    return $result;
}

print_r(flatten([3, 2, [], [3, 4, 2], 3, [123, 3]]));

Этот код можно сделать еще проще, если использовать встроенную функцию array_merge(). Тогда код слияния массивов будет выглядеть так:

<?php

$result = array_merge($result, $item);

Остались вопросы? Задайте их в разделе «Обсуждение»

Вам ответят команда поддержки Хекслета или другие студенты.