Important: This document is for the beta version of the new Pdfcrowd API. Use this documentation for the stable API version.

Image to Image - PHP SDK

Installation

You can download pdfcrowd-4.3.0-php.zip, unzip it and import pdfcrowd.php into your code.

You can learn more install options (Composer, GitHub) here.

The library requires PHP 5.5 and higher and it depends on cURL.

The API client library si common for all Pdfcrowd converters.

Authentication

Authentication is needed in order to use the Pdfcrowd API. The credentials used for accessing the API are your Pdfcrowd username and the API key. You can find the API key in your account page.

Getting Started

Convert Local Image

Convert a local PNG file to a JPEG file

<?php
require 'pdfcrowd.php';

try
{
    // create the API client instance
    $client = new \Pdfcrowd\ImageToImageClient("username", "apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // run the conversion and write the result to a file
    $client->convertFileToFile("/path/to/logo.png", "logo.jpg");
}
catch(\Pdfcrowd\Error $why)
{
    // report the error to the standard error stream
    fwrite(STDERR, "Pdfcrowd Error: {$why}\n");
}

?>

Convert a local PNG file to in-memory JPEG

<?php
require 'pdfcrowd.php';

try
{
    // create the API client instance
    $client = new \Pdfcrowd\ImageToImageClient("username", "apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // create output file for conversion result
    $output_file = fopen("logo.jpg", "wb");

    // run the conversion and store the result into an image variable
    $image = $client->convertFile("/path/to/logo.png");

    // write the image the into the output file
    fwrite($output_file, $image);

    // close the output file
    fclose($output_file);
}
catch(\Pdfcrowd\Error $why)
{
    // report the error to the standard error stream
    fwrite(STDERR, "Pdfcrowd Error: {$why}\n");
}

?>

Convert a local PNG file and write the resulting JPEG to an output stream

<?php
require 'pdfcrowd.php';

try
{
    // create the API client instance
    $client = new \Pdfcrowd\ImageToImageClient("username", "apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // create output stream for conversion result
    $output_stream = fopen("logo.jpg", "wb");

    // run the conversion and write the result into the output stream
    $client->convertFileToStream("/path/to/logo.png", $output_stream);

    // close the output stream
    fclose($output_stream);
}
catch(\Pdfcrowd\Error $why)
{
    // report the error to the standard error stream
    fwrite(STDERR, "Pdfcrowd Error: {$why}\n");
}

?>

Convert Image URL

Convert url with PNG file to a JPEG file

<?php
require 'pdfcrowd.php';

try
{
    // create the API client instance
    $client = new \Pdfcrowd\ImageToImageClient("username", "apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // run the conversion and write the result to a file
    $client->convertUrlToFile("http://pdfcrowd.com/static/images/logo.png", "logo.jpg");
}
catch(\Pdfcrowd\Error $why)
{
    // report the error to the standard error stream
    fwrite(STDERR, "Pdfcrowd Error: {$why}\n");
}

?>

Convert url with PNG file to in-memory JPEG

<?php
require 'pdfcrowd.php';

try
{
    // create the API client instance
    $client = new \Pdfcrowd\ImageToImageClient("username", "apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // create output file for conversion result
    $output_file = fopen("logo.jpg", "wb");

    // run the conversion and store the result into an image variable
    $image = $client->convertUrl("http://pdfcrowd.com/static/images/logo.png");

    // write the image the into the output file
    fwrite($output_file, $image);

    // close the output file
    fclose($output_file);
}
catch(\Pdfcrowd\Error $why)
{
    // report the error to the standard error stream
    fwrite(STDERR, "Pdfcrowd Error: {$why}\n");
}

?>

Convert url with PNG file and write the resulting JPEG to an output stream

<?php
require 'pdfcrowd.php';

try
{
    // create the API client instance
    $client = new \Pdfcrowd\ImageToImageClient("username", "apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // create output stream for conversion result
    $output_stream = fopen("logo.jpg", "wb");

    // run the conversion and write the result into the output stream
    $client->convertUrlToStream("http://pdfcrowd.com/static/images/logo.png", $output_stream);

    // close the output stream
    fclose($output_stream);
}
catch(\Pdfcrowd\Error $why)
{
    // report the error to the standard error stream
    fwrite(STDERR, "Pdfcrowd Error: {$why}\n");
}

?>

Convert In-Memory Image

Convert an in-memory PNG to a JPEG file

<?php
require 'pdfcrowd.php';

try
{
    // create the API client instance
    $client = new \Pdfcrowd\ImageToImageClient("username", "apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // run the conversion and write the result to a file
    $client->convertRawDataToFile(file_get_contents("/path/to/logo.png"), "logo.jpg");
}
catch(\Pdfcrowd\Error $why)
{
    // report the error to the standard error stream
    fwrite(STDERR, "Pdfcrowd Error: {$why}\n");
}

?>

Convert an in-memory PNG to in-memory JPEG

<?php
require 'pdfcrowd.php';

try
{
    // create the API client instance
    $client = new \Pdfcrowd\ImageToImageClient("username", "apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // create output file for conversion result
    $output_file = fopen("logo.jpg", "wb");

    // run the conversion and store the result into an image variable
    $image = $client->convertRawData(file_get_contents("/path/to/logo.png"));

    // write the image the into the output file
    fwrite($output_file, $image);

    // close the output file
    fclose($output_file);
}
catch(\Pdfcrowd\Error $why)
{
    // report the error to the standard error stream
    fwrite(STDERR, "Pdfcrowd Error: {$why}\n");
}

?>

Convert an in-memory PNG and write the resulting JPEG to an output stream

<?php
require 'pdfcrowd.php';

try
{
    // create the API client instance
    $client = new \Pdfcrowd\ImageToImageClient("username", "apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");

    // create output stream for conversion result
    $output_stream = fopen("logo.jpg", "wb");

    // run the conversion and write the result into the output stream
    $client->convertRawDataToStream(file_get_contents("/path/to/logo.png"), $output_stream);

    // close the output stream
    fclose($output_stream);
}
catch(\Pdfcrowd\Error $why)
{
    // report the error to the standard error stream
    fwrite(STDERR, "Pdfcrowd Error: {$why}\n");
}

?>

Conversion Info

Get info about the current conversion

<?php
require 'pdfcrowd.php';

try
{
    // create the API client instance
    $client = new \Pdfcrowd\ImageToImageClient("username", "apikey");

    // configure the conversion
    $client->setOutputFormat("jpg");
    $client->setDebugLog(true);

    // run the conversion and write the result to a file
    $client->convertFileToFile("/path/to/logo.png", "logo.jpg");
    
    // print URL to the debug log
    echo "Debug log url: " . $client->getDebugLogUrl() . "\n";
    
    // print the number of available conversion credits in your account
    echo "Remaining credit count: " . $client->getRemainingCreditCount() . "\n";
    
    // print the number of credits consumed by the conversion
    echo "Consumed credit count: " . $client->getConsumedCreditCount() . "\n";
    
    // print the unique ID of the conversion
    echo "Job id: " . $client->getJobId() . "\n";
    
    // print the size of the output in bytes
    echo "Output size: " . $client->getOutputSize() . "\n";
}
catch(\Pdfcrowd\Error $why)
{
    // report the error to the standard error stream
    fwrite(STDERR, "Pdfcrowd Error: {$why}\n");
}

?>

API Reference - class ImageToImageClient

Conversion from one image format to another image format.

Constructor

function __construct($user_name, $api_key)
Constructor for the Pdfcrowd API client.
Parameter Description Default
user_name
Your username at Pdfcrowd.
api_key
Your API key.

 

Conversion Input

function convertUrl($url)
Convert an image.
Parameter Description Default
url
The address of the image to convert.
The supported protocols are http:// and https://.
Returns
  • byte[] - Byte array containing the conversion output.
function convertUrlToStream($url, $out_stream)
Convert an image and write the result to an output stream.
Parameter Description Default
url
The address of the image to convert.
The supported protocols are http:// and https://.
out_stream
The output stream that will contain the conversion output.
function convertUrlToFile($url, $file_path)
Convert an image and write the result to a local file.
Parameter Description Default
url
The address of the image to convert.
The supported protocols are http:// and https://.
file_path
The output file path.
The string must not be empty.
function convertFile($file)
Convert a local file.
Parameter Description Default
file
The path to a local file to convert.
The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip).
The file must exist and not be empty.
Returns
  • byte[] - Byte array containing the conversion output.
function convertFileToStream($file, $out_stream)
Convert a local file and write the result to an output stream.
Parameter Description Default
file
The path to a local file to convert.
The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip).
The file must exist and not be empty.
out_stream
The output stream that will contain the conversion output.
function convertFileToFile($file, $file_path)
Convert a local file and write the result to a local file.
Parameter Description Default
file
The path to a local file to convert.
The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip).
The file must exist and not be empty.
file_path
The output file path.
The string must not be empty.
function convertRawData($data)
Convert raw data.
Parameter Description Default
data
The raw content to be converted.
Returns
  • byte[] - Byte array with the output.
function convertRawDataToStream($data, $out_stream)
Convert raw data and write the result to an output stream.
Parameter Description Default
data
The raw content to be converted.
out_stream
The output stream that will contain the conversion output.
function convertRawDataToFile($data, $file_path)
Convert raw data to a file.
Parameter Description Default
data
The raw content to be converted.
file_path
The output file path.
The string must not be empty.

 

Conversion Format

function setOutputFormat($output_format)
The format of the output file.
Parameter Description Default
output_format
Allowed values:
  • png
  • jpg
  • gif
  • tiff
  • bmp
  • ico
  • ppm
  • pgm
  • pbm
  • pnm
  • psb
  • pct
  • ras
  • tga
  • sgi
  • sun
  • webp
png
Returns
  • ImageToImageClient - The converter object.

 

Image operations

Settings used for operations with images.

function setResize($resize)
Resize the image.
Parameter Description Default
resize
The resize percentage or new image dimensions.
100%
Returns
  • ImageToImageClient - The converter object.
Examples:
  • setResize("200%")
  • setResize("1024x768")
function setRotate($rotate)
Rotate the image.
Parameter Description Default
rotate
The rotation specified in degrees.
0
Returns
  • ImageToImageClient - The converter object.

 

Miscellaneous

function setDebugLog($debug_log)
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method.
Parameter Description Default
debug_log
Set to true to enable the debug logging.
false
Returns
  • ImageToImageClient - The converter object.
function getDebugLogUrl()
Get the URL of the debug log for the last conversion.
Returns
  • string - The link to the debug log.
function getRemainingCreditCount()
Get the number of conversion credits available in your account.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
Returns
  • int - The number of credits.
function getConsumedCreditCount()
Get the number of credits consumed by the last conversion.
Returns
  • int - The number of credits.
function getJobId()
Get the job id.
Returns
  • string - The unique job identifier.
function getOutputSize()
Get the size of the output in bytes.
Returns
  • int - The count of bytes.

 

API Client Options

function setUseHttp($use_http)
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
Parameter Description Default
use_http
Set to true to use HTTP.
false
Returns
  • ImageToImageClient - The converter object.
function setUserAgent($user_agent)
Set a custom user agent HTTP header. It can be usefull if you are behind some proxy or firewall.
Parameter Description Default
user_agent
The user agent string.
pdfcrowd_php_client/4.3.0 (http://pdfcrowd.com)
Returns
  • ImageToImageClient - The converter object.
function setProxy($host, $port, $user_name, $password)
Specifies an HTTP proxy that the API client library will use to connect to the internet.
Parameter Description Default
host
The proxy hostname.
port
The proxy port.
user_name
The username.
password
The password.
Returns
  • ImageToImageClient - The converter object.
function setRetryCount($retry_count)
Specifies the number of retries when the 502 HTTP status code is received. The 502 status code indicates a temporary network issue. This feature can be disabled by setting to 0.
Parameter Description Default
retry_count
Number of retries wanted.
1
Returns
  • ImageToImageClient - The converter object.

 

Error Handling

try 
{
    // call the API 
}
catch(\Pdfcrowd\Error $why) 
{
    // print error
    fwrite(STDERR, "Pdfcrowd Error: {$why}\n");

    // print just error code
    fwrite(STDERR, "Pdfcrowd Error Code: {$why->getCode()}\n");

    // print just error message
    fwrite(STDERR, "Pdfcrowd Error Message: {$why->getMessage()}\n");

    // or handle the error by your way
}