Consulte cette page quand tu connais le type d’intégration, mais pas la page propre au package. Chaque ligne pointe vers la référence d’API qui fait autorité pour cette zone d’extension.
Les pages d’API s’appuient sur le code source et reprennent la même structure de tableau : symbole, paramètres, comportement par défaut, valeur de retour, mode d’échec et notes opérationnelles.
| Surface | Package | Symboles principaux | Page d’API |
|---|
| Façade Laravel et liaisons au conteneur | nextpdf/laravel | Pdf, NextPdfServiceProvider, PdfDocumentInterface, DocumentFactoryInterface | API Laravel |
| Réponses HTTP Laravel | nextpdf/laravel | PdfResponse::inline, PdfResponse::download, assistants de réponse en flux | API Laravel |
| Jobs de file d’attente Laravel | nextpdf/laravel | GeneratePdfJob::handle, failed, then, catch | API Laravel |
| Factory et bundle Symfony | nextpdf/symfony | PdfFactory, NextPdfBundle, NextPdfExtension, Configuration | API Symfony |
| Symfony Messenger | nextpdf/symfony | GeneratePdfMessage, PdfBuilderInterface, GeneratePdfHandler | API Symfony |
| Service/library CodeIgniter | nextpdf/codeigniter | Services, Pdf, pdf(), pdf_document() | API CodeIgniter |
| Job de file d’attente CodeIgniter | nextpdf/codeigniter | GeneratePdfJob::process, callable de construction statique | API CodeIgniter |
| Surface | Package | Symboles principaux | Page d’API |
|---|
| Rendu Chrome sur l’hôte local | nextpdf/artisan | ChromeHtmlRenderer, ChromeRendererConfig, ChromeRenderResult, BrowserPool | API Artisan |
| Import PDF Chrome | nextpdf/artisan | PdfReader, PageImporter, ImportedFormXObject, PdfObject | API Artisan |
| Diagnostics du parseur de bas niveau | nextpdf/artisan | PdfTokenizer, CrossRefParser, RevisionXRefTable, StreamDecoder | API Artisan |
| Cloudflare Browser Rendering | nextpdf/cloudflare | CloudflareHtmlRenderer, CloudflareRendererConfig, CloudflareRenderPayload, CloudflareResponseParser | API Cloudflare |
| Protection d’API Cloudflare | nextpdf/cloudflare | ApiProtection, ApiProtectionConfig, ApiKeyValidator, RateLimitResult | API Cloudflare |
| Archivage Cloudflare R2 | nextpdf/cloudflare | R2ArchiveManager, R2ArchiveConfig, R2ObjectKey, R2UploadResult | API Cloudflare |
| Conversion de documents bureautiques Gotenberg | nextpdf/gotenberg | GotenbergBridge, GotenbergConfig, GotenbergConvertPayload, GotenbergConvertResult | API Gotenberg |
| Politique de format et de transport Gotenberg | nextpdf/gotenberg | OfficeFormat, GotenbergSecurityPolicy, GotenbergResponseParser, PinnedCurlTransport | API Gotenberg |
| Surface | Package | Symboles principaux | Page d’API |
|---|
| Adaptateur TCPDF | nextpdf/compat-legacy | TCPDF, CompatAdapterInterface, LegacyBootstrap, AdaptationConfig | API de compatibilité TCPDF |
| Familles de méthodes TCPDF | nextpdf/compat-legacy | Préoccupations relatives au texte, à la police, à la page, à l’image, au dessin, à la sécurité, au formulaire et à la sortie | Couverture des méthodes TCPDF |
| Scripts de build du backport | nextpdf/backport-builder | Build, MergeSources, AdjustComposer, ValidateBuildContract | API Backport Builder |
| Règles Rector du backport | nextpdf/backport-builder | DowngradeAsymmetricVisibilityRector, DowngradeCloneWithRector, DowngradeTraitConstantsRector | API Backport Builder |
| Tâche | Commence par | Lis ensuite |
|---|
| Renvoyer un PDF depuis un contrôleur de framework | PdfResponse dans le package de framework correspondant. | Le quickstart du package, puis son tableau de réponses api. |
| Générer des PDF dans un worker en arrière-plan | Laravel GeneratePdfJob, Symfony GeneratePdfMessage ou CodeIgniter GeneratePdfJob. | Le developer-guide du package, puis le modèle de file d’attente ou Messenger. |
| Rendre du HTML avec Chrome sur l’hôte local | ChromeHtmlRenderer::render(). | Pages de configuration, de sécurité et d’usage en production d’Artisan. |
| Rendre du HTML via Cloudflare | CloudflareHtmlRenderer::render(). | Pages de protection d’API et d’opérations Worker Cloudflare. |
| Convertir des documents bureautiques | GotenbergBridge::convertFile() ou convertString(). | Pages de configuration et de dépannage de Gotenberg. |
| Archiver les PDF générés dans un stockage objet | R2ArchiveManager::upload() et generateSignedUrl(). | Pages d’usage en production et de sécurité Cloudflare. |
| Migrer une base de code TCPDF | TCPDF, couverture des méthodes et OutputBridge. | Guide de migration de compatibilité TCPDF. |
| Construire des packages pour des runtimes plus anciens | scripts/build.php et Build::run(). | Guide développeur et page d’usage en production du backport. |
| Tâche | Zone de configuration | Page du package |
|---|
| Définir les valeurs par défaut des métadonnées de document | defaults.* | Configuration Laravel, Symfony ou CodeIgniter. |
| Précharger les polices de production | preload_fonts ou preloadFonts | Pages de configuration du framework. |
| Configurer le binaire Chrome et le délai d’expiration | artisan.* ou ChromeRendererConfig | Pages de configuration d’Artisan et du framework. |
| Configurer la signature et la TSA | signature.*, tsa.*, ocsp_cache.* | Pages de configuration du framework. |
| Protéger les points d’accès de rendu publics | ApiProtectionConfig | Pages d’API et de sécurité Cloudflare. |
| Configurer l’archive R2 | R2ArchiveConfig | Pages de configuration et d’API Cloudflare. |
| Configurer le service Gotenberg | GotenbergConfig | Pages de configuration et d’API Gotenberg. |
| Ajuster le comportement de compatibilité | AdaptationConfig | Page de configuration de compatibilité TCPDF. |
| Symptôme | Frontière d’API probable | Première page de diagnostic |
|---|
| La réponse est téléchargée avec le mauvais nom de fichier | Assistant PdfResponse du framework. | Page d’API du framework correspondant. |
| Le job de file d’attente échoue avant le rendu | Validation du job ou du message. | Page de dépannage du framework correspondant. |
| Le rendu Chrome dépasse le délai d’expiration | ChromeHtmlRenderer ou BrowserPool. | Page de dépannage d’Artisan. |
| Le worker renvoie des données non PDF | CloudflareResponseParser. | Page de dépannage de Cloudflare. |
| L’upload R2 réussit mais l’URL n’est pas utilisable | R2UploadResult ou génération d’URL signée. | Page d’usage en production de Cloudflare. |
| Le fichier bureautique est rejeté | OfficeFormat ou GotenbergSecurityPolicy. | Page de dépannage de Gotenberg. |
| Une méthode TCPDF héritée lève une exception | Préoccupation de compatibilité ou fabrique d’exceptions. | Page de couverture des méthodes TCPDF. |
| La sortie du backport échoue à la vérification de syntaxe | Configuration Rector ou règle personnalisée. | Guide développeur du backport. |
Chaque page d’API de package doit documenter :
| Détail requis | Raison |
|---|
| Symbole pleinement qualifié | Permet aux lecteurs de rechercher dans le code source et les tests sans avoir à deviner les espaces de noms. |
| Noms de paramètres et valeurs par défaut | Évite l’ambiguïté au point d’appel et prend en charge les exemples typés. |
| Comportement par défaut | Rend sûre l’omission délibérée de l’entrée optionnelle. |
| Valeur de retour ou effet de bord | Indique si la méthode est chaînable, terminale ou diagnostique. |
| Mode d’échec | Aide le code de production à échouer en mode fermé et à journaliser la bonne frontière. |
| Note opérationnelle | Capture les points d’attention liés à la sûreté du worker, à la sécurité, à la mémoire, au délai d’expiration ou à la compatibilité. |
