Integrasi
Sekilas pandang
Bagian berjudul “Sekilas pandang”Ekstensi NextPDF menghubungkan mesin inti Portable Document Format (PDF) dengan framework aplikasi, renderer peramban, layanan edge, perkakas build, dan jalur migrasi sistem lama. Setiap bagian ekstensi mengikuti struktur manual yang sama: ikhtisar, pemasangan, mulai cepat, konfigurasi, API, panduan pengembang, penggunaan produksi, keamanan, dan pemecahan masalah.
Peta ekstensi
Bagian berjudul “Peta ekstensi”| Ekstensi | Paket | Gunakan saat | Bagian utama |
|---|---|---|---|
| Laravel | nextpdf/laravel | Gunakan saat Anda membangun aplikasi Laravel dan membutuhkan binding container, facade, respons, serta queue job. | Laravel |
| Symfony | nextpdf/symfony | Gunakan saat Anda membangun aplikasi Symfony dan membutuhkan bundle, dependency injection wiring, job Messenger, serta respons Hypertext Transfer Protocol (HTTP). | Symfony |
| CodeIgniter | nextpdf/codeigniter | Gunakan saat Anda membangun aplikasi CodeIgniter 4 dan membutuhkan service, wrapper library, respons, serta queue job. | CodeIgniter |
| Artisan | nextpdf/artisan | Gunakan saat Anda membutuhkan rendering Hypertext Markup Language (HTML) melalui Chrome DevTools Protocol (CDP), impor halaman, atau utilitas inspeksi PDF tingkat rendah. | Artisan |
| Cloudflare | nextpdf/cloudflare | Gunakan saat Anda melakukan rendering melalui Cloudflare Browser Rendering, melindungi akses API, atau mengarsipkan PDF ke R2. | Cloudflare |
| Gotenberg | nextpdf/gotenberg | Gunakan saat Anda mengonversi dokumen office atau HTML melalui layanan Gotenberg. | Gotenberg |
| Kompatibilitas TCPDF | nextpdf/compat-legacy | Gunakan saat Anda memigrasikan kode aplikasi bergaya TCPDF ke NextPDF tanpa penulisan ulang menyeluruh. | Kompatibilitas TCPDF |
| Backport Builder | nextpdf/backport-builder | Gunakan saat Anda memelihara artefak rilis untuk runtime versi lama PHP: Hypertext Preprocessor (PHP). | Backport Builder |
Panduan pemilihan
Bagian berjudul “Panduan pemilihan”| Kebutuhan | Mulai di sini | Catatan operasional |
|---|---|---|
| Helper respons framework | Laravel, Symfony, atau CodeIgniter | Paket framework menangani integrasi container dan respons; inti menangani penyusunan dokumen. |
| Rendering HTML berbasis piksel | Artisan atau Cloudflare | Pilih Artisan untuk Chrome CDP lokal di host. Pilih Cloudflare saat proses rendering sebaiknya berlangsung di edge. |
| Konversi office | Gotenberg | Perlakukan Gotenberg sebagai batas layanan eksternal dengan kontrol untuk timeout, ukuran, dan server-side request forgery (SSRF). |
| Migrasi TCPDF lama | Kompatibilitas TCPDF | Periksa tabel cakupan metode sebelum Anda menganggap sebuah panggilan lama didukung. |
| Distribusi PHP versi lama | Backport Builder | Ini hanya perkakas build; jangan memasangnya sebagai dependensi runtime aplikasi. |
Struktur manual
Bagian berjudul “Struktur manual”Setiap bagian ekstensi memuat jenis halaman berikut:
| Halaman | Tujuan |
|---|---|
overview | Batas produk, audiens sasaran, alur kerja yang didukung, dan batasan. |
install | Perintah pemasangan dan dependensi runtime yang diperlukan. |
quickstart | Alur kerja minimal yang berjalan, dengan hasil pertama yang dapat disalin. |
configuration | Kunci konfigurasi yang didukung, variabel lingkungan, nilai standar, dan efeknya. |
api | Kelas publik, metode, parameter, nilai standar, nilai kembalian, dan exception. |
developer-guide | Arsitektur ekstensi, siklus hidup, titik ekstensi, dan organisasi kode. |
production-usage | Deployment, keandalan, performa, keamanan worker, dan observability. |
security-and-operations | Batas kepercayaan, nilai standar yang aman, secret, akses berkas, dan kontrol operasional. |
troubleshooting | Gejala, diagnostik, kemungkinan penyebab, dan tindakan perbaikan. |
Konvensi tabel API
Bagian berjudul “Konvensi tabel API”Tabel API menggunakan kolom yang sama di seluruh manual, sehingga Anda dapat membandingkan paket tanpa mempelajari tata letak baru.
| Kolom | Makna |
|---|---|
| Simbol | Kelas yang sepenuhnya berkualifikasi, metode, endpoint, perintah command-line interface (CLI), atau objek konfigurasi. |
| Parameter | Nama, tipe, status wajib, nilai standar, dan nilai yang diterima. |
| Perilaku standar | Apa yang terjadi saat input opsional tidak diberikan. |
| Mengembalikan | Tipe kembalian atau artefak keluaran. |
| Melempar atau gagal dengan | Tipe exception, status HTTP, kegagalan validasi, atau mode kegagalan operasional. |
| Catatan | Detail keamanan, keamanan worker, kompatibilitas, atau performa. |
Kesiapan terjemahan
Bagian berjudul “Kesiapan terjemahan”Sumber bahasa Inggris ditulis untuk pelokalan di kemudian hari: bagian singkat, judul stabil, kata benda eksplisit, tanpa idiom, dan tabel untuk struktur berulang. Pertahankan nama metode, kunci konfigurasi, flag CLI, dan nama exception dalam format kode pada halaman API baru agar perkakas terjemahan dapat mempertahankannya.