Абстрактный класс: AjaxAbstractResponse

Краткое содержание:

Абстрактный класс, представляющий базовый ответ в виде JSON.

Описание:

Предназначен для наследования, чтобы реализовать конкретные типы ответов (например, успех или ошибка).

Свойства

public $data
public $message
public $meta
public $status
public $success
protected $data
protected $message
protected $meta
protected $redirect
protected $status
protected $success

Методы

public getRedirect()
public isSuccess()
public send()
public setData()
public setMessage()
public setMeta()
public setRedirect()
public setStatus()
public setSuccess()
protected buildResponse()

Подробности

Путь: engine/inc/maharder/_includes/responses/AjaxAbstractResponse.php

Свойства

public $data : array

Описание

Основные данные ответа.

Тип: Массив

public $message : string

Описание

Текстовое сообщение, сопровождающее ответ.

Тип: Текст

public $meta : array

Описание

Дополнительные мета-данные.

Тип: Массив

public $status : int

Описание

HTTP статус ответа.

Тип: Целое число

public $success : bool

Описание

Указывает, успешен ли ответ.

Тип: Логические значения

protected $data : array

Тип: Массив

protected $message : string

Тип: Текст

protected $meta : array

Тип: Массив

Подробности:

protected $redirect : ?string

Тип: Текст или null

protected $status : int

Тип: Целое число

protected $success : bool

Тип: Логические значения

Методы

getRedirect

Text Only
1	`public getRedirect() : null\|string`

Краткое содержание

Возвращает URL-адрес перенаправления, установленный для отклика Ajax.

Смотри так-же:

\AjaxAbstractResponse::setRedirect()

Возвращает:

Text Only
1	`null\|string`

URL-адрес перенаправления.

isSuccess

Text Only
1	`public isSuccess() : bool`

Краткое содержание

Проверяет, указано ли успешное выполнение запроса.

Смотри так-же:

\AjaxAbstractResponse::$success

Возвращает:

Text Only
1	`bool`

Возвращает true, если запрос выполнен успешно, иначе false.

send

Text Only
1	`public send() : string`

Краткое содержание

Отправляет HTTP-ответ в формате JSON и завершает выполнение скрипта.

Описание

Устанавливает заголовок ответа с указанием типа содержимого (application/json), HTTP-статус, тело ответа в формате JSON, а затем завершает выполнение.

Заголовки и статус берутся из свойств экземпляра класса, а тело ответа формируется методом {@see}.

Возвращает:

Text Only
1	`string`

setData

Text Only
1	`public setData(array data) : self`

Краткое содержание

Устанавливает данные ответа.

Смотри так-же:

\AjaxAbstractResponse::$data

Свойства:

Название	Тип	По умолчанию
$data	array

Возвращает:

Text Only
1	`self`

Экземпляр текущего объекта для цепочки вызовов.

setMessage

Text Only
1	`public setMessage(string message) : self`

Краткое содержание

Устанавливает сообщение ответа.

Смотри так-же:

\AjaxAbstractResponse::$message

Свойства:

Название	Тип	По умолчанию
$message	string

Возвращает:

Text Only
1	`self`

Экземпляр текущего объекта для цепочки вызовов.

setMeta

Text Only
1	`public setMeta(array meta) : self`

Краткое содержание

Устанавливает дополнительные мета-данные.

Смотри так-же:

\AjaxAbstractResponse::$meta

Свойства:

Название	Тип	По умолчанию
$meta	array

Возвращает:

Text Only
1	`self`

Экземпляр текущего объекта для цепочки вызовов.

setRedirect

Text Only
1	`public setRedirect(string redirect) : \AjaxAbstractResponse`

Краткое содержание

Устанавливает URL для перенаправления.

Описание

Метод сохраняет указанный URL в свойстве redirect и возвращает текущий экземпляр объекта для цепочки вызовов.

Смотри так-же:

\AjaxAbstractResponse::$redirect

Свойства:

Название	Тип	По умолчанию
$redirect	string

Возвращает:

Text Only
1	`\AjaxAbstractResponse`

Экземпляр текущего объекта для цепочки вызовов.

setStatus

Text Only
1	`public setStatus(int status) : self`

Краткое содержание

Устанавливает HTTP статус ответа.

Смотри так-же:

\AjaxAbstractResponse::$status

Свойства:

Название	Тип	По умолчанию
$status	int

Возвращает:

Text Only
1	`self`

Экземпляр текущего объекта для цепочки вызовов.

setSuccess

Text Only
1	`public setSuccess(bool success) : \AjaxAbstractResponse`

Краткое содержание

Устанавливает статус успешности выполнения операции.

Описание

Метод сохраняет переданное булево значение в свойстве success и возвращает текущий экземпляр объекта для реализации цепочки вызовов.

Смотри так-же:

\AjaxAbstractResponse::$success

Свойства:

Название	Тип	По умолчанию
$success	bool

Возвращает:

Text Only
1	`\AjaxAbstractResponse`

Экземпляр текущего объекта для цепочки вызовов.

buildResponse

Text Only
1	`protected buildResponse() : string`

Краткое содержание

Формирует тело ответа в формате JSON.

Описание

Метод преобразует свойства текущего экземпляра класса, такие как успех операции, HTTP-статус, сообщение, данные и мета-информацию, в JSON-строку.

Смотри так-же:

\AjaxAbstractResponse::$success
\AjaxAbstractResponse::$status
\AjaxAbstractResponse::$message
\AjaxAbstractResponse::$data
\AjaxAbstractResponse::$meta

Возвращает:

Text Only
1	`string`

JSON-представление ответа.