PdfGateClient
in package
PDFGate API client.
Tags
Table of Contents
Constants
- PROD_BASE_URL = 'https://api.pdfgate.com'
- SANDBOX_BASE_URL = 'https://api-sandbox.pdfgate.com'
Properties
Methods
- __construct() : mixed
- compressPdf() : PdfGateDocumentMetadata
- Compresses an existing PDF document.
- createEnvelope() : PdfGateEnvelope
- Creates a signing envelope from existing source documents.
- extractPdfFormData() : array<string, mixed>
- Extracts PDF form fields and values for an existing document.
- flattenPdf() : PdfGateDocumentMetadata
- Flattens an existing PDF document.
- generatePdf() : PdfGateDocumentMetadata
- Generates a PDF from HTML or URL.
- getDocument() : PdfGateDocumentMetadata
- Retrieves metadata and file details for an existing document.
- getEnvelope() : PdfGateEnvelope
- Retrieves the current state of an existing envelope.
- getFile() : resource
- Retrieves a generated PDF file as a readable stream resource.
- protectPdf() : PdfGateDocumentMetadata
- Protects an existing PDF document with encryption and permission restrictions.
- sendEnvelope() : PdfGateEnvelope
- Sends an existing envelope to all configured recipients.
- uploadFile() : PdfGateDocumentMetadata
- Uploads a raw PDF file or URL source.
- watermarkPdf() : PdfGateDocumentMetadata
- Adds a text or image watermark to an existing PDF document.
- buildEnvelopeResponse() : PdfGateEnvelope
- createRequestHandler() : ApiRequestHandler
- resolveBaseUrl() : string
Constants
PROD_BASE_URL
private
mixed
PROD_BASE_URL
= 'https://api.pdfgate.com'
SANDBOX_BASE_URL
private
mixed
SANDBOX_BASE_URL
= 'https://api-sandbox.pdfgate.com'
Properties
$requestHandler
private
ApiRequestHandler
$requestHandler
Methods
__construct()
public
__construct(string $apiKey) : mixed
Parameters
- $apiKey : string
-
PDFGate API key.
compressPdf()
Compresses an existing PDF document.
public
compressPdf(CompressPdfRequestPayload $request) : PdfGateDocumentMetadata
Parameters
- $request : CompressPdfRequestPayload
-
Compress PDF request payload.
Return values
PdfGateDocumentMetadatacreateEnvelope()
Creates a signing envelope from existing source documents.
public
createEnvelope(CreateEnvelopeRequestPayload $request) : PdfGateEnvelope
Parameters
- $request : CreateEnvelopeRequestPayload
-
Create envelope request payload.
Return values
PdfGateEnvelopeextractPdfFormData()
Extracts PDF form fields and values for an existing document.
public
extractPdfFormData(ExtractPdfFormDataRequestPayload $request) : array<string, mixed>
Parameters
- $request : ExtractPdfFormDataRequestPayload
-
Extract PDF form data request payload.
Return values
array<string, mixed>flattenPdf()
Flattens an existing PDF document.
public
flattenPdf(FlattenPdfRequestPayload $request) : PdfGateDocumentMetadata
Parameters
- $request : FlattenPdfRequestPayload
-
Flatten PDF request payload.
Return values
PdfGateDocumentMetadatageneratePdf()
Generates a PDF from HTML or URL.
public
generatePdf(GeneratePdfRequestPayload $request) : PdfGateDocumentMetadata
Parameters
- $request : GeneratePdfRequestPayload
-
Generate PDF request payload.
Return values
PdfGateDocumentMetadatagetDocument()
Retrieves metadata and file details for an existing document.
public
getDocument(string $documentId[, GetDocumentQueryPayload $query = array() ]) : PdfGateDocumentMetadata
Parameters
- $documentId : string
-
Existing document ID.
- $query : GetDocumentQueryPayload = array()
-
Optional get-document query options.
Return values
PdfGateDocumentMetadatagetEnvelope()
Retrieves the current state of an existing envelope.
public
getEnvelope(string $envelopeId) : PdfGateEnvelope
Parameters
- $envelopeId : string
-
Existing envelope ID.
Return values
PdfGateEnvelopegetFile()
Retrieves a generated PDF file as a readable stream resource.
public
getFile(string $documentId) : resource
Parameters
- $documentId : string
-
Generated document identifier.
Return values
resourceprotectPdf()
Protects an existing PDF document with encryption and permission restrictions.
public
protectPdf(ProtectPdfRequestPayload $request) : PdfGateDocumentMetadata
Parameters
- $request : ProtectPdfRequestPayload
-
Protect PDF request payload.
Return values
PdfGateDocumentMetadatasendEnvelope()
Sends an existing envelope to all configured recipients.
public
sendEnvelope(string $envelopeId) : PdfGateEnvelope
Parameters
- $envelopeId : string
-
Existing envelope ID.
Return values
PdfGateEnvelopeuploadFile()
Uploads a raw PDF file or URL source.
public
uploadFile(UploadFileRequestPayload $request) : PdfGateDocumentMetadata
Parameters
- $request : UploadFileRequestPayload
-
Upload request payload.
Return values
PdfGateDocumentMetadatawatermarkPdf()
Adds a text or image watermark to an existing PDF document.
public
watermarkPdf(WatermarkPdfRequestPayload $request) : PdfGateDocumentMetadata
Parameters
- $request : WatermarkPdfRequestPayload
-
Watermark PDF request payload.
Return values
PdfGateDocumentMetadatabuildEnvelopeResponse()
private
buildEnvelopeResponse(array<string, mixed> $response) : PdfGateEnvelope
Parameters
- $response : array<string, mixed>
Return values
PdfGateEnvelopecreateRequestHandler()
private
createRequestHandler(string $apiKey, HttpTransportInterface $transport) : ApiRequestHandler
Parameters
- $apiKey : string
- $transport : HttpTransportInterface
Return values
ApiRequestHandlerresolveBaseUrl()
private
resolveBaseUrl(string $apiKey) : string
Parameters
- $apiKey : string