Gebruik deze pagina wanneer u het integratietype kent, maar voor werk met Portable Document Format (PDF) de pakketspecifieke referentie nodig hebt. Elke rij verwijst naar de gezaghebbende application programming interface (API)-pagina voor dat uitbreidingsgebied.
De API-pagina’s zijn gebaseerd op de broncode en gebruiken een gedeeld tabelformaat: symbool, parameters, standaardgedrag, retourwaarde, foutmodus en operationele opmerkingen.
| Onderdeel | Pakket | Belangrijkste symbolen | API-pagina |
|---|
| Laravel-facade en containerbindingen | nextpdf/laravel | Pdf, NextPdfServiceProvider, PdfDocumentInterface, DocumentFactoryInterface | Laravel API |
| Laravel-antwoorden via Hypertext Transfer Protocol (HTTP) | nextpdf/laravel | PdfResponse::inline, PdfResponse::download, hulpfuncties voor stream-antwoorden | Laravel API |
| Laravel-wachtrijtaken | nextpdf/laravel | GeneratePdfJob::handle, failed, then, catch | Laravel API |
| Symfony-factory en -bundle | nextpdf/symfony | PdfFactory, NextPdfBundle, NextPdfExtension, Configuration | Symfony API |
| Symfony Messenger | nextpdf/symfony | GeneratePdfMessage, PdfBuilderInterface, GeneratePdfHandler | Symfony API |
| CodeIgniter-service en -bibliotheek | nextpdf/codeigniter | Services, Pdf, pdf(), pdf_document() | CodeIgniter API |
| CodeIgniter-wachtrijtaak | nextpdf/codeigniter | GeneratePdfJob::process, statische, aanroepbare builder | CodeIgniter API |
| Onderdeel | Pakket | Belangrijkste symbolen | API-pagina |
|---|
| Chrome-weergave op de host | nextpdf/artisan | ChromeHtmlRenderer, ChromeRendererConfig, ChromeRenderResult, BrowserPool | Artisan API |
| Chrome PDF-import | nextpdf/artisan | PdfReader, PageImporter, ImportedFormXObject, PdfObject | Artisan API |
| Diagnostiek voor de low-level parser | nextpdf/artisan | PdfTokenizer, CrossRefParser, RevisionXRefTable, StreamDecoder | Artisan API |
| Cloudflare Browser Rendering | nextpdf/cloudflare | CloudflareHtmlRenderer, CloudflareRendererConfig, CloudflareRenderPayload, CloudflareResponseParser | Cloudflare API |
| Cloudflare-API-bescherming | nextpdf/cloudflare | ApiProtection, ApiProtectionConfig, ApiKeyValidator, RateLimitResult | Cloudflare API |
| Cloudflare R2-archivering | nextpdf/cloudflare | R2ArchiveManager, R2ArchiveConfig, R2ObjectKey, R2UploadResult | Cloudflare API |
| Gotenberg-conversie van kantoordocumenten | nextpdf/gotenberg | GotenbergBridge, GotenbergConfig, GotenbergConvertPayload, GotenbergConvertResult | Gotenberg API |
| Gotenberg-beleid voor formaat en transport | nextpdf/gotenberg | OfficeFormat, GotenbergSecurityPolicy, GotenbergResponseParser, PinnedCurlTransport | Gotenberg API |
| Onderdeel | Pakket | Belangrijkste symbolen | API-pagina |
|---|
| TCPDF-adapter | nextpdf/compat-legacy | TCPDF, CompatAdapterInterface, LegacyBootstrap, AdaptationConfig | TCPDF compatibility API |
| TCPDF-methodefamilies | nextpdf/compat-legacy | Tekst, lettertypen, pagina’s, afbeeldingen, tekenen, beveiliging, formulieren en uitvoer | TCPDF method coverage |
| Buildscripts voor de backport | nextpdf/backport-builder | Build, MergeSources, AdjustComposer, ValidateBuildContract | Backport Builder API |
| Rector-regels voor de backport | nextpdf/backport-builder | DowngradeAsymmetricVisibilityRector, DowngradeCloneWithRector, DowngradeTraitConstantsRector | Backport Builder API |
| Taak | Begin met | Lees vervolgens |
|---|
| Een PDF retourneren vanuit een framework-controller | PdfResponse in het bijbehorende framework-pakket. | De quickstart van het pakket, gevolgd door de antwoordtabel in api. |
| PDF-bestanden genereren in een achtergrondworker | Laravel GeneratePdfJob, Symfony GeneratePdfMessage of CodeIgniter GeneratePdfJob. | Het wachtrij- of Messenger-patroon in de developer-guide van het pakket. |
| Hypertext Markup Language (HTML) weergeven met Chrome op de host | ChromeHtmlRenderer::render(). | De Artisan-pagina’s over configuratie, beveiliging en productiegebruik. |
| HTML weergeven via Cloudflare | CloudflareHtmlRenderer::render(). | De Cloudflare-pagina’s over API-bescherming en Worker-bewerkingen. |
| Kantoordocumenten converteren | GotenbergBridge::convertFile() of convertString(). | De Gotenberg-pagina’s over configuratie en probleemoplossing. |
| Gegenereerde PDF’s archiveren in objectopslag | R2ArchiveManager::upload() en generateSignedUrl(). | De Cloudflare-pagina’s over productiegebruik en beveiliging. |
| Een TCPDF-codebase migreren | TCPDF, methodedekking en OutputBridge. | De TCPDF-compatibiliteitsgids voor migratie. |
| Pakketten bouwen voor oudere runtimes | scripts/build.php en Build::run(). | De Backport-ontwikkelaarsgids en de pagina’s over productiegebruik. |
| Taak | Configuratiegebied | Pakketpagina |
|---|
| Standaardwaarden voor documentmetadata instellen | defaults.* | Configuratie voor Laravel, Symfony of CodeIgniter. |
| Productielettertypen vooraf laden | preload_fonts of preloadFonts | Framework-configuratiepagina’s. |
| De Chrome-binary en de time-out configureren | artisan.* of ChromeRendererConfig | Artisan- en framework-configuratiepagina’s. |
| Ondertekening en Time-Stamping Authority (TSA) configureren | signature.*, tsa.*, ocsp_cache.* | Framework-configuratiepagina’s. |
| Openbare weergave-eindpunten beschermen | ApiProtectionConfig | Cloudflare-pagina’s over API en beveiliging. |
| Het R2-archief configureren | R2ArchiveConfig | Cloudflare-pagina’s over configuratie en API. |
| De Gotenberg-service configureren | GotenbergConfig | Gotenberg-pagina’s over configuratie en API. |
| Compatibiliteitsgedrag afstemmen | AdaptationConfig | TCPDF-compatibiliteitsconfiguratiepagina. |
| Symptoom | Waarschijnlijke API-grens | Eerste diagnosepagina |
|---|
| Het antwoord wordt gedownload met de verkeerde bestandsnaam | Framework-hulpfunctie PdfResponse. | Bijbehorende framework-API-pagina. |
| De wachtrijtaak mislukt vóór de weergave | Validatie van taak/bericht. | Bijbehorende framework-pagina voor probleemoplossing. |
| Chrome-weergave loopt af door een time-out | ChromeHtmlRenderer of BrowserPool. | De Artisan-pagina voor probleemoplossing. |
| De Worker retourneert gegevens die geen PDF-uitvoer zijn | CloudflareResponseParser. | De Cloudflare-pagina voor probleemoplossing. |
| R2-upload slaagt, maar de Uniform Resource Locator (URL) is niet bruikbaar | R2UploadResult of het genereren van een ondertekende URL. | De Cloudflare-pagina over productiegebruik. |
| Het kantoorbestand wordt geweigerd | OfficeFormat of GotenbergSecurityPolicy. | De Gotenberg-pagina voor probleemoplossing. |
| Verouderde TCPDF-methode werpt een uitzondering | Compatibiliteitsprobleem of exception-factory. | De TCPDF-pagina over methodedekking. |
| Backport-uitvoer doorstaat de syntaxiscontrole niet | Rector-configuratie of aangepaste regel. | De Backport-ontwikkelaarsgids. |
Van elke pakket-API-pagina wordt verwacht dat deze het volgende documenteert:
| Vereist detail | Reden |
|---|
| Volledig gekwalificeerd symbool | Helpt u de broncode en tests te doorzoeken zonder naar namespaces te hoeven raden. |
| Parameternamen en standaardwaarden | Voorkomt dubbelzinnigheid op de aanroeplocatie en ondersteunt getypeerde voorbeelden. |
| Standaardgedrag | Maakt het veilig om optionele invoer bewust weg te laten. |
| Retourwaarde of neveneffect | Laat zien of de methode vloeiend, terminaal of diagnostisch is. |
| Foutmodus | Helpt productiecode veilig te falen en de juiste grens te loggen. |
| Operationele opmerking | Legt aandachtspunten vast rond worker-veiligheid, beveiliging, geheugen, time-outs of compatibiliteit. |
