PHP PDF library integration

This guide will help you build your own PDFNet PHP wrappers by binding a free trial of the PDFNetC library to PHP. It will also show you how to run Apryse samples and integrate the Apryse SDK into PHP applications on macOS. Your free trial includes unlimited trial usage and support from solution engineers.

• Targeting PHP8Please refer to PDFNet wrappers for more information
  • PHP8 with developer extensions and SWIG 4.1.0 and above.
• Targeting PHP7
  • PHP7 with developer extensions and SWIG 3.0.12 OR SWIG 4.0.2 and above
• Targeting PHP5
  • PHP5 with developer extensions and SWIG 2.0.4 - 2.0.12
• CMake version ≥ 2.8
• Apryse's PHP PDF library for macOS:

NOTE: If you're using PHP 7 We highly recommend that you install PHP it using Homebrew

Download the SDK

1. Make a directory to store the wrappers and navigate into that directory.
2. Clone the uncompiled PDFNet wrappers by executing

1git clone https://github.com/PDFTron/PDFNetWrappers

1. Navigate to PDFNetWrappers/PDFNetC and move the downloaded [PDFNet C/C++ SDK] for macOS(#prerequisites) into that directory and unzip it. Ensure you obtain the right architecture for your PHP interpreter. This can be done with these two commands:

1curl -L -O http://www.pdftron.com/downloads/PDFNetCMac.zip
2unzip PDFNetCMac.zip

1. Now to move the headers and libraries in place, make sure you are in the PDFNetWrappers/PDFNetC directory and executeYou can delete PDFNetCMac.zip to free up space.Your /PDFNetC folder should be laid out like this like this:

1mv PDFNetCMac/Headers/ .
2mv PDFNetCMac/Lib/ .

1PDFNetC
2├── Headers
3├── Lib
4├── PDFNetCMac
5└── README.txt

1. Make a build directory inside /PDFNetWrappers and navigate to it. This guide will assume the build directory is called Build.

1cd .. # Go back up /PDFNetWrappers.
2mkdir Build # Create a directory to create the Makefiles in.
3cd Build # Move to that directory.

1. Generate the Makefile with cmake.

1cmake -D BUILD_PDFNetPHP=ON ..

1. Execute make followed by sudo make install.If all goes well, you should get a message which reads:

1make # Build the PHP wrappers with SWIG.
2sudo make install # Copy the PHP wrappers to where the samples can find them.

1Build files have been written to ~/PDFNetWrappers/Build

1. Next we need to fix the rpaths issue on Mac. While still in the same Build directory, execute these lines:

1cp ../fix_rpaths.sh ../PDFNetC/Lib/
2cd ../PDFNetC/Lib/
3sudo sh ./fix_rpaths.sh

1. Get your Apryse trial key.

You are now ready to run the samples or integrate Apryse SDK into your own application.

Run a specific sample

1. To run a test, navigate to the PHP folder in the sample, for example /Samples/AddImageTest/PHP and execute ./RunTest.sh

Run all samples

1. To run all tests, navigate to /Samples and execute:The tests will run one by one.

1cd ../../Samples # Move to the Samples directory.
2./runall_php.sh # Run all PHP code samples, using the new wrappers.

This section will show you how to use our SDK to create a simple Apryse "Hello World!" application. It will create a document with one blank page and save it as a linearized PDF in its running directory.

1. Navigate into your /Samples directory and make a new directory called myApp (if it does not exist already). This guide will assume your application is named myApp. For organization, create a new directory inside myApp called PHP.
2. Navigate inside that PHP directory and create a new PHP file called myApp.php. Open it with your favorite text editor and paste this into it:Run your application by executing php myApp.php. If all goes well, your console should output:

1<?php
2 include("../../../PDFNetC/Lib/PDFNetPHP.php");
3 PDFNet::Initialize("YOUR_APRYSE_LICENSE_KEY"); // PDFNet must be initialized before accessing any Apryse API
4 $doc = new PDFDoc();
5 $page = $doc->PageCreate(); // Start a new page
6 $doc->PagePushBack($page); // Add the page to document
7 $doc->Save("output.pdf", SDFDoc::e_linearized); // Save the document as a linearized PDF
8 echo nl2br("Hello World!\n");
9?>

1PDFNet is running in demo mode.
2Permission: write
3Hello World!<br />

Check the output.pdf that the program output in the same directory. It should be a PDF with one blank page.

Check the troubleshooting page and our PDFNetWrappers github if you run into any issues going through this document.

This guide will help you build your own PDFNet PHP wrappers by binding a free trial of the PDFNetC library to PHP. It will also show you how to run Apryse samples and integrate the Apryse SDK into PHP applications on Linux. Your free trial includes unlimited trial usage and support from solution engineers.

• Targeting PHP8Please refer to PDFNet wrappers for more information
  • PHP8 with developer extensions and SWIG 4.1.0 and above.
• Targeting PHP7
  • PHP7 with developer extensions and SWIG 3.0.12 OR SWIG 4.0.2 and above
• Targeting PHP5
  • PHP5 with developer extensions and SWIG 2.0.4 - 2.0.12
• CMake version ≥ 2.8
• Apryse SDK for Linux:

Download the SDK

1. Make a directory to store the wrappers and navigate into that directory.
2. Clone the uncompiled PDFNet wrappers by executing

1git clone https://github.com/PDFTron/PDFNetWrappers # Git clone the code.

1. Navigate to PDFNetWrappers/PDFNetC and download the PDFNet C/C++ SDK into that directory. Ensure you obtain the right architecture for your PHP interpreter. For example, if your interpreter is 64bit (which this guide will assume), execute

1cd PDFNetWrappers/PDFNetC # Move to where we download PDFNet.
2wget http://www.pdftron.com/downloads/PDFNetC64.tar.gz # Download PDFNet.
3tar xzvf PDFNetC64.tar.gz # Unpack PDFNet.

1. Unpack PDFNetC64.tar.gz by tar xvzf PDFNetC64.tar.gz, then executeto move the PDFNet libraries in place.You can delete PDFNetC64.tar.gz to free up space.Your /PDFNetC folder should be laid out like this like this:

1mv PDFNetC64/Headers/ . # Move PDFNet Headers/ into place.
2mv PDFNetC64/Lib/ . # Move PDFNet Lib/ into place.

1PDFNetC
2├── Headers
3├── Lib
4├── PDFNetC64
5└── README.txt

1. Make a build directory inside /PDFNetWrappers and navigate to it. This guide will assume the build directory is called Build.

1cd .. # Go back up /PDFNetWrappers.
2mkdir Build # Create a directory to create the Makefiles in.
3cd Build # Move to that directory.

1. Execute make followed by sudo make install. It is important when installing the php-dev directories to target the same version of PHP you're utilizing, otherwise it will pull the latest and likely cause build errors. For instance for PHP 7.4 execute sudo apt-get install php7.4-dev.If all goes well, you should get a message which reads:

1sudo apt-get install php-dev # add php-dev for required PHP include directories
2cmake -D BUILD_PDFNetPHP=ON .. # Create the Makefiles with CMake.
3make # Build the PHP wrappers with SWIG.
4sudo make install # Copy the PHP wrappers to where the samples can find them.

1Build files have been written to ~/PDFNetWrappers/Build

1. Please note that you may need to register PDFNetPHP.so as an extension to your PHP by adding the following line in all your php.ini files:You may also need to enable dynamic loaded extensions by updating enable_dl = On in all your php.ini files as well.

1extension=/full/path/to/PDFNetPHP.so

1enable_dl = On

1. Get your Apryse trial key.

You are now ready to run the samples or integrate Apryse SDK into your own application.

Run a specific sample

1. To run a test, navigate to the PHP folder in the sample, for example /Samples/AddImageTest/PHP and execute ./RunTest.sh

Run all samples

1. To run all tests, navigate to /Samples and execute:The tests will run one by one.

1cd ../Samples # Move to the Samples directory.
2./runall_php.sh # Run all PHP code samples, using the new wrappers.

This section will show you how to use our SDK to create a simple Apryse "Hello World!" application. It will create a document with one blank page and save it as a linearized PDF in its running directory.

1. Navigate into your /Samples directory and make a new directory called myApp (if it does not exist already). This guide will assume your application is named myApp. For organization, create a new directory inside myApp called PHP.
2. Navigate inside that PHP directory and create a new PHP file called myApp.php. Open it with your favorite text editor and paste this into it:Run your application by executing php myApp.php. If all goes well, your console should output:

1<?php
2 include("../../../PDFNetC/Lib/PDFNetPHP.php");
3 PDFNet::Initialize("YOUR_APRYSE_LICENSE_KEY"); // PDFNet must be initialized before accessing any Apryse API
4 $doc = new PDFDoc();
5 $page = $doc->PageCreate(); // Start a new page
6 $doc->PagePushBack($page); // Add the page to document
7 $doc->Save("output.pdf", SDFDoc::e_linearized); // Save the document as a linearized PDF
8 echo nl2br("Hello World!\n");
9?>

1PDFNet is running in demo mode.
2Permission: write
3Hello World!<br />

Check the output.pdf that the program output in the same directory. It should be a PDF with one blank page.

Check the troubleshooting page and our PDFNetWrappers github if you run into any issues going through this document.