Используйте эту страницу, когда тип интеграции уже известен, но нужен справочник по API конкретного пакета для работы с форматом переносимых документов (PDF). Каждая строка ведёт на каноническую страницу API для соответствующей области расширения.
Страницы API основаны на исходном коде и используют единый табличный формат: символ, параметры, поведение по умолчанию, возвращаемое значение, режим отказа и примечания по эксплуатации.
| Область | Пакет | Основные символы | Страница API |
|---|
| Фасад Laravel и привязки контейнера | nextpdf/laravel | Pdf, NextPdfServiceProvider, PdfDocumentInterface, DocumentFactoryInterface | API Laravel |
| HTTP-ответы Laravel (Hypertext Transfer Protocol, HTTP) | nextpdf/laravel | PdfResponse::inline, PdfResponse::download, помощники для потоковых ответов | API Laravel |
| Задания очереди Laravel | nextpdf/laravel | GeneratePdfJob::handle, failed, then, catch | API Laravel |
| Фабрика и бандл Symfony | nextpdf/symfony | PdfFactory, NextPdfBundle, NextPdfExtension, Configuration | API Symfony |
| Symfony Messenger (обмен сообщениями) | nextpdf/symfony | GeneratePdfMessage, PdfBuilderInterface, GeneratePdfHandler | API Symfony |
| Сервис и библиотека CodeIgniter | nextpdf/codeigniter | Services, Pdf, pdf(), pdf_document() | API CodeIgniter |
| Задание очереди CodeIgniter | nextpdf/codeigniter | GeneratePdfJob::process, статически вызываемый построитель | API CodeIgniter |
| Область | Пакет | Основные символы | Страница API |
|---|
| Отрисовка на хосте через Chrome | nextpdf/artisan | ChromeHtmlRenderer, ChromeRendererConfig, ChromeRenderResult, BrowserPool | API Artisan |
| Импорт PDF через Chrome | nextpdf/artisan | PdfReader, PageImporter, ImportedFormXObject, PdfObject | API Artisan |
| Низкоуровневая диагностика парсера | nextpdf/artisan | PdfTokenizer, CrossRefParser, RevisionXRefTable, StreamDecoder | API Artisan |
| Cloudflare Browser Rendering (отрисовка в браузере) | nextpdf/cloudflare | CloudflareHtmlRenderer, CloudflareRendererConfig, CloudflareRenderPayload, CloudflareResponseParser | API Cloudflare |
| Защита API в Cloudflare | nextpdf/cloudflare | ApiProtection, ApiProtectionConfig, ApiKeyValidator, RateLimitResult | API Cloudflare |
| Архивация в Cloudflare R2 | nextpdf/cloudflare | R2ArchiveManager, R2ArchiveConfig, R2ObjectKey, R2UploadResult | API Cloudflare |
| Преобразование офисных документов через Gotenberg | nextpdf/gotenberg | GotenbergBridge, GotenbergConfig, GotenbergConvertPayload, GotenbergConvertResult | API Gotenberg |
| Политика форматов и транспорта Gotenberg | nextpdf/gotenberg | OfficeFormat, GotenbergSecurityPolicy, GotenbergResponseParser, PinnedCurlTransport | API Gotenberg |
| Область | Пакет | Основные символы | Страница API |
|---|
| Адаптер TCPDF | nextpdf/compat-legacy | TCPDF, CompatAdapterInterface, LegacyBootstrap, AdaptationConfig | API совместимости с TCPDF |
| Семейства методов TCPDF | nextpdf/compat-legacy | Текст, шрифты, страницы, изображения, рисование, безопасность, формы и вывод | Покрытие методов TCPDF |
| Скрипты сборки Backport | nextpdf/backport-builder | Build, MergeSources, AdjustComposer, ValidateBuildContract | API Backport Builder (сборщик) |
| Правила Rector в Backport | nextpdf/backport-builder | DowngradeAsymmetricVisibilityRector, DowngradeCloneWithRector, DowngradeTraitConstantsRector | API Backport Builder (сборщик) |
| Задача | Начните с | Затем прочитайте |
|---|
| Возвращать PDF из контроллера фреймворка | PdfResponse в соответствующем пакете фреймворка. | Раздел пакета quickstart, затем таблицу ответов api. |
| Создавать файлы PDF в фоновом обработчике | Laravel GeneratePdfJob, Symfony GeneratePdfMessage или CodeIgniter GeneratePdfJob. | Шаблон очереди или Messenger в developer-guide соответствующего пакета. |
| Отрисовывать HTML (Hypertext Markup Language, HTML) через Chrome на хосте | ChromeHtmlRenderer::render(). | Страницы Artisan по конфигурации, безопасности и эксплуатации в продакшене. |
| Отрисовка HTML через Cloudflare | CloudflareHtmlRenderer::render(). | Страницы Cloudflare по защите API и операциям Worker. |
| Преобразовывать офисные документы | GotenbergBridge::convertFile() или convertString(). | Страницы Gotenberg по конфигурации и устранению неполадок. |
| Архивировать созданные файлы PDF в объектное хранилище | R2ArchiveManager::upload() и generateSignedUrl(). | Страницы Cloudflare по эксплуатации в продакшене и безопасности. |
| Переносить кодовую базу TCPDF | TCPDF, покрытие методов и OutputBridge. | Руководство по миграции совместимости с TCPDF. |
| Собирать пакеты для более старых сред выполнения | scripts/build.php и Build::run(). | Руководство разработчика Backport и страницы по эксплуатации в продакшене. |
| Задача | Область конфигурации | Страница пакета |
|---|
| Задавать значения метаданных документа по умолчанию | defaults.* | Конфигурация Laravel, Symfony или CodeIgniter. |
| Предзагружать шрифты для продакшена | preload_fonts или preloadFonts | Страницы конфигурации фреймворков. |
| Настраивать исполняемый файл Chrome и тайм-аут | artisan.* или ChromeRendererConfig | Страницы конфигурации Artisan и фреймворков. |
| Настраивать подпись и службу меток времени (Time-Stamping Authority, TSA) | signature.*, tsa.*, ocsp_cache.* | Страницы конфигурации фреймворков. |
| Защищать публичные конечные точки отрисовки | ApiProtectionConfig | Страницы Cloudflare по API и безопасности. |
| Настраивать архив R2 | R2ArchiveConfig | Страницы Cloudflare по конфигурации и API. |
| Настраивать службу Gotenberg | GotenbergConfig | Страницы Gotenberg по конфигурации и API. |
| Настраивать поведение совместимости | AdaptationConfig | Страница конфигурации совместимости с TCPDF. |
| Симптом | Вероятная граница API | Первая страница для диагностики |
|---|
| Ответ скачивается с неправильным именем файла | Помощник PdfResponse в фреймворке. | Соответствующая страница API фреймворка. |
| Задание очереди завершается с ошибкой до отрисовки | Проверка задания или сообщения. | Соответствующая страница фреймворка по устранению неполадок. |
| Отрисовка через Chrome истекает по тайм-ауту | ChromeHtmlRenderer или BrowserPool. | Страница Artisan по устранению неполадок. |
| Worker возвращает данные, которые не являются выводом PDF | CloudflareResponseParser. | Страница Cloudflare по устранению неполадок. |
| Загрузка в R2 проходит успешно, но единый указатель ресурса (Uniform Resource Locator, URL) оказывается непригодным | R2UploadResult или генерация подписанного URL. | Страница Cloudflare по эксплуатации в продакшене. |
| Офисный файл отклонён | OfficeFormat или GotenbergSecurityPolicy. | Страница Gotenberg по устранению неполадок. |
| Устаревший метод TCPDF выбрасывает исключение | Аспект совместимости или фабрика исключений. | Страница покрытия методов TCPDF. |
| Вывод Backport не проходит проверку синтаксиса | Конфигурация Rector или пользовательское правило. | Руководство разработчика Backport. |
Каждая страница API пакета должна описывать:
| Обязательная деталь | Причина |
|---|
| Полностью квалифицированный символ | Помогает находить его в исходном коде и тестах, не угадывая пространства имён. |
| Имена параметров и значения по умолчанию | Убирает неоднозначность в месте вызова и поддерживает типизированные примеры. |
| Поведение по умолчанию | Позволяет безопасно и осознанно опускать необязательные входные данные. |
| Возвращаемое значение или побочный эффект | Показывает, поддерживает ли метод цепочку вызовов, является терминальным или диагностическим. |
| Режим отказа | Помогает рабочему коду отказывать в закрытом режиме и логировать правильную границу. |
| Эксплуатационное примечание | Фиксирует вопросы безопасности обработчика, защиты, памяти, тайм-аутов или совместимости. |
