คู่มือสูตร PHP
ดัชนีนี้แสดงรายการสูตรของ NextPDF ที่เขียนด้วย PHP โดยตรง ซึ่งเป็นหน้าที่เน้นงานเฉพาะและรันได้ โดยเขียนกับ PHP API หลักโดยตรง สูตรแต่ละรายการอยู่ในความรับผิดชอบและผ่านการตรวจสอบของรีโพซิทอรีหลัก nextpdf ภายใต้ docs/public/cookbook/php/ แต่ละสูตรมีสคริปต์ examples/*.php และฮาร์เนสทดสอบ tests/Cookbook/Php/ จากนั้นตัวรวบรวมจะดึงแต่ละหน้าเข้ามาในไซต์นี้และคงข้อมูลที่มาของหน้าจากแหล่งต้นทางไว้
เนื่องจากหน้านี้เป็นดัชนี จึงไม่ได้กล่าวอ้างด้านพฤติกรรมเกี่ยวกับสูตรใด ๆ แต่ละแถวบันทึกเจตนาของสูตร โมดูลหลักที่สูตรใช้ และโปรไฟล์ความสามารถในการทำซ้ำที่สูตรประกาศไว้ โปรไฟล์และคำกล่าวอ้างด้านการสอดคล้องใด ๆ อยู่ในหน้าสูตรนั้นเอง ข้อมูลเหล่านี้มาจาก front-matter ของหน้านั้นและการทดสอบภายในรีโพของหน้านั้น ไม่ได้มาจากดัชนีนี้ สำหรับคู่มือสูตรด้านการผสานรวม (เฟรมเวิร์ก/เรนเดอร์เรอร์/เซอร์วิส) โปรดดู คู่มือสูตรด้านการผสานรวม สำหรับสัญญาที่ทุกสูตรซึ่งรันได้ต้องปฏิบัติตาม โปรดดู ข้อตกลงของสูตร
slug ของสูตรถูกจัดระเบียบอย่างไร
หัวข้อที่มีชื่อว่า “slug ของสูตรถูกจัดระเบียบอย่างไร”ทุกสูตรเขียนขึ้นในรีโพซิทอรีหลักภายใต้ docs/public/cookbook/php/ และเผยแพร่เข้าสู่ไซต์นี้โดยตัวรวบรวม แต่ละ slug ใช้รูปแบบเดียวกัน คือเป็นเซกเมนต์เดี่ยว
/cookbook/php/<recipe>/<recipe> ระบุเจตนาของสูตรในรูปแบบ kebab-case (ตัวอย่างเช่น render-html-to-pdf ไม่ใช่ชื่อโมดูล html) ใช้ตัวพิมพ์เล็ก คั่นด้วยยัติภังค์ ไม่มีหมายเลขเวอร์ชัน และลงท้ายด้วยเครื่องหมายทับหนึ่งตัว
โปรไฟล์ความสามารถในการทำซ้ำแบบสรุปบรรทัดเดียว
หัวข้อที่มีชื่อว่า “โปรไฟล์ความสามารถในการทำซ้ำแบบสรุปบรรทัดเดียว”แต่ละสูตรประกาศโปรไฟล์ที่เข้มงวดที่สุดเท่าที่สามารถทำได้อย่างตรงไปตรงมา:
- bitwise — เหมือนกันทุกไบต์ทุกครั้งที่รัน (เนื้อหาที่กำหนดได้แน่นอนแบบเรียบง่ายโดยตรึงเอนโทรปีทั้งหมดไว้)
- structural — เหมือนกันหลังจากปรับอะตอมที่ผันแปรให้เป็นมาตรฐานแล้ว (รายการ
/IDในเทรลเลอร์ วันที่ creation/modification คำนำหน้าซับเซ็ตของฟอนต์ — ในทางปฏิบัติคือ PDF ทุกไฟล์ที่มีหลายอ็อบเจกต์) - semantic — เทียบเท่ากันเฉพาะระดับ structural-AST รวมกับเมทาดาทาเท่านั้น (เอาต์พุตที่ลงนามหรือประทับเวลาแล้ว หรือเอาต์พุตที่โดยเนื้อแท้ความเทียบเท่าในระดับไบต์ไม่เสถียร)
หน้าสูตรพิสูจน์โปรไฟล์ด้วยฮาร์เนสทดสอบของหน้านั้น ดัชนีนี้เพียงรายงานค่าที่หน้านั้นประกาศไว้เท่านั้น
พื้นฐาน
หัวข้อที่มีชื่อว่า “พื้นฐาน”สร้าง แบ่งหน้า และจัดรูปแบบเอกสาร
| สูตร | ทำอะไร | โมดูล | โปรไฟล์ |
|---|---|---|---|
render-html-to-pdf | เรนเดอร์เอกสาร HTML เป็น PDF | Html | structural |
style-with-css | ใช้ CSS กับการเรนเดอร์ HTML | Html | structural |
html-table-layout | จัดวางตาราง HTML | Html | structural |
paginate-long-html | แบ่งหน้าเอกสาร HTML ขนาดยาว | Html | structural |
paginate-large-html-tables | แบ่งหน้าตาราง HTML ขนาดใหญ่ข้ามหลายหน้า | Html | structural |
render-rtl-arabic-html | เรนเดอร์ HTML ภาษาอาหรับแบบขวาไปซ้าย | Html | structural |
compose-text-and-fonts | จัดองค์ประกอบข้อความพร้อมควบคุม typography | Typography | structural |
embed-and-subset-fonts | ฝังฟอนต์และทำซับเซ็ต | Font | structural |
cjk-vertical-writing | จัดวางข้อความ CJK ในโหมดการเขียนแนวตั้ง | Typography | structural |
multi-page-document | สร้างเอกสารหลายหน้า | Document | structural |
headers-and-footers | เพิ่มหัวกระดาษและท้ายกระดาษแบบต่อเนื่อง | Layout | structural |
กราฟิกและเนื้อหา
หัวข้อที่มีชื่อว่า “กราฟิกและเนื้อหา”ทำงานกับเวกเตอร์ รูปภาพ เลเยอร์ และพื้นที่พิกัด
| สูตร | ทำอะไร | โมดูล | โปรไฟล์ |
|---|---|---|---|
draw-vector-graphics | วาดกราฟิกเวกเตอร์ | Graphics | structural |
gradients-and-transparency | ใช้การไล่ระดับสีและความโปร่งใส | Graphics | structural |
embed-images | ฝังรูปภาพแบบแรสเตอร์ | Content | structural |
add-watermarks-and-backgrounds | เพิ่มลายน้ำหรือพื้นหลังแบบข้อความและรูปภาพลงในหน้า | Content | structural |
cmyk-spot-color-and-icc-profiles | สร้างสี CMYK และสีพิเศษที่พร้อมสำหรับงานพิมพ์ | Color | structural |
embed-file-attachments | ฝังไฟล์และสร้างพอร์ตโฟลิโอ PDF | Content | structural |
optional-content-layers | ใช้เนื้อหาเสริม (เลเยอร์) | Graphics | structural |
transform-coordinate-space | แปลงพื้นที่พิกัด | Graphics | structural |
การนำทางและฟอร์ม
หัวข้อที่มีชื่อว่า “การนำทางและฟอร์ม”เพิ่มบุ๊กมาร์ก ลิงก์ คำอธิบายประกอบ และฟิลด์ AcroForm
| สูตร | ทำอะไร | โมดูล | โปรไฟล์ |
|---|---|---|---|
bookmarks-and-toc | สร้างบุ๊กมาร์กและสารบัญ | Navigation | structural |
generate-dynamic-table-of-contents | สร้างสารบัญแบบไดนามิก | Navigation | structural |
links-and-annotations | เพิ่มลิงก์และคำอธิบายประกอบ | Navigation | structural |
generate-barcodes | สร้างบาร์โค้ด | Barcode | bitwise |
gs1-composite-barcodes | สร้างบาร์โค้ด GS1 Composite (ตัวพา CC-C) | Barcode | structural |
fill-pdf-form | กรอก AcroForm | Form | structural |
flatten-form-fields | flatten ฟิลด์ของฟอร์ม | Form | structural |
form-field-validation-and-flatten-with-state | ตรวจสอบฟิลด์ของฟอร์มและ flatten พร้อมสถานะ | Form | structural |
ข้อมูลของเอกสาร
หัวข้อที่มีชื่อว่า “ข้อมูลของเอกสาร”ตั้งค่าเมทาดาทาและพฤติกรรมของโปรแกรมดู
| สูตร | ทำอะไร | โมดูล | โปรไฟล์ |
|---|---|---|---|
set-document-metadata | ตั้งค่าเมทาดาทาของเอกสาร | Metadata | structural |
set-viewer-preferences | ตั้งค่าการกำหนดลักษณะโปรแกรมดู | Document | structural |
การดำเนินการกับเอกสาร
หัวข้อที่มีชื่อว่า “การดำเนินการกับเอกสาร”ประกอบ แบ่ง และปรับเอกสารที่มีอยู่ให้เหมาะสม
| สูตร | ทำอะไร | โมดูล | โปรไฟล์ |
|---|---|---|---|
merge-external-pdfs | ผสาน PDF ภายนอกหรือเพิ่มหน้าเข้าไป | Document | structural |
split-and-extract-pages | แบ่ง PDF และสกัดช่วงหน้า | Document | structural |
optimize-pdf-file-size | ลดขนาดไฟล์ PDF ด้วยการบีบอัดและการทำซับเซ็ต | Document | structural |
ความปลอดภัย ลายเซ็น และการสอดคล้อง
หัวข้อที่มีชื่อว่า “ความปลอดภัย ลายเซ็น และการสอดคล้อง”ใช้การเข้ารหัสลับ การลงนาม การเข้าถึงได้ และเอาต์พุตตามโปรไฟล์ สูตรเหล่านี้รักษาขอบเขต support≠conformance และ presence≠validity ไว้ในหน้าสูตร
| สูตร | ทำอะไร | โมดูล | โปรไฟล์ |
|---|---|---|---|
encrypt-aes256 | เข้ารหัสลับด้วย AES-256 และตั้งค่าแฟล็กสิทธิ์ | Security | structural |
encrypt-with-permissions | เข้ารหัสลับพร้อมแฟล็กสิทธิ์ | Security | structural |
sign-pades-b-b | ใส่ลายเซ็น PAdES (B-B และ B-T) | Security | semantic |
inspect-existing-signature | ตรวจสอบลายเซ็นที่มีอยู่ | Inspect | semantic |
tagged-pdf-ua2 | ส่งออกโครงสร้างที่มีแท็กสำหรับ PDF/UA-2 | Accessibility | semantic |
accessible-pdfua2-from-html | ส่งออกโครงสร้างที่มีแท็กสำหรับการสร้าง PDF/UA-2 ที่เข้าถึงได้จาก HTML | Accessibility | semantic |
pdf-a-4-output | สร้างเอาต์พุต PDF/A-4 | Conformance | semantic |
pdfa4-conformance-gate | สร้างเอาต์พุต PDF/A-4 และกำหนด gate ด้วยตัวตรวจสอบความถูกต้องภายนอก | Conformance | semantic |
validate-conformance | ตรวจสอบความถูกต้องกับโปรไฟล์การสอดคล้อง | Compliance | semantic |
การตรวจสอบและการสกัด
หัวข้อที่มีชื่อว่า “การตรวจสอบและการสกัด”อ่านเนื้อหาและโครงสร้างกลับออกจาก PDF
| สูตร | ทำอะไร | โมดูล | โปรไฟล์ |
|---|---|---|---|
extract-text-content | สกัดเนื้อหาข้อความ | Text | semantic |
multilingual-copy-paste-extraction | ทำให้ PDF ภาษา CJK และภาษาอาหรับคัดลอก-วางได้อย่างถูกต้อง | Text | structural |
parse-and-inspect-pdf | แยกวิเคราะห์และตรวจสอบ PDF | Inspect | semantic |
inspect-layout-boxes | ตรวจสอบกล่องเค้าโครง | Inspect | semantic |
รูปแบบข้ามส่วน
หัวข้อที่มีชื่อว่า “รูปแบบข้ามส่วน”ใช้รูปแบบที่ครอบคลุมหลายโมดูล
| สูตร | ทำอะไร | ครอบคลุม | โปรไฟล์ |
|---|---|---|---|
worker-safe-batch-rendering | เรนเดอร์อย่างปลอดภัยในเวิร์กเกอร์ที่ทำงานยาวนาน (รีจิสทรีที่ใช้ร่วมกัน หน่วยความจำที่มีขอบเขตจำกัด) | Core · Performance · Support | semantic |
streaming-and-memory | ทำโปรไฟล์การสตรีมและการใช้หน่วยความจำ | Performance | bitwise |
exception-aware-error-handling | จัดการข้อผิดพลาดด้วยลำดับชั้นของ exception ของ NextPDF | Exception · Contracts | structural |
custom-error-recovery-patterns | ปรับใช้กลยุทธ์การกู้คืนข้อผิดพลาดและการลองใหม่แบบกำหนดเอง | Exception | semantic |
observe-with-opentelemetry | สังเกตการณ์การเรนเดอร์ด้วย OpenTelemetry | Observability · Telemetry · Event | semantic |
ทุกสูตรด้านบนเผยแพร่พร้อมสคริปต์ examples/*.php ที่รองรับ และฮาร์เนสทดสอบ tests/Cookbook/Php/ ในรีโพซิทอรีหลัก เมื่อมีการเขียนสูตรใหม่ที่ต้นทาง สูตรนั้นจะปรากฏที่นี่เมื่อตัวอย่างและการทดสอบถูกเพิ่มเข้ามาแล้ว
ดูเพิ่มเติม
หัวข้อที่มีชื่อว่า “ดูเพิ่มเติม”- คู่มือสูตรด้านการผสานรวม — ดัชนีการผสานรวมสำหรับเฟรมเวิร์ก เรนเดอร์เรอร์ และเซอร์วิส
- ข้อตกลงของสูตร — สัญญาที่ทุกสูตรซึ่งรันได้ในคู่มือสูตรนี้ต้องปฏิบัติตาม