Карта навигации документации
Документация по карта навигации документации. Часть API wrapper для КиноПоиска.
Интерактивная карта навигации по всей документации NotKinopoisk PHP Library.
📚 Навигация: Главная → Карта навигации
🗺️ Структура документации
📁 docs/
├── 📄 index.md # Главная страница
├── 📄 navigation-map.md # Карта навигации (этот файл)
├── 📄 client.md # Основной клиент
│
├── 📁 services/ # Сервисы API
│ ├── 📄 index.md # Обзор сервисов
│ ├── 📄 film-service.md # Сервис фильмов
│ ├── 📄 person-service.md # Сервис персон
│ ├── 📄 media-service.md # Сервис медиа
│ └── 📄 user-service.md # Сервис пользователей
│
├── 📁 models/ # Модели данных
│ ├── 📄 index.md # Обзор моделей
│ ├── 📄 film.md # Модель фильма
│ ├── 📄 person.md # Модель персоны
│ ├── 📄 staff.md # Модель съемочной группы
│ ├── 📄 review.md # Модель отзыва
│ ├── 📄 fact.md # Модель факта
│ ├── 📄 image.md # Модель изображения
│ ├── 📄 video.md # Модель видео
│ ├── 📄 award.md # Модель награды
│ ├── 📄 box-office.md # Модель кассовых сборов
│ ├── 📄 country.md # Модель страны
│ ├── 📄 genre.md # Модель жанра
│ ├── 📄 episode.md # Модель эпизода
│ ├── 📄 season.md # Модель сезона
│ ├── 📄 external-source.md # Модель внешнего источника
│ ├── 📄 distribution.md # Модель дистрибуции
│ ├── 📄 film-search-result.md # Модель результата поиска
│ ├── 📄 person-spouse.md # Модель супруга
│ ├── 📄 person-film.md # Модель фильма персоны
│ ├── 📄 user-vote.md # Модель голоса пользователя
│ ├── 📄 film-collection.md # Модель коллекции фильмов
│ ├── 📄 filters.md # Модель фильтров
│ ├── 📄 related-film.md # Модель связанного фильма
│ ├── 📄 api-key-info.md # Модель информации об API ключе
│ ├── 📄 api-key-qouta.md # Модель квоты API ключа
│ └── 📄 media-post.md # Модель медиа поста
│
├── 📁 enums/ # Перечисления
│ ├── 📄 index.md # Обзор перечислений
│ ├── 📄 image-type.md # Типы изображений
│ ├── 📄 review-order.md # Порядок сортировки отзывов
│ ├── 📄 review-type.md # Типы отзывов
│ ├── 📄 fact-type.md # Типы фактов
│ ├── 📄 profession-key.md # Ключи профессий
│ ├── 📄 video-site.md # Сайты видео
│ ├── 📄 box-office-type.md # Типы кассовых сборов
│ ├── 📄 distribution-type.md # Типы дистрибуции
│ ├── 📄 relation-type.md # Типы связей
│ ├── 📄 sex.md # Пол
│ ├── 📄 api-version.md # Версии API
│ ├── 📄 month.md # Месяцы
│ ├── 📄 film-order.md # Порядок сортировки фильмов
│ ├── 📄 content-type.md # Типы контента
│ ├── 📄 collection-type.md # Типы коллекций
│ ├── 📄 distribution-sub-type.md # Подтипы дистрибуции
│ ├── 📄 production-status.md # Статусы производства
│ └── 📄 account-type.md # Типы аккаунтов
│
├── 📁 responses/ # Ответы API
│ ├── 📄 index.md # Обзор ответов
│ ├── 📄 default-response.md # Базовый ответ
│ ├── 📄 paginated-response.md # Пагинированный ответ
│ ├── 📄 keyword-search-response.md # Ответ поиска
│ ├── 📄 budget-response.md # Ответ с бюджетом
│ ├── 📄 sequel-prequel-response.md # Ответ с сиквелами/приквелами
│ ├── 📄 movie-staff-response.md # Ответ со съемочной командой
│ ├── 📄 review-response.md # Ответ с отзывами
│ └── 📄 simple-response.md # Простой ответ
│
├── 📁 exceptions/ # Исключения
│ ├── 📄 index.md # Обзор исключений
│ ├── 📄 api-exception.md # Базовое исключение API
│ ├── 📄 invalid-api-key-exception.md # Неверный API ключ
│ ├── 📄 rate-limit-exception.md # Превышение лимита
│ ├── 📄 resource-not-found-exception.md # Ресурс не найден
│ └── 📄 kp-validation-exception.md # Ошибка валидации
│
└── 📁 interfaces/ # Интерфейсы
├── 📄 index.md # Обзор интерфейсов
├── 📄 model-interface.md # Интерфейс модели
└── 📄 response-interface.md # Интерфейс ответа🔗 Быстрые ссылки
🚀 Начало работы
- Главная страница - Обзор библиотеки и быстрый старт
- Основной клиент - Главный класс для работы с API
- Примеры использования - Готовые примеры кода
📦 Основные компоненты
- Сервисы - Работа с различными типами данных
- Модели - Структуры данных API
- Перечисления - Константы и типы
- Ответы - Классы ответов API
- Исключения - Обработка ошибок
- Интерфейсы - Базовые контракты
🎯 Популярные разделы
🎬 Работа с фильмами
- FilmService - Основной сервис для работы с фильмами
- Film - Модель фильма с полной информацией
- FilmSearchResult - Результаты поиска фильмов
- ContentType - Типы контента (фильм, сериал, etc.)
- FilmOrder - Сортировка фильмов
👥 Работа с персонами
- PersonService - Сервис для работы с персонами
- Person - Модель персоны
- Staff - Съемочная группа
- ProfessionKey - Профессии в кино
- PersonFilm - Фильмография персоны
🎥 Работа с медиа
- MediaService - Сервис для работы с медиа
- Image - Изображения фильмов
- Video - Видео контент
- ImageType - Типы изображений
- VideoSite - Сайты видео
📝 Работа с отзывами и фактами
- Review - Отзывы пользователей
- Fact - Интересные факты
- ReviewType - Типы отзывов
- ReviewOrder - Сортировка отзывов
- FactType - Типы фактов
🔍 Поиск по функциональности
🔍 Поиск и фильтрация
- FilmService::searchByKeyword() - Поиск фильмов
- PersonService::searchByName() - Поиск персон
- FilmService::getTop() - Топ фильмов
- Filters - Фильтры для поиска
📊 Статистика и рейтинги
- BoxOffice - Кассовые сборы
- Award - Награды и номинации
- UserVote - Пользовательские голоса
- ExternalSource - Внешние источники рейтингов
🎬 Сериалы и эпизоды
- Episode - Эпизоды сериалов
- Season - Сезоны сериалов
- FilmService::getSeasons() - Получение сезонов
🔗 Связанный контент
- RelatedFilm - Связанные фильмы
- FilmService::getSequelsAndPrequels() - Сиквелы и приквелы
- FilmCollection - Коллекции фильмов
⚠️ Обработка ошибок
🔑 Аутентификация
- InvalidApiKeyException - Неверный API ключ
- ApiKeyInfo - Информация об API ключе
- ApiKeyQouta - Квоты запросов
⏱️ Лимиты и ограничения
- RateLimitException - Превышение лимита запросов
- UserService - Информация о лимитах
🔍 Ошибки ресурсов
- ResourceNotFoundException - Ресурс не найден
- ApiException - Общие ошибки API
✅ Валидация данных
- KpValidationException - Ошибки валидации
- ModelInterface - Базовый интерфейс моделей
🛠️ Утилиты и помощники
📄 Ответы API
- DefaultResponse - Базовый ответ
- PaginatedResponse - Пагинация
- KeywordSearchResponse - Ответ поиска
🔧 Интерфейсы
- ModelInterface - Интерфейс моделей
- ResponseInterface - Интерфейс ответов
🌍 Справочные данные
- Country - Страны
- Genre - Жанры
- Distribution - Дистрибуция
- Month - Месяцы
📚 Примеры использования
🚀 Быстрый старт
// Создание клиента
$client = new Client('your-api-key');
// Получение фильма
$film = $client->films->getById(301);
// Поиск фильмов
$searchResults = $client->films->searchByKeyword('матрица');
// Получение съемочной группы
$staff = $client->films->getStaff(301);🔍 Поиск и фильтрация
// Поиск персон
$persons = $client->persons->searchByName('Том Круз');
// Получение топ фильмов
$topFilms = $client->films->getTop();
// Получение изображений
$images = $client->media->getImages(301, ImageType::POSTER);⚠️ Обработка ошибок
try {
$film = $client->films->getById(999999);
} catch (ResourceNotFoundException $e) {
echo "Фильм не найден\n";
} catch (RateLimitException $e) {
echo "Превышен лимит запросов\n";
}🎯 Рекомендуемые маршруты изучения
🆕 Для новичков
- Главная страница - Обзор библиотеки
- Основной клиент - Базовые концепции
- FilmService - Работа с фильмами
- Film - Структура данных фильма
- Примеры - Практические примеры
🔧 Для разработчиков
- Интерфейсы - Базовые контракты
- Исключения - Обработка ошибок
- Ответы - Структура ответов API
- Перечисления - Константы и типы
- Модели - Все модели данных
🎬 Для работы с контентом
- FilmService - Основные операции с фильмами
- PersonService - Работа с персонами
- MediaService - Медиа контент
- UserService - Пользовательские данные
- Связанные модели - Дополнительные данные
🔍 Для поиска и анализа
- FilmService::searchByKeyword() - Поиск фильмов
- PersonService::searchByName() - Поиск персон
- FilmService::getTop() - Топ фильмов
- Статистические модели - Анализ данных
- Перечисления для сортировки - Настройка поиска
📊 Статистика документации
📁 Файлы документации
- Всего файлов: 60+
- Главная страница: 1
- Сервисы: 5
- Модели: 25
- Перечисления: 18
- Ответы: 4
- Исключения: 6
- Интерфейсы: 3
🔗 Связи между компонентами
- Перекрестные ссылки: 200+
- Навигационные элементы: 60+
- Примеры кода: 100+
- Связанные классы: 300+
📚 Содержание
- Строк документации: 15,000+
- Примеров кода: 500+
- Методов API: 50+
- Моделей данных: 25+
- Перечислений: 18+
📚 Навигация: Главная → Карта навигации