Package Home

Zend Framework 2 Documentation (Manual)

PHK Home

File: /modules/zendpdf.create.html

Size:11660
Storage flags:no_autoload,compress/gzip (28%)

Creating and Loading PDF Documents — Zend Framework 2 2.4.2 documentation

Creating and Loading PDF DocumentsΒΆ

The ZendPdf\PdfDocument class represents PDF documents and provides document-level operations.

To create a new document, a new ZendPdf\PdfDocument object should first be created.

ZendPdf\PdfDocument class also provides two static methods to load an existing PDF document. These are the ZendPdf\PdfDocument::load() and ZendPdf\PdfDocument::parse() methods. Both of them return ZendPdf\PdfDocument objects as a result or throw an exception if an error occurs.

Create new or load existing PDF document

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
...
// Create a new PDF document
$pdf1 = new ZendPdf\PdfDocument();

// Load a PDF document from a file
$pdf2 = ZendPdf\PdfDocument::load($fileName);

// Load a PDF document from a string
$pdf3 = ZendPdf\PdfDocument::parse($pdfString);
...

The PDF file format supports incremental document update. Thus each time a document is updated, then a new revision of the document is created. ZendPdf component supports the retrieval of a specified revision.

A revision can be specified as a second parameter to the ZendPdf\PdfDocument::load() and ZendPdf\PdfDocument::parse() methods or requested by calling the ZendPdf\PdfDocument::rollback() method. [1] call.

Requesting Specific Revisions of a PDF Document

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
...
// Load the previous revision of the PDF document
$pdf1 = ZendPdf\PdfDocument::load($fileName, 1);

// Load the previous revision of the PDF document
$pdf2 = ZendPdf\PdfDocument::parse($pdfString, 1);

// Load the first revision of the PDF document
$pdf3 = ZendPdf\PdfDocument::load($fileName);
$revisions = $pdf3->revisions();
$pdf3->rollback($revisions - 1);
...
[1]ZendPdf\PdfDocument::rollback() method must be invoked before any changes are applied to the document, otherwise the behavior is not defined.

This Page

Note: You need to stay logged into your GitHub account to contribute to the documentation.

Edit this document

Edit this document

The source code of this file is hosted on GitHub. Everyone can update and fix errors in this document with few clicks - no downloads needed.

  1. Login with your GitHub account.
  2. Go to Creating and Loading PDF Documents on GitHub.
  3. Edit file contents using GitHub's text editor in your web browser
  4. Fill in the Commit message text box at the end of the page telling why you did the changes. Press Propose file change button next to it when done.
  5. On Send a pull request page you don't need to fill in text anymore. Just press Send pull request button.
  6. Your changes are now queued for review under project's Pull requests tab on GitHub.

For more information about the PHK package format: http://phk.tekwire.net