Indice delle API per le integrazioni

In sintesi

Usare questa pagina quando si conosce il tipo di integrazione, ma non la pagina specifica del pacchetto. Ogni riga rimanda al riferimento API autorevole per la rispettiva sezione dell’estensione.

Le pagine API si basano sul codice sorgente e usano la stessa struttura di tabella: simbolo, parametri, comportamento predefinito, valore restituito, modalità di errore e note operative.

API dei framework

Ambito	Pacchetto	Simboli principali	Pagina API
Facade di Laravel e binding del container	nextpdf/laravel	Pdf, NextPdfServiceProvider, PdfDocumentInterface, DocumentFactoryInterface	Laravel API
Risposte HTTP di Laravel	nextpdf/laravel	PdfResponse::inline, PdfResponse::download, helper per le risposte in streaming	Laravel API
Job di coda di Laravel	nextpdf/laravel	GeneratePdfJob::handle, failed, then, catch	Laravel API
Factory e bundle di Symfony	nextpdf/symfony	PdfFactory, NextPdfBundle, NextPdfExtension, Configuration	Symfony API
Symfony Messenger	nextpdf/symfony	GeneratePdfMessage, PdfBuilderInterface, GeneratePdfHandler	Symfony API
Service/library di CodeIgniter	nextpdf/codeigniter	Services, Pdf, pdf(), pdf_document()	CodeIgniter API
Job di coda di CodeIgniter	nextpdf/codeigniter	GeneratePdfJob::process, callable statico del builder	CodeIgniter API

API di rendering e conversione

Ambito	Pacchetto	Simboli principali	Pagina API
Rendering con Chrome locale all’host	nextpdf/artisan	ChromeHtmlRenderer, ChromeRendererConfig, ChromeRenderResult, BrowserPool	Artisan API
Importazione PDF tramite Chrome	nextpdf/artisan	PdfReader, PageImporter, ImportedFormXObject, PdfObject	Artisan API
Diagnostica del parser di basso livello	nextpdf/artisan	PdfTokenizer, CrossRefParser, RevisionXRefTable, StreamDecoder	Artisan API
Cloudflare Browser Rendering	nextpdf/cloudflare	CloudflareHtmlRenderer, CloudflareRendererConfig, CloudflareRenderPayload, CloudflareResponseParser	Cloudflare API
Protezione delle API di Cloudflare	nextpdf/cloudflare	ApiProtection, ApiProtectionConfig, ApiKeyValidator, RateLimitResult	Cloudflare API
Archiviazione su Cloudflare R2	nextpdf/cloudflare	R2ArchiveManager, R2ArchiveConfig, R2ObjectKey, R2UploadResult	Cloudflare API
Conversione di documenti Office con Gotenberg	nextpdf/gotenberg	GotenbergBridge, GotenbergConfig, GotenbergConvertPayload, GotenbergConvertResult	Gotenberg API
Criteri di formato e trasporto di Gotenberg	nextpdf/gotenberg	OfficeFormat, GotenbergSecurityPolicy, GotenbergResponseParser, PinnedCurlTransport	Gotenberg API

API di migrazione e build

Ambito	Pacchetto	Simboli principali	Pagina API
Adapter per TCPDF	nextpdf/compat-legacy	TCPDF, CompatAdapterInterface, LegacyBootstrap, AdaptationConfig	API di compatibilità TCPDF
Famiglie di metodi TCPDF	nextpdf/compat-legacy	Ambiti di testo, font, pagina, immagine, disegno, sicurezza, modulo e output	Copertura dei metodi TCPDF
Script di build per il backport	nextpdf/backport-builder	Build, MergeSources, AdjustComposer, ValidateBuildContract	Backport Builder API
Regole Rector per il backport	nextpdf/backport-builder	DowngradeAsymmetricVisibilityRector, DowngradeCloneWithRector, DowngradeTraitConstantsRector	Backport Builder API

API per attività

Attività	Iniziare da	Poi leggere
Restituire un PDF da un controller del framework	PdfResponse nel pacchetto del framework corrispondente.	La quickstart del pacchetto, poi la relativa tabella api delle risposte.
Generare PDF in un worker in background	Laravel GeneratePdfJob, Symfony GeneratePdfMessage o CodeIgniter GeneratePdfJob.	Il pattern di coda o Messenger nella developer-guide del pacchetto.
Eseguire il rendering di HTML con Chrome locale all’host	ChromeHtmlRenderer::render().	Pagine di configurazione, sicurezza e uso in produzione per Artisan.
Eseguire il rendering di HTML tramite Cloudflare	CloudflareHtmlRenderer::render().	Pagine sulla protezione delle API di Cloudflare e sulle operazioni dei Worker.
Convertire documenti Office	GotenbergBridge::convertFile() o convertString().	Pagine di configurazione e risoluzione dei problemi di Gotenberg.
Archiviare i PDF generati su un object storage	R2ArchiveManager::upload() e generateSignedUrl().	Pagine sull’uso in produzione e sulla sicurezza per Cloudflare.
Migrare una codebase TCPDF	TCPDF, copertura dei metodi e OutputBridge.	Guida alla migrazione per la compatibilità TCPDF.
Compilare pacchetti per runtime meno recenti	scripts/build.php e Build::run().	Guida per sviluppatori e uso in produzione del backport.

Configurazione per attività

Attività	Area di configurazione	Pagina del pacchetto
Impostare i valori predefiniti dei metadati del documento	defaults.*	Configurazione di Laravel, Symfony o CodeIgniter.
Precaricare i font di produzione	preload_fonts o preloadFonts	Pagine di configurazione dei framework.
Configurare il binario Chrome e il timeout	artisan.* o ChromeRendererConfig	Pagine di configurazione di Artisan e dei framework.
Configurare la firma e la TSA	signature.*, tsa.*, ocsp_cache.*	Pagine di configurazione dei framework.
Proteggere gli endpoint di rendering pubblici	ApiProtectionConfig	Pagine sulle API e sulla sicurezza di Cloudflare.
Configurare l’archivio R2	R2ArchiveConfig	Pagine di configurazione e API per Cloudflare.
Configurare il servizio Gotenberg	GotenbergConfig	Pagine di configurazione e API di Gotenberg.
Ottimizzare il comportamento di compatibilità	AdaptationConfig	Pagina di configurazione per la compatibilità TCPDF.

Indice delle modalità di errore

Sintomo	Probabile confine API	Prima pagina diagnostica
La risposta viene scaricata con il nome file errato	Helper PdfResponse del framework.	Pagina API del framework corrispondente.
Il job di coda fallisce prima del rendering	Convalida del job/messaggio.	Pagina di risoluzione dei problemi del framework corrispondente.
Il rendering di Chrome va in timeout	ChromeHtmlRenderer o BrowserPool.	Pagina di risoluzione dei problemi di Artisan.
Il worker restituisce dati non PDF	CloudflareResponseParser.	Pagina di risoluzione dei problemi di Cloudflare.
Il caricamento su R2 riesce ma l’URL non è utilizzabile	R2UploadResult o generazione di URL firmati.	Pagina sull’uso in produzione per Cloudflare.
Il file Office viene rifiutato	OfficeFormat o GotenbergSecurityPolicy.	Pagina di risoluzione dei problemi di Gotenberg.
Un metodo TCPDF legacy genera un’eccezione	Ambito di compatibilità o factory delle eccezioni.	Pagina di copertura dei metodi TCPDF.
L’output del backport non supera il controllo di sintassi	Configurazione di Rector o regola personalizzata.	Guida per sviluppatori del backport.

Contratto redazionale

Ogni pagina API di pacchetto dovrebbe documentare:

Dettaglio richiesto	Motivazione
Simbolo con namespace completo	Consente di cercare nel codice sorgente e nei test senza dover indovinare i namespace.
Nomi e valori predefiniti dei parametri	Evita ambiguità nei punti di chiamata e supporta esempi tipizzati.
Comportamento predefinito	Permette di omettere deliberatamente gli input facoltativi in modo sicuro.
Valore restituito o effetto collaterale	Indica se il metodo è fluent, terminale o diagnostico.
Modalità di errore	Aiuta il codice di produzione a fallire in modo sicuro e a registrare il confine corretto.
Nota operativa	Documenta le considerazioni su sicurezza dei worker, protezione, memoria, timeout o compatibilità.