ใช้หน้านี้เมื่อคุณทราบประเภทงานผสานรวมแล้ว แต่ต้องการเอกสารอ้างอิงเฉพาะแพ็กเกจสำหรับงาน Portable Document Format (PDF) แต่ละแถวเชื่อมโยงไปยังหน้า application programming interface (API) ที่เป็นแหล่งอ้างอิงของส่วนขยายนั้น
หน้า API อ้างอิงจากซอร์สโค้ดและใช้รูปแบบตารางเดียวกัน ได้แก่ สัญลักษณ์ พารามิเตอร์ พฤติกรรมเริ่มต้น ค่าที่คืน โหมดความล้มเหลว และบันทึกการใช้งาน
| พื้นผิว | แพ็กเกจ | สัญลักษณ์หลัก | หน้า API |
|---|
| Laravel facade และการผูก container | nextpdf/laravel | Pdf, NextPdfServiceProvider, PdfDocumentInterface, DocumentFactoryInterface | Laravel API |
| response ของ Laravel สำหรับ Hypertext Transfer Protocol (HTTP) | nextpdf/laravel | PdfResponse::inline, PdfResponse::download, ตัวช่วยสตรีม response | Laravel API |
| งานในคิวของ Laravel | nextpdf/laravel | GeneratePdfJob::handle, failed, then, catch | Laravel API |
| Symfony factory และ bundle | nextpdf/symfony | PdfFactory, NextPdfBundle, NextPdfExtension, Configuration | Symfony API |
| Symfony Messenger | nextpdf/symfony | GeneratePdfMessage, PdfBuilderInterface, GeneratePdfHandler | Symfony API |
| service และ library ของ CodeIgniter | nextpdf/codeigniter | Services, Pdf, pdf(), pdf_document() | CodeIgniter API |
| งานในคิวของ CodeIgniter | nextpdf/codeigniter | GeneratePdfJob::process, callable แบบ static สำหรับ builder | CodeIgniter API |
| พื้นผิว | แพ็กเกจ | สัญลักษณ์หลัก | หน้า API |
|---|
| การเรนเดอร์ด้วย Chrome บนโฮสต์ | nextpdf/artisan | ChromeHtmlRenderer, ChromeRendererConfig, ChromeRenderResult, BrowserPool | Artisan API |
| การนำเข้า PDF ด้วย Chrome | nextpdf/artisan | PdfReader, PageImporter, ImportedFormXObject, PdfObject | Artisan API |
| การวินิจฉัยตัวแยกวิเคราะห์ระดับล่าง | nextpdf/artisan | PdfTokenizer, CrossRefParser, RevisionXRefTable, StreamDecoder | Artisan API |
| Cloudflare Browser Rendering | nextpdf/cloudflare | CloudflareHtmlRenderer, CloudflareRendererConfig, CloudflareRenderPayload, CloudflareResponseParser | Cloudflare API |
| การป้องกัน Cloudflare API | nextpdf/cloudflare | ApiProtection, ApiProtectionConfig, ApiKeyValidator, RateLimitResult | Cloudflare API |
| การจัดเก็บถาวรด้วย Cloudflare R2 | nextpdf/cloudflare | R2ArchiveManager, R2ArchiveConfig, R2ObjectKey, R2UploadResult | Cloudflare API |
| การแปลงเอกสารสำนักงานด้วย Gotenberg | nextpdf/gotenberg | GotenbergBridge, GotenbergConfig, GotenbergConvertPayload, GotenbergConvertResult | Gotenberg API |
| นโยบายรูปแบบและการส่งข้อมูลของ Gotenberg | nextpdf/gotenberg | OfficeFormat, GotenbergSecurityPolicy, GotenbergResponseParser, PinnedCurlTransport | Gotenberg API |
| พื้นผิว | แพ็กเกจ | สัญลักษณ์หลัก | หน้า API |
|---|
| อะแดปเตอร์ TCPDF | nextpdf/compat-legacy | TCPDF, CompatAdapterInterface, LegacyBootstrap, AdaptationConfig | TCPDF compatibility API |
| กลุ่มเมท็อดของ TCPDF | nextpdf/compat-legacy | ส่วนที่เกี่ยวกับข้อความ ฟอนต์ หน้า รูปภาพ การวาด ความปลอดภัย ฟอร์ม และเอาต์พุต | TCPDF method coverage |
| สคริปต์สร้างแบบ Backport | nextpdf/backport-builder | Build, MergeSources, AdjustComposer, ValidateBuildContract | Backport Builder API |
| กฎ Rector ของ Backport | nextpdf/backport-builder | DowngradeAsymmetricVisibilityRector, DowngradeCloneWithRector, DowngradeTraitConstantsRector | Backport Builder API |
| งาน | เริ่มต้นด้วย | จากนั้นอ่าน |
|---|
| คืนค่า PDF จาก controller ของเฟรมเวิร์ก | PdfResponse ในแพ็กเกจเฟรมเวิร์กที่ตรงกัน | quickstart ของแพ็กเกจ จากนั้นอ่านตาราง response ใน api นั้น |
| สร้างไฟล์ PDF ใน worker ที่ทำงานเบื้องหลัง | ได้แก่ GeneratePdfJob ของ Laravel, GeneratePdfMessage ของ Symfony หรือ GeneratePdfJob ของ CodeIgniter | รูปแบบคิวหรือ Messenger ใน developer-guide ของแพ็กเกจ |
| เรนเดอร์ 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 | หน้าการกำหนดค่าและ API ของ Cloudflare |
| กำหนดค่าบริการ Gotenberg | GotenbergConfig | หน้าการกำหนดค่าและ API ของ Gotenberg |
| ปรับแต่งพฤติกรรมความเข้ากันได้ | AdaptationConfig | หน้าการกำหนดค่าความเข้ากันได้กับ TCPDF |
| อาการ | ขอบเขต API ที่น่าจะเกี่ยวข้อง | หน้าวินิจฉัยอันดับแรก |
|---|
| response ดาวน์โหลดมีชื่อไฟล์ไม่ถูกต้อง | ตัวช่วย PdfResponse ของเฟรมเวิร์ก | หน้า API ของเฟรมเวิร์กที่ตรงกัน |
| งานในคิวล้มเหลวก่อนการเรนเดอร์ | การตรวจสอบความถูกต้องของ job/message | หน้าการแก้ไขปัญหาของเฟรมเวิร์กที่ตรงกัน |
| การเรนเดอร์ด้วย Chrome หมดเวลา | ChromeHtmlRenderer หรือ BrowserPool อย่างใดอย่างหนึ่ง | หน้าการแก้ไขปัญหาของ Artisan |
| Worker คืนข้อมูลที่ไม่ใช่เอาต์พุต PDF | CloudflareResponseParser | หน้าการแก้ไขปัญหาของ Cloudflare |
| อัปโหลด R2 สำเร็จ แต่ Uniform Resource Locator (URL) ใช้งานไม่ได้ | R2UploadResult หรือการสร้าง signed URL | หน้าการใช้งานในสภาพแวดล้อมจริงของ Cloudflare |
| ไฟล์เอกสารสำนักงานถูกปฏิเสธ | OfficeFormat หรือ GotenbergSecurityPolicy อย่างใดอย่างหนึ่ง | หน้าการแก้ไขปัญหาของ Gotenberg |
| เมท็อด TCPDF รุ่นเก่าโยนข้อยกเว้น | ส่วนที่เกี่ยวกับความเข้ากันได้หรือโรงงานสร้างข้อยกเว้น | หน้าความครอบคลุมของเมท็อด TCPDF |
| เอาต์พุต Backport ไม่ผ่านการตรวจสอบไวยากรณ์ | การกำหนดค่า Rector หรือกฎที่กำหนดเอง | คู่มือนักพัฒนาของ Backport |
หน้า API ของแต่ละแพ็กเกจควรบันทึกข้อมูลต่อไปนี้:
| รายละเอียดที่จำเป็น | เหตุผล |
|---|
| สัญลักษณ์แบบระบุครบถ้วน | ช่วยให้คุณค้นหาในซอร์สโค้ดและการทดสอบได้โดยไม่ต้องเดา namespace |
| ชื่อพารามิเตอร์และค่าเริ่มต้น | ป้องกันความกำกวมที่จุดเรียกใช้และรองรับตัวอย่างที่ระบุชนิดข้อมูล |
| พฤติกรรมเริ่มต้น | ช่วยให้ละเว้นอินพุตทางเลือกได้อย่างปลอดภัยเมื่อเป็นความตั้งใจ |
| ค่าที่คืนหรือผลข้างเคียง | แสดงว่าเมท็อดเป็นแบบ fluent แบบสิ้นสุด หรือแบบวินิจฉัย |
| โหมดความล้มเหลว | ช่วยให้โค้ดในสภาพแวดล้อมจริงล้มเหลวแบบปิด (fail closed) และบันทึกขอบเขตที่ถูกต้อง |
| บันทึกการใช้งาน | บันทึกข้อกังวลเกี่ยวกับความปลอดภัยของ worker ความปลอดภัย หน่วยความจำ ไทม์เอาต์ หรือความเข้ากันได้ |
