Development of internet and intranet solutions
PDF solutions based on pure PHP

Manuals

SetaPDF-Stamper API - Examples of Use

Constants / Configuration Zend

Simple Text-Stamp

This example creates a simple text stamp and add it to the PDF document.

<?php
/**
 * set the includepath for SetaPDF APIs
 * You have to point the the root directory "SetaPDF"
 */
set_include_path(get_include_path() . PATH_SEPARATOR . realpath(dirname(__FILE__).'/../../'));

// require the SetaPDF_Stamper-class
require_once("Stamper/SetaPDF_Stamper.php");

// Define the path, where the SetaPDF-Stamper will find the font-definition files
define('SetaPDF_STAMPER_FONTPATH', 'Stamper/font/');

// Create a new instance of SetaPDF_Stamper with output method "Inline"
$stamper =& SetaPDF_Stamper::factory('I');

// Add a pdf-file and define its output and use of compression
$stamper->addFile(
	array(
		"in"  => "docs/License_Agreement_SetaPDF.pdf",
		"out" => "demo.pdf",
		"compression" => true
	)
);

// Let's create the text stamp
// require the SetaPDF_TextStamp-class
require_once("Stamper/SetaPDF_Stamp/SetaPDF_TextStamp.php");

// Initiate a new instance of text_stamp
$textstamp =& new SetaPDF_TextStamp();
// Set the text
$textstamp->setText("Simple Text-Stamp");

// Now we assign the text stamp to our stamper 
$stamper->setStamp($textstamp);

// Let's stamp! 
$stamper->stampit();

Watermark

This example creates a text stamp with red colored text "TOP SECRET". The stamp will appear on every page. Furthermore the stamp will be rotated about 60 degrees and the opacity will be set to 10%.

// require the SetaPDF_Stamper-class
require_once("Stamper/SetaPDF_Stamper.php");

// Define the path, where the SetaPDF-Stamper will find the font-definition files
define('SetaPDF_STAMPER_FONTPATH', 'Stamper/font/');

// Create a new instance of SetaPDF_Stamper with output method "Inline"
$stamper =& SetaPDF_Stamper::factory('I');

$stamper->addFile( 
	array(
		"in"  => "docs/License_Agreement_SetaPDF.pdf",
		"out" => "demo.pdf", 
		"compression" => true
	) 
);

// Let's create the text stamp
// require the SetaPDF_TextStamp-class
require_once("Stamper/SetaPDF_Stamp/SetaPDF_TextStamp.php");
// Initiate a new instance of text_stamp 
$textstamp =& new SetaPDF_TextStamp(); 
// Set the text 
$textstamp->setText("TOP SECRET"); 
// Set font definitions 
$textstamp->setFont("Arial", "B", 90); 
// Set text color to red 
$textstamp->SetFontColor(255,0,0); 
// Set the charspacing 
$textstamp->setCharSpacing(15); 
// Set the rendering mode 
$textstamp->setRenderingMode(2); 
// Set the opacity 
$textstamp->setAlpha(0.1);

/** 
* Now we assign the text stamp to our stamper 
* - we define the position on the center and middle of a page (CM) 
* - the stamp should appear on "all" pages 
* - no translation of the x-axis nor the y-axis will be done 
* - we rotate the stamp about 60 degree 
*/ 
$stamper->setStamp($textstamp,"CM", "all", 0, 0, 60);

// Let's stamp! 
$stamper->stampit();

Companylogo and text on different pages

The following example will create an image stamp and a text stamp, which will be positioned in the right bottom corner. The image stamp will be used on odd pages, while the text stamp will be used on all pages (or better even and odd).

The example uses a PNG file. So it uses the SetaPDF_PNGStamp class.

<?php
/**
 * set the includepath for SetaPDF APIs
 * You have to point to the root directory "SetaPDF"
 */
set_include_path(get_include_path() . PATH_SEPARATOR . realpath(dirname(__FILE__).'/../../'));

// require the SetaPDF_Stamper-class
require_once("Stamper/SetaPDF_Stamper.php");

// Define the path, where the SetaPDF-Stamper will find the font-definition files
define('SetaPDF_STAMPER_FONTPATH', 'Stamper/font/');

// Create a new instance of SetaPDF_Stamper with output method "Inline"
$stamper =& SetaPDF_Stamper::factory('I');

$stamper->addFile(
	array(
		"in"  => "docs/License_Agreement_SetaPDF.pdf",
		"out" => "demo.pdf",
		"compression" => true
	)
);

// require the SetaPDF_PNGStamp-class
require_once("Stamper/SetaPDF_Stamp/SetaPDF_ImageStamp/SetaPDF_PNGStamp.php");
// initiate a new instance of png_stamp
$logo =& new SetaPDF_PNGStamp();
// Set the image-path
$logo->setFileName("docs/setasign_logo.png");
// Set the image-width
$logo->setWidth(100);

/**
 * Now we assign the image-stamp to our stamper
 * - we define the position on the right bottom of each page (RB)
 * - the stamp should appear only on "odd" pages
 * - and translate the position about -5 dots
 */
$stamper->setStamp($logo, "RB", "odd", -5, -5);

require_once("Stamper/SetaPDF_Stamp/SetaPDF_TextStamp.php");
// Initiate a new instance of text_stamp
$textstamp =& new SetaPDF_TextStamp();
// Set text with more lines
$textstamp->setText("Stamped by\nSetaPDF-Stamper API\n".chr(169)." Setasign");
// Set Fontdefinitions
$textstamp->setFont("Arial", "", 10, null, "R");

/**
 * Now we assign the text stamp to our stamper 
 * - we define the position on the right bottom of each page (RB)
 * - the stamp should appear only on "odd" pages
 * - translation of the x-axis will be -110 and the y-axis will be -5
 */
$stamper->setStamp($textstamp,"RB", "odd", -110, -5);

/**
 * Now we reuse the text stamp and assign it to the "even" pages
 * while we use another translation.
 */
$stamper->setStamp($textstamp,"RB", "even", -5, -5);
 
$stamper->stampit();

Don't update but create the document from scratch

<?php
/**
 * same as demo1.php but we'll not just update the PDF but rewrite it from scratch.
 */
set_include_path(get_include_path() . PATH_SEPARATOR . realpath(dirname(__FILE__).'/../../'));

require_once("Stamper/SetaPDF_Stamper.php");

define('SetaPDF_STAMPER_FONTPATH', 'Stamper/font/');

$stamper =& SetaPDF_Stamper::factory('I');
/**
 * NEW: Define that the document will not be updated but recreated at all.
 * This feature makes it much more complicated to remove the stamped content
 * from the new document. But (of course) it is also slower.
 */
$stamper->setUseUpdate(false);

$stamper->addFile(
	array(
		"in"  => "docs/License_Agreement_SetaPDF.pdf",
		"out" => "demo.pdf",
		"compression" => true
	)
);

require_once("Stamper/SetaPDF_Stamp/SetaPDF_TextStamp.php");
$textstamp =& new SetaPDF_TextStamp();
$textstamp->setText("This simple Text-Stamp is not just an update but the document is completely rewritten.");

/**
 * We want the stamp to be centered on top of each 
 * "odd" page.
 */
$stamper->setStamp($textstamp, "CT", "odd");
$stamper->stampit();

Constants / Configuration Zend

Manuals

SetaPDF-Stamper

Table of Contents

PDF Download

Productinfo

Miscellaneous

SetaPDF-Stamper API - Examples of Use

Simple Text-Stamp

Watermark

Companylogo and text on different pages

Don't update but create the document from scratch