PendingRequest

класс PendingRequest (Просмотреть исходный код)

Трейты

Свойства

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

Методы

$this\|TWhenReturnType	when($value = null, callable $callback = null, callable $default = null) Примените обратный вызов, если заданное «значение» истинно (или преобразуется в истинное).	из Conditionable
$this\|TUnlessReturnType	unless($value = null, callable $callback = null, callable $default = null) Примените обратный вызов, если заданное «значение» ложно (или преобразуется в ложное).	из Conditionable
static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательское макро.	из Macroable
static void	mixin(object $mixin, bool $replace = true) Включить другой объект в класс.	из Macroable
static bool	hasMacro(string $name) Проверить, зарегистрировано ли макро.	из Macroable
static void	flushMacros() Очистить существующие макросы.	из Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обработать вызовы к классу.	из Macroable
mixed	__call(string $method, array $parameters) Динамически обработать вызовы к классу.	из Macroable
void	__construct(Factory $factory = null) Создать новый экземпляр HTTP-клиента.
$this	baseUrl(string $url) Установить базовый URL для ожидаемого запроса.
$this	withBody(string $content, string $contentType) Прикрепить сырой тело к запросу.
$this	asJson() Указать, что запрос содержит JSON.
$this	asForm() Указать, что запрос содержит параметры формы.
$this	attach(string\|array $name, string\|resource $contents = '', string\|null $filename = null, array $headers = []) Прикрепить файл к запросу.
$this	asMultipart() Указать, что запрос является запросом с многочастной формой.
$this	bodyFormat(string $format) Указать формат тела запроса.
$this	contentType(string $contentType) Указать тип содержимого запроса.
$this	acceptJson() Указать, что сервер должен вернуть JSON.
$this	accept(string $contentType) Указать тип содержимого, который должен вернуть сервер.
$this	withHeaders(array $headers) Добавить заданные заголовки к запросу.

$this	withBasicAuth(string $username, string $password) Укажите имя пользователя и пароль для базовой аутентификации запроса.
$this	withDigestAuth(string $username, string $password) Укажите имя пользователя и пароль для аутентификации по Digest для запроса.
$this	withToken(string $token, string $type = 'Bearer') Укажите токен авторизации для запроса.
$this	withUserAgent(string $userAgent) Укажите пользователя для запроса.
$this	withUrlParameters(array $parameters = []) Укажите параметры URL, которые могут быть подставлены в URL запроса.
$this	withCookies(array $cookies, string $domain) Укажите cookie, которые должны быть включены в запрос.
$this	maxRedirects(int $max) Укажите максимальное количество редиректов.
$this	withoutRedirecting() Укажите, что редиректы не должны следовать.
$this	withoutVerifying() Укажите, что сертификаты TLS не должны проверяться.
$this	sink(string\|resource $to) Укажите путь, где должен храниться тело ответа.
$this	timeout(int $seconds) Укажите таймаут (в секундах) для запроса.
$this	connectTimeout(int $seconds) Укажите таймаут подключения (в секундах) для запроса.
$this	retry(int $times, int $sleepMilliseconds = 0, callable\|null $when = null, bool $throw = true) Укажите количество попыток запроса.
$this	withOptions(array $options) Замените указанные параметры запроса.
$this	withMiddleware(callable $middleware) Добавьте новый middleware в стек обработчиков клиента.
$this	beforeSending(callable $callback) Добавьте новый callback "перед отправкой" для запроса.
$this	throw(callable $callback = null) Выбросить исключение, если произошла ошибка сервера или клиента.
$this	throwIf(callable\|bool $condition) Выбросить исключение, если произошла ошибка сервера или клиента и заданное условие истинно.
$this	throwUnless(bool $condition) Выбросить исключение, если произошла ошибка сервера или клиента и заданное условие ложно.
$this	dump() Вывести запрос перед отправкой.
$this	dd() Вывести запрос перед отправкой и завершить скрипт.
Response	get(string $url, array\|string\|null $query = null) Выполнить запрос GET по указанному URL.
Response	head(string $url, array\|string\|null $query = null) Выполнить запрос HEAD по указанному URL.

Response	post(string $url, array $data = []) Выполнить POST-запрос к заданному URL.
Response	patch(string $url, array $data = []) Выполнить PATCH-запрос к заданному URL.
Response	put(string $url, array $data = []) Выполнить PUT-запрос к заданному URL.
Response	delete(string $url, array $data = []) Выполнить DELETE-запрос к заданному URL.
array	pool(callable $callback) Отправить пул асинхронных запросов параллельно.
Response	send(string $method, string $url, array $options = []) Отправить запрос к заданному URL.
string	expandUrlParameters(string $url) Заменить параметры URL в заданном URL.
array	parseHttpOptions(array $options) Обработать заданные HTTP-параметры и установить соответствующие дополнительные параметры.
array\|array[]	parseMultipartBodyFormat(array $data) Обработать данные в формате multipart.
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	preventStrayRequests(bool $prevent = true) Указать, что следует бросить исключение, если какой-либо запрос не смоделирован.
$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|TWhenReturnType when($value = null, callable $callback = null, callable $default = null)

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

Параметры

	$value
callable	$callback
callable	$default

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

$this|TWhenReturnType

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

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

Параметры

	$value
callable	$callback
callable	$default

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

$this|TUnlessReturnType

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

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

Параметры

string	$name
object\|callable	$macro

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

void

статический void mixin(object $mixin, bool $replace = true)

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

Параметры

object	$mixin
bool	$replace

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

void

Исключения

ReflectionException

статический bool hasMacro(string $name)

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

Параметры

string

$name

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

bool

статический void flushMacros()

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

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

void

статический mixed __callStatic(string $method, array $parameters)

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

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

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)

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

Параметры

string

$userAgent

Значение результата

$this

$this withUrlParameters(array $parameters = [])

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

Параметры

array

$parameters

Значение результата

$this

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

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

Параметры

array	$cookies
string	$domain

Значение результата

$this

$this maxRedirects(int $max)

Укажите максимальное количество переадресаций, разрешённых.

Параметры

int

$max

Значение результата

$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 connectTimeout(int $seconds)

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

Параметры

int

$seconds

Значение результата

$this

$this retry(int $times, int $sleepMilliseconds = 0, callable|null $when = null, bool $throw = true)

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

Параметры

int	$times
int	$sleepMilliseconds
callable\|null	$when
bool	$throw

Значение результата

$this

$this withOptions(array $options)

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

Параметры

array

$options

Значение результата

$this

$this withMiddleware(callable $middleware)

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

Параметры

callable

$middleware

Значение результата

$this

$this beforeSending(callable $callback)

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

Параметры

callable

$callback

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

$this

$this throw(callable $callback = null)

Выбросить исключение, если произошла ошибка сервера или клиента.

Параметры

callable

$callback

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

$this

$this throwIf(callable|bool $condition)

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

Параметры

callable|bool

$condition

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

$this

$this throwUnless(bool $condition)

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

Параметры

bool

$condition

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

$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.

Parameters

string	$url
array	$data

Return Value

Response

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

Отправить запрос DELETE на указанный URL.

Parameters

string	$url
array	$data

Return Value

Response

array pool(callable $callback)

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

Parameters

callable

$callback

Return Value

array

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

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

Parameters

string	$method
string	$url
array	$options

Return Value

Response

Exceptions

Exception

protected string expandUrlParameters(string $url)

Заменить параметры URL в заданном URL.

Parameters

string

$url

Return Value

string

protected array parseHttpOptions(array $options)

Обработать заданные HTTP параметры и установить соответствующие дополнительные параметры.

Parameters

array

$options

Return Value

array

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

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

Parameters

array

$data

Return Value

array|array[]

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

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

Parameters

string	$method
string	$url
array	$options

Return Value

PromiseInterface

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

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

Parameters

string	$method
string	$url
array	$options

Return Value

MessageInterface|PromiseInterface

Exceptions

Exception

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

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

Parameters

string	$method
string	$url
array	$options

Return Value

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 preventStrayRequests(bool $prevent = true)

Указать, что исключение должно быть выброшено, если какой-либо запрос не является фейковым.

Parameters

bool

$prevent

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)

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

Параметры

callable

$handler

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

$this

array getOptions()

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

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

array

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