95 lines
2.9 KiB
HTML
95 lines
2.9 KiB
HTML
<html>
|
|
<head>
|
|
<title>Events</title>
|
|
<link rel="stylesheet" type="text/css" medial="all" title="Default" href="css/help.css"/>
|
|
<style type="text/css">
|
|
div.note {
|
|
margin: 0.5em 0;
|
|
}
|
|
|
|
div.class {
|
|
margin: 0.5em 0 0.5em 2em;
|
|
}
|
|
|
|
div.interface {
|
|
margin: 1em 0 0.5em 0;
|
|
padding: 2px 5px;
|
|
background-color: #f0f0f0;
|
|
}
|
|
|
|
span.interface_name {
|
|
font-weight: bold;
|
|
}
|
|
|
|
span.method_name {
|
|
font-weight: bold;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
|
|
<h1>Events</h1>
|
|
<p>
|
|
Sometimes you'd want to add your own code to the rendering routines; for example, you could want to make your own watermarks,
|
|
count pages in the multiple-document batch, add digital signature to the generated PDF file or
|
|
perform any other actions requiring low-level access to PDF file at the certain moments. Now you may do this using
|
|
HTML2PS events. Pipeline object will fire events at predefined moments while rendering PDF file; you may catch them and
|
|
do something useful.
|
|
</p>
|
|
|
|
<p>The code below illustrates installation of a simple callback to be called immediately after
|
|
new page was rendered. (If you're using PHP 5, you can write this way more elegant, but we're keeping PHP 4 compatibility here)</p>
|
|
<pre>
|
|
$dispatcher =& $pipeline->get_dispatcher();
|
|
$dispatcher->add_observer('after-page', 'my_watermark_callback_func');
|
|
</pre>
|
|
|
|
<p>
|
|
A single parameter is passed to the callback function: an associative array containing information related to event.
|
|
</p>
|
|
|
|
<p>Following events are available:</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Fired…</th>
|
|
<th>Event information</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="event-name">after-batch</td>
|
|
<td>after all documents in current batch were rendered</td>
|
|
<td>pipeline: reference to current pipeline object</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="event-name">after-document</td>
|
|
<td>after all pages in a current document were rendered</td>
|
|
<td>pipeline: reference to current pipeline object; document: reference to the body box object</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="event-name">after-page</td>
|
|
<td>after all elements were rendered on current page, but before new page is added.</td>
|
|
<td>pipeline: reference to current pipeline object; document: reference to the body box object; pageno: current page number (1-based)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="event-name">before-batch</td>
|
|
<td>before new document batch starts rendering</td>
|
|
<td>pipeline: reference to current pipeline object</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="event-name">before-document</td>
|
|
<td>before new document in a batch starts rendering</td>
|
|
<td>pipeline: reference to current pipeline object; document: reference to the body box object</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="event-name">before-page</td>
|
|
<td>after new blank page is added to the PDF document but before any elements are rendered</td>
|
|
<td>pipeline: reference to current pipeline object; document: reference to the body box object; pageno: current page number (1-based)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</body>
|
|
</html> |