Использование $APPLICATION->RestartBuffer() в связке с AJAX-запросами

Что такое $APPLICATION->RestartBuffer()?

Метод $APPLICATION->RestartBuffer() используется для сброса буфера вывода в 1С-Битрикс. Это значит, что все данные, которые были выведены до вызова этого метода, будут удалены, включая шаблон страницы. Таким образом, вы сможете начать выводить новые данные.

Пример использования: автоматическое обновление элементов на странице

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

• Обернуть шаблон списка новостей (например, компонент news.list) в проверку на наличие AJAX-запроса.
• В случае AJAX-запроса вызвать $APPLICATION->RestartBuffer(), чтобы исключить все, кроме новостей, из ответа.
• В конце выполнения скрипта вызвать die(), чтобы прервать дальнейшее выполнение и отправить только обновленный блок.

// файл template.php вашего списка новостей
use Bitrix\Main\Application;
$request = Application::getInstance()->getContext()->getRequest();
if ($request->isAjaxRequest()) {
    // Если это AJAX запрос Очистка буфера вывода, чтобы в ответе были только новости
    // По сути "отрезаем" весь вывод до сюда
    $APPLICATION->RestartBuffer();
}
foreach ($arResult["ITEMS"] as $arItem) {
    // шаблон компонента новостей
    // ...
}
if ($request->isAjaxRequest()) {
    // Если это AJAX запрос прекращаем "создавать" страницу
    die();
}

На страницу, где планируется вывод новостей (запросом с другой страницы), добавляем JavaScript для автоматического обновления блока и блок, в который будет вставляться ответ:

<div id="news-container"></div>
<script>
setInterval(function () {
    fetch('/news/index.php') // Путь к странице источнику
        .then(response => response.text())
        .then(data => {
            document.getElementById('news-container').innerHTML = data;
        });
}, 10000); // обновлять каждые 10 секунд
</script>

Да, пример немного "надуманный", Но для понимания работы метода, более чем уместен. Для решения описанной задачи можно было вывести компонент на страницу и обновлять его AJAX запросом без $APPLICATION->RestartBuffer().

Обработка формы обратной связи с JSON-ответом

Более наглядный пример работы. Предположим, на странице есть форма которая отправляет запрос к самой себе (обработчик формы находится по этому же адресу). Нужно "обрезать" шаблон сайта при получении результата:

use Bitrix\Main\Application;
$request = Application::getInstance()->getContext()->getRequest();
if ($request->isAjaxRequest()) {
    $APPLICATION->RestartBuffer();
    // Обработка данных формы
    $name = $request->getPost('name');
    $email = $request->getPost('email');
    // Здесь можно добавить логику для сохранения данных или отправки email
    // Формируем ответ
    $response = [
        'status' => 'success',
        'message' => 'Спасибо за ваше сообщение, ' . htmlspecialchars($name) . '!'
    ];
    // Отправляем JSON-ответ
    header('Content-Type: application/json');
    echo json_encode($response);
    die();
}

Может пригодиться заметка:
Работа с HTTP-запросами в Bitrix

В этом примере, если запрос является AJAX-запросом, мы очищаем буфер вывода, обрабатываем данные формы и отправляем JSON-ответ с сообщением об успешной отправке.