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

KeywordSearchFilter

Описание: Фильтр для поиска ключевых слов Класс предоставляет методы для создания фильтров поиска ключевых слов по различным критериям: ID, названию, связанным фильмам, датам и т.д. Используется в KeywordRequests для формирования параметров запроса к API.

С версии: 1.0.0

Версия: 1.0.0

См. также:

  • \KinopoiskDev\Http\KeywordRequests: Для использования фильтра

id()

Описание: Добавляет фильтр по ID ключевого слова

Параметры:

  • $id (int|array): ID ключевого слова или массив ID
  • $operator (string): Оператор сравнения (eq, ne, in, nin)

title()

Описание: Добавляет фильтр по названию ключевого слова

Параметры:

  • $title (string): Название ключевого слова
  • $operator (string): Оператор сравнения (eq, ne, regex)

movieId()

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

Параметры:

  • $movieId (int|array): ID фильма или массив ID фильмов

createdAt()

Описание: Добавляет фильтр по дате создания

Параметры:

  • $createdAt (string): Дата создания в ISO формате
  • $operator (string): Оператор сравнения (eq, ne, gt, gte, lt, lte)

updatedAt()

Описание: Добавляет фильтр по дате обновления

Параметры:

  • $updatedAt (string): Дата обновления в ISO формате
  • $operator (string): Оператор сравнения (eq, ne, gt, gte, lt, lte)

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

Параметры:

  • $query (string): Поисковый запрос

onlyPopular()

Описание: Фильтр для популярных ключевых слов (связанных с большим количеством фильмов) Возвращает ключевые слова, которые встречаются в 10 и более фильмах.

Параметры:

  • $minMovieCount (int): Минимальное количество связанных фильмов

recentlyCreated()

Описание: Фильтр для недавно созданных ключевых слов

Параметры:

  • $daysAgo (int): Количество дней назад от текущей даты

recentlyUpdated()

Описание: Фильтр для недавно обновленных ключевых слов

Параметры:

  • $daysAgo (int): Количество дней назад от текущей даты

createdBetween()

Описание: Фильтр по диапазону дат создания

Параметры:

  • $startDate (string): Начальная дата в ISO формате
  • $endDate (string): Конечная дата в ISO формате

updatedBetween()

Описание: Фильтр по диапазону дат обновления

Параметры:

  • $startDate (string): Начальная дата в ISO формате
  • $endDate (string): Конечная дата в ISO формате

selectFields()

Описание: Выбор определенных полей для возвращения

Параметры:

  • $fields (array): Массив названий полей

notNullFields()

Описание: Исключение записей с пустыми значениями в указанных полях

Параметры:

  • $fields (array): Массив названий полей

sortById()

Описание: Сортировка по ID ключевого слова

Параметры:

  • $direction (string): Направление сортировки ('asc' или 'desc')

sortByTitle()

Описание: Сортировка по названию ключевого слова

Параметры:

  • $direction (string): Направление сортировки ('asc' или 'desc')

sortByCreatedAt()

Описание: Сортировка по дате создания

Параметры:

  • $direction (string): Направление сортировки ('asc' или 'desc')

sortByUpdatedAt()

Описание: Сортировка по дате обновления

Параметры:

  • $direction (string): Направление сортировки ('asc' или 'desc')

sortByPopularity()

Описание: Сортировка по популярности (количеству связанных фильмов)

Параметры:

  • $direction (string): Направление сортировки ('desc' для самых популярных)

Возвращает: static

getFilters()

Описание: Возвращает массив фильтров

Возвращает: array<string, mixed>

name()

Описание: Добавляет фильтр по названию

Параметры:

  • $name (string): Название
  • $operator (string): Оператор сравнения

enName()

Описание: Добавляет фильтр по английскому названию

Параметры:

  • $enName (string): Английское название
  • $operator (string): Оператор сравнения

type()

Описание: Добавляет фильтр по типу

Параметры:

  • $type (string|\KinopoiskDev\Enums\ReviewType): Тип
  • $operator (string): Оператор сравнения

Возвращает: \KinopoiskDev\Filter\MovieSearchFilter|\KinopoiskDev\Filter\ImageSearchFilter|\KinopoiskDev\Filter\KeywordSearchFilter|\KinopoiskDev\Filter\PersonSearchFilter|\KinopoiskDev\Filter\ReviewSearchFilter|\KinopoiskDev\Filter\SeasonSearchFilter|\KinopoiskDev\Filter\StudioSearchFilter|\KinopoiskDev\Utils\FilterTrait

searchByName()

Описание: Добавляет поисковый фильтр по названию с использованием регулярных выражений

Параметры:

  • $query (string): Поисковый запрос

searchByEnName()

Описание: Добавляет поисковый фильтр по английскому названию с использованием регулярных выражений

Параметры:

  • $query (string): Поисковый запрос

searchByDescription()

Описание: Добавляет поисковый фильтр по описанию с использованием регулярных выражений

Параметры:

  • $query (string): Поисковый запрос

withMinRating()

Описание: Добавляет фильтр по минимальному рейтингу

Параметры:

  • $minRating (float): Минимальный рейтинг
  • $field (string): Поле рейтинга (kp, imdb и т.д.)

withMaxRating()

Описание: Добавляет фильтр по максимальному рейтингу

Параметры:

  • $maxRating (float): Максимальный рейтинг
  • $field (string): Поле рейтинга (kp, imdb и т.д.)

withRatingBetween()

Описание: Добавляет фильтр по диапазону рейтинга

Параметры:

  • $minRating (float): Минимальный рейтинг
  • $maxRating (float): Максимальный рейтинг
  • $field (string): Поле рейтинга (kp, imdb и т.д.)

addRangeFilter()

Описание: Добавляет фильтр по диапазону

Параметры:

  • $field (string): Имя поля
  • $minValue (int): Минимальное значение
  • $maxValue (int): Максимальное значение

seasonRange()

Описание: Добавляет фильтр по диапазону сезонов

Параметры:

  • $fromSeason (int): Начальный сезон
  • $toSeason (int): Конечный сезон

ageRange()

Описание: Добавляет фильтр по возрастному диапазону

Параметры:

  • $minAge (int): Минимальный возраст
  • $maxAge (int): Максимальный возраст