PendingRequest
class PendingRequest (View source)
Traits
| Conditionable | |
| Macroable |
Properties
| static protected array | $macros | Зарегистрированные строковые макросы. | from Macroable |
| protected Factory|null | $factory | Экземпляр фабрики. | |
| protected Client | $client | Экземпляр клиента Guzzle. | |
| protected callable | $handler | Обработчик HTTP Guzzle. | |
| protected string | $baseUrl | Базовый URL для запроса. | |
| protected array | $urlParameters | Параметры, которые можно подставить в URL. | |
| protected string | $bodyFormat | Формат тела запроса. | |
| protected StreamInterface|string | $pendingBody | Необработанное тело запроса. | |
| protected array | $pendingFiles | Ожидаемые файлы для запроса. | |
| protected array | $cookies | Куки запроса. | |
| protected TransferStats | $transferStats | Статистика передачи для запроса. | |
| protected array | $options | Параметры запроса. | |
| protected Closure | $throwCallback | Обратный вызов для выполнения при возникновении ошибки сервера или клиента. | |
| protected Closure | $throwIfCallback | Обратный вызов для проверки, следует ли выбрасывать исключение при возникновении ошибки сервера или клиента. | |
| protected int | $tries | Количество попыток запроса. | |
| protected Closure|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. |
Methods
| $this|TWhenReturnType | when($value = null, callable $callback = null, callable $default = null)
Применить обратный вызов, если заданное "значение" является (или разрешается в) истинным. | from Conditionable |
| $this|TUnlessReturnType | unless($value = null, callable $callback = null, callable $default = null)
Применить обратный вызов, если заданное "значение" является (или разрешается в) ложным. | from Conditionable |
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс. | from Macroable |
| static bool | hasMacro(string $name)
Проверяет, зарегистрирован ли макрос. | from Macroable |
| static void | flushMacros()
Очистить существующие макросы. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Динамически обрабатывать вызовы класса. | from Macroable |
| mixed | __call(string $method, array $parameters)
Динамически обрабатывать вызовы класса. | from Macroable |
| void | __construct(Factory $factory = null, array $middleware = [])
Создать новый экземпляр HTTP-клиента. | |
| $this | baseUrl(string $url)
Установить базовый URL для ожидающего запроса. | |
| $this | withBody(StreamInterface|string $content, string $contentType = 'application/json')
Прикрепить необработанный текст к запросу. | |
| $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 | withQueryParameters(array $parameters)
Установить заданные параметры запроса в URI запроса. | |
| $this | contentType(string $contentType)
Указать тип содержимого запроса. | |
| $this | acceptJson()
Указать, что сервер должен вернуть JSON. | |
| $this | accept(string $contentType)
Указать тип содержимого, который должен быть возвращен сервером. | |
| $this | withHeaders(array $headers)
Добавить заданные заголовки к запросу. | |
| $this | withHeader(string $name, mixed $value)
Добавить заданный заголовок к запросу. | |
| $this | replaceHeaders(array $headers)
Заменить заданные заголовки в запросе. | |
| $this | withBasicAuth(string $username, string $password)
Указать имя пользователя и пароль базовой аутентификации для запроса. | |
| $this | withDigestAuth(string $username, string $password)
Указать имя пользователя и пароль дайджест-аутентификации для запроса. | |
| $this | withToken(string $token, string $type = 'Bearer')
Указать маркер авторизации для запроса. | |
| $this | withUserAgent(string|bool $userAgent)
Указать user agent для запроса. | |
| $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(array|int $times, Closure|int $sleepMilliseconds = 0, callable|null $when = null, bool $throw = true)
Указать количество попыток запроса. | |
| $this | withOptions(array $options)
Заменить указанные параметры в запросе. | |
| $this | withMiddleware(callable $middleware)
Добавить новое промежуточное ПО в стек обработчиков клиента. | |
| $this | withRequestMiddleware(callable $middleware)
Добавить новое промежуточное ПО запроса в стек обработчиков клиента. | |
| $this | withResponseMiddleware(callable $middleware)
Добавить новое промежуточное ПО ответа в стек обработчиков клиента. | |
| $this | beforeSending(callable $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. | |
| Response> | 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)
Обработать данные многочастной формы. | |
| 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)
Получить данные запроса в виде массива, чтобы можно было прикрепить их к запросу для удобства утверждений. | |
| array | normalizeRequestOptions(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)
Заменить заданные параметры на текущие параметры запроса. | |
| Response | newResponse(MessageInterface $response)
Создать новый экземпляр ответа, используя заданный PSR-ответ. | |
| $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(Request $request)
Отправить событие ConnectionFailed, если диспетчер доступен. | |
| $this | setClient(Client $client)
Установить экземпляр клиента. | |
| $this | setHandler(callable $handler)
Создать новый экземпляр клиента с помощью заданного обработчика. | |
| array | getOptions()
Получить параметры ожидающего запроса. |
Details
$this|TWhenReturnType when($value = null, callable $callback = null, callable $default = null)
Применить обратный вызов, если заданное «значение» истинно (или разрешается до истинного).
$this|TUnlessReturnType unless($value = null, callable $callback = null, callable $default = null)
Применить обратный вызов, если заданное «значение» ложно (или разрешается до ложного).
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос.
static void mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрирован ли макрос.
static void flushMacros()
Очистить существующие макросы.
static mixed __callStatic(string $method, array $parameters)
Динамически обработать вызовы к классу.
mixed __call(string $method, array $parameters)
Динамически обработать вызовы к классу.
void __construct(Factory $factory = null, array $middleware = [])
Создать новый экземпляр HTTP-клиента.
$this baseUrl(string $url)
Установить базовый URL для ожидающего запроса.
$this withBody(StreamInterface|string $content, string $contentType = 'application/json')
Прикрепить к запросу сырое тело.
$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 withQueryParameters(array $parameters)
Установить заданные параметры запроса в URI запроса.
$this contentType(string $contentType)
Указать тип содержимого запроса.
$this acceptJson()
Указать, что JSON должен быть возвращен сервером.
$this accept(string $contentType)
Указать тип содержимого, который должен быть возвращен сервером.
$this withHeaders(array $headers)
Добавить заданные заголовки к запросу.
$this withHeader(string $name, mixed $value)
Добавить указанный заголовок к запросу.
$this replaceHeaders(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|bool $userAgent)
Указать пользовательского агента для запроса.
$this withUrlParameters(array $parameters = [])
Указать параметры URL, которые могут быть подставлены в URL запроса.
$this withCookies(array $cookies, string $domain)
Указать куки, которые должны быть включены в запрос.
$this maxRedirects(int $max)
Указать максимальное количество редиректов.
$this withoutRedirecting()
Указать, что редиректы не должны следовать.
$this withoutVerifying()
Указать, что сертификаты TLS не должны проверяться.
$this sink(string|resource $to)
Указать путь, куда следует сохранить тело ответа.
$this timeout(int $seconds)
Указать таймаут (в секундах) для запроса.
$this connectTimeout(int $seconds)
Указать таймаут соединения (в секундах) для запроса.
$this retry(array|int $times, Closure|int $sleepMilliseconds = 0, callable|null $when = null, bool $throw = true)
Указать количество попыток для запроса.
$this withOptions(array $options)
Заменить указанные опции в запросе.
$this withMiddleware(callable $middleware)
Добавить новый middleware в стек обработчиков клиента.
$this withRequestMiddleware(callable $middleware)
Добавить новый middleware для обработки запроса в стек обработчиков клиента.
$this withResponseMiddleware(callable $middleware)
Добавить новый middleware для обработки ответа в стек обработчиков клиента.
$this beforeSending(callable $callback)
Добавить новый callback "перед отправкой" в запрос.
$this throw(callable $callback = null)
Выбросить исключение, если произошла ошибка сервера или клиента.
$this throwIf(callable|bool $condition)
Выбросить исключение, если произошла ошибка сервера или клиента, и данное условие истинно.
$this throwUnless(bool $condition)
Выбросить исключение, если произошла ошибка сервера или клиента, и заданное условие равно false.
$this dump()
Вывести запрос перед отправкой.
$this dd()
Вывести запрос перед отправкой и завершить сценарий.
Ответ get(string $url, array|string|null $query = null)
Отправить запрос GET по указанному URL.
Ответ head(string $url, array|string|null $query = null)
Отправить запрос HEAD по указанному URL.
Ответ post(string $url, array $data = [])
Отправить запрос POST по указанному URL.
Ответ patch(string $url, array $data = [])
Отправить запрос PATCH по указанному URL.
Ответ put(string $url, array $data = [])
Отправить запрос PUT по указанному URL.
Ответ delete(string $url, array $data = [])
Отправить запрос DELETE по указанному URL.
Response> pool(callable $callback)
Отправить пул асинхронных запросов одновременно.
Ответ send(string $method, string $url, array $options = [])
Отправить запрос по указанному URL.
protected string expandUrlParameters(string $url)
Заменить параметры URL в данном URL.
protected array parseHttpOptions(array $options)
Обработать заданные HTTP-параметры и установить соответствующие дополнительные параметры.
protected array|array[] parseMultipartBodyFormat(array $data)
Обработать данные многочастной формы.
protected PromiseInterface makePromise(string $method, string $url, array $options = [])
Отправить асинхронный запрос по указанному URL.
protected MessageInterface|PromiseInterface sendRequest(string $method, string $url, array $options = [])
Отправить запрос синхронно или асинхронно.
protected array parseRequestData(string $method, string $url, array $options)
Получить данные запроса в виде массива, чтобы можно было прикрепить их к запросу для удобного использования в утверждениях.
protected array normalizeRequestOptions(array $options)
Нормализовать заданные параметры запроса.
protected Ответ populateResponse(Ответ $response)
Заполнить предоставленный ответ дополнительными данными.
Клиент buildClient()
Создать клиент Guzzle.
protected bool requestsReusableClient()
Определить, требуется ли повторно используемый клиент.
protected Клиент getReusableClient()
Получить повторно используемый клиент Guzzle.
Клиент createClient(HandlerStack $handlerStack)
Создать новый клиент Guzzle.
HandlerStack buildHandlerStack()
Создать стек обработчиков клиента Guzzle.
HandlerStack pushHandlers(HandlerStack $handlerStack)
Добавить необходимые обработчики в заданный стек обработчиков.
Closure buildBeforeSendingHandler()
Создать обработчик перед отправкой.
Closure buildRecorderHandler()
Создать обработчик записи.
Closure buildStubHandler()
Создать обработчик заглушки.
protected Closure sinkStubHandler(string $sink)
Получить обратный вызов обработчика заглушки стока.
RequestInterface runBeforeSendingCallbacks(RequestInterface $request, array $options)
Выполнить обратные вызовы «перед отправкой».
array mergeOptions(array ...$options)
Заменить указанные параметры текущими параметрами запроса.
protected Response newResponse(MessageInterface $response)
Создать новый экземпляр ответа, используя предоставленный PSR-ответ.
$this stub(callable $callback)
Зарегистрировать вызываемый объект заглушки, который будет перехватывать запросы и сможет возвращать ответы заглушки.
$this preventStrayRequests(bool $prevent = true)
Указать, что должно быть выброшено исключение, если какой-либо запрос не является поддельным.
$this async(bool $async = true)
Переключить асинхронность в запросах.
PromiseInterface|null getPromise()
Получить ожидаемое обещание запроса.
protected void dispatchRequestSendingEvent()
Отправить событие RequestSending, если диспетчер доступен.
protected void dispatchResponseReceivedEvent(Response $response)
Отправить событие ResponseReceived, если диспетчер доступен.
protected void dispatchConnectionFailedEvent(Request $request)
Отправить событие ConnectionFailed, если диспетчер доступен.
$this setClient(Client $client)
Установить экземпляр клиента.
$this setHandler(callable $handler)
Создать новый экземпляр клиента, используя предоставленный обработчик.
array getOptions()
Получить параметры ожидаемого запроса.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Http/Client/PendingRequest.html
