การผสานการทำงาน
ภาพรวมโดยย่อ
หัวข้อที่มีชื่อว่า “ภาพรวมโดยย่อ”ส่วนขยายของ NextPDF เชื่อมต่อเอนจิน Portable Document Format (PDF) หลักเข้ากับเฟรมเวิร์กของแอปพลิเคชัน ตัวเรนเดอร์ของเบราว์เซอร์ บริการที่ขอบเครือข่าย เครื่องมือบิลด์ และการย้ายระบบเดิม ส่วนของส่วนขยายแต่ละรายการใช้โครงสร้างคู่มือเดียวกัน ได้แก่ ภาพรวม การติดตั้ง การเริ่มต้นใช้งานอย่างรวดเร็ว การกำหนดค่า application programming interface (API) คู่มือนักพัฒนา การใช้งานในสภาพแวดล้อมการผลิต ความปลอดภัย และการแก้ไขปัญหา
แผนผังส่วนขยาย
หัวข้อที่มีชื่อว่า “แผนผังส่วนขยาย”| ส่วนขยาย | แพ็กเกจ | ใช้เมื่อ | ส่วนหลัก |
|---|---|---|---|
| Laravel | nextpdf/laravel | ใช้เมื่อสร้างแอปพลิเคชัน Laravel และต้องการการผูกกับคอนเทนเนอร์ facade การตอบกลับ และงานในคิว | Laravel |
| Symfony | nextpdf/symfony | ใช้เมื่อสร้างแอปพลิเคชัน Symfony และต้องการ bundle การเชื่อมต่อแบบ dependency injection งานของ Messenger และการตอบกลับแบบ Hypertext Transfer Protocol (HTTP) | Symfony |
| CodeIgniter | nextpdf/codeigniter | ใช้เมื่อสร้างแอปพลิเคชัน CodeIgniter 4 และต้องการบริการ ตัวห่อหุ้มไลบรารี การตอบกลับ และงานในคิว | CodeIgniter |
| Artisan | nextpdf/artisan | ใช้เมื่อต้องการเรนเดอร์ Hypertext Markup Language (HTML) ผ่าน Chrome DevTools Protocol (CDP) นำเข้าหน้า หรือใช้ยูทิลิตีตรวจสอบ PDF ระดับล่าง | Artisan |
| Cloudflare | nextpdf/cloudflare | ใช้เมื่อเรนเดอร์ผ่าน Cloudflare Browser Rendering ป้องกันการเข้าถึง API หรือจัดเก็บ PDF ไว้ใน R2 | Cloudflare |
| Gotenberg | nextpdf/gotenberg | ใช้เมื่อต้องแปลงเอกสารสำนักงานหรือ HTML ผ่านบริการ Gotenberg | Gotenberg |
| ความเข้ากันได้กับ TCPDF | nextpdf/compat-legacy | ใช้เมื่อย้ายโค้ดแอปพลิเคชันรูปแบบ TCPDF ไปยัง NextPDF โดยไม่ต้องเขียนใหม่ทั้งหมด | ความเข้ากันได้กับ TCPDF |
| Backport Builder | nextpdf/backport-builder | ใช้เมื่อดูแลอาร์ติแฟกต์รีลีสสำหรับรันไทม์ PHP: Hypertext Preprocessor (PHP) รุ่นเก่า | Backport Builder |
คู่มือการเลือก
หัวข้อที่มีชื่อว่า “คู่มือการเลือก”| ความต้องการ | เริ่มต้นที่นี่ | หมายเหตุด้านการปฏิบัติงาน |
|---|---|---|
| ตัวช่วยการตอบกลับของเฟรมเวิร์ก | Laravel, Symfony หรือ CodeIgniter | แพ็กเกจของเฟรมเวิร์กรับผิดชอบการผสานการทำงานกับคอนเทนเนอร์และการตอบกลับ ส่วนคอร์รับผิดชอบการสร้างเอกสาร |
| การเรนเดอร์ HTML แบบเน้นพิกเซล | Artisan หรือ Cloudflare | เลือก Artisan สำหรับ Chrome CDP ที่อยู่บนโฮสต์ภายใน เลือก Cloudflare เมื่อควรให้การเรนเดอร์อยู่ที่ขอบเครือข่าย |
| การแปลงเอกสารสำนักงาน | Gotenberg | ให้ถือว่า Gotenberg เป็นขอบเขตของบริการภายนอกที่ต้องควบคุมไทม์เอาต์ ขนาด และ server-side request forgery (SSRF) |
| การย้ายระบบ TCPDF เดิม | ความเข้ากันได้กับ TCPDF | ตรวจสอบตารางความครอบคลุมของเมธอดก่อนสรุปว่ารองรับการเรียกแบบเดิม |
| ดิสทริบิวชัน PHP รุ่นเก่า | Backport Builder | เป็นเครื่องมือสำหรับบิลด์เท่านั้น อย่าติดตั้งเป็นดีเพนเดนซีของรันไทม์แอปพลิเคชัน |
โครงสร้างของคู่มือ
หัวข้อที่มีชื่อว่า “โครงสร้างของคู่มือ”ส่วนของส่วนขยายแต่ละรายการมีหน้าประเภทต่อไปนี้:
| หน้า | วัตถุประสงค์ |
|---|---|
overview | ขอบเขตของผลิตภัณฑ์ กลุ่มเป้าหมาย เวิร์กโฟลว์ที่รองรับ และข้อจำกัด |
install | คำสั่งติดตั้งและดีเพนเดนซีของรันไทม์ที่จำเป็น |
quickstart | ขั้นตอนขั้นต่ำที่ใช้งานได้ พร้อมผลลัพธ์แรกที่คัดลอกได้ |
configuration | คีย์การกำหนดค่าที่รองรับ ตัวแปรสภาพแวดล้อม ค่าเริ่มต้น และผลกระทบ |
api | คลาส เมธอด พารามิเตอร์ ค่าเริ่มต้น ค่าที่ส่งกลับ และข้อยกเว้นสาธารณะ |
developer-guide | สถาปัตยกรรมของส่วนขยาย วงจรการทำงาน จุดขยาย และการจัดระเบียบโค้ด |
production-usage | การปรับใช้ ความน่าเชื่อถือ ประสิทธิภาพ ความปลอดภัยของเวิร์กเกอร์ และการสังเกตได้ |
security-and-operations | ขอบเขตความเชื่อถือ ค่าเริ่มต้นที่ปลอดภัย ข้อมูลลับ การเข้าถึงไฟล์ และการควบคุมด้านการปฏิบัติงาน |
troubleshooting | อาการ การวินิจฉัย สาเหตุที่เป็นไปได้ และวิธีแก้ไข |
แบบแผนของตาราง API
หัวข้อที่มีชื่อว่า “แบบแผนของตาราง API”ตาราง API ใช้คอลัมน์เดียวกันตลอดทั้งคู่มือ จึงเปรียบเทียบแพ็กเกจได้โดยไม่ต้องเรียนรู้เค้าโครงใหม่
| คอลัมน์ | ความหมาย |
|---|---|
| สัญลักษณ์ | คลาส เมธอด เอนด์พอยต์ คำสั่ง command-line interface (CLI) หรืออ็อบเจกต์การกำหนดค่าที่มีชื่อเต็ม |
| พารามิเตอร์ | ชื่อ ชนิด สถานะว่าจำเป็นหรือไม่ ค่าเริ่มต้น และค่าที่ยอมรับ |
| พฤติกรรมเริ่มต้น | สิ่งที่เกิดขึ้นเมื่อละเว้นอินพุตทางเลือก |
| ค่าที่ส่งกลับ | ชนิดของค่าที่ส่งกลับหรืออาร์ติแฟกต์เอาต์พุต |
| โยนข้อยกเว้นหรือล้มเหลวด้วย | ชนิดของข้อยกเว้น สถานะ HTTP ความล้มเหลวจากการตรวจสอบความถูกต้อง หรือรูปแบบความล้มเหลวด้านการปฏิบัติงาน |
| หมายเหตุ | รายละเอียดด้านความปลอดภัย ความปลอดภัยของเวิร์กเกอร์ ความเข้ากันได้ หรือประสิทธิภาพ |
ความพร้อมสำหรับการแปล
หัวข้อที่มีชื่อว่า “ความพร้อมสำหรับการแปล”ต้นฉบับภาษาอังกฤษเขียนขึ้นเพื่อรองรับการแปลในภายหลัง โดยใช้ส่วนที่สั้น หัวเรื่องที่คงที่ คำนามที่ชัดเจน ไม่มีสำนวน และตารางสำหรับโครงสร้างที่ซ้ำกัน ให้คงชื่อเมธอด คีย์การกำหนดค่า แฟล็ก CLI และชื่อข้อยกเว้นไว้ในรูปแบบโค้ดบนหน้า API ใหม่ เพื่อให้เครื่องมือแปลรักษาค่าเหล่านี้ไว้