Tích hợp
Tổng quan nhanh
Phần tiêu đề “Tổng quan nhanh”Các extension của NextPDF kết nối engine Portable Document Format (PDF) lõi với các framework ứng dụng, bộ kết xuất trình duyệt, dịch vụ biên, công cụ build và các bản di chuyển từ hệ thống cũ. Mỗi phần về extension tuân theo cùng một cấu trúc sổ tay: tổng quan, cài đặt, bắt đầu nhanh, cấu hình, application programming interface (API), hướng dẫn cho nhà phát triển, sử dụng trong môi trường production, bảo mật và xử lý sự cố.
Bản đồ extension
Phần tiêu đề “Bản đồ extension”| Extension | Gói | Dùng khi | Phần chính |
|---|---|---|---|
| Laravel | nextpdf/laravel | Dùng khi bạn xây dựng ứng dụng Laravel và cần các container binding, một facade, response và queue job. | Laravel |
| Symfony | nextpdf/symfony | Dùng khi bạn xây dựng ứng dụng Symfony và cần một bundle, cấu hình dependency injection, Messenger job và các response Hypertext Transfer Protocol (HTTP). | Symfony |
| CodeIgniter | nextpdf/codeigniter | Dùng khi bạn xây dựng ứng dụng CodeIgniter 4 và cần các service, một library wrapper, response và queue job. | CodeIgniter |
| Artisan | nextpdf/artisan | Dùng khi bạn cần kết xuất Hypertext Markup Language (HTML) qua Chrome DevTools Protocol (CDP), nhập trang hoặc các tiện ích kiểm tra PDF ở mức thấp. | Artisan |
| Cloudflare | nextpdf/cloudflare | Dùng khi bạn kết xuất qua Cloudflare Browser Rendering, bảo vệ quyền truy cập API hoặc lưu trữ PDF vào R2. | Cloudflare |
| Gotenberg | nextpdf/gotenberg | Dùng khi bạn chuyển đổi tài liệu văn phòng hoặc HTML qua một dịch vụ Gotenberg. | Gotenberg |
| Tương thích TCPDF | nextpdf/compat-legacy | Dùng khi bạn di chuyển mã ứng dụng theo kiểu TCPDF sang NextPDF mà không phải viết lại toàn bộ. | Tương thích TCPDF |
| Backport Builder | nextpdf/backport-builder | Dùng khi bạn duy trì các release artifact cho các runtime PHP: Hypertext Preprocessor (PHP) cũ hơn. | Backport Builder |
Hướng dẫn lựa chọn
Phần tiêu đề “Hướng dẫn lựa chọn”| Nhu cầu | Bắt đầu từ đây | Lưu ý vận hành |
|---|---|---|
| Helper response cho framework | Laravel, Symfony hoặc CodeIgniter | Gói framework đảm nhận tích hợp container và response; phần lõi đảm nhận việc soạn tài liệu. |
| Kết xuất HTML chính xác theo pixel | Artisan hoặc Cloudflare | Chọn Artisan cho Chrome CDP chạy cục bộ trên host. Chọn Cloudflare khi việc kết xuất nên diễn ra ở biên. |
| Chuyển đổi tài liệu văn phòng | Gotenberg | Hãy xem Gotenberg là một ranh giới dịch vụ bên ngoài, kèm các biện pháp kiểm soát timeout, kích thước và server-side request forgery (SSRF). |
| Di chuyển từ TCPDF cũ | Tương thích TCPDF | Hãy kiểm tra bảng phạm vi hỗ trợ phương thức trước khi bạn giả định một lệnh gọi cũ được hỗ trợ. |
| Bản phân phối PHP cũ hơn | Backport Builder | Đây chỉ là công cụ build; đừng cài đặt nó như một dependency runtime của ứng dụng. |
Cấu trúc sổ tay
Phần tiêu đề “Cấu trúc sổ tay”Mỗi phần về extension chứa các loại trang sau:
| Trang | Mục đích |
|---|---|
overview | Ranh giới sản phẩm, đối tượng mục tiêu, các quy trình được hỗ trợ và các giới hạn. |
install | Các lệnh cài đặt và các dependency runtime bắt buộc. |
quickstart | Luồng làm việc tối thiểu cùng với kết quả đầu tiên có thể sao chép. |
configuration | Các config key được hỗ trợ, biến môi trường, giá trị mặc định và tác động của chúng. |
api | Các class, method, tham số, giá trị mặc định, giá trị trả về và exception công khai. |
developer-guide | Kiến trúc extension, vòng đời, các điểm mở rộng và cách tổ chức mã. |
production-usage | Triển khai, độ tin cậy, hiệu năng, an toàn worker và khả năng quan sát. |
security-and-operations | Ranh giới tin cậy, các giá trị mặc định an toàn, secret, quyền truy cập tệp và các biện pháp kiểm soát vận hành. |
troubleshooting | Triệu chứng, chẩn đoán, nguyên nhân khả dĩ và các hành động khắc phục. |
Quy ước bảng API
Phần tiêu đề “Quy ước bảng API”Các bảng API dùng cùng một bộ cột xuyên suốt sổ tay, nên bạn có thể so sánh các gói mà không cần làm quen với một bố cục mới.
| Cột | Ý nghĩa |
|---|---|
| Ký hiệu | Class, method, endpoint, lệnh command-line interface (CLI) hoặc config object dưới dạng tên đầy đủ. |
| Tham số | Tên, kiểu, trạng thái bắt buộc, giá trị mặc định và các giá trị được chấp nhận. |
| Hành vi mặc định | Điều xảy ra khi bạn bỏ qua đầu vào tùy chọn. |
| Giá trị trả về | Kiểu trả về hoặc artifact đầu ra. |
| Ném ra hoặc thất bại với | Kiểu exception, trạng thái HTTP, lỗi xác thực hoặc dạng lỗi vận hành. |
| Ghi chú | Chi tiết về bảo mật, an toàn worker, khả năng tương thích hoặc hiệu năng. |
Mức độ sẵn sàng để dịch
Phần tiêu đề “Mức độ sẵn sàng để dịch”Bản nguồn tiếng Anh được viết để dễ bản địa hóa về sau: các phần ngắn, tiêu đề ổn định, danh từ rõ ràng, không dùng thành ngữ và dùng bảng cho các cấu trúc lặp lại. Hãy giữ tên method, config key, cờ CLI và tên exception ở định dạng mã trong các trang API mới để công cụ dịch giữ nguyên chúng.