Правильно ли я строю HTML конструкции на PHP?

Question

[IvanIF]

У меня есть динамически изменяющийся HTML-список пользователей. В качестве элементов списка пользователей выступают HTML-ссылки, которые я формирую через PHP-функцию. Правильно ли я это делаю? Может есть более простой способ, о котором я не знаю? Это пример с простым HTML, а если надо будет сформировать HTML-код длинной 2500 символов?

$user_html_entity =
    '
    <a href="/user/' . $user_id . '" class="user" data-id="users___user_link">
      <div class="section_900">
        <!-- ## -->
        <img src="' . $user_avatar_link . '" />
        <!-- ## -->
        <div class="no_image_content">
          <p class="nickname">' . $user_nickname . '</p>
          <p class="online_status">' . Get_Online_Status_From_Datetime($user_last_online_datetime) . '</p>
          <p class="initials">' . $user_initials_info_string . '</p>
          <p class="location">' . $user_location_string . '</p>
        </div>
        <!-- ## -->
      </div>
    </a>
    '
    ;

Comments

[edward_freedom]

ты хочешь, чтобы разметку генерировал сервер или ты допускаешь возможность, которую возможно не знаешь, чтобы вернуть на клиента json и на js отрендерить разметку?

[FanatPHP]

Я ничего не понял.
Это разметка на одного пользователя будет длинной 2500 символов или на всех?

[IvanIF]

FanatPHP, на одного. В том смысле, что, если сам шаблон будет очень большим, то легко запутаться. Поэтому спрашиваю, правильно ли я делаю...

Answer 1

[lUser L]

Никогда так не делайте, не слушайте тех, кто будет говорить и советовать подобное. Вместо этой каши используй шаблонизаторы, возьми twig, он лёгкий в освоении. Так хоть 3к строк можешь писать (на самом деле не стоит писать 3к строк в одном twig шаблоне, лучше разбивать html на парты).
Главное всегда разделять логику и представление

$user_html_entity =
    '
    <a href="/user/' . $user_id . '" class="user" data-id="users___user_link">
      <div class="section_900">
        <!-- ## -->
        <img src="' . $user_avatar_link . '" />
        <!-- ## -->
        <div class="no_image_content">
          <p class="nickname">' . $user_nickname . '</p>
          <p class="online_status">' . Get_Online_Status_From_Datetime($user_last_online_datetime) . '</p>
          <p class="initials">' . $user_initials_info_string . '</p>
          <p class="location">' . $user_location_string . '</p>
        </div>
        <!-- ## -->
      </div>
    </a>
    '
    ;

Я всегда проклинаю тех, кто пишет такой код. Все из-за влияния ужасного, мерзкого, неимоверно отвратительного WP.

spoiler

Get_Online_Status_From_Datetime($user_last_online_datetime)

А именовать функции так, это вообще отдельная история...

Comments

[IvanIF]

А именовать функции так, это вообще отдельная история...

А как надо?

[FanatPHP]

я ничего не понял из этой тирады

[lUser L]

IvanIF, либо camelCase либо snake_case

[lUser L]

FanatPHP, ладно. Я тоже не ничего не понял, но из очевидного - ужасный код, каша из phphtml. Дал совет, как мне кажется весьма дельный

[FrelFrloich]

Попробуй что то вроде этого, yii из коробки и смотрится вроде ничего

if (empty($rows) && $this->emptyText !== false) {
            $colspan = count($this->columns);
            return "<div>\n<div><div colspan=\"$colspan\">" . $this->renderEmpty() . "</div></div>\n</div>";
        }
        return '<div class="flex-row wrapper--result-table">' . "\n" . implode("\n", $rows) . "\n</div>";

[Immortal_pony]

Эмиль 🔥 Зачем рекомендовать изучение шаблонизаторов, когда PHP сам себе шаблонизатор?
И без всяких шаблонизаторов можно отделять логику от представления

IvanIF вот вам про стандарты оформления кода.
https://svyatoslav.biz/misc/psr_translation/#_PSR-1
https://svyatoslav.biz/misc/psr_translation/#_PSR-2

Если сможете читать в оригинале - ещё лучше: https://www.php-fig.org/psr/psr-2/

[Adamos]

Immortal_pony, например, вы в своем ответе используете РНР не как шаблонизатор (вызывая функцию посреди шаблона, как и ТС).

[Immortal_pony]

Adamos Во-первых, в моём примере от этого легко можно избавиться. Во-вторых, шаблонизаторы в общем и вышеупомянутый Twig в частности такое тоже сделать позволяют.

Answer 2

[Immortal_pony]

Шаблоны выносить в отдельные файлы.
Если тебе нужно весь этот HTML складывать в переменную, то вот тебе волшебная функция:

function render($part, array $vars=[]) {
    extract($vars);
    ob_start();
    require __DIR__ . "/views/" . $part . ".php"; // путь тут поправь в соответствии с твоими реалиями
    return ob_get_clean();    
}

Всё, дальше свои шаблоны можешь складывать в папке /views.
Итого, в твоем исходном файле будет вот такой код вместо твоей портянки:

$user_html_entity = render("user_entity", compact(
    "user_id", 
    "user_avatar_link", 
    "user_nickname",
    "user_last_online_datetime",
    "user_initials_info_string",
    "user_location_string"
));

А, твой шаблон будет лежать красиво отдельно и там будет HTML с минимальным количеством PHP для вывода динамически генерируемых данных.

Вот так примерно:

<a href="/user/<?= $user_id ?>" class="user" data-id="users___user_link">
    <div class="section_900">
        <img src="<?= $user_avatar_link ?>">
        <div class="no_image_content">
            <p class="nickname"><?= $user_nickname ?></p>
            <p class="online_status"><?= Get_Online_Status_From_Datetime($user_last_online_datetime) ?></p>
            <p class="initials"><?= $user_initials_info_string ?></p>
            <p class="location"><?= $user_location_string ?></p>
        </div>
    </div>
</a>

PS Волшебную функцию можно будет использовать и внутри самого шаблона, так что если у тебя будет много кода, который надо будет побить на меньшие кусочки, то и это ты легко сможешь сделать

Comments

[Adamos]

Вы, конечно, красиво переоформили говнокод, но в случае ошибки в той самой вызванной посреди верстки функции вывод перекосоебит ровно так же.

[Immortal_pony]

Adamos, это другая проблема и существует не один способ её решить.

[Adamos]

Immortal_pony, например, использование шаблонизаторов по назначению - только для вывода готовых данных. Любые возможные ошибки должны произойти до того и уйти другим путем.

[Immortal_pony]

Adamos, да, это вполне подходящее решение.
Думаю, что автор вполне справится с доработкой кода согласно вашим рекомендациям, если ему понадобится решить подобную проблему.