Генерация строки в цикле — PHP: Массивы

Генерация строк в циклах — это частая задача в работе программиста, часто возникающая на практике. Типичный пример в вебе — функция-хелпер, помогающая генерировать HTML-списки в шаблонах. Она принимает на вход коллекцию элементов и возвращает список из них:

<?php

$coll = ['milk', 'butter', 'eggs', 'bread'];
buildList($coll);
// <ul><li>milk</li><li>butter</li><li>eggs</li><li>bread</li></ul>

Самый примитивный алгоритм, который приходит в голову — пройтись циклом по элементам коллекции и дописать в результирующую строку очередной тег <li>. В начале и конце нужно добавить <ul> и вернуть строчку наружу:

<?php

$result = '';
foreach ($coll as $item) {
    $result .= "<li>{$item}</li>";
    // либо так
    // $result = "{$result}<li>{$item}</li>";
}
$result = "<ul>{$result}</ul>";

Такой способ вполне рабочий, но для большинства языков программирования он максимально неэффективен.

Дело в том, что конкатенация и интерполяция порождают новую строчку вместо старой. И подобная ситуация повторяется на каждой итерации, причем строка становится все больше и больше. Копирование строк приводит к серьезному расходу памяти и может влиять на производительность.

Конечно, для большинства приложений эта проблема не так актуальна из-за небольшого объема прогоняемых данных. Тем не менее лучше использовать более эффективный подход, ведь он не сложнее в реализации и обладает дополнительными плюсами. Лучше сразу приучиться работать правильно и никогда больше не возвращаться к этому вопросу.

В статических языках для подобной цели используется String Buffer, а в динамических — обычный массив. Перепишем программу выше, используя эти новые знания:

<?php

$parts = []; // Меняем имя, чтобы не менять значения переменной
foreach ($coll as $item) {
    $parts[] = "<li>{$item}</li>";
}
$innerValue = implode('', $parts);
$result = "<ul>{$innerValue}</ul>";

Как видите, код не сильно поменялся. Разница в том, что теперь он собирает массив вместо строки, а в конце выдает строку с помощью implode. Помимо эффективности у такого подхода есть дополнительные плюсы:

• Такой код проще отлаживать и анализировать внутренности
• Массив можно дополнительно обработать при необходимости, а строку — уже нет

Регулируя разделитель, строки можно объединять разными способами. Например, через запятую:

<?php

$parts = ['JavaScript', 'PHP', 'Python'];

$output = implode(',', $parts);

print_r($output); // => JavaScript,PHP,Python

Пробел после запятой добавит пространство между словами, сделает вывод более аккуратным:

<?php

$parts = ['JavaScript', 'PHP', 'Python'];

$output = implode(', ', $parts); // Поменяли разделитель и добавили пробел

print_r($output); // => JavaScript, PHP, Python

Если каждое слово надо вывести на новой строчке, то в качестве разделителя используем символ перевода строки "\n":

<?php

$parts = ['JavaScript', 'PHP', 'Python'];

$output = implode("\n", $parts);
// Теперь каждое слово будет начинаться с новой строки
// или с предопределенной константой
// $output = implode(PHP_EOL, $parts);

print_r($output); // =>
// JavaScript
// PHP
// Python

Дополнительные материалы

1. Джоэль Спольски. Назад к основам (английская версия)