Класс: JsonResponse¶
Краткое содержание:¶
JSON-ответ AJAX с единым контрактом success/data/notice/error.
Свойства¶
Нет публичных свойств.
Методы¶
- public __construct()
- public toast()
- public ok()
- public notify()
- public fail()
- private noticePayload()
- private build()
- public send()
Подробности¶
- Путь:
devcraft/src/classes/Http/JsonResponse.php
Детали¶
Методы¶
__construct()¶
Создаёт JSON-ответ с заданным телом и HTTP-кодом.
С версии: 200.4.0
Параметры: - $status_code — HTTP-статус.
toast()¶
Формирует успешный ответ с toast-уведомлением.
С версии: 200.4.0
Параметры: - $message — Текст toast. - $status — HTTP-статус.
Возвращает: self — Экземпляр JSON-ответа.
ok()¶
Формирует успешный ответ без обязательного уведомления.
С версии: 200.4.0
Параметры: - $toastMessage — Необязательный текст toast.
Возвращает: self — Экземпляр JSON-ответа.
notify()¶
Формирует ответ с notify-блоком в интерфейсе.
С версии: 200.4.0
Параметры: - $title — Заголовок уведомления. - $message — Текст уведомления. - $type — Тип уведомления (см. TYPE_*). - $status — HTTP-статус. - $success — Флаг успеха операции.
Возвращает: self — Экземпляр JSON-ответа.
fail()¶
Формирует ответ об ошибке с notify и структурой error.
С версии: 200.4.0
Параметры: - $title — Заголовок ошибки. - $message — Текст ошибки. - $code — Машиночитаемый код ошибки. - $status — HTTP-статус.
Возвращает: self — Экземпляр JSON-ответа.
noticePayload()¶
Собирает структуру notice для toast или notify.
С версии: 200.4.0
Параметры: - $channel — Канал уведомления. - $message — Текст сообщения. - $title — Заголовок (для notify). - $type — Тип уведомления.
Возвращает: array{channel: string, message: string, title?: string, type?: string} — Payload notice.
build()¶
Создаёт экземпляр ответа из готового тела.
С версии: 200.4.0
Параметры: - $status — HTTP-статус.
Возвращает: self — Экземпляр JSON-ответа.
send()¶
Отправляет JSON-ответ клиенту с заголовками и HTTP-кодом.
С версии: 200.4.0