Class Zend_Pdf

Description

General entity which describes PDF document.

It implements document abstraction with a document level operations.

Class is used to create new PDF document or load existing document. See details in a class constructor description

Class agregates document level properties and entities (pages, bookmarks, document level actions, attachments, form object, etc)

Located in /Zend/Pdf.php (line 89)


	
			
Variable Summary
Method Summary
 Zend_Pdf __construct ([string &$source = null], [integer $revision = null], [mixed $load = false])
 string getJavaScript ()
 array getNamedActions ()
 Zend_Pdf load ([string $source = null], [integer $revision = null])
 Zend_Pdf_Page newPage (mixed $param1, [mixed $param2 = null])
 Zend_Pdf parse ([string &$source = null], [integer $revision = null])
 array properties ()
 string render ([boolean $newSegmentOnly = false])
 integer revisions ()
 void rollback (integer $steps)
 void save (string $filename, [boolean $updateOnly = false])
 void setJavaScript (string $javascript)
 void _dumpPages ()
 void _loadPages (Zend_Pdf_Element_Reference $pages, [array|null $attributes = null])
Variables
array $pages = array() (line 100)

Pages collection

  • var: - array of Zend_Pdf_Page object
  • access: public
  • todo: implement it as a class, which supports ArrayAccess and Iterator interfaces, to provide incremental parsing and pages tree updating. That will give good performance and memory (PDF size) benefits.
string $_javaScript = null (line 114)

Document level javascript

  • access: private
array $_namedActions = array() (line 123)

Document named actions "GoTo..." actions, used to refer document parts from outside PDF

  • var: - array of Zend_Pdf_Action objects
  • access: private
Zend_Pdf_ElementFactory $_objFactory = null (line 139)

PDF objects factory.

  • access: private
array $_properties = array() (line 107)

Document properties

  • access: private
Zend_Pdf_Trailer $_trailer = null (line 131)

Pdf trailer (last or just created)

  • access: private
Methods
Constructor __construct (line 209)

Creates or loads PDF document.

If $source is null, then it creates a new document.

If $source is a string and $load is false, then it loads document from a binary string.

If $source is a string and $load is true, then it loads document from a file. $revision used to roll back document to specified version (0 - currtent version, 1 - previous version, 2 - ...)

  • access: public
  • throws: Zend_Pdf_Exception
Zend_Pdf __construct ([string &$source = null], [integer $revision = null], [mixed $load = false])
  • string $source: - PDF file to load
  • integer $revision
getJavaScript (line 435)

Return the document-level JavaScript or null if there is no JavaScript for this document

  • access: public
string getJavaScript ()
getNamedActions (line 448)

Return an associative array containing all the named actions in the PDF.

Named actions (it's always "GoTo" actions) can be used to reference from outside the PDF, ex: 'http://www.something.com/mydocument.pdf#MyAction'

  • access: public
array getNamedActions ()
load (line 161)

Load PDF document from a file

  • access: public
  • static:
Zend_Pdf load ([string $source = null], [integer $revision = null])
  • string $source
  • integer $revision
newPage (line 401)

Create page object, attached to the PDF document.

Method signatures:

  1. Create new page with a specified pagesize. If $factory is null then it will be created and page must be attached to the document to be included into output.
--------------------------------------------------------- new Zend_Pdf_Page(string $pagesize); ---------------------------------------------------------

2. Create new page with a specified pagesize (in default user space units). If $factory is null then it will be created and page must be attached to the document to be included into output. --------------------------------------------------------- new Zend_Pdf_Page(numeric $width, numeric $height); ---------------------------------------------------------

  • access: public
Zend_Pdf_Page newPage (mixed $param1, [mixed $param2 = null])
  • mixed $param1
  • mixed $param2
parse (line 149)

Create new PDF document from a $source string

  • access: public
  • static:
Zend_Pdf parse ([string &$source = null], [integer $revision = null])
  • string $source
  • integer $revision
properties (line 423)

Return return the an associative array with PDF meta information, values may be string, boolean or float.

Returned array could be used directly to access, add, modify or remove document properties.

Standard document properties: Title (must be set for PDF/X documents), Author, Subject, Keywords (comma separated list), Creator (the name of the application, that created document, if it was converted from other format), Trapped (must be true, false or null, can not be null for PDF/X documents)

  • access: public
array properties ()
render (line 461)

Render the completed PDF to a string.

If $newSegmentOnly is true, then only appended part of PDF is returned.

  • access: public
string render ([boolean $newSegmentOnly = false])
  • boolean $newSegmentOnly
revisions (line 263)

Retrive number of revisions.

  • access: public
integer revisions ()
rollback (line 283)

Rollback document $steps number of revisions.

This method must be invoked before any changes, applied to the document. Otherwise behavior is undefined.

  • access: public
void rollback (integer $steps)
  • integer $steps
save (line 175)

Render PDF document and save it.

If $updateOnly is true, then it only appends new section to the end of file.

  • access: public
  • throws: Zend_Pdf_Exception
void save (string $filename, [boolean $updateOnly = false])
  • string $filename
  • boolean $updateOnly
setJavaScript (line 554)

Set the document-level JavaScript

  • access: public
void setJavaScript (string $javascript)
  • string $javascript
_dumpPages (line 358)

Orginize pages to tha pages tree structure.

  • access: private
  • todo: atomatically attach page to the document, if it's not done yet.
  • todo: check, that page is attached to the current document
  • todo: Dump pages as a balanced tree instead of a plain set.
void _dumpPages ()
_loadPages (line 307)

Load pages recursively

  • access: private
void _loadPages (Zend_Pdf_Element_Reference $pages, [array|null $attributes = null])

Documentation generated on Tue, 18 Apr 2006 11:55:26 -0700 by phpDocumentor 1.3.0RC3