استخدم هذه الصفحة عندما تعرف نوع عملية الدمج، لكنك تحتاج إلى مرجع الحزمة الخاص بأعمال PDF. يربط كل صف بصفحة API المرجعية لذلك المجال من مجالات الامتداد.
تستند صفحات API إلى المصدر، وتستخدم تنسيق جدول موحّدًا: الرمز، والمعاملات، والسلوك الافتراضي، والقيمة المُعادة، ووضع الفشل، والملاحظات التشغيلية.
| واجهة الدمج | الحزمة | الرموز الأساسية | صفحة API |
|---|
| واجهة Laravel الساكنة وارتباطات الحاوية | nextpdf/laravel | Pdf, NextPdfServiceProvider, PdfDocumentInterface, DocumentFactoryInterface | Laravel API |
| استجابات Laravel عبر HTTP | nextpdf/laravel | PdfResponse::inline، PdfResponse::download، مساعدات استجابة الدفق | Laravel API |
| مهام طابور Laravel | nextpdf/laravel | GeneratePdfJob::handle, failed, then, catch | Laravel API |
| مصنع Symfony والحزمة المجمّعة | nextpdf/symfony | PdfFactory, NextPdfBundle, NextPdfExtension, Configuration | Symfony API |
| Symfony Messenger | nextpdf/symfony | GeneratePdfMessage, PdfBuilderInterface, GeneratePdfHandler | Symfony API |
| خدمة CodeIgniter ومكتبتها | nextpdf/codeigniter | Services, Pdf, pdf(), pdf_document() | CodeIgniter API |
| مهمة طابور CodeIgniter | nextpdf/codeigniter | GeneratePdfJob::process، بانٍ ساكن قابل للاستدعاء | CodeIgniter API |
| واجهة الدمج | الحزمة | الرموز الأساسية | صفحة API |
|---|
| العرض عبر Chrome على المضيف | nextpdf/artisan | ChromeHtmlRenderer, ChromeRendererConfig, ChromeRenderResult, BrowserPool | Artisan API |
| استيراد Chrome لملفات PDF | nextpdf/artisan | PdfReader, PageImporter, ImportedFormXObject, PdfObject | Artisan API |
| تشخيصات المحلّل منخفضة المستوى | nextpdf/artisan | PdfTokenizer, CrossRefParser, RevisionXRefTable, StreamDecoder | Artisan API |
| عرض المتصفح عبر Cloudflare | nextpdf/cloudflare | CloudflareHtmlRenderer, CloudflareRendererConfig, CloudflareRenderPayload, CloudflareResponseParser | Cloudflare API |
| حماية API في Cloudflare | nextpdf/cloudflare | ApiProtection, ApiProtectionConfig, ApiKeyValidator, RateLimitResult | Cloudflare API |
| الأرشفة في Cloudflare R2 | nextpdf/cloudflare | R2ArchiveManager, R2ArchiveConfig, R2ObjectKey, R2UploadResult | Cloudflare API |
| تحويل مستندات Office عبر Gotenberg | nextpdf/gotenberg | GotenbergBridge, GotenbergConfig, GotenbergConvertPayload, GotenbergConvertResult | Gotenberg API |
| سياسة الصيغة والنقل في Gotenberg | nextpdf/gotenberg | OfficeFormat, GotenbergSecurityPolicy, GotenbergResponseParser, PinnedCurlTransport | Gotenberg API |
| المهمة | ابدأ بـ | ثم اقرأ |
|---|
| إرجاع ملف PDF من متحكّم في إطار العمل | PdfResponse في حزمة إطار العمل المطابقة. | مستند quickstart الخاص بالحزمة، ثم جدول الاستجابة في api. |
| إنشاء ملفات PDF في عامل يعمل في الخلفية | استخدم GeneratePdfJob في Laravel، أو GeneratePdfMessage في Symfony، أو GeneratePdfJob في CodeIgniter. | نمط الطابور أو Messenger في مستند developer-guide الخاص بالحزمة. |
| عرض HTML عبر Chrome على المضيف | ChromeHtmlRenderer::render(). | صفحات إعداد Artisan والأمان والاستخدام في الإنتاج. |
| عرض HTML عبر Cloudflare | CloudflareHtmlRenderer::render(). | صفحات حماية واجهة برمجة التطبيقات وعمليات Worker في Cloudflare. |
| تحويل مستندات Office | 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 or preloadFonts | صفحات إعداد أطر العمل. |
| إعداد ملف Chrome التنفيذي والمهلة | artisan.* or ChromeRendererConfig | صفحات إعداد Artisan وأطر العمل. |
| إعداد التوقيع وسلطة الطوابع الزمنية (TSA) | signature.*, tsa.*, ocsp_cache.* | صفحات إعداد أطر العمل. |
| حماية نقاط نهاية العرض العامة | ApiProtectionConfig | صفحات API والأمان في Cloudflare. |
| إعداد أرشيف R2 | R2ArchiveConfig | صفحات إعداد Cloudflare وواجهة برمجة التطبيقات. |
| إعداد خدمة Gotenberg | GotenbergConfig | صفحات إعداد Gotenberg وAPI. |
| ضبط سلوك التوافق | AdaptationConfig | صفحة إعداد توافق TCPDF. |
| العَرَض | حدّ API المُرجَّح | أول صفحة تشخيصية |
|---|
| يُنزَّل ملف الاستجابة باسم خاطئ | مساعد PdfResponse في إطار العمل. | صفحة API لإطار العمل المطابق. |
| تفشل مهمة الطابور قبل العرض | التحقق من صحة المهمة أو الرسالة. | صفحة استكشاف أخطاء إطار العمل المطابق وإصلاحها. |
| تنتهي مهلة العرض عبر Chrome | ChromeHtmlRenderer أو BrowserPool. | صفحة استكشاف أخطاء Artisan وإصلاحها. |
| يُعيد العامل بيانات ليست ناتج PDF | CloudflareResponseParser. | صفحة استكشاف أخطاء Cloudflare وإصلاحها. |
| ينجح الرفع إلى R2، لكن محدّد موقع المورد الموحّد (URL) غير قابل للاستخدام | R2UploadResult أو توليد عنوان URL موقَّع. | صفحة الاستخدام في الإنتاج في Cloudflare. |
| يُرفض ملف Office | OfficeFormat أو GotenbergSecurityPolicy. | صفحة استكشاف أخطاء Gotenberg وإصلاحها. |
| تطرح دالة TCPDF قديمة استثناءً | شأن توافق أو مصنع استثناءات. | صفحة تغطية دوال TCPDF. |
| يفشل ناتج Backport في فحص الصياغة | إعداد Rector أو قاعدة مخصّصة. | دليل مطوّر Backport. |
يُتوقَّع من كل صفحة API لحزمة أن توثّق ما يلي:
| التفصيل المطلوب | السبب |
|---|
| الرمز المؤهَّل بالكامل | يساعدك على البحث في المصدر والاختبارات دون تخمين مساحات الأسماء. |
| أسماء المعاملات وقيمها الافتراضية | يمنع الالتباس في موضع الاستدعاء ويدعم الأمثلة المُحدَّدة الأنواع. |
| السلوك الافتراضي | يجعل حذف الإدخال الاختياري آمنًا عن قصد. |
| القيمة المُعادة أو الأثر الجانبي | يوضّح ما إذا كانت الدالة انسيابية أو نهائية أو تشخيصية. |
| وضع الفشل | يساعد شيفرة الإنتاج على الفشل المغلق وتسجيل الحدّ الصحيح. |
| الملاحظة التشغيلية | ترصد اعتبارات سلامة العامل، والأمان، والذاكرة، والمهلة، أو التوافق. |
