BCL easyPDF SDK
easyPDF SDK Usermanual
PDF Creator Programming API  |  Download Free Trial  |  Contact Us to Purchase

Native PHP PDFConverter API

Usage

The native PHP API, which is written in PHP 5, is a thin interface around a binary executable. It is very similar to the native .NET API, with the exception of some language-specific differences.

In order to use easyPDF, just import the library by adding require("easyPDFConverter.php");. The PDFConverter SDK is inside the BCL\easyPDF\PDFConverter\ namespace. easyPDFConverter.php can be found under C:\Program Files\Common Files\BCL Technologies\easyPDF 8.

When an error occurs, an exception of type PDFConverterException is thrown.

The PDFConverter class has a destructor, which means it is automatically disposed when the object goes out of scope. That makes memory management trivial, just make sure you are not holding on to the variable when you are no longer using the SDK.

If the customer's application crashes, the system automatically closes all pipes belonging to the process, which means all related worker processes automatically quit as well.

The minimal PHP sample code looks like this:

<?php
require("easyPDFConverter.php");
$converter = new BCL\easyPDF\PDFConverter\PDFConverter();
try
{
   $pdf2image = $converter->getPDF2Image();
   $pdf2image->Convert("c:\\test\\input.pdf", "c:\\test\\output.jpg", "", -1, -1);
}
catch(BCL\easyPDF\PDFConverter\PDFConverterException $ex)
{
   echo $ex->getMessage(), "\n";
}
?>

PDFConverter's constructor is designed to never throw exceptions. That's because it does not launch a worker process and does not create a named pipe, it merely initializes a few variables to their default values. In other words, creating a PDFConverter object is extremely lightweight, like creating a Color object.

However, as soon as you do anything else, it instantly launches a worker process.

Notification Events

Notification events in the native PHP API are slightly different than in the native .NET API. Here is an example that catches OnPageStart, which is called before converting each page:

function handlePageStart($pageNumber, $pageCount, $fileName) { echo "Page ", $pageNumber + 1, " of ", $pageCount, "...\n"; return BCL\easyPDF\PDFConverter\cnvMonitorResponse::CNV_MON_CONTINUE_CONVERSION; }

$converter = new BCL\easyPDF\PDFConverter\PDFConverter();
try
{
   $monitor = $converter->getPDFConverterMonitor();
   $monitor->OnPageStart = handlePageStart;
   $pdf2image = $converter->getPDF2Image();
   $pdf2image->Convert("c:\\test\\input.pdf", "c:\\test\\output.jpg", "", -1, -1);
}
catch(BCL\easyPDF\PDFConverter\PDFConverterException $ex)
{
   echo $ex->getMessage(), "\n";
}

Launch Timeout

Launching the worker process and connecting the named pipe should happen very fast, in milliseconds. However, under an abnormally heavy load, the computer may not have enough cycles to perform this task in a timely fashion.

The Native PHP API has an internal timeout built-in. The default value is 1 minute. This is because a server may momentarily slow down so much that it is not responding for seconds, but it usually recovers after a while.

The default timeout value can be changed via PDFConverter's launchTimeout member (in milliseconds). This must be performed immediately after the creation of the PDFConverter object.

$converter = new BCL\easyPDF\PDFConverter\PDFConverter();
try
{
   $converter->launchTimeout = 60000;
   $pdf2image = $converter->getPDF2Image();
   $pdf2image->Convert("c:\\test\\input.pdf", "c:\\test\\output.jpg", "", -1, -1);
}
catch(BCL\easyPDF\PDFConverter\PDFConverterException $ex)
{
   echo $ex->getMessage(), "\n";
}

Upon timeout an exception is thrown, and the SDK cannot be used. Another attempt may be made later.