Пакет · cast

Быстрый старт

Шесть шагов от одной строки до параллельных запросов. Каждый шаг можно запустить отдельно в CLI.

Нужно PHP 8.4, ext-curlВремя ~5 минут

1. Запрос в одну строку

Для скрипта или проверки хватит фасада Cast:

php
use Flytachi\Winter\Cast\Cast;

$response = Cast::get('https://httpbin.org/get', ['q' => 'winter'])->send();

$response->getStatusCode();   // 200
$response->json()['args'];    // ['q' => 'winter']

Второй аргумент — параметры query. json() возвращает массив или null, если тело не JSON-объект.

2. Клиент, настроенный один раз

В приложении удобнее собрать клиент с базовым адресом и заголовками:

php
use Flytachi\Winter\Cast\Client\CastClient;

$api = CastClient::create()
  ->withBaseUrl('https://httpbin.org')
  ->withHeader('X-Api-Key', 'demo')
  ->withUserAgent('my-app/1.0')
  ->withTimeout(10);

$echo = $api->get('headers')->send()->json();
$echo['headers']['X-Api-Key'];    // "demo"
$echo['headers']['User-Agent'];   // "my-app/1.0 WinterCast/2.0.0 curl/8.11.0"

Путь headers дописывается к базовому адресу. Ваш User-Agent идёт первым, Cast добавляет к нему свою версию и версию cURL.

3. Отправить JSON

php
$created = $api->post('post')
  ->withJsonBody(['title' => 'Hello', 'tags' => ['a', 'b']])
  ->send()
  ->json();

$created['json'];   // ['title' => 'Hello', 'tags' => ['a', 'b']]

withJsonBody() кодирует данные и ставит Content-Type: application/json.

4. Обработать ошибку

Ответ 4xx/5xx — это обычный ответ. Чтобы получить исключение, вызовите throw():

php
use Flytachi\Winter\Cast\Exception\ClientErrorException;
use Flytachi\Winter\Cast\Exception\NetworkException;

try {
  $api->get('status/404')->send()->throw();
} catch (ClientErrorException $e) {
  $e->getStatusCode();   // 404
} catch (NetworkException $e) {
  // сервер недоступен или истёк таймаут
}

Подробнее — в Обработке ошибок.

5. Скачать файл

Большой ответ лучше писать сразу на диск, а не в память:

php
$response = $api->get('bytes/5000000')->sinkTo('/tmp/data.bin')->send()->throw();

filesize('/tmp/data.bin');   // 5000000
$response->isSunk();         // true

В файл пишется только успешный ответ (2xx). Подробнее — в Файлах.

6. Несколько запросов сразу

php
$responses = $api->sendAll([
  'one'   => $api->get('delay/1'),
  'two'   => $api->get('delay/1'),
  'three' => $api->get('delay/1'),
]);

// ~1 секунда, а не 3
$responses['two']->getStatusCode();   // 200

Ответы возвращаются с теми же ключами. Подробнее — в Параллельных запросах.

Дальше