PDFGate's PHP SDK

Types

Centralized PHPStan type aliases used across the SDK.

Tags
phpstan-type

MarginPayload array{ top?: string, bottom?: string, left?: string, right?: string }

phpstan-type

ClickSelectorChainPayload array{ selectors: list }

phpstan-type

ClickSelectorChainSetupPayload array{ ignoreFailingChains: bool, chains: list<ClickSelectorChainPayload> }

phpstan-type

GeneratePdfPageSizeType 'a0'|'a1'|'a2'|'a3'|'a4'|'a5'|'a6'|'ledger'|'tabloid'|'legal'|'letter'

phpstan-type

GeneratePdfOrientation 'portrait'|'landscape'

phpstan-type

GeneratePdfEmulateMediaType 'screen'|'print'

phpstan-type

ProtectPdfAlgorithm 'AES256'|'AES128'

phpstan-type

GeneratePdfRequestPayload array{ html?: string, url?: string, preSignedUrlExpiresIn?: int, pageSizeType?: GeneratePdfPageSizeType, width?: float|int, height?: float|int, orientation?: GeneratePdfOrientation, header?: string, footer?: string, margin?: MarginPayload, timeout?: int, javascript?: string, css?: string, emulateMediaType?: GeneratePdfEmulateMediaType, waitForSelector?: string, clickSelector?: string, clickSelectorChainSetup?: ClickSelectorChainSetupPayload, waitForNetworkIdle?: bool, delay?: int, loadImages?: bool, scale?: float|int, pageRanges?: string, printBackground?: bool, userAgent?: string, httpHeaders?: array<string,mixed>, authentication?: array<string,mixed>, viewport?: array<string,mixed>, enableFormFields?: bool, metadata?: array<string,mixed> }

phpstan-type

UploadFileRequestPayload array{ file?: \CURLFile, url?: string, preSignedUrlExpiresIn?: int, metadata?: array<string,mixed> }

phpstan-type

FlattenPdfRequestPayload array{ documentId: string, preSignedUrlExpiresIn?: int, metadata?: array<string,mixed> }

phpstan-type

CompressPdfRequestPayload array{ documentId: string, linearize?: bool, preSignedUrlExpiresIn?: int, metadata?: array<string,mixed> }

phpstan-type

ProtectPdfRequestPayload array{ documentId: string, algorithm?: ProtectPdfAlgorithm, userPassword?: string, ownerPassword?: string, disablePrint?: bool, disableCopy?: bool, disableEditing?: bool, encryptMetadata?: bool, preSignedUrlExpiresIn?: int, metadata?: array<string,mixed> }

phpstan-type

WatermarkPdfType 'text'|'image'

phpstan-type

WatermarkPdfFont 'times-roman'|'times-bold'|'times-italic'|'times-bolditalic'|'helvetica'|'helvetica-bold'|'helvetica-oblique'|'helvetica-boldoblique'|'courier'|'courier-bold'|'courier-oblique'|'courier-boldoblique'

phpstan-type

WatermarkPdfRequestPayload array{ documentId: string, type: WatermarkPdfType, text?: string, watermark?: \CURLFile, fontFile?: \CURLFile, font?: WatermarkPdfFont, fontSize?: float|int, fontColor?: string, opacity?: float, xPosition?: float|int, yPosition?: float|int, imageWidth?: float|int, imageHeight?: float|int, rotate?: float|int, preSignedUrlExpiresIn?: int, metadata?: array<string,mixed> }

phpstan-type

ExtractPdfFormDataRequestPayload array{ documentId: string, metadata?: array<string,mixed> }

phpstan-type

GetDocumentQueryPayload array{ preSignedUrlExpiresIn?: int }

phpstan-type

EnvelopeRecipientPayload array{ email: string, name: string, role?: string }

phpstan-type

EnvelopeDocumentPayload array{ sourceDocumentId: string, name: string, recipients: list<EnvelopeRecipientPayload> }

phpstan-type

CreateEnvelopeRequestPayload array{ documents: list<EnvelopeDocumentPayload>, requesterName: string, metadata?: array<string,mixed> }

Table of Contents


        
On this page

Search results