PendingRequest
class PendingRequest (View source)
Трейты
| Conditionable | |
| Macroable |
Свойства
| static protected array | $macros | Зарегистрированные строковые макросы. | from 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 StreamInterface|string | $pendingBody | Необработанное тело для запроса. | |
| protected array | $pendingFiles | Файлы, ожидающие обработки для запроса. | |
| protected array | $cookies | 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 | $mergeableOptions | Опции запроса Guzzle, которые можно объединить с помощью array_merge_recursive. |
Методы
| $this|TWhenReturnType | when($value = null, callable|null $callback = null, callable|null $default = null)
Применить обратный вызов, если данное "значение" истинно (или разрешается как истинное). | from Conditionable |
| $this|TUnlessReturnType | unless($value = null, callable|null $callback = null, callable|null $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|null $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)
Указать агент пользователя для запроса. | |
| $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|null $callback = null)
Выбросить исключение, если произошла ошибка сервера или клиента. | |
| $this | throwIf(callable|bool $condition)
Выбросить исключение, если произошла ошибка сервера или клиента и заданное условие равно true. |
| $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 = [], int $attempt = 1)
Отправить асинхронный запрос к заданному URL. | |
| mixed | handlePromiseResponse(TransferException $response, string $method, string $url, array $options, int $attempt)
Обработка ответа асинхронного запроса. | |
| 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, ConnectionException $exception)
Отправить событие ConnectionFailed, если диспетчер доступен. | |
| $this | setClient(Client $client)
Установить экземпляр клиента. | |
| $this | setHandler(callable $handler)
Создать новый экземпляр клиента, используя заданный обработчик. | |
| array | getOptions()
Получить параметры ожидаемого запроса. |
Details
$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)
Применить обратный вызов, если заданное "значение" истинно.
$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $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|null $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)
Указать имя пользователя и пароль для аутентификации по протоколу Basic для запроса.
$this withDigestAuth(string $username, string $password)
Указать имя пользователя и пароль для аутентификации по протоколу Digest для запроса.
$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)
Указать куки, которые должны быть включены в запрос.
$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|null $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.
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 = [], int $attempt = 1)
Отправить асинхронный запрос по указанному URL.
protected mixed handlePromiseResponse(TransferException $response, string $method, string $url, array $options, int $attempt)
Обработать ответ асинхронного запроса.
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 Response populateResponse(Response $response)
Заполнить заданный ответ дополнительными данными.
Client buildClient()
Создать клиент Guzzle.
protected bool requestsReusableClient()
Определить, требуется ли повторно используемый клиент.
protected Client getReusableClient()
Получить повторно используемый клиент Guzzle.
Client 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, ConnectionException $exception)
Отправить событие 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/11.x/Illuminate/Http/Client/PendingRequest.html
