PDF to PDF in PHP

Overview

Merge, split and modify PDF documents with the PDFCrowd PHP client. The client handles communication with the API, while processing runs on PDFCrowd's servers.

Installation

Install the PHP client with Composer, or see other installation options.

composer require pdfcrowd/pdfcrowd

Quick Start

Update the input URLs and filenames as needed.

<?php
require 'vendor/autoload.php';

$client = new \Pdfcrowd\PdfToPdfClient('demo', 'demo');

$client->addPdfFile('cover.pdf');
$client->addPdfFile('proposal.pdf');
$client->addPdfFile('price.pdf');
$client->addPdfFile('contact.pdf');
$client->convertToFile('offer.pdf');

<?php
require 'vendor/autoload.php';

$client = new \Pdfcrowd\PdfToPdfClient('demo', 'demo');

$client->setPageWatermark('watermark.pdf');
$client->addPdfFile('proposal.pdf');
$client->convertToFile('company_offer.pdf');

<?php
require 'vendor/autoload.php';

$client = new \Pdfcrowd\PdfToPdfClient('demo', 'demo');

$client->setAction('extract');
$client->setPageRange('3,7-');
$client->addPdfFile('13_pages.pdf');
$client->convertToFile('output.pdf');

Configure a Conversion

Authentication

Pass your PDFCrowd username and API key to PdfToPdfClient. Find your credentials on the API Keys page.

Add Input PDFs

Add each PDF before calling a conversion method. The default action joins the documents in the order they were added.

For encrypted input PDFs, set the document password with setInputPdfPassword() before conversion. This is separate from your API key and the passwords used to protect the output PDF.

Send PDF Bytes

Read two local PDFs as bytes, merge them in order, and save the result locally as merged.pdf:

<?php
require 'vendor/autoload.php';

$client = new \Pdfcrowd\PdfToPdfClient('demo', 'demo');

foreach (['cover.pdf', 'proposal.pdf'] as $filename) {
    $data = file_get_contents($filename);
    if ($data === false) {
        throw new \RuntimeException('Cannot read ' . $filename);
    }
    $client->addPdfRawData($data);
}
$client->convertToFile('merged.pdf');

Add Conversion Settings

Set conversion options on the client before calling a conversion method. For example, $client->setLinearize(true); optimizes the output PDF for progressive loading.

Common settings are listed below. See the method reference for all available options or browse PHP examples.

Use "extract" with a page range to keep selected pages, or "delete" to remove them. The "shuffle" action interleaves pages from the input PDFs.

Handle the Result

Choose an Output

After adding the inputs and settings, choose how to receive the PDF:

PHP strings can hold binary data. This example merges two PDFs, receives the result as a string and saves it as merged.pdf:

<?php
require 'vendor/autoload.php';

$client = new \Pdfcrowd\PdfToPdfClient('demo', 'demo');

$client->addPdfFile('cover.pdf');
$client->addPdfFile('proposal.pdf');
$result = $client->convert();
if (file_put_contents('merged.pdf', $result) !== strlen($result)) {
    throw new \RuntimeException('Cannot save the conversion result');
}

When serving the result from a web application, use Content-Type: application/pdf.

Handle Errors

The client throws a Pdfcrowd\Error exception on conversion or validation errors. This example merges two PDFs and logs any PDFCrowd error, including its HTTP status and reason code:

<?php
require 'vendor/autoload.php';

$client = new \Pdfcrowd\PdfToPdfClient('demo', 'demo');

try {
    $client->addPdfFile('cover.pdf');
    $client->addPdfFile('proposal.pdf');
    $client->convertToFile('merged.pdf');
} catch (\Pdfcrowd\Error $error) {
    error_log('PDFCrowd: ' . $error);
    error_log(sprintf('Status: %s; reason: %s',
        $error->getStatusCode(), $error->getReasonCode()));
    throw $error;
}

Local PHP errors, such as a failure to read an input file or write the output, may need separate handling.

Pdfcrowd\Error provides these methods:

(string) $error returns the complete error, including available status and reason codes.

Common Status Codes

See all status and reason codes for specific explanations and Limits and Retries for retry behavior.

Read Conversion Information

This information is available after a conversion and describes the client's last conversion.

Limits and Retries

Request rate and concurrency limits depend on your license. Control how quickly your application submits conversions and how many it runs at once. A 429 response concerns request rate; a 430 response concerns requests already in progress. The maximum upload size is 300 MB.

The PHP client automatically retries a request once when it receives HTTP 502 or 503. Use setRetryCount() to change that count, or set it to 0 to disable automatic retries. Account for these retries when adding an application-level retry policy.

Troubleshooting

Inspect a Conversion

This example merges two PDFs with debug logging enabled and records the debug log URL when available. Use the input and settings from the conversion you are investigating.

<?php
require 'vendor/autoload.php';

$client = new \Pdfcrowd\PdfToPdfClient('demo', 'demo');

try {
    $client->addPdfFile('cover.pdf');
    $client->addPdfFile('proposal.pdf');
    $client->setDebugLog(true);
    $client->convertToFile('merged.pdf');
} catch (\Pdfcrowd\Error $error) {
    error_log('PDFCrowd: ' . $error);
    error_log(sprintf('Status: %s; reason: %s',
        $error->getStatusCode(), $error->getReasonCode()));
    throw $error;
} finally {
    if ($client->getDebugLogUrl()) {
        error_log('Debug log: ' . $client->getDebugLogUrl());
    }
}

The debug log contains conversion settings and processing details. You can also find logs in your conversion history. A local or connection failure may occur before a conversion log is available.

Common Problems

For help, contact support and include any available diagnostics, the client version, and enough detail to reproduce the problem.