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

SortField

Описание: Enum для полей сортировки при поиске фильмов Этот enum содержит все возможные поля, которые можно использовать для сортировки результатов поиска через API Kinopoisk.dev

С версии: 1.0.0

Версия: 1.0.0

getPersonFields()

Описание: Возвращает массив полей персон для выбора Предоставляет статически кэшируемый список всех доступных полей персон, которые могут быть использованы при запросах к API для получения информации о персонах. Включает основные данные персоны, информацию о супругах, фильмографию и дополнительные метаданные. Возвращаемые поля включают: - Базовую информацию: ID, имя, год рождения, пол, рост - Даты: дата создания/обновления записи, день рождения, дата смерти - Профессиональную информацию: профессия, количество наград, возраст - Места: место рождения и смерти - Фото и факты - Информацию о супругах: ID, имя, пол, развод и причины, дети, тип отношений - Фильмографию: ID фильмов, названия, альтернативные названия, рейтинги, общую информацию, описания, английские профессии Метод использует статическое кэширование для оптимизации производительности при множественных вызовах в рамках одного запроса.

С версии: 1.0.0

Возвращает: array<int, string> Массив строковых значений полей персон

Пример:

PHP
1
2
3
4
$fields = PersonField::getPersonFields();
$selectFields = implode(',', $fields); // Для API запроса
// Использование в запросе
$filter->selectFields($fields);

getRatingFields()

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

Возвращает: array<SortField> Массив всех рейтинговых полей SortField

getVotesFields()

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

Возвращает: array<SortField> Массив всех полей голосов SortField

getDescription()

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

Возвращает: string Описательное название поля на русском языке

isRatingField()

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

Возвращает: bool true, если поле является рейтинговым, false в противном случае

isVotesField()

Описание: Проверяет, является ли поле полем голосов Определяет, относится ли поле сортировки к категории голосов. Используется для группировки и специальной обработки полей голосов.

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

isDateField()

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

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

getDataType()

Описание: Возвращает тип данных поля для валидации Определяет тип данных поля сортировки для обеспечения корректной валидации и обработки параметров сортировки.

Возвращает: string Тип данных поля ('number', 'string', 'date')

isNumericField()

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

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

getDefaultDirection()

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

Возвращает: SortDirection Рекомендуемое направление сортировки

Cases

ID

Значение: 'id'

NAME

Значение: 'name'

EN_NAME

Значение: 'enName'

ALTERNATIVE_NAME

Значение: 'alternativeName'

YEAR

Значение: 'year'

CREATED_AT

Значение: 'createdAt'

UPDATED_AT

Значение: 'updatedAt'

RATING_KP

Значение: 'rating.kp'

RATING_IMDB

Значение: 'rating.imdb'

RATING_TMDB

Значение: 'rating.tmdb'

RATING_FILM_CRITICS

Значение: 'rating.filmCritics'

RATING_RUSSIAN_FILM_CRITICS

Значение: 'rating.russianFilmCritics'

RATING_AWAIT

Значение: 'rating.await'

VOTES_KP

Значение: 'votes.kp'

VOTES_IMDB

Значение: 'votes.imdb'

VOTES_TMDB

Значение: 'votes.tmdb'

VOTES_FILM_CRITICS

Значение: 'votes.filmCritics'

VOTES_RUSSIAN_FILM_CRITICS

Значение: 'votes.russianFilmCritics'

VOTES_AWAIT

Значение: 'votes.await'

MOVIE_LENGTH

Значение: 'movieLength'

SERIES_LENGTH

Значение: 'seriesLength'

TOTAL_SERIES_LENGTH

Значение: 'totalSeriesLength'

AGE_RATING

Значение: 'ageRating'

TOP_10

Значение: 'top10'

TOP_250

Значение: 'top250'

PREMIERE_WORLD

Значение: 'premiere.world'

PREMIERE_RUSSIA

Значение: 'premiere.russia'

PREMIERE_USA

Значение: 'premiere.usa'

TYPE

Значение: 'type'

TITLE

Значение: 'title'

MOVIES

Значение: 'movies'

PHOTO

Значение: 'photo'

SEX

Значение: 'sex'

GROWTH

Значение: 'growth'

BIRTHDAY

Значение: 'birthday'

DEATH

Значение: 'death'

AGE

Значение: 'age'

BIRTH_PLACE

Значение: 'birthPlace.value'

DEATH_PLACE

Значение: 'deathPlace.value'

COUNT_AWARDS

Значение: 'countAwards'

PROFESSION

Значение: 'profession.value'

SPOUSES_ID

Значение: 'spouses.id'

SPOUSES_NAME

Значение: 'spouses.name'

SPOUSES_DIVORCED

Значение: 'spouses.divorced'

SPOUSES_DIVORCED_REASON

Значение: 'spouses.divorcedReason'

SPOUSES_SEX

Значение: 'spouses.sex'

SPOUSES_CHILDREN

Значение: 'spouses.children'

SPOUSES_RELATION

Значение: 'spouses.relation'

FACTS

Значение: 'facts.value'

MOVIES_ID

Значение: 'movies.id'

MOVIES_NAME

Значение: 'movies.name'

MOVIES_ALTERNATIVE_NAME

Значение: 'movies.alternativeName'

MOVIES_RATING

Значение: 'movies.rating'

MOVIES_GENERAL

Значение: 'movies.general'

MOVIES_DESCRIPTION

Значение: 'movies.description'

MOVIES_EN_PROFESSION

Значение: 'movies.enProfession'