Интеграции
Интеграции NextPDF связывают ядро Portable Document Format (PDF) с фреймворками приложений, средствами отрисовки в браузере, пограничными сервисами, инструментами сборки и миграциями устаревшего кода. Каждый раздел интеграции построен по единой структуре руководства: обзор, установка, быстрый старт, настройка, API, руководство для разработчика, эксплуатация в продакшене, безопасность и устранение неполадок.
Карта интеграций
Заголовок раздела «Карта интеграций»| Интеграция | Пакет | Когда использовать | Основной раздел |
|---|---|---|---|
| Laravel | nextpdf/laravel | Используйте, когда разрабатываете приложения на Laravel и вам нужны привязки контейнера, фасад, ответы и задания очередей. | Laravel |
| Symfony | nextpdf/symfony | Используйте, когда разрабатываете приложения на Symfony и вам нужны bundle, связывание через внедрение зависимостей, задания Messenger и HTTP-ответы. | Symfony |
| CodeIgniter | nextpdf/codeigniter | Используйте, когда разрабатываете приложения на CodeIgniter 4 и вам нужны сервисы, библиотечная обёртка, ответы и задания очередей. | CodeIgniter |
| Artisan | nextpdf/artisan | Используйте, когда вам нужна отрисовка HTML через Chrome DevTools Protocol (CDP), импорт страниц или низкоуровневые утилиты для проверки PDF. | Artisan |
| Cloudflare | nextpdf/cloudflare | Используйте, когда выполняете отрисовку через Cloudflare Browser Rendering, защищаете доступ к API или архивируете PDF в R2. | Cloudflare |
| Gotenberg | nextpdf/gotenberg | Используйте, когда преобразуете офисные документы или HTML через сервис Gotenberg. | Gotenberg |
| Совместимость с TCPDF | nextpdf/compat-legacy | Используйте, когда переносите код приложения в стиле TCPDF на NextPDF без полного переписывания. | Совместимость с TCPDF |
| Backport Builder (сборщик бэкпортов) | nextpdf/backport-builder | Используйте, когда сопровождаете артефакты выпуска для более старых сред выполнения PHP (PHP: Hypertext Preprocessor). | Backport Builder (сборщик бэкпортов) |
Руководство по выбору
Заголовок раздела «Руководство по выбору»| Потребность | Начните отсюда | Примечание по эксплуатации |
|---|---|---|
| Хелперы ответов фреймворка | Laravel, Symfony или CodeIgniter | Пакет фреймворка отвечает за интеграцию с контейнером и ответами; ядро создаёт документы. |
| Пиксельная отрисовка HTML | Artisan или Cloudflare | Выбирайте Artisan для локального Chrome с CDP на своём хосте. Выбирайте Cloudflare, когда отрисовка должна выполняться на границе сети. |
| Преобразование офисных документов | Gotenberg | Рассматривайте Gotenberg как границу внешнего сервиса и контролируйте тайм-ауты, размер и риски подделки запросов на стороне сервера (SSRF). |
| Миграция с устаревшего TCPDF | Совместимость с TCPDF | Проверьте таблицу покрытия методов, прежде чем считать, что устаревший вызов поддерживается. |
| Более старый дистрибутив PHP | Backport Builder (сборщик бэкпортов) | Это только инструмент сборки; не устанавливайте его как зависимость среды выполнения приложения. |
Структура руководства
Заголовок раздела «Структура руководства»Каждый раздел интеграции содержит следующие типы страниц:
| Страница | Назначение |
|---|---|
overview | Границы продукта, целевая аудитория, поддерживаемые сценарии работы и ограничения. |
install | Команды установки и необходимые зависимости среды выполнения. |
quickstart | Минимальный рабочий сценарий с первым результатом, который можно скопировать. |
configuration | Поддерживаемые ключи конфигурации, переменные окружения, значения по умолчанию и их эффекты. |
api | Публичные классы, методы, параметры, значения по умолчанию, возвращаемые значения и исключения. |
developer-guide | Архитектура расширения, жизненный цикл, точки расширения и организация кода. |
production-usage | Развёртывание, надёжность, производительность, безопасность воркеров и наблюдаемость. |
security-and-operations | Границы доверия, безопасные значения по умолчанию, секреты, доступ к файлам и средства операционного контроля. |
troubleshooting | Симптомы, диагностика, вероятные причины и способы исправления. |
Соглашение о таблицах API
Заголовок раздела «Соглашение о таблицах API»Таблицы API используют одни и те же столбцы во всём руководстве, поэтому вы можете сравнивать пакеты без изучения новой структуры.
| Столбец | Значение |
|---|---|
| Символ | Полностью квалифицированное имя класса, метод, конечная точка, команда интерфейса командной строки (CLI) или объект конфигурации. |
| Параметры | Имя, тип, признак обязательности, значение по умолчанию и допустимые значения. |
| Поведение по умолчанию | Что происходит, когда вы не передаёте необязательные входные данные. |
| Возвращает | Тип возвращаемого значения или выходной артефакт. |
| Выбрасывает или завершается с ошибкой | Тип исключения, статус HTTP, ошибка проверки или сценарий эксплуатационного сбоя. |
| Примечания | Сведения о безопасности, безопасности воркеров, совместимости или производительности. |
Готовность к переводу
Заголовок раздела «Готовность к переводу»Английский исходный текст написан с расчётом на последующую локализацию: короткие разделы, стабильные заголовки, явные существительные, отсутствие идиом и таблицы для повторяющихся структур. На новых страницах API сохраняйте имена методов, ключи конфигурации, флаги CLI и имена исключений в форматировании кода, чтобы инструменты перевода оставляли их без изменений.