Документация для разработчиков
Темная тема

AjaxJson

\Bitrix\Main\Engine\Response\AjaxJson - методы json-ответов.

По умолчанию все ответы от контроллеров \Bitrix\Main\Engine\Controller имеют типизированную структуру, которую прекрасно понимают js API [link=]BX.ajax.runAction[/link], [link=]BX.ajax.runComponentAction[/link]:

{
    "status": string,
    "data": mixed,
    "errors": array
}
Каким образом AjaxJson создается внутри контроллеров можно ознакомиться здесь.

Методы

Метод Описание С версии
__construct(
   $data = null,
   $status = self::STATUS_SUCCESS,
   ErrorCollection $errorCollection = null
)
Конструктор класса. Параметры:
  • $data {mixed} Данные, основная часть json-ответа. Должны конвертироваться в json-представление механизмами php либо, реализуя один из интерфейсов:
    \JsonSerializable
    \Bitrix\Main\Type\Contract\Jsonable
    \Bitrix\Main\Type\Contract\Arrayable
  • $status {string} Статус ответа. По умолчанию success.
  • $errorCollection \Bitrix\Main\ErrorCollection Коллекция ошибок. По умолчанию пуста.
createSuccess(
   $data = null
)
Создает объект AjaxJson со статусом success.
createError(
   ErrorCollection $errorCollection = null,
   $data = null
)
Создает объект AjaxJson со статусом error и позволяет передать коллецию ошибок и, при необходимости, данные.
createDenied(
   ErrorCollection $errorCollection = null,
   $data = null
)
Создает объект AjaxJson со статусом denied и позволяет передать коллецию ошибок и при необходимости данные.

© «Битрикс», 2001-2021, «1С-Битрикс», 2021
Наверх