Перейти к содержанию

ExternalId

Описание: Класс для представления внешних идентификаторов фильмов Содержит идентификаторы фильма в различных внешних системах, таких как Kinopoisk HD, IMDB и The Movie Database (TMDB). Предоставляет методы для работы с идентификаторами, включая получение URL-адресов и проверку существования идентификаторов.

С версии: 1.0.0

Версия: 1.0.0

См. также:

  • \KinopoiskDev\Models\LinkedMovie: Для связанных фильмов с внешними идентификаторами
  • \KinopoiskDev\Models\Movie: Для использования внешних идентификаторов в фильмах

__construct()

Описание: Конструктор для создания объекта внешних идентификаторов Создает новый экземпляр класса ExternalId с указанными идентификаторами из внешних систем. Все параметры являются опциональными и могут быть null при отсутствии соответствующего идентификатора.

Параметры:

  • $kpHD (string|null): Идентификатор фильма в системе Kinopoisk HD (null если не указан)
  • $imdb (string|null): Идентификатор фильма в системе IMDB (null если не указан)
  • $tmdb (int|null): Идентификатор фильма в системе TMDB (null если не указан)

См. также:

  • ExternalId::fromArray: () Для создания объекта из массива данных API
  • ExternalId::toArray: () Для преобразования объекта в массив

__toString()

Описание: Возвращает строковое представление внешних идентификаторов Магический метод для преобразования объекта в строку. Формирует читаемое представление всех доступных внешних идентификаторов, разделенных запятыми. Если идентификаторы отсутствуют, возвращает сообщение об их отсутствии. "KP HD: {id}, IMDB: {id}, TMDB: {id}" или "No external IDs"

Возвращает: string Строковое представление внешних идентификаторов в формате

См. также:

  • ExternalId::getAvailableIds: () Для получения доступных идентификаторов
  • ExternalId::hasAnyId: () Для проверки наличия идентификаторов

fromArray()

Описание: Создает объект ExternalId из массива данных API Фабричный метод для создания экземпляра класса ExternalId из массива данных, полученных от API Kinopoisk.dev. Безопасно обрабатывает отсутствующие значения, устанавливая их в null. Преобразует строковое значение TMDB в целое число. - kpHD: string|null - идентификатор Kinopoisk HD - imdb: string|null - идентификатор IMDB - tmdb: string|int|null - идентификатор TMDB

Возвращает: static Новый экземпляр класса ExternalId с данными из массива

См. также:

  • ExternalId::toArray: () Для обратного преобразования в массив

toArray()

Описание: Преобразует объект в массив данных Конвертирует текущий экземпляр класса ExternalId в массив, совместимый с форматом API Kinopoisk.dev. Используется для сериализации данных при отправке запросов к API или для экспорта данных в JSON. - kpHD: string|null - идентификатор Kinopoisk HD - imdb: string|null - идентификатор IMDB - tmdb: int|null - идентификатор TMDB

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

См. также:

  • ExternalId::fromArray: () Для создания объекта из массива

getImdbUrl()

Описание: Генерирует URL-адрес страницы фильма в системе IMDB Формирует полный URL-адрес страницы фильма в системе IMDB на основе сохраненного идентификатора. Возвращает null, если идентификатор IMDB не установлен.

Возвращает: string|null URL-адрес страницы фильма в IMDB или null, если идентификатор не установлен

См. также:

  • ExternalId::getImdbId: () Для получения идентификатора IMDB
  • ExternalId::hasImdbId: () Для проверки существования идентификатора

getTmdbUrl()

Описание: Генерирует URL-адрес страницы фильма в системе TMDB Формирует полный URL-адрес страницы фильма в системе The Movie Database (TMDB) на основе сохраненного идентификатора. Возвращает null, если идентификатор TMDB не установлен.

Возвращает: string|null URL-адрес страницы фильма в TMDB или null, если идентификатор не установлен

См. также:

  • ExternalId::getTmdbId: () Для получения идентификатора TMDB
  • ExternalId::hasTmdbId: () Для проверки существования идентификатора

hasAnyId()

Описание: Проверяет наличие хотя бы одного внешнего идентификатора Определяет, установлен ли хотя бы один из внешних идентификаторов (Kinopoisk HD, IMDB или TMDB). Возвращает true, если найден хотя бы один не null идентификатор.

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

См. также:

  • ExternalId::hasImdbId: () Для проверки конкретного идентификатора IMDB
  • ExternalId::hasTmdbId: () Для проверки конкретного идентификатора TMDB
  • ExternalId::hasKinopoiskHdId: () Для проверки конкретного идентификатора Kinopoisk HD

hasImdbId()

Описание: Проверяет наличие идентификатора IMDB Определяет, установлен ли идентификатор фильма в системе IMDB. Возвращает true, если идентификатор не равен null.

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

См. также:

  • ExternalId::getImdbId: () Для получения идентификатора IMDB
  • ExternalId::hasAnyId: () Для проверки любого идентификатора

hasTmdbId()

Описание: Проверяет наличие идентификатора TMDB Определяет, установлен ли идентификатор фильма в системе The Movie Database (TMDB). Возвращает true, если идентификатор не равен null.

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

См. также:

  • ExternalId::getTmdbId: () Для получения идентификатора TMDB
  • ExternalId::hasAnyId: () Для проверки любого идентификатора

hasKinopoiskHdId()

Описание: Проверяет наличие идентификатора Kinopoisk HD Определяет, установлен ли идентификатор фильма в системе Kinopoisk HD. Возвращает true, если идентификатор не равен null.

Возвращает: bool true, если идентификатор Kinopoisk HD установлен, false в противном случае

См. также:

  • ExternalId::getKinopoiskHdId: () Для получения идентификатора Kinopoisk HD
  • ExternalId::hasAnyId: () Для проверки любого идентификатора

getAvailableIds()

Описание: Возвращает все доступные идентификаторы в виде ассоциативного массива Собирает все установленные (не null) внешние идентификаторы в ассоциативный массив, где ключами являются названия систем, а значениями - соответствующие идентификаторы. Отсутствующие идентификаторы не включаются в результат. - ключ 'kpHD' содержит идентификатор Kinopoisk HD (если установлен) - ключ 'imdb' содержит идентификатор IMDB (если установлен) - ключ 'tmdb' содержит идентификатор TMDB (если установлен)

Возвращает: array<string, string|int> Ассоциативный массив с доступными идентификаторами, где:

См. также:

  • ExternalId::hasAnyId: () Для проверки наличия идентификаторов
  • ExternalId::toArray: () Для получения всех идентификаторов включая null

validate()

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

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