Image¶

Описание: Класс для представления изображений фильмов Представляет изображение фильма, включая постеры, фоны, логотипы и другие визуальные элементы. Содержит URL-адреса изображений в полном размере и их уменьшенные версии для предварительного просмотра, а также информацию о размерах и разрешении. Предоставляет методы для анализа соотношения сторон и категории качества изображения.

С версии: 1.0.0

Версия: 1.0.0

См. также:

• \KinopoiskDev\Models\ShortImage: Для упрощенной модели изображений
• \KinopoiskDev\Models\Logo: Для логотипов

__construct()¶

Описание: Конструктор модели изображения

Параметры:

• $url (string|null): URL полноразмерного изображения (null если недоступно)
• $previewUrl (string|null): URL превью изображения (null если недоступно)
• $height (int|null): Высота изображения в пикселях (null если неизвестна)
• $width (int|null): Ширина изображения в пикселях (null если неизвестна)

__toString()¶

Описание: Строковое представление изображения Магический метод для получения строкового представления объекта. Возвращает описательную информацию об изображении, включая размеры и категорию разрешения. Если изображение недоступно, возвращает соответствующее сообщение. или изображение недоступно

Возвращает: string Строковое описание изображения в формате "WIDTHxHEIGHT - CATEGORY"

exists()¶

Описание: Проверяет, доступно ли изображение Определяет, доступно ли изображение, проверяя наличие хотя бы одного из URL-адресов (полноразмерного или превью).

Возвращает: bool true если изображение доступно, false в противном случае

getFormattedDimensions()¶

Описание: Возвращает размеры изображения в виде строки Если размеры неизвестны, возвращает null.

Возвращает: string|null Строка размеров в формате "1920x1080" или null если размеры неизвестны

getResolutionCategory()¶

Описание: Возвращает категорию разрешения изображения Определяет категорию разрешения на основе размеров изображения. Если размеры неизвестны, возвращает null.

Возвращает: string|null Категория разрешения ('4K', 'Full HD', 'HD', 'SD', 'Low') или null если размеры неизвестны

fromArray()¶

Описание: Создает объект Image из массива данных API Фабричный метод для создания экземпляра класса Image из массива данных, полученных от API Kinopoisk.dev. Безопасно обрабатывает отсутствующие значения, устанавливая их в null. Автоматически преобразует строковые значения размеров в целые числа. - url: string|null - URL полноразмерного изображения - previewUrl: string|null - URL превью изображения - height: int|string|null - высота изображения - width: int|string|null - ширина изображения

Возвращает: \KinopoiskDev\Models\Image Новый экземпляр класса Image с данными из массива

toArray()¶

Описание: Преобразует объект в массив Конвертирует текущий экземпляр класса Image в массив, совместимый с форматом API Kinopoisk.dev. Используется для сериализации данных при отправке запросов к API или экспорте в JSON. - url: string|null - URL полноразмерного изображения - previewUrl: string|null - URL превью изображения - height: int|null - высота изображения - width: int|null - ширина изображения

Возвращает: array<string, mixed> Массив с данными изображения, содержащий ключи:

getBestUrl()¶

Описание: Возвращает лучший доступный URL изображения Приоритет: полноразмерное изображение > превью

Возвращает: string|null URL наилучшего доступного изображения или null если изображения недоступны

getDimensions()¶

Описание: Возвращает размеры изображения в виде массива Если размеры неизвестны, возвращает null.

Возвращает: array<string, int>|null Массив размеров с ключами 'width' и 'height' или null если размеры неизвестны

isPortrait()¶

Описание: Проверяет, является ли изображение портретным Определяет ориентацию изображения на основе соотношения сторон. Портретным считается изображение с соотношением сторон меньше 1.

Возвращает: bool|null true если изображение портретное, false если альбомное или квадратное, null если размеры неизвестны

getAspectRatio()¶

Описание: Возвращает соотношение сторон изображения

Возвращает: float|null Соотношение сторон (ширина/высота) или null если размеры неизвестны или высота равна 0

isLandscape()¶

Описание: Проверяет, является ли изображение альбомным Определяет ориентацию изображения на основе соотношения сторон. Альбомным считается изображение с соотношением сторон больше 1.

Возвращает: bool|null true если изображение альбомное, false если портретное или квадратное, null если размеры неизвестны

isSquare()¶

Описание: Проверяет, является ли изображение квадратным Определяет, является ли изображение квадратным, сравнивая соотношение сторон с 1 с допуском 0.01 для учета погрешностей вычислений.

Возвращает: bool|null true если изображение квадратное, false в противном случае, null если размеры неизвестны

validate()¶

Описание: Валидирует данные модели

Возвращает: bool True если данные валидны