Функция cot_display_message в Cotonti

Функция cot_display_messages используется для отображения различных типов сообщений (ошибок, предупреждений и успешных сообщений) на веб-странице, используя систему шаблонов.

Код функции cot_display_messages:

function cot_display_messages($tpl, $block = 'MAIN')
{
    global $L;
    
    // Проверяем, есть ли сообщения для отображения
    if (!cot_check_messages())
    {
        // Если нет сообщений, просто выходим
        return;
    }
    
    // Обрабатываем блок шаблона
    $block = (!empty($block)) ? $block.'.' : '';
    
    // Получаем все ошибки
    $errors = cot_get_messages('', 'error');
    
    // Если есть ошибки, выводим их
    if (count($errors) > 0)
    {
        // Для каждой ошибки
        foreach ($errors as $msg)
        {
            // Переводим текст ошибки с использованием языковых строк
            $text = isset($L[$msg['text']]) ? $L[$msg['text']] : $msg['text'];
            // Присваиваем текст ошибки в шаблон
            $tpl->assign('ERROR_ROW_MSG', $text);
            // Парсим шаблон строки ошибки
            $tpl->parse($block.'ERROR.ERROR_ROW');
        }
        // Парсим основной блок ошибок
        $tpl->parse($block.'ERROR');
    }
    
    // Получаем все предупреждения
    $warnings = cot_get_messages('', 'warning');
    
    // Если есть предупреждения, выводим их
    if (count($warnings) > 0)
    {
        // Для каждого предупреждения
        foreach ($warnings as $msg)
        {
            // Переводим текст предупреждения с использованием языковых строк
            $text = isset($L[$msg['text']]) ? $L[$msg['text']] : $msg['text'];
            // Присваиваем текст предупреждения в шаблон
            $tpl->assign('WARNING_ROW_MSG', $text);
            // Парсим шаблон строки предупреждения
            $tpl->parse($block.'WARNING.WARNING_ROW');
        }
        // Парсим основной блок предупреждений
        $tpl->parse($block.'WARNING');
    }
    
    // Получаем все успешные сообщения
    $okays = cot_get_messages('', 'ok');
    
    // Если есть успешные сообщения, выводим их
    if (count($okays) > 0)
    {
        // Для каждого успешного сообщения
        foreach ($okays as $msg)
        {
            // Переводим текст сообщения с использованием языковых строк
            $text = isset($L[$msg['text']]) ? $L[$msg['text']] : $msg['text'];
            // Присваиваем текст успешного сообщения в шаблон
            $tpl->assign('DONE_ROW_MSG', $text);
            // Парсим шаблон строки успешного сообщения
            $tpl->parse($block.'DONE.DONE_ROW');
        }
        // Парсим основной блок успешных сообщений
        $tpl->parse($block.'DONE');
    }
    
    // Очищаем все сообщения, чтобы избежать их повторного отображения
    cot_clear_messages();
}

 

Пошаговое объяснение функции cot_display_message:

Параметры функции cot_display_messages:

1. $tpl (XTemplate): Тип: объект.

Описание: Это объект текущего шаблона. В данном случае, объект класса XTemplate, который управляет HTML-шаблоном. Этот объект используется для привязки данных к шаблону и вывода контента.
Назначение: Функция использует объект шаблона $tpl, чтобы присвоить текст сообщений (ошибок, предупреждений, успешных действий) к различным переменным шаблона и отобразить их в нужных местах. Используются методы assign и parse для обновления и обработки блоков шаблона.

2. $block (string, по умолчанию 'MAIN'): Тип: строка

Описание: Определяет, какой блок шаблона будет использоваться для вывода сообщений. По умолчанию используется блок 'MAIN', но при необходимости можно передавать и другие блоки, чтобы сообщения отображались в разных частях страницы.
Назначение: Этот параметр влияет на то, как будет формироваться имя блока, который будет использован для отображения сообщений. Например, если в параметре передано 'FOOTER', то сообщения будут привязаны к блоку FOOTER.

 

Глобальные переменные:

В первой строке функции используется глобальная переменная $L, которая содержит языковые строки для перевода сообщений.

Проверка наличия сообщений:

cot_check_messages() проверяет, есть ли сообщения для отображения. Если нет, функция завершится на этом этапе, ничего не выводя.

Обработка блока шаблона:

Если параметр $block не пустой, добавляется точка (.) в конец, чтобы указать блок, в котором будут отображаться сообщения. Это может быть полезно для отображения сообщений в разных частях страницы (например, ошибки могут выводиться в одном блоке, а успешные сообщения в другом).

Получение сообщений об ошибках:

С помощью функции cot_get_messages('', 'error') получаем все ошибки, которые нужно отобразить.
Если ошибки есть, для каждой из них выполняется следующее:
Текст ошибки переводится с помощью языковых строк из массива $L (если такой текст существует).
Текст ошибки передается в шаблон с помощью $tpl->assign('ERROR_ROW_MSG', $text).
Шаблон строки ошибки парсится с помощью $tpl->parse($block.'ERROR.ERROR_ROW').
После этого весь блок ошибок парсится с помощью $tpl->parse($block.'ERROR').

Получение предупреждений:

Аналогично обработке ошибок, но для сообщений с типом 'warning'. Они получаются с помощью cot_get_messages('', 'warning'), и выводятся в том же формате.

Получение успешных сообщений:

Аналогично предыдущим этапам, но для успешных сообщений с типом 'ok'. Сообщения выводятся с помощью шаблона для успешных сообщений.

Очищение сообщений:

После того как все сообщения были отображены, вызывается cot_clear_messages(), чтобы очистить их и предотвратить повторное отображение на следующей странице.

пример использования функции cot_display_messages выглядит следующим образом:
 

$t = new XTemplate($mskin);
// Error and message handling
cot_display_messages($t);

Объяснение шагов:
Создание экземпляра шаблона:

$t = new XTemplate($mskin);

Здесь создается объект $t класса XTemplate и в конструктор передается переменная $mskin, которая, скорее всего, содержит путь к файлу шаблона или имя шаблона (например, 'default.tpl'). Этот объект $t будет использоваться для рендеринга шаблона страницы, на котором будут отображаться сообщения.
Вызов функции cot_display_messages($t):

cot_display_messages($t);

Эта строка вызывает функцию cot_display_messages и передает в нее объект шаблона $t. Основная цель этой функции — отобразить все типы сообщений, такие как ошибки, предупреждения и успешные сообщения, на веб-странице.

Пояснение работы:

Передача шаблона в функцию: Функция cot_display_messages использует переданный объект $t (в данном случае — экземпляр XTemplate) для добавления сообщений на страницу. Этот объект $t предоставляет методы для работы с шаблонами и их содержимым, например, assign() и parse(), которые позволяют добавлять динамическое содержимое в шаблон.

Рендеринг сообщений:

Внутри функции cot_display_messages:

Если есть сообщения об ошибках, предупреждениях или успешных действиях, они будут добавлены в шаблон с помощью

$tpl->assign() и $tpl->parse()

Например, если есть ошибки, они будут вставлены в шаблон в определенный блок, такой как ERROR_ROW_MSG, и затем будет выполнен парсинг шаблона для отображения этих сообщений.
Окончательное отображение: После того как все сообщения были добавлены в шаблон, будет вызван метод $tpl->out('MAIN'), чтобы вывести итоговый результат на экран, где 'MAIN' — это основной блок шаблона. В этом блоке будут отображаться ошибки, предупреждения и успешные сообщения, если они были.

Пример:
Допустим, в вашем приложении есть некая ошибка, и вы вызываете функцию cot_display_messages для отображения этой ошибки на странице. Код будет выглядеть так:

В коде возникла ошибка:

cot_error('Some error occurred');

При рендеринге страницы:

$t = new XTemplate('mytemplate.tpl');
cot_display_messages($t);

Функция cot_display_messages проверяет, есть ли сообщения об ошибках, и если есть, она добавляет их в шаблон $t.

В результате, в шаблоне mytemplate.tpl будет отображено сообщение об ошибке, вставленное в соответствующий блок шаблона (например, <div class="error">Some error occurred</div>).

Заключение:

В данном контексте функция cot_display_messages($t) управляет выводом сообщений (ошибок, предупреждений и успешных сообщений) на страницу, используя переданный объект шаблона $t. Это позволяет динамически отображать сообщения, улучшая взаимодействие с пользователем, а также улучшая обработку ошибок и уведомлений.

Функция cot_display_messages эффективно выводит ошибки, предупреждения и успешные сообщения на странице, используя систему шаблонов Cotonti. Она также обеспечивает поддержку перевода сообщений через языковые строки и очищает сообщения после их отображения.