Skorzystaj z tej strony, gdy znasz typ integracji, ale potrzebujesz dokumentacji odpowiedniego pakietu do pracy z formatem PDF (Portable Document Format). Każdy wiersz prowadzi do kanonicznej strony API dla danego obszaru rozszerzeń.
Strony API opierają się na kodzie źródłowym i korzystają ze wspólnego formatu tabeli: symbol, parametry, zachowanie domyślne, wartość zwracana, tryb awarii oraz uwagi operacyjne.
| Obszar | Pakiet | Główne symbole | Strona API |
|---|
| Fasada Laravel i powiązania kontenera | nextpdf/laravel | Pdf, NextPdfServiceProvider, PdfDocumentInterface, DocumentFactoryInterface | Laravel API |
| Odpowiedzi HTTP Laravel | nextpdf/laravel | PdfResponse::inline, PdfResponse::download, pomocniki odpowiedzi strumieniowych | Laravel API |
| Zadania w kolejce Laravel | nextpdf/laravel | GeneratePdfJob::handle, failed, then, catch | Laravel API |
| Fabryka i bundle Symfony | nextpdf/symfony | PdfFactory, NextPdfBundle, NextPdfExtension, Configuration | Symfony API |
| Symfony Messenger | nextpdf/symfony | GeneratePdfMessage, PdfBuilderInterface, GeneratePdfHandler | Symfony API |
| Usługa i biblioteka CodeIgniter | nextpdf/codeigniter | Services, Pdf, pdf(), pdf_document() | CodeIgniter API |
| Zadanie kolejki CodeIgniter | nextpdf/codeigniter | GeneratePdfJob::process, statyczny obiekt wywoływalny budowniczego | CodeIgniter API |
| Obszar | Pakiet | Główne symbole | Strona API |
|---|
| Renderowanie przez Chrome na hoście | nextpdf/artisan | ChromeHtmlRenderer, ChromeRendererConfig, ChromeRenderResult, BrowserPool | Artisan API |
| Import PDF przez Chrome | nextpdf/artisan | PdfReader, PageImporter, ImportedFormXObject, PdfObject | Artisan API |
| Diagnostyka parsera niskiego poziomu | nextpdf/artisan | PdfTokenizer, CrossRefParser, RevisionXRefTable, StreamDecoder | Artisan API |
| Cloudflare Browser Rendering | nextpdf/cloudflare | CloudflareHtmlRenderer, CloudflareRendererConfig, CloudflareRenderPayload, CloudflareResponseParser | Cloudflare API |
| Ochrona API Cloudflare | nextpdf/cloudflare | ApiProtection, ApiProtectionConfig, ApiKeyValidator, RateLimitResult | Cloudflare API |
| Archiwizacja Cloudflare R2 | nextpdf/cloudflare | R2ArchiveManager, R2ArchiveConfig, R2ObjectKey, R2UploadResult | Cloudflare API |
| Konwersja dokumentów biurowych Gotenberg | nextpdf/gotenberg | GotenbergBridge, GotenbergConfig, GotenbergConvertPayload, GotenbergConvertResult | Gotenberg API |
| Zasady dotyczące formatu i transportu Gotenberg | nextpdf/gotenberg | OfficeFormat, GotenbergSecurityPolicy, GotenbergResponseParser, PinnedCurlTransport | Gotenberg API |
| Obszar | Pakiet | Główne symbole | Strona API |
|---|
| Adapter TCPDF | nextpdf/compat-legacy | TCPDF, CompatAdapterInterface, LegacyBootstrap, AdaptationConfig | TCPDF compatibility API |
| Rodziny metod TCPDF | nextpdf/compat-legacy | Zagadnienia tekstu, czcionek, strony, obrazów, rysowania, zabezpieczeń, formularzy i wyjścia | TCPDF method coverage |
| Skrypty kompilacji backportu | nextpdf/backport-builder | Build, MergeSources, AdjustComposer, ValidateBuildContract | Backport Builder API |
| Reguły Rector dla backportu | nextpdf/backport-builder | DowngradeAsymmetricVisibilityRector, DowngradeCloneWithRector, DowngradeTraitConstantsRector | Backport Builder API |
| Zadanie | Zacznij od | Następnie przeczytaj |
|---|
| Zwracanie pliku PDF z kontrolera platformy | PdfResponse w odpowiednim pakiecie platformy. | Sekcja quickstart pakietu, a następnie tabela odpowiedzi api. |
| Generowanie plików PDF w tle | Laravel GeneratePdfJob, Symfony GeneratePdfMessage lub CodeIgniter GeneratePdfJob. | Wzorzec kolejki lub Messengera w sekcji developer-guide pakietu. |
| Renderowanie HTML przez Chrome na hoście | ChromeHtmlRenderer::render(). | Strony konfiguracji, zabezpieczeń i użycia produkcyjnego Artisan. |
| Renderowanie HTML za pośrednictwem Cloudflare | CloudflareHtmlRenderer::render(). | Strony ochrony API Cloudflare i operacji Worker. |
| Konwersja dokumentów biurowych | GotenbergBridge::convertFile() lub convertString(). | Strony konfiguracji i rozwiązywania problemów Gotenberg. |
| Archiwizowanie wygenerowanych plików PDF w magazynie obiektów | R2ArchiveManager::upload() oraz generateSignedUrl(). | Strony użycia produkcyjnego i zabezpieczeń Cloudflare. |
| Migracja bazy kodu TCPDF | TCPDF, pokrycie metod oraz OutputBridge. | Przewodnik migracji zgodności TCPDF. |
| Kompilowanie pakietów dla starszego środowiska uruchomieniowego | scripts/build.php oraz Build::run(). | Przewodnik dewelopera i strony użycia produkcyjnego backportu. |
| Zadanie | Obszar konfiguracji | Strona pakietu |
|---|
| Ustawianie wartości domyślnych metadanych dokumentu | defaults.* | Konfiguracja Laravel, Symfony lub CodeIgniter. |
| Wstępne ładowanie czcionek produkcyjnych | preload_fonts lub preloadFonts | Strony konfiguracji platform. |
| Konfiguracja pliku binarnego Chrome i limitu czasu | artisan.* lub ChromeRendererConfig | Strony konfiguracji Artisan i platform. |
| Konfiguracja podpisywania i urzędu znakowania czasem (Time-Stamping Authority, TSA) | signature.*, tsa.*, ocsp_cache.* | Strony konfiguracji platform. |
| Ochrona publicznych punktów końcowych renderowania | ApiProtectionConfig | Strony API i zabezpieczeń Cloudflare. |
| Konfiguracja archiwum R2 | R2ArchiveConfig | Strony konfiguracji i API Cloudflare. |
| Konfiguracja usługi Gotenberg | GotenbergConfig | Strony konfiguracji i API Gotenberg. |
| Dostrajanie zachowania zgodności | AdaptationConfig | Strona konfiguracji zgodności TCPDF. |
| Objaw | Prawdopodobna granica API | Pierwsza strona diagnostyczna |
|---|
| Odpowiedź jest pobierana z nieprawidłową nazwą pliku | Pomocnik PdfResponse platformy. | Odpowiednia strona API platformy. |
| Zadanie w kolejce kończy się niepowodzeniem przed renderowaniem | Walidacja zadania lub wiadomości. | Odpowiednia strona rozwiązywania problemów platformy. |
| Renderowanie Chrome przekracza limit czasu | ChromeHtmlRenderer lub BrowserPool. | Strona rozwiązywania problemów Artisan. |
| Proces roboczy zwraca dane, które nie są wyjściem PDF | CloudflareResponseParser. | Strona rozwiązywania problemów Cloudflare. |
| Przesłanie do R2 się udaje, ale adres URL jest nieprzydatny | R2UploadResult lub generowanie podpisanego adresu URL. | Strona użycia produkcyjnego Cloudflare. |
| Plik biurowy zostaje odrzucony | OfficeFormat lub GotenbergSecurityPolicy. | Strona rozwiązywania problemów Gotenberg. |
| Starsza metoda TCPDF zgłasza wyjątek | Zagadnienie zgodności lub fabryka wyjątków. | Strona pokrycia metod TCPDF. |
| Wyjście backportu nie przechodzi kontroli składni | Konfiguracja Rector lub reguła niestandardowa. | Przewodnik dewelopera backportu. |
Każda strona API pakietu powinna dokumentować:
| Wymagany szczegół | Uzasadnienie |
|---|
| W pełni kwalifikowany symbol | Pomaga przeszukiwać kod źródłowy i testy bez zgadywania przestrzeni nazw. |
| Nazwy parametrów i wartości domyślne | Zapobiega niejednoznaczności w miejscu wywołania i ułatwia tworzenie typowanych przykładów. |
| Zachowanie domyślne | Sprawia, że opcjonalne dane wejściowe można bezpiecznie i świadomie pominąć. |
| Wartość zwracana lub efekt uboczny | Pokazuje, czy metoda jest fluent, terminalna, czy diagnostyczna. |
| Tryb awarii | Pomaga kodowi produkcyjnemu zawodzić bezpiecznie (fail closed) i rejestrować właściwą granicę. |
| Uwaga operacyjna | Uwzględnia kwestie bezpieczeństwa procesu roboczego, zabezpieczeń, pamięci, limitu czasu lub zgodności. |
