Пакет · cast

Исключения

Все исключения Cast живут в Flytachi\Winter\Cast\Exception и реализуют Psr\Http\Client\ClientExceptionInterface.

Иерархия

text
CastException                         RuntimeException, ClientExceptionInterface
├── RequestException                  запрос нельзя отправить            RequestExceptionInterface
├── NetworkException                  ответа нет                         NetworkExceptionInterface
│   └── TimeoutException              истёк таймаут или дедлайн
├── TooLargeException                 тело больше maxResponseSize
├── HttpException                     4xx/5xx — только при throw() / withThrowOnError()
│   ├── ClientErrorException          4xx
│   └── ServerErrorException          5xx
└── BatchException                    sendAll(): часть запросов без ответа

InvalidArgumentException              \InvalidArgumentException, ClientExceptionInterface

CastException

Корень. catch (CastException $e) ловит всё, что связано с отправкой, кроме InvalidArgumentException. Бросается напрямую:

  • jsonOrFail() — тело не JSON-объект или массив;
  • MockTransport — в очереди не осталось ответа.

RequestException

Запрос нельзя отправить. Реализует PSR-18 RequestExceptionInterface.

Когда Сообщение
схема не http/https Only absolute http:// and https:// URLs can be sent
относительный путь без базового адреса … is not an absolute URL and the client has no base URL
больше max редиректов Too many redirects (more than 10) from …
файл sinkTo() не открыть или не записать Cannot open the sink file … / Cannot write the response body …

getRequest() — запрос.

NetworkException

Ответа нет: DNS, отказ в соединении, TLS, обрыв. Реализует PSR-18 NetworkExceptionInterface.

Метод Что возвращает
getRequest() запрос
getCurlErrno(): ?int код ошибки cURL (CURLE_*)
isTransient(): bool повтор может помочь — такие ошибки повторяет RetryPolicy

Временные: не удалось подключиться (7), таймаут (28), пустой ответ (52), ошибка отправки (55) и приёма (56), обрыв тела (18), ошибки HTTP/2 (16, 92). Неизвестный хост и ошибки сертификата временными не считаются.

TimeoutException

Наследует NetworkException.

Метод Что возвращает
isConnect(): bool соединение не установилось за connect
isDeadline(): bool кончился дедлайн всей операции, а не таймаут одной попытки
isTransient(): bool true, кроме дедлайна

Сообщение по таймауту зависания (idle) содержит «Operation too slow».

TooLargeException

Тело в памяти больше maxResponseSize. Бросается по Content-Length до скачивания или при приёме, как только предел превышен.

Метод Что возвращает
getRequest() запрос
getLimit(): int предел в байтах

HttpException

Ответ 4xx/5xx — только из throw() или при withThrowOnError(). Класс выбирается по статусу.

Метод Что возвращает
getRequest() запрос последней попытки
getResponse(): CastResponse ответ — тело ошибки можно прочитать
getStatusCode(): int статус
  • ClientErrorException — 4xx;
  • ServerErrorException — 5xx.

Сообщение — «HTTP 404 Not Found: GET https://api.example.com/users/9», адрес без query и user:password@.

BatchException

Из sendAll(), когда часть запросов не получила ответа. Бросается после завершения всех.

Метод Что возвращает
responses(): array полученные ответы — с ключами запросов
failures(): array ключ запроса ⇒ исключение

getPrevious() — первое из исключений.

InvalidArgumentException

Неверный аргумент при сборке запроса — до какой-либо отправки:

  • заголовок: пустое или неверное имя, \r, \n, NUL;
  • неверный URI, порт, метод или статус ответа;
  • данные, которые нельзя закодировать в JSON;
  • служебная опция в withCurlOptions();
  • неверный аргумент настроек: отрицательный размер, нулевой таймаут, sinkTo() не того типа.

Наследует стандартный \InvalidArgumentException — этого требует PSR-7 для методов with*() — и реализует ClientExceptionInterface.