Lewati ke konten

Indeks API integrasi

Gunakan halaman ini ketika Anda sudah mengetahui jenis integrasi yang dibutuhkan, tetapi memerlukan rujukan khusus paket untuk pekerjaan Portable Document Format (PDF). Setiap baris mengarah ke halaman API resmi untuk area ekstensi tersebut.

Halaman API berbasis kode sumber dan menggunakan format tabel yang sama: simbol, parameter, perilaku standar, nilai kembalian, mode kegagalan, dan catatan operasional.

PermukaanPaketSimbol utamaHalaman API
Facade Laravel dan binding containernextpdf/laravelPdf, NextPdfServiceProvider, PdfDocumentInterface, DocumentFactoryInterfaceLaravel API
Respons Hypertext Transfer Protocol (HTTP) Laravelnextpdf/laravelPdfResponse::inline, PdfResponse::download, helper respons streamLaravel API
Tugas antrean Laravelnextpdf/laravelGeneratePdfJob::handle, failed, then, catchLaravel API
Factory dan bundle Symfonynextpdf/symfonyPdfFactory, NextPdfBundle, NextPdfExtension, ConfigurationSymfony API
Symfony Messengernextpdf/symfonyGeneratePdfMessage, PdfBuilderInterface, GeneratePdfHandlerSymfony API
Service dan library CodeIgniternextpdf/codeigniterServices, Pdf, pdf(), pdf_document()CodeIgniter API
Tugas antrean CodeIgniternextpdf/codeigniterGeneratePdfJob::process, callable builder statisCodeIgniter API
PermukaanPaketSimbol utamaHalaman API
Perenderan Chrome di hostnextpdf/artisanChromeHtmlRenderer, ChromeRendererConfig, ChromeRenderResult, BrowserPoolArtisan API
Impor PDF Chromenextpdf/artisanPdfReader, PageImporter, ImportedFormXObject, PdfObjectArtisan API
Diagnostik parser tingkat rendahnextpdf/artisanPdfTokenizer, CrossRefParser, RevisionXRefTable, StreamDecoderArtisan API
Cloudflare Browser Renderingnextpdf/cloudflareCloudflareHtmlRenderer, CloudflareRendererConfig, CloudflareRenderPayload, CloudflareResponseParserCloudflare API
Proteksi API Cloudflarenextpdf/cloudflareApiProtection, ApiProtectionConfig, ApiKeyValidator, RateLimitResultCloudflare API
Pengarsipan Cloudflare R2nextpdf/cloudflareR2ArchiveManager, R2ArchiveConfig, R2ObjectKey, R2UploadResultCloudflare API
Konversi dokumen office dengan Gotenbergnextpdf/gotenbergGotenbergBridge, GotenbergConfig, GotenbergConvertPayload, GotenbergConvertResultGotenberg API
Kebijakan format dan transport Gotenbergnextpdf/gotenbergOfficeFormat, GotenbergSecurityPolicy, GotenbergResponseParser, PinnedCurlTransportGotenberg API
PermukaanPaketSimbol utamaHalaman API
Adapter TCPDFnextpdf/compat-legacyTCPDF, CompatAdapterInterface, LegacyBootstrap, AdaptationConfigAPI kompatibilitas TCPDF
Keluarga metode TCPDFnextpdf/compat-legacyPenanganan teks, fon, halaman, gambar, penggambaran, keamanan, formulir, dan keluaranCakupan metode TCPDF
Skrip build backportnextpdf/backport-builderBuild, MergeSources, AdjustComposer, ValidateBuildContractBackport Builder API
Aturan Rector backportnextpdf/backport-builderDowngradeAsymmetricVisibilityRector, DowngradeCloneWithRector, DowngradeTraitConstantsRectorBackport Builder API
TugasMulai denganLalu baca
Mengembalikan PDF dari controller frameworkPdfResponse di paket framework yang sesuai.Bagian quickstart paket, lalu tabel respons pada api.
Membuat berkas PDF di worker latar belakangLaravel GeneratePdfJob, Symfony GeneratePdfMessage, atau CodeIgniter GeneratePdfJob.Pola antrean atau Messenger dalam developer-guide paket.
Merender Hypertext Markup Language (HTML) dengan Chrome di hostChromeHtmlRenderer::render().Halaman konfigurasi, keamanan, dan penggunaan produksi Artisan.
Merender HTML melalui CloudflareCloudflareHtmlRenderer::render().Halaman proteksi API Cloudflare dan operasi Worker.
Mengonversi dokumen officeGotenbergBridge::convertFile() atau convertString().Halaman konfigurasi dan pemecahan masalah Gotenberg.
Mengarsipkan PDF yang dihasilkan ke penyimpanan objekR2ArchiveManager::upload() dan generateSignedUrl().Halaman penggunaan produksi dan keamanan Cloudflare.
Memigrasikan basis kode TCPDFTCPDF, cakupan metode, dan OutputBridge.Panduan migrasi kompatibilitas TCPDF.
Membangun paket runtime lamascripts/build.php dan Build::run().Panduan pengembang Backport dan halaman penggunaan produksi.
TugasArea konfigurasiHalaman paket
Mengatur standar metadata dokumendefaults.*Konfigurasi Laravel, Symfony, atau CodeIgniter.
Melakukan preload fon produksipreload_fonts atau preloadFontsHalaman konfigurasi framework.
Mengonfigurasi biner dan batas waktu Chromeartisan.* atau ChromeRendererConfigHalaman konfigurasi Artisan dan framework.
Mengonfigurasi penandatanganan dan Time-Stamping Authority (TSA)signature.*, tsa.*, ocsp_cache.*Halaman konfigurasi framework.
Melindungi endpoint render publikApiProtectionConfigHalaman API dan keamanan Cloudflare.
Mengonfigurasi arsip R2R2ArchiveConfigHalaman konfigurasi dan API Cloudflare.
Mengonfigurasi layanan GotenbergGotenbergConfigHalaman konfigurasi dan API Gotenberg.
Menyetel perilaku kompatibilitasAdaptationConfigHalaman konfigurasi kompatibilitas TCPDF.
GejalaKemungkinan batas APIHalaman diagnostik pertama
Respons diunduh dengan nama berkas yang salahHelper PdfResponse pada framework.Halaman API framework yang sesuai.
Tugas antrean gagal sebelum perenderanValidasi tugas atau pesan.Halaman pemecahan masalah framework yang sesuai.
Perenderan Chrome melampaui batas waktuChromeHtmlRenderer atau BrowserPool.Halaman pemecahan masalah Artisan.
Worker mengembalikan data yang bukan keluaran PDFCloudflareResponseParser.Halaman pemecahan masalah Cloudflare.
Unggahan R2 berhasil, tetapi Uniform Resource Locator (URL) tidak dapat digunakanR2UploadResult atau pembuatan URL bertanda tangan.Halaman penggunaan produksi Cloudflare.
Berkas office ditolakOfficeFormat atau GotenbergSecurityPolicy.Halaman pemecahan masalah Gotenberg.
Metode TCPDF lama melemparkan pengecualianPenanganan kompatibilitas atau factory pengecualian.Halaman cakupan metode TCPDF.
Keluaran backport gagal pemeriksaan sintaksisKonfigurasi Rector atau aturan kustom.Panduan pengembang Backport.

Setiap halaman API paket diharapkan mendokumentasikan:

Detail yang diperlukanAlasan
Simbol yang sepenuhnya memenuhi syaratMembantu Anda menelusuri kode sumber dan pengujian tanpa menebak namespace.
Nama parameter dan nilai standarMencegah ambiguitas di titik pemanggilan dan mendukung contoh bertipe.
Perilaku standarMembuat masukan opsional aman untuk diabaikan secara sengaja.
Nilai kembalian atau efek sampingMenunjukkan apakah metode bersifat fluent, terminal, atau diagnostik.
Mode kegagalanMembantu kode produksi gagal-tertutup dan mencatat batas yang benar.
Catatan operasionalMenangkap aspek keselamatan worker, keamanan, memori, batas waktu, atau kompatibilitas.