Абстрактный класс: 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

public getRedirect() : null|string

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

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

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

• \AjaxAbstractResponse::setRedirect()

Возвращает:

null|string

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

isSuccess

public isSuccess() : bool

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

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

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

• \AjaxAbstractResponse::$success

Возвращает:

bool

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

send

public send() : string

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

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

Описание

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

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

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

• \AjaxAbstractResponse::buildResponse()
• \AjaxAbstractResponse::$status
• \AjaxAbstractResponse::$success
• \AjaxAbstractResponse::$message
• \AjaxAbstractResponse::$data
• \AjaxAbstractResponse::$meta

Возвращает:

string

setData

public setData(array  data) : self

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

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

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

• \AjaxAbstractResponse::$data

Свойства:

Возвращает:

self

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

setMessage

public setMessage(string  message) : self

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

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

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

• \AjaxAbstractResponse::$message

Свойства:

Возвращает:

self

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

setMeta

public setMeta(array  meta) : self

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

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

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

• \AjaxAbstractResponse::$meta

Свойства:

Возвращает:

self

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

setRedirect

public setRedirect(string  redirect) : \AjaxAbstractResponse

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

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

Описание

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

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

• \AjaxAbstractResponse::$redirect

Свойства:

Возвращает:

\AjaxAbstractResponse

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

setStatus

public setStatus(int  status) : self

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

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

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

• \AjaxAbstractResponse::$status

Свойства:

Возвращает:

self

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

setSuccess

public setSuccess(bool  success) : \AjaxAbstractResponse

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

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

Описание

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

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

• \AjaxAbstractResponse::$success

Свойства:

Возвращает:

\AjaxAbstractResponse

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

buildResponse

protected buildResponse() : string

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

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

Описание

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

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

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

Возвращает:

string

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