Опции и перечисления

Значения, которые SDK принимает в параметрах и возвращает в полях сущностей. Перечисления повторяют серверные — те же случаи и те же значения.

ImageOptions

Что сделать с картинкой при загрузке: перекодировать, задать качество, вписать в рамку. Обработка выполняется один раз на сервере, в бакет попадает только результат, оригинал не хранится. Поворот по EXIF применяется, остальные метаданные удаляются.

Неизменяемый объект: каждый метод возвращает новый.

Создание

public function __construct(
  ImageFormat $format = ImageFormat::ORIGINAL,
  ?int $quality = null,
  ?int $maxWidth = null,
  ?int $maxHeight = null,
)

public static function original(): ImageOptions
public static function webp(?int $quality = null): ImageOptions
public static function jpeg(?int $quality = null): ImageOptions
public static function png(?int $quality = null): ImageOptions
public static function avif(?int $quality = null): ImageOptions

Пределы проверяет сервер: значение за ними даёт ValidationException с ошибкой по полю, например {"quality": ["must not exceed 100"]}.

ImageOptions::fit()

Вписывает картинку в рамку. Только уменьшает, никогда не увеличивает, пропорции сохраняются: 320×200 в рамке 160×160 станет 160×100.

public function fit(?int $maxWidth, ?int $maxHeight = null): ImageOptions

fit(800) ограничивает только ширину; fit(null, 600) — только высоту.

ImageOptions::quality()

Задаёт качество, остальное сохраняет.

public function quality(int $quality): ImageOptions

ImageOptions::isEmpty()

true, если опции ничего не просят: формат ORIGINAL, качество и размеры не заданы. Такие опции сервер не применяет вовсе — processed->reason будет no options.

public function isEmpty(): bool

Примеры

use Flytachi\Winter\SDK\S5w\Option\ImageOptions;

ImageOptions::webp();                     // WebP, качество 82
ImageOptions::webp(80)->fit(1600, 1600);  // WebP 80, вписать в 1600×1600
ImageOptions::avif(50);                   // AVIF 50
ImageOptions::original()->fit(800);       // формат оставить, ширина не больше 800
ImageOptions::jpeg()->quality(90);        // JPEG 90

ImageFormat

Во что перекодировать картинку. Строковое перечисление.

Методы

mime(): ?string — MIME-тип формата; null для ORIGINAL.

Retention

Сколько хранятся файлы папки, считая от создания каждого файла. Очистка на сервере идёт раз в пять минут, поэтому удаление происходит быстро, но не мгновенно.

Методы

interval(): ?DateInterval — срок как интервал; null для NONE.

$file->createdAt->add($folder->retention->interval());   // когда файл удалится

(Точное время удаления есть и в самом файле — $file->expiresAt.)

CacheVisibility

Кто может кэшировать файл — директива заголовка Cache-Control.

Методы

directive(): string — директива для Cache-Control.

TokenAccess

Уровень доступа ключа — поле KeyInfo::$access.

Методы

isFull(): bool — можно ли этим ключом работать с folders(), files() и uploads().

if (!$s5w->check()->access->isFull()) {
  throw new RuntimeException('Нужен ключ FULL');
}

FileSort

Поле сортировки в files()->list() и files()->all().

SortDirection