The PHP sample provided in this section uses the Muhimbi PDF Converter Services Online to apply a 'composite watermark' to a PDF file. This is typically done when a single file requires multiple watermarks. Composite watermarks are defined using Muhimbi's XML based watermarking syntax.
Additional sample code to convert, merge, watermark, secure and OCR files can be found here.
Full details about the composite_watermark
method, fields and properties can be found in the Wiki.
Download the sample code using a method of your choice. Some examples are provided below.
-
Git: Clone the entire repository to your system. You can find the examples under the
clients/v1/php/samples
folder.git clone https://github.com/Muhimbi/PDF-Converter-Services-Online
-
SVN: A common trick to download only part of a Git repository is to use
svn
. Download only the PHP client and sample code using the following command.svn export https://github.com/Muhimbi/PDF-Converter-Services-Online/trunk/clients/v1/php
-
ZIP: Download a ZIP archive of the entire repository. Once downloaded, you can find the examples under the
clients/v1/php/samples
folder.
In order to successfully execute the sample code, make sure you have a valid subscription, either a full one or the 30 day trial.
❗ Each subscription comes with a unique api_key
. Before executing the sample, please insert your key in the code. ❗
Make sure the prerequisites are in place. The sample code expects the client libraries to be present under ../../client/
.
There are many ways to execute PHP code, in this example we use PHP's internal web server, but naturally it will work equally well using Apache, IIS or any other PHP capable platform.
Launch PHP and activate the built-in web server as follows:
php -S localhost:8080 -t some_path_to/PDF-Converter-Services-Online/clients/v1/php/samples/watermarking/composite_watermark
You may want to change the port number and naturally you must specify the full path to the folder containing this sample.
With PHP running - and in this example - listening on port 8080, open a browser and navigate to http://localhost:8080/composite_watermark.php
.
Choose a PDF file, optionally change the XML based watermark definition, and click the Watermark
button.
If you have any questions or comments then please contact our friendly support desk.