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

KeywordRequests

Описание: Класс для API-запросов, связанных с ключевыми словами Этот класс предоставляет методы для всех конечных точек ключевых слов API Kinopoisk.dev. Позволяет получать информацию о тематических метках, которые используются для категоризации и поиска фильмов по содержанию.

С версии: 1.0.0

Версия: 1.0.0

См. также:

  • \KinopoiskDev\Models\Keyword: Для структуры данных ключевого слова
  • \KinopoiskDev\Filter\KeywordSearchFilter: Для фильтрации запросов

getKeywordsByTitle()

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

Параметры:

  • $title (string): Название ключевого слова для поиска
  • $page (int): Номер страницы результатов
  • $limit (int): Количество результатов на странице

Возвращает: KeywordDocsResponseDto Ключевые слова с подходящими названиями

Исключения:

  • KinopoiskDevException: При ошибках API
  • \JsonException: При ошибках парсинга JSON

searchKeywords()

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

API Endpoint: /v1.4/keyword

Параметры:

  • $filters (KeywordSearchFilter|null): Объект фильтра для поиска ключевых слов
  • $page (int): Номер страницы результатов (по умолчанию: 1)
  • $limit (int): Количество результатов на странице (по умолчанию: 10, максимум: 250)

Возвращает: KeywordDocsResponseDto Результаты поиска с пагинацией

Исключения:

  • KinopoiskDevException: При ошибках API

getKeywordsForMovie()

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

Параметры:

  • $movieId (int): Идентификатор фильма
  • $page (int): Номер страницы результатов
  • $limit (int): Количество результатов на странице

Возвращает: KeywordDocsResponseDto Ключевые слова, связанные с фильмом

Исключения:

  • KinopoiskDevException: При ошибках API
  • \JsonException: При ошибках парсинга JSON

getKeywordById()

Описание: Получает ключевое слово по его ID Выполняет поиск конкретного ключевого слова по его уникальному идентификатору.

Параметры:

  • $keywordId (int): Уникальный идентификатор ключевого слова

Возвращает: Keyword|null Ключевое слово или null если не найдено

Исключения:

  • KinopoiskDevException: При ошибках API
  • \JsonException: При ошибках парсинга JSON