PendingRequest
класс PendingRequest (Просмотреть исходный код)
Трейты
| Macroable |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| защищённый Factory|null | $factory | Экземпляр фабрики. | |
| защищённая строка | $baseUrl | Базовый URL для запроса. | |
| защищённая строка | $bodyFormat | Формат тела запроса. | |
| защищённая строка | $pendingBody | Необработанное тело запроса. | |
| защищённый массив | $pendingFiles | Прикреплённые файлы для запроса. | |
| защищённый массив | $cookies | Куки запроса. | |
| защищённый | $transferStats | Статистика передачи для запроса. | |
| защищённый массив | $options | Параметры запроса. | |
| защищённое целое число | $tries | Количество попыток запроса. | |
| защищённое целое число | $retryDelay | Количество миллисекунд ожидания между повторами. | |
| защищённый Collection | $beforeSendingCallbacks | Обработчики, которые должны быть выполнены перед отправкой запроса. | |
| защищённый Collection|null | $stubCallbacks | Заглушки, которые будут обрабатывать запросы. | |
| защищённый Collection | $middleware | Обработчики среднего уровня, добавленные пользователями, которые будут обрабатывать запросы. |
Методы
| 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 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(resource|string $content, string $contentType)
Прикрепить сырой тело к запросу. | |
| $this | asJson()
Указать, что запрос содержит JSON. | |
| $this | asForm()
Указать, что запрос содержит параметры формы. | |
| $this | attach(string $name, string $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 | withCookies(array $cookies, string $domain)
Указать куки, которые должны быть включены в запрос. | |
| $this | withoutRedirecting()
Указать, что перенаправления не должны следовать. | |
| $this | withoutVerifying()
Указать, что сертификаты TLS не должны проверяться. | |
| $this | sink(string|resource $to)
Указать путь, где должно храниться тело ответа. | |
| $this | timeout(int $seconds)
Указать тайм-аут (в секундах) для запроса. | |
| $this | retry(int $times, int $sleep = 0)
Указать количество попыток выполнения запроса. | |
| $this | withOptions(array $options)
Объединить новые параметры в клиент. | |
| $this | withMiddleware(callable $middleware)
Добавить новый middleware в стек обработчиков клиента. | |
| $this | beforeSending(callable $callback)
Добавить новый callback «перед отправкой» к запросу. | |
| 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 | send(string $method, string $url, array $options = [])
Отправить запрос по заданному URL. | |
| array|array[] | parseMultipartBodyFormat(array $data)
Разбор данных многочастной формы. | |
| array | parseRequestData(string $method, string $url, array $options)
Получить данные запроса в виде массива для удобства проверки. | |
| Client | buildClient()
Создать клиент Guzzle. | |
| HandlerStack | buildHandlerStack()
Создать стек обработчиков «перед отправкой». | |
| Closure | buildBeforeSendingHandler()
Создать обработчик «перед отправкой». | |
| Closure | buildRecorderHandler()
Создать обработчик записи. | |
| Closure | buildStubHandler()
Создать обработчик заглушки. | |
| Closure | sinkStubHandler(string $sink)
Получить обратный вызов обработчика заглушки синков. |
| Closure | runBeforeSendingCallbacks(RequestInterface $request, array $options)
Выполнить обратные вызовы «перед отправкой». | |
| массив | mergeOptions(array ...$options)
Объединить заданные параметры с текущими параметрами запроса. | |
| $this | stub(callable $callback)
Зарегистрировать вызываемый объект-заглушку, который будет перехватывать запросы и возвращать запросы-заглушки. |
Подробности
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательскую макрокоманду.
static void mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрирована ли макрокоманда.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывать вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обрабатывать вызовы класса.
void __construct(Factory $factory = null)
Создать новый экземпляр HTTP-клиента.
$this baseUrl(string $url)
Установить базовый URL для ожидающего запроса.
$this withBody(resource|string $content, string $contentType)
Прикрепить к запросу тело в сыром формате.
$this asJson()
Указать, что запрос содержит JSON.
$this asForm()
Указать, что запрос содержит параметры формы.
$this attach(string $name, string $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 withCookies(array $cookies, string $domain)
Укажите куки, которые должны быть включены в запрос.
$this withoutRedirecting()
Укажите, что перенаправления не должны следовать.
$this withoutVerifying()
Укажите, что сертификаты TLS не должны проверяться.
$this sink(string|resource $to)
Укажите путь, куда должно храниться тело ответа.
$this timeout(int $seconds)
Укажите таймаут (в секундах) для запроса.
$this retry(int $times, int $sleep = 0)
Укажите количество попыток запроса.
$this withOptions(array $options)
Объединить новые параметры в клиент.
$this withMiddleware(callable $middleware)
Добавить новый мидлвар в стек обработчика клиента.
$this beforeSending(callable $callback)
Добавить новый обратный вызов «перед отправкой» к запросу.
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 send(string $method, string $url, array $options = [])
Отправить запрос по указанному URL.
protected array|array[] parseMultipartBodyFormat(array $data)
Разбор данных multipart-формата.
protected array parseRequestData(string $method, string $url, array $options)
Получить данные запроса в виде массива для удобства проверок.
Client buildClient()
Создать клиент Guzzle.
HandlerStack buildHandlerStack()
Создать стек обработчиков перед отправкой.
Closure buildBeforeSendingHandler()
Создать обработчик перед отправкой.
Closure buildRecorderHandler()
Создать обработчик записи.
Closure buildStubHandler()
Создать обработчик эмуляции.
protected Closure sinkStubHandler(string $sink)
Получить обратный вызов обработчика эмуляции стока.
Closure runBeforeSendingCallbacks(RequestInterface $request, array $options)
Выполнить обратные вызовы "перед отправкой".
array mergeOptions(array ...$options)
Объединить заданные параметры с текущими параметрами запроса.
$this stub(callable $callback)
Зарегистрировать вызываемый элемент эмуляции, который будет перехватывать запросы и сможет возвращать эмулированные ответы.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Http/Client/PendingRequest.html
