Описание класса Request | Universal Bot

Request
in

Class Request

Класс отвечающий за отправку curl запросов на необходимый url. Поддерживаются различные заголовки, а также присутствует возможность отправки файлов.

Table of Contents

HEADER_RSS_XML 'Content-Type: application/rss+xml'
HEADER_GZIP 'Content-Encoding: gzip'
HEADER_AP_JSON 'Content-Type: application/json'
HEADER_AP_XML 'Content-Type: application/xml'
HEADER_FORM_DATA 'Content-Type: multipart/form-data'
$url Адрес, на который отправляется запрос. string
$get Get параметры запроса. string|array
$post Post параметры запроса. string|array
$header Отправляемые заголовки. string|array
$attach Прикреплённый файл (url, путь к файлу на сервере либо содержимое файла). string
$isAttachContent Тип передаваемого файла. bool
$attachName Название параметра при отправке файла (По умолчанию file). string
$customRequest Кастомный (Пользовательский) заголовок (DELETE и тд.). string
$maxTimeQuery Максимально время, за которое должен быть получен ответ. В мсек. int|null
$isConvertJson Формат ответа. bool
$isPostEncode Нужно ли декодировать post запрос. bool
$error Ошибки при выполнении запроса. string
__construct() Request constructor. mixed
getError() Возвращаем текст с ошибкой, произошедшей при выполнении запроса. string
run() Начинаем отправку curl запроса. mixed
send() Отправка запроса. array

Constants

HEADER_RSS_XML

mixed $HEADER_RSS_XML = 'Content-Type: application/rss+xml'

HEADER_GZIP

mixed $HEADER_GZIP = 'Content-Encoding: gzip'

HEADER_AP_JSON

mixed $HEADER_AP_JSON = 'Content-Type: application/json'

HEADER_AP_XML

mixed $HEADER_AP_XML = 'Content-Type: application/xml'

HEADER_FORM_DATA

mixed $HEADER_FORM_DATA = 'Content-Type: multipart/form-data'

Properties

$url

Адрес, на который отправляется запрос.

public string $url

$get

Get параметры запроса.

public string|array $get

$post

Post параметры запроса.

public string|array $post

$header

Отправляемые заголовки.

public string|array $header

$attach

Прикреплённый файл (url, путь к файлу на сервере либо содержимое файла).

public string $attach

$isAttachContent

Тип передаваемого файла.

public bool $isAttachContent
True, если передается содержимое файла, иначе false. По умолчанию: false.

$attachName

Название параметра при отправке файла (По умолчанию file).

public string $attachName

$customRequest

Кастомный (Пользовательский) заголовок (DELETE и тд.).

public string $customRequest

$maxTimeQuery

Максимально время, за которое должен быть получен ответ. В мсек.

public int|null $maxTimeQuery

$isConvertJson

Формат ответа.

public bool $isConvertJson
True, если полученный ответ нужно преобразовать как json. По умолчанию true.

$isPostEncode

Нужно ли декодировать post запрос.

public bool $isPostEncode
По умолчанию false

$error

Ошибки при выполнении запроса.

private string $error

Methods

__construct()

Request constructor.

public __construct( ) : mixed
Return values
mixed

getError()

Возвращаем текст с ошибкой, произошедшей при выполнении запроса.

public getError( ) : string
Tags
api
Return values
string

run()

Начинаем отправку curl запроса.

private run( ) : mixed

В случае успеха возвращаем содержимое запроса, в противном случае null.

Return values
mixed

send()

Отправка запроса.

public send( [ $url : string|null = null ] ) : array

Возвращаем массив. В случае успеха свойство 'status' = true.

Parameters
$url : string|null = null

Адрес, на который отправляется запрос.

Tags
api
Return values
array —

[

  • bool status Статус выполнения запроса.
  • mixed data Данные полученные при выполнении запроса. ]

Search results