PendingRequest

class PendingRequest (View source)

Трейты

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected Factory\|null	$factory	Экземпляр фабрики.
protected Client	$client	Экземпляр клиента Guzzle.
protected string	$baseUrl	Базовый URL для запроса.
protected string	$bodyFormat	Формат тела запроса.
protected string	$pendingBody	Необработанное тело запроса.
protected array	$pendingFiles	Загружаемые файлы для запроса.
protected array	$cookies	Куки запроса.
protected	$transferStats	Статистика передачи для запроса.
protected array	$options	Параметры запроса.
protected int	$tries	Количество попыток запроса.
protected int	$retryDelay	Количество миллисекунд ожидания между повторениями.
protected callable\|null	$retryWhenCallback	Обратный вызов, определяющий, следует ли повторять запрос.
protected Collection	$beforeSendingCallbacks	Обратные вызовы, которые должны выполняться перед отправкой запроса.
protected Collection\|null	$stubCallbacks	Заглушки-вызовы, которые будут обрабатывать запросы.
protected Collection	$middleware	Вызовы middleware, добавленные пользователями, которые будут обрабатывать запросы.
protected bool	$async	Являются ли запросы асинхронными.
protected PromiseInterface	$promise	Обещание запроса.
protected Request\|null	$request	Объект отправленного запроса, если запрос был отправлен.
protected array	$mergableOptions	Параметры запроса Guzzle, которые можно объединить с помощью array_merge_recursive.

Методы

$this\|смешанный	when(смешанный $value, вызываемый $callback, вызываемый\|null $default = null) Применить обратный вызов, если заданное «значение» истинно.	из Conditionable
$this\|смешанный	unless(смешанный $value, вызываемый $callback, вызываемый\|null $default = null) Применить обратный вызов, если заданное «значение» ложно.	из Conditionable
static void	macro(строка $name, объект\|вызываемый $macro) Зарегистрировать пользовательский макрос.	из Macroable
static void	mixin(объект $mixin, bool $replace = true) Смешать другой объект в класс.	из Macroable
static bool	hasMacro(строка $name) Проверяет, зарегистрирован ли макрос.	из Macroable
static void	flushMacros() Очистить существующие макросы.	из Macroable
static смешанный	__callStatic(строка $method, массив $parameters) Динамически обрабатывает вызовы к классу.	из Macroable
смешанный	__call(строка $method, массив $parameters) Динамически обрабатывает вызовы к классу.	из Macroable
void	__construct(Factory $factory = null) Создать новый экземпляр HTTP-клиента.
$this	baseUrl(строка $url) Установить базовый URL для ожидаемого запроса.
$this	withBody(строка $content, строка $contentType) Прикрепить к запросу исходное тело.
$this	asJson() Указать, что запрос содержит JSON.
$this	asForm() Указать, что запрос содержит параметры формы.
$this	attach(строка\|массив $name, строка\|ресурс $contents = '', строка\|null $filename = null, массив $headers = []) Прикрепить файл к запросу.
$this	asMultipart() Указать, что запрос является запросом multipart-формы.
$this	bodyFormat(строка $format) Указать формат тела запроса.
$this	contentType(строка $contentType) Указать тип содержимого запроса.
$this	acceptJson() Указать, что сервер должен вернуть JSON.
$this	accept(строка $contentType) Указать тип содержимого, который должен вернуть сервер.
$this	withHeaders(массив $headers) Добавить заданные заголовки к запросу.
$this	withBasicAuth(строка $username, строка $password) Указать имя пользователя и пароль для базовой аутентификации запроса.
$this	withDigestAuth(строка $username, строка $password) Указать имя пользователя и пароль для аутентификации запроса по Digest.
$this	withToken(строка $token, строка $type = 'Bearer') Указать токен авторизации для запроса.
$this	withUserAgent(строка $userAgent) Указать пользовательского агента для запроса.
$this	withCookies(массив $cookies, строка $domain) Указать cookie, которые должны быть включены в запрос.
$this	withoutRedirecting() Указать, что редиректы не должны следовать.
$this	withoutVerifying() Указать, что сертификаты TLS не должны проверяться.
$this	sink(строка\|ресурс $to) Указать путь, куда должно быть сохранено тело ответа.
$this	timeout(целое $seconds) Указать таймаут (в секундах) для запроса.
$this	retry(целое $times, целое $sleep = 0, вызываемый\|null $when = null) Указать количество попыток запроса.
$this	withOptions(массив $options) Заменить указанные параметры запроса.
$this	withMiddleware(вызываемый $middleware) Добавить новый middleware в стек обработчиков клиента.
$this	beforeSending(вызываемый $callback) Добавить новый обратный вызов «перед отправкой» к запросу.
$this	dump() Вывести запрос перед отправкой.
$this	dd() Вывести запрос перед отправкой и завершить сценарий.
Response	get(строка $url, массив\|строка\|null $query = null) Выполнить запрос GET по заданному URL.
Response	head(строка $url, массив\|строка\|null $query = null) Выполнить запрос HEAD по заданному URL.
Response	post(строка $url, массив $data = []) Выполнить запрос POST по заданному URL.
Response	patch(строка $url, массив $data = []) Выполнить запрос PATCH по заданному URL.
Response	put(строка $url, массив $data = []) Выполнить запрос PUT по заданному URL.
Response	delete(строка $url, массив $data = []) Выполнить запрос DELETE по заданному URL.
массив	pool(вызываемый $callback) Отправить пул асинхронных запросов одновременно.
Response	send(строка $method, строка $url, массив $options = []) Отправить запрос по заданному URL.

array\|array[]	parseMultipartBodyFormat(array $data) Обработать данные многочастной формы.
PromiseInterface	makePromise(string $method, string $url, array $options = []) Отправить асинхронный запрос на указанный URL.
MessageInterface\|PromiseInterface	sendRequest(string $method, string $url, array $options = []) Отправить запрос синхронно или асинхронно.
array	parseRequestData(string $method, string $url, array $options) Получить данные запроса в виде массива, чтобы можно было удобно их прикрепить к запросу для удобных проверок.
Response	populateResponse(Response $response) Заполнить полученный ответ дополнительными данными.
Client	buildClient() Создать клиент Guzzle.
bool	requestsReusableClient() Определить, требуется ли повторно используемый клиент.
Client	getReusableClient() Получить повторно используемый клиент Guzzle.
Client	createClient(HandlerStack $handlerStack) Создать новый клиент Guzzle.
HandlerStack	buildHandlerStack() Создать стек обработчиков клиента Guzzle.
HandlerStack	pushHandlers(HandlerStack $handlerStack) Добавить необходимые обработчики в данный стек обработчиков.
Closure	buildBeforeSendingHandler() Создать обработчик перед отправкой.
Closure	buildRecorderHandler() Создать обработчик записи.
Closure	buildStubHandler() Создать обработчик эмуляции.
Closure	sinkStubHandler(string $sink) Получить обратный вызов обработчика эмуляции стока.
RequestInterface	runBeforeSendingCallbacks(RequestInterface $request, array $options) Выполнить обратные вызовы "перед отправкой".
array	mergeOptions(array ...$options) Заменить указанные параметры текущими параметрами запроса.
$this	stub(callable $callback) Зарегистрировать обратный вызов эмуляции, который будет перехватывать запросы и сможет возвращать ответы эмуляции.
$this	async(bool $async = true) Переключить асинхронность в запросах.
PromiseInterface\|null	getPromise() Получить ожидаемую промис запроса.
void	dispatchRequestSendingEvent() Отправить событие RequestSending, если диспетчер доступен.
void	dispatchResponseReceivedEvent(Response $response) Отправить событие ResponseReceived, если диспетчер доступен.
void	dispatchConnectionFailedEvent() Отправить событие ConnectionFailed, если диспетчер доступен.
$this	setClient(Client $client) Установить экземпляр клиента.
$this	setHandler(callable $handler) Создать новый экземпляр клиента, используя данный обработчик.
array	getOptions() Получить параметры ожидаемого запроса.

Подробности

$this|mixed when(mixed $value, callable $callback, callable|null $default = null)

Применить обратный вызов, если заданное «значение» истинно.

Параметры

mixed	$value
callable	$callback
callable\|null	$default

Возвращаемое значение

$this|mixed

$this|mixed unless(mixed $value, callable $callback, callable|null $default = null)

Применить обратный вызов, если заданное «значение» ложно.

Параметры

mixed	$value
callable	$callback
callable\|null	$default

Возвращаемое значение

$this|mixed

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макро.

Параметры

string	$name
object\|callable	$macro

Возвращаемое значение

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Параметры

object	$mixin
bool	$replace

Возвращаемое значение

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверяет, зарегистрировано ли макро.

Параметры

string

$name

Возвращаемое значение

bool

static void flushMacros()

Очистить существующие макросы.

Возвращаемое значение

void

static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы класса.

Параметры

string	$method
array	$parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

END_OF_DOCUMENT_MARKER

mixed __call(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Параметры

string	$method
array	$parameters

Значение возврата

mixed

Исключения

BadMethodCallException

void __construct(Factory $factory = null)

Создать новый экземпляр HTTP-клиента.

Параметры

Factory

$factory

Значение возврата

void

$this baseUrl(string $url)

Установить базовый URL для ожидающего запроса.

Параметры

string

$url

Значение возврата

$this

$this withBody(string $content, string $contentType)

Прикрепить сырое тело к запросу.

Параметры

string	$content
string	$contentType

Значение возврата

$this

$this asJson()

Указать, что запрос содержит JSON.

Значение возврата

$this

$this asForm()

Указать, что запрос содержит параметры формы.

Значение возврата

$this

$this attach(string|array $name, string|resource $contents = '', string|null $filename = null, array $headers = [])

Прикрепить файл к запросу.

Параметры

string\|array	$name
string\|resource	$contents
string\|null	$filename
array	$headers

Значение возврата

$this

$this asMultipart()

Указать, что запрос является многочастотным запросом формы.

Значение возврата

$this

$this bodyFormat(string $format)

Указать формат тела запроса.

Параметры

string

$format

Значение возврата

$this

$this contentType(string $contentType)

Указать тип содержимого запроса.

Параметры

string

$contentType

Значение возврата

$this

$this acceptJson()

Указать, что сервер должен вернуть JSON.

Значение возврата

$this

$this accept(string $contentType)

Указать тип содержимого, который должен вернуть сервер.

Параметры

string

$contentType

Значение возврата

$this

$this withHeaders(array $headers)

Добавить заданные заголовки к запросу.

Параметры

array

$headers

Значение возврата

$this

$this withBasicAuth(string $username, string $password)

Указать имя пользователя и пароль для базовой аутентификации запроса.

Параметры

string	$username
string	$password

Значение возврата

$this

$this withDigestAuth(string $username, string $password)

Указать имя пользователя и пароль для аутентификации по Digest для запроса.

Параметры

string	$username
string	$password

Значение возврата

$this

$this withToken(string $token, string $type = 'Bearer')

Указать токен авторизации для запроса.

Параметры

string	$token
string	$type

Значение возврата

$this

$this withUserAgent(string $userAgent)

Указать user agent для запроса.

Параметры

string

$userAgent

Значение возврата

$this

$this withCookies(array $cookies, string $domain)

Указать куки, которые должны быть включены в запрос.

Параметры

array	$cookies
string	$domain

Значение возврата

$this

$this withoutRedirecting()

Указать, что перенаправления не должны следовать.

Значение возврата

$this

$this withoutVerifying()

Указать, что сертификаты TLS не должны проверяться.

Значение возврата

$this

$this sink(string|resource $to)

Указать путь, где должно храниться тело ответа.

Параметры

string|resource

$to

Значение возврата

$this

$this timeout(int $seconds)

Указать таймаут (в секундах) для запроса.

Параметры

int

$seconds

Значение возврата

$this

$this retry(int $times, int $sleep = 0, callable|null $when = null)

Укажите количество попыток запроса.

Параметры

int	$times
int	$sleep
callable\|null	$when

Возвращаемое значение

$this

$this withOptions(array $options)

Замените указанные параметры запроса.

Параметры

array

$options

Возвращаемое значение

$this

$this withMiddleware(callable $middleware)

Добавить новый обработчик middleware в стек клиента.

Параметры

callable

$middleware

Возвращаемое значение

$this

$this beforeSending(callable $callback)

Добавить новый обратный вызов "перед отправкой" в запрос.

Параметры

callable

$callback

Возвращаемое значение

$this

$this dump()

Вывести запрос перед отправкой.

Возвращаемое значение

$this

$this dd()

Вывести запрос перед отправкой и завершить скрипт.

Возвращаемое значение

$this

Response get(string $url, array|string|null $query = null)

Отправить запрос GET по заданному URL.

Параметры

string	$url
array\|string\|null	$query

Возвращаемое значение

Response

Response head(string $url, array|string|null $query = null)

Отправить запрос HEAD по заданному URL.

Параметры

string	$url
array\|string\|null	$query

Возвращаемое значение

Response

Response post(string $url, array $data = [])

Отправить запрос POST по заданному URL.

Параметры

string	$url
array	$data

Возвращаемое значение

Response

Response patch(string $url, array $data = [])

Отправить запрос PATCH по заданному URL.

Параметры

string	$url
array	$data

Возвращаемое значение

Response

Response put(string $url, array $data = [])

Отправить запрос PUT по заданному URL.

Параметры

string	$url
array	$data

Возвращаемое значение

Response

Response delete(string $url, array $data = [])

Отправить запрос DELETE по заданному URL.

Параметры

string	$url
array	$data

Возвращаемое значение

Response

array pool(callable $callback)

Отправить пул асинхронных запросов одновременно.

Параметры

callable

$callback

Возвращаемое значение

array

Response send(string $method, string $url, array $options = [])

Отправить запрос по заданному URL.

Параметры

string	$method
string	$url
array	$options

Возвращаемое значение

Response

Исключения

Exception

protected array|array[] parseMultipartBodyFormat(array $data)

Обработать данные в формате multipart.

Параметры

array

$data

Возвращаемое значение

array|array[]

protected PromiseInterface makePromise(string $method, string $url, array $options = [])

Отправить асинхронный запрос по заданному URL.

Параметры

string	$method
string	$url
array	$options

Возвращаемое значение

PromiseInterface

protected MessageInterface|PromiseInterface sendRequest(string $method, string $url, array $options = [])

Отправить запрос синхронно или асинхронно.

Параметры

string	$method
string	$url
array	$options

Возвращаемое значение

MessageInterface|PromiseInterface

Исключения

Exception

protected array parseRequestData(string $method, string $url, array $options)

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

Параметры

string	$method
string	$url
array	$options

Возвращаемое значение

array

protected Response populateResponse(Response $response)

Заполнить полученный ответ дополнительными данными.

Parameters

Response

$response

Return Value

Response

Client buildClient()

Создать клиент Guzzle.

Return Value

Client

protected bool requestsReusableClient()

Определить, требуется ли повторно используемый клиент.

Return Value

bool

protected Client getReusableClient()

Получить повторно используемый клиент Guzzle.

Return Value

Client

Client createClient(HandlerStack $handlerStack)

Создать новый клиент Guzzle.

Parameters

HandlerStack

$handlerStack

Return Value

Client

HandlerStack buildHandlerStack()

Создать стек обработчиков клиента Guzzle.

Return Value

HandlerStack

HandlerStack pushHandlers(HandlerStack $handlerStack)

Добавить необходимые обработчики в данный стек обработчиков.

Parameters

HandlerStack

$handlerStack

Return Value

HandlerStack

Closure buildBeforeSendingHandler()

Создать обработчик до отправки.

Return Value

Closure

Closure buildRecorderHandler()

Создать обработчик записи.

Return Value

Closure

Closure buildStubHandler()

Создать обработчик эмуляции.

Return Value

Closure

protected Closure sinkStubHandler(string $sink)

Получить обратный вызов обработчика эмуляции стока.

Parameters

string

$sink

Return Value

Closure

RequestInterface runBeforeSendingCallbacks(RequestInterface $request, array $options)

Выполнить обратные вызовы «перед отправкой».

Parameters

RequestInterface	$request
array	$options

Return Value

RequestInterface

array mergeOptions(array ...$options)

Заменить заданные параметры текущими параметрами запроса.

Parameters

array

...$options

Return Value

array

$this stub(callable $callback)

Зарегистрировать вызываемый объект эмуляции, который будет перехватывать запросы и сможет возвращать ответы эмуляции.

Parameters

callable

$callback

Return Value

$this

$this async(bool $async = true)

Включить/выключить асинхронность в запросах.

Parameters

bool

$async

Return Value

$this

PromiseInterface|null getPromise()

Получить ожидающую очередь запроса.

Return Value

PromiseInterface|null

protected void dispatchRequestSendingEvent()

Отправить событие RequestSending, если диспетчер доступен.

Return Value

void

protected void dispatchResponseReceivedEvent(Response $response)

Отправить событие ResponseReceived, если диспетчер доступен.

Parameters

Response

$response

Return Value

void

protected void dispatchConnectionFailedEvent()

Отправить событие ConnectionFailed, если диспетчер доступен.

Return Value

void

$this setClient(Client $client)

Установить экземпляр клиента.

Parameters

Client

$client

Return Value

$this

$this setHandler(callable $handler)

Создать новый экземпляр клиента, используя заданный обработчик.

Parameters

callable

$handler

Return Value

$this

array getOptions()

Получить параметры ожидающего запроса.

Return Value

array

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Http/Client/PendingRequest.html