Public Member Functions
	save ($filename, $updateOnly=false)

	__construct ($source=null, $revision=null, $load=false)

	revisions ()

	rollback ($steps)

	getTextFieldNames ()

	setTextFieldProperties ($name, $bitmask)

	markTextFieldAsReadOnly ($name)

	newPage ($param1, $param2=null)

	getMetadata ()

	setMetadata ($metadata)

	getJavaScript ()

	getOpenAction ()

	setOpenAction (Zend_Pdf_Target $openAction=null)

	getNamedDestinations ()

	getNamedDestination ($name)

	setNamedDestination ($name, $destination=null)

	resolveDestination (Zend_Pdf_Destination $destination, $refreshPageCollectionHashes=true)

	extractFonts ()

	extractFont ($fontName)

	render ($newSegmentOnly=false, $outputStream=null)

	setJavaScript ($javaScript)

	resetJavaScript ()

	addJavaScript ($javaScript)

Static Public Member Functions
static	getMemoryManager ()

static	setMemoryManager (Zend_Memory_Manager $memoryManager)

static	parse (&$source=null, $revision=null)

static	load ($source=null, $revision=null)

static	pdfDate ($timestamp=null)

Data Fields
const	PDF_VERSION = '1.4'

const	PDF_HEADER = "%PDF-1.4\n%\xE2\xE3\xCF\xD3\n"

const	PDF_FORM_FIELD_READONLY = 1

const	PDF_FORM_FIELD_REQUIRED = 2

const	PDF_FORM_FIELD_NOEXPORT = 4

	$pages = array()

	$properties = array()

	$outlines = array()

Protected Member Functions
	_loadPages (Zend_Pdf_Element_Reference $pages, $attributes=array())

	_loadNamedDestinations (Zend_Pdf_Element_Reference $root, $pdfHeaderVersion)

	_loadOutlines (Zend_Pdf_Element_Reference $root)

	_loadJavaScript (Zend_Pdf_Element_Reference $root)

	_loadFormFields (Zend_Pdf_Element_Reference $root)

	_dumpPages ()

	_dumpNamedDestinations ()

	_dumpOutlines ()

	_refreshPagesHash ()

	_cleanUpAction (Zend_Pdf_Action $action, $refreshPageCollectionHashes=true)

Protected Attributes
	$_originalProperties = array()

	$_javaScript = null

	$_namedTargets = array()

	$_originalOutlines = array()

	$_originalOpenOutlinesCount = 0

	$_trailer = null

	$_objFactory = null

	$_parser

	$_formFields = array()

	$_isNewDocument = true

	$_pageReferences = null

	$_pageNumbers = null

Static Protected Attributes
static	$_memoryManager = null

static	$_inheritableAttributes = array('Resources', 'MediaBox', 'CropBox', 'Rotate')

Detailed Description

Definition at line 84 of file Pdf.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$source = `null`,
		$revision = `null`,
		$load = `false`
	)

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 - current version, 1 - previous version, 2 - ...)

Parameters

string	$source	- PDF file to load
integer	$revision
bool	$load

Exceptions

Zend_Pdf_Exception

Returns: Zend_Pdf

Document id

Document catalog indirect object.

Pages container

Definition at line 322 of file Pdf.php.

     {
         #require_once 'Zend/Pdf/ElementFactory.php';
         $this->_objFactory = Zend_Pdf_ElementFactory::createFactory(1);
 
         if ($source !== null) {
             #require_once 'Zend/Pdf/Parser.php';
             $this->_parser           = new Zend_Pdf_Parser($source, $this->_objFactory, $load);
             $this->_pdfHeaderVersion = $this->_parser->getPDFVersion();
             $this->_trailer          = $this->_parser->getTrailer();
             if ($this->_trailer->Encrypt !== null) {
                 #require_once 'Zend/Pdf/Exception.php';
                 throw new Zend_Pdf_Exception('Encrypted document modification is not supported');
             }
             if ($revision !== null) {
                 $this->rollback($revision);
             } else {
                 $this->_loadPages($this->_trailer->Root->Pages);
             }
 
             $this->_loadNamedDestinations($this->_trailer->Root, $this->_parser->getPDFVersion());
             $this->_loadOutlines($this->_trailer->Root);
             $this->_loadJavaScript($this->_trailer->Root);
             $this->_loadFormFields($this->_trailer->Root);
 
             if ($this->_trailer->Info !== null) {
                 $this->properties = $this->_trailer->Info->toPhp();
 
                 if (isset($this->properties['Trapped'])) {
                     switch ($this->properties['Trapped']) {
                         case 'True':
                             $this->properties['Trapped'] = true;
                             break;
 
                         case 'False':
                             $this->properties['Trapped'] = false;
                             break;
 
                         case 'Unknown':
                             $this->properties['Trapped'] = null;
                             break;
 
                         default:
                             // Wrong property value
                             // Do nothing
                             break;
                     }
                 }
 
                 $this->_originalProperties = $this->properties;
             }
 
             $this->_isNewDocument = false;
         } else {
             $this->_pdfHeaderVersion = Zend_Pdf::PDF_VERSION;
 
             $trailerDictionary = new Zend_Pdf_Element_Dictionary();
 
             $docId = md5(uniqid(rand(), true));   // 32 byte (128 bit) identifier
             $docIdLow  = substr($docId,  0, 16);  // first 16 bytes
             $docIdHigh = substr($docId, 16, 16);  // second 16 bytes
 
             $trailerDictionary->ID = new Zend_Pdf_Element_Array();
             $trailerDictionary->ID->items[] = new Zend_Pdf_Element_String_Binary($docIdLow);
             $trailerDictionary->ID->items[] = new Zend_Pdf_Element_String_Binary($docIdHigh);
 
             $trailerDictionary->Size = new Zend_Pdf_Element_Numeric(0);
 
             #require_once 'Zend/Pdf/Trailer/Generator.php';
             $this->_trailer = new Zend_Pdf_Trailer_Generator($trailerDictionary);
 
             $docCatalog = $this->_objFactory->newObject(new Zend_Pdf_Element_Dictionary());
             $docCatalog->Type    = new Zend_Pdf_Element_Name('Catalog');
             $docCatalog->Version = new Zend_Pdf_Element_Name(Zend_Pdf::PDF_VERSION);
             $this->_trailer->Root = $docCatalog;
 
             $docPages = $this->_objFactory->newObject(new Zend_Pdf_Element_Dictionary());
             $docPages->Type  = new Zend_Pdf_Element_Name('Pages');
             $docPages->Kids  = new Zend_Pdf_Element_Array();
             $docPages->Count = new Zend_Pdf_Element_Numeric(0);
             $docCatalog->Pages = $docPages;
         }
     }

Member Function Documentation

◆ _cleanUpAction()

_cleanUpAction	(	Zend_Pdf_Action	$action,
			$refreshPageCollectionHashes = `true`
	)

protected

Walk through action and its chained actions tree and remove nodes if they are GoTo actions with an unresolved target.

Returns null if root node is deleted or updated action overwise.

Todo:: Give appropriate name and make method public

Parameters

Zend_Pdf_Action	$action
bool	$refreshPageCollectionHashes	Refresh page collection hashes before processing

Returns: Zend_Pdf_Action|null

Definition at line 1179 of file Pdf.php.

     {
         if ($this->_pageReferences === null  ||  $refreshPageCollectionHashes) {
             $this->_refreshPagesHash();
         }
 
         // Named target is an action
         if ($action instanceof Zend_Pdf_Action_GoTo  &&
             $this->resolveDestination($action->getDestination(), false) === null) {
             // Action itself is a GoTo action with an unresolved destination
             return null;
         }
 
         // Walk through child actions
         $iterator = new RecursiveIteratorIterator($action, RecursiveIteratorIterator::SELF_FIRST);
 
         $actionsToClean        = array();
         $deletionCandidateKeys = array();
         foreach ($iterator as $chainedAction) {
             if ($chainedAction instanceof Zend_Pdf_Action_GoTo  &&
                 $this->resolveDestination($chainedAction->getDestination(), false) === null) {
                 // Some child action is a GoTo action with an unresolved destination
                 // Mark it as a candidate for deletion
                 $actionsToClean[]        = $iterator->getSubIterator();
                 $deletionCandidateKeys[] = $iterator->getSubIterator()->key();
             }
         }
         foreach ($actionsToClean as $id => $action) {
             unset($action->next[$deletionCandidateKeys[$id]]);
         }
 
         return $action;
     }

◆ _dumpNamedDestinations()

_dumpNamedDestinations ( )

protected

Dump named destinations

Todo:: Create a balanced tree instead of plain structure.

Definition at line 817 of file Pdf.php.

     {
         ksort($this->_namedTargets, SORT_STRING);
 
         $destArrayItems = array();
         foreach ($this->_namedTargets as $name => $destination) {
             $destArrayItems[] = new Zend_Pdf_Element_String($name);
 
             if ($destination instanceof Zend_Pdf_Target) {
                 $destArrayItems[] = $destination->getResource();
             } else {
                 #require_once 'Zend/Pdf/Exception.php';
                 throw new Zend_Pdf_Exception('PDF named destinations must be a Zend_Pdf_Target object.');
             }
         }
         $destArray = $this->_objFactory->newObject(new Zend_Pdf_Element_Array($destArrayItems));
 
         $DestTree = $this->_objFactory->newObject(new Zend_Pdf_Element_Dictionary());
         $DestTree->Names = $destArray;
 
         $root = $this->_trailer->Root;
 
         if ($root->Names === null) {
             $root->touch();
             $root->Names = $this->_objFactory->newObject(new Zend_Pdf_Element_Dictionary());
         } else {
             $root->Names->touch();
         }
         $root->Names->Dests = $DestTree;
     }

◆ _dumpOutlines()

_dumpOutlines ( )

protected

Dump outlines recursively

Definition at line 851 of file Pdf.php.

     {
         $root = $this->_trailer->Root;
 
         if ($root->Outlines === null) {
             if (count($this->outlines) == 0) {
                 return;
             } else {
                 $root->Outlines = $this->_objFactory->newObject(new Zend_Pdf_Element_Dictionary());
                 $root->Outlines->Type = new Zend_Pdf_Element_Name('Outlines');
                 $updateOutlinesNavigation = true;
             }
         } else {
             $updateOutlinesNavigation = false;
             if (count($this->_originalOutlines) != count($this->outlines)) {
                 // If original and current outlines arrays have different size then outlines list was updated
                 $updateOutlinesNavigation = true;
             } else if ( !(array_keys($this->_originalOutlines) === array_keys($this->outlines)) ) {
                 // If original and current outlines arrays have different keys (with a glance to an order) then outlines list was updated
                 $updateOutlinesNavigation = true;
             } else {
                 foreach ($this->outlines as $key => $outline) {
                     if ($this->_originalOutlines[$key] !== $outline) {
                         $updateOutlinesNavigation = true;
                     }
                 }
             }
         }
 
         $lastOutline = null;
         $openOutlinesCount = 0;
         if ($updateOutlinesNavigation) {
             $root->Outlines->touch();
             $root->Outlines->First = null;
 
             foreach ($this->outlines as $outline) {
                 if ($lastOutline === null) {
                     // First pass. Update Outlines dictionary First entry using corresponding value
                     $lastOutline = $outline->dumpOutline($this->_objFactory, $updateOutlinesNavigation, $root->Outlines);
                     $root->Outlines->First = $lastOutline;
                 } else {
                     // Update previous outline dictionary Next entry (Prev is updated within dumpOutline() method)
                     $currentOutlineDictionary = $outline->dumpOutline($this->_objFactory, $updateOutlinesNavigation, $root->Outlines, $lastOutline);
                     $lastOutline->Next = $currentOutlineDictionary;
                     $lastOutline       = $currentOutlineDictionary;
                 }
                 $openOutlinesCount += $outline->openOutlinesCount();
             }
 
             $root->Outlines->Last  = $lastOutline;
         } else {
             foreach ($this->outlines as $outline) {
                 $lastOutline = $outline->dumpOutline($this->_objFactory, $updateOutlinesNavigation, $root->Outlines, $lastOutline);
                 $openOutlinesCount += $outline->openOutlinesCount();
             }
         }
 
         if ($openOutlinesCount != $this->_originalOpenOutlinesCount) {
             $root->Outlines->touch;
             $root->Outlines->Count = new Zend_Pdf_Element_Numeric($openOutlinesCount);
         }
     }

◆ _dumpPages()

_dumpPages ( )

protected

Orginize pages to tha pages tree structure.

Todo:

atomatically attach page to the document, if it's not done yet.

check, that page is attached to the current document

Todo:: Dump pages as a balanced tree instead of a plain set.

Definition at line 724 of file Pdf.php.

     {
         $root = $this->_trailer->Root;
         $pagesContainer = $root->Pages;
 
         $pagesContainer->touch();
         $pagesContainer->Kids->items = array();
 
         foreach ($this->pages as $page ) {
             $page->render($this->_objFactory);
 
             $pageDictionary = $page->getPageDictionary();
             $pageDictionary->touch();
             $pageDictionary->Parent = $pagesContainer;
 
             $pagesContainer->Kids->items[] = $pageDictionary;
         }
 
         $this->_refreshPagesHash();
 
         $pagesContainer->Count->touch();
         $pagesContainer->Count->value = count($this->pages);
 
 
         // Refresh named destinations list
         foreach ($this->_namedTargets as $name => $namedTarget) {
             if ($namedTarget instanceof Zend_Pdf_Destination_Explicit) {
                 // Named target is an explicit destination
                 if ($this->resolveDestination($namedTarget, false) === null) {
                     unset($this->_namedTargets[$name]);
                 }
             } else if ($namedTarget instanceof Zend_Pdf_Action) {
                 // Named target is an action
                 if ($this->_cleanUpAction($namedTarget, false) === null) {
                     // Action is a GoTo action with an unresolved destination
                     unset($this->_namedTargets[$name]);
                 }
             } else {
                 #require_once 'Zend/Pdf/Exception.php';
                 throw new Zend_Pdf_Exception('Wrong type of named targed (\'' . get_class($namedTarget) . '\').');
             }
         }
 
         // Refresh outlines
         #require_once 'Zend/Pdf/RecursivelyIteratableObjectsContainer.php';
         $iterator = new RecursiveIteratorIterator(new Zend_Pdf_RecursivelyIteratableObjectsContainer($this->outlines), RecursiveIteratorIterator::SELF_FIRST);
         foreach ($iterator as $outline) {
             $target = $outline->getTarget();
 
             if ($target !== null) {
                 if ($target instanceof Zend_Pdf_Destination) {
                     // Outline target is a destination
                     if ($this->resolveDestination($target, false) === null) {
                         $outline->setTarget(null);
                     }
                 } else if ($target instanceof Zend_Pdf_Action) {
                     // Outline target is an action
                     if ($this->_cleanUpAction($target, false) === null) {
                         // Action is a GoTo action with an unresolved destination
                         $outline->setTarget(null);
                     }
                 } else {
                     #require_once 'Zend/Pdf/Exception.php';
                     throw new Zend_Pdf_Exception('Wrong outline target.');
                 }
             }
         }
 
         $openAction = $this->getOpenAction();
         if ($openAction !== null) {
             if ($openAction instanceof Zend_Pdf_Action) {
                 // OpenAction is an action
                 if ($this->_cleanUpAction($openAction, false) === null) {
                     // Action is a GoTo action with an unresolved destination
                     $this->setOpenAction(null);
                 }
             } else if ($openAction instanceof Zend_Pdf_Destination) {
                 // OpenAction target is a destination
                 if ($this->resolveDestination($openAction, false) === null) {
                     $this->setOpenAction(null);
                 }
             } else {
                 #require_once 'Zend/Pdf/Exception.php';
                 throw new Zend_Pdf_Exception('OpenAction has to be either PDF Action or Destination.');
             }
         }
     }

◆ _loadFormFields()

_loadFormFields ( Zend_Pdf_Element_Reference $root )

protected

Load form fields

Populates the _formFields array, for later lookup of fields by name

Parameters

Zend_Pdf_Element_Reference $root Document catalog entry

Definition at line 623 of file Pdf.php.

     {
         if ($root->AcroForm === null || $root->AcroForm->Fields === null) {
             return;
         }
 
         foreach ($root->AcroForm->Fields->items as $field) {
             /* We only support fields that are textfields and have a name */
             if ($field->FT && $field->FT->value == 'Tx' && $field->T
                 && $field->T !== null
             ) {
                 $this->_formFields[$field->T->value] = $field;
             }
         }
 
         if (!$root->AcroForm->NeedAppearances
             || !$root->AcroForm->NeedAppearances->value
         ) {
             /* Ask the .pdf viewer to generate its own appearance data, so we do not have to */
             $root->AcroForm->add(
                 new Zend_Pdf_Element_Name('NeedAppearances'),
                 new Zend_Pdf_Element_Boolean(true)
             );
             $root->AcroForm->touch();
         }
     }

◆ _loadJavaScript()

_loadJavaScript ( Zend_Pdf_Element_Reference $root )

protected

Load JavaScript

Populates the _javaScript string, for later use of getJavaScript method.

Parameters

Zend_Pdf_Element_Reference $root Document catalog entry

Definition at line 599 of file Pdf.php.

     {
         if (null === $root->Names || null === $root->Names->JavaScript
             || null === $root->Names->JavaScript->Names
         ) {
             return;
         }
 
         foreach ($root->Names->JavaScript->Names->items as $item) {
             if ($item instanceof Zend_Pdf_Element_Reference
                 && $item->S->value === 'JavaScript'
             ) {
                 $this->_javaScript[] = $item->JS->value;
             }
         }
     }

◆ _loadNamedDestinations()

_loadNamedDestinations	(	Zend_Pdf_Element_Reference	$root,
			$pdfHeaderVersion
	)

protected

Load named destinations recursively

Parameters

Zend_Pdf_Element_Reference	$root	Document catalog entry
string	$pdfHeaderVersion

Exceptions

Zend_Pdf_Exception

Definition at line 513 of file Pdf.php.

     {
         if ($root->Version !== null  &&  version_compare($root->Version->value, $pdfHeaderVersion, '>')) {
             $versionIs_1_2_plus = version_compare($root->Version->value,    '1.1', '>');
         } else {
             $versionIs_1_2_plus = version_compare($pdfHeaderVersion, '1.1', '>');
         }
 
         if ($versionIs_1_2_plus) {
             // PDF version is 1.2+
             // Look for Destinations structure at Name dictionary
             if ($root->Names !== null  &&  $root->Names->Dests !== null) {
                 #require_once 'Zend/Pdf/NameTree.php';
                 #require_once 'Zend/Pdf/Target.php';
                 foreach (new Zend_Pdf_NameTree($root->Names->Dests) as $name => $destination) {
                     $this->_namedTargets[$name] = Zend_Pdf_Target::load($destination);
                 }
             }
         } else {
             // PDF version is 1.1 (or earlier)
             // Look for Destinations sructure at Dest entry of document catalog
             if ($root->Dests !== null) {
                 if ($root->Dests->getType() != Zend_Pdf_Element::TYPE_DICTIONARY) {
                     #require_once 'Zend/Pdf/Exception.php';
                     throw new Zend_Pdf_Exception('Document catalog Dests entry must be a dictionary.');
                 }
 
                 #require_once 'Zend/Pdf/Target.php';
                 foreach ($root->Dests->getKeys() as $destKey) {
                     $this->_namedTargets[$destKey] = Zend_Pdf_Target::load($root->Dests->$destKey);
                 }
             }
         }
     }

◆ _loadOutlines()

_loadOutlines ( Zend_Pdf_Element_Reference $root )

protected

Load outlines recursively

Parameters

Zend_Pdf_Element_Reference $root Document catalog entry

Exceptions

Zend_Pdf_Exception

Definition at line 554 of file Pdf.php.

     {
         if ($root->Outlines === null) {
             return;
         }
 
         if ($root->Outlines->getType() != Zend_Pdf_Element::TYPE_DICTIONARY) {
             #require_once 'Zend/Pdf/Exception.php';
             throw new Zend_Pdf_Exception('Document catalog Outlines entry must be a dictionary.');
         }
 
         if ($root->Outlines->Type !== null  &&  $root->Outlines->Type->value != 'Outlines') {
             #require_once 'Zend/Pdf/Exception.php';
             throw new Zend_Pdf_Exception('Outlines Type entry must be an \'Outlines\' string.');
         }
 
         if ($root->Outlines->First === null) {
             return;
         }
 
         $outlineDictionary = $root->Outlines->First;
         $processedDictionaries = new SplObjectStorage();
         while ($outlineDictionary !== null  &&  !$processedDictionaries->contains($outlineDictionary)) {
             $processedDictionaries->attach($outlineDictionary);
 
             #require_once 'Zend/Pdf/Outline/Loaded.php';
             $this->outlines[] = new Zend_Pdf_Outline_Loaded($outlineDictionary);
 
             $outlineDictionary = $outlineDictionary->Next;
         }
 
         $this->_originalOutlines = $this->outlines;
 
         if ($root->Outlines->Count !== null) {
             $this->_originalOpenOutlinesCount = $root->Outlines->Count->value;
         }
     }

◆ _loadPages()

_loadPages	(	Zend_Pdf_Element_Reference	$pages,
			$attributes = `array()`
	)

protected

Load pages recursively

Parameters

Zend_Pdf_Element_Reference	$pages
array \| null	$attributes

Exceptions

Zend_Pdf_Exception

Important note. If any attribute or dependant object is an indirect object, then it's still shared between pages.

Definition at line 465 of file Pdf.php.

     {
         if ($pages->getType() != Zend_Pdf_Element::TYPE_DICTIONARY) {
             #require_once 'Zend/Pdf/Exception.php';
             throw new Zend_Pdf_Exception('Wrong argument');
         }
 
         foreach ($pages->getKeys() as $property) {
             if (in_array($property, self::$_inheritableAttributes)) {
                 $attributes[$property] = $pages->$property;
                 $pages->$property = null;
             }
         }
 
 
         foreach ($pages->Kids->items as $child) {
             if ($child->Type->value == 'Pages') {
                 $this->_loadPages($child, $attributes);
             } else if ($child->Type->value == 'Page') {
                 foreach (self::$_inheritableAttributes as $property) {
                     if ($child->$property === null && array_key_exists($property, $attributes)) {
                         if ($attributes[$property] instanceof Zend_Pdf_Element_Object  ||
                             $attributes[$property] instanceof Zend_Pdf_Element_Reference) {
                             $child->$property = $attributes[$property];
                         } else {
                             $child->$property = $this->_objFactory->newObject($attributes[$property]);
                         }
                     }
                 }
 
                 #require_once 'Zend/Pdf/Page.php';
                 $this->pages[] = new Zend_Pdf_Page($child, $this->_objFactory);
             }
         }
     }

◆ _refreshPagesHash()

_refreshPagesHash ( )

protected

Refresh page collection hashes

Returns: Zend_Pdf

Definition at line 1098 of file Pdf.php.

     {
         $this->_pageReferences = array();
         $this->_pageNumbers    = array();
         $count = 1;
         foreach ($this->pages as $page) {
             $pageDictionaryHashId = spl_object_hash($page->getPageDictionary()->getObject());
             $this->_pageReferences[$pageDictionaryHashId] = $page;
             $this->_pageNumbers[$count++]                 = $page;
         }
 
         return $this;
     }

◆ addJavaScript()

addJavaScript ( $javaScript )

Appends JavaScript to the document-level JavaScript

Parameters

string | array $javaScript

Exceptions

Zend_Pdf_Exception

Definition at line 1563 of file Pdf.php.

     {
         if (empty($javaScript)) {
             throw new Zend_Pdf_Exception(
                 'JavaScript must be a non empty string or array of strings'
             );
         }
 
         if (!is_array($javaScript)) {
             $javaScript = array($javaScript);
         }
 
         if (null === $this->_javaScript) {
             $this->_javaScript = $javaScript;
         } else {
             $this->_javaScript = array_merge($this->_javaScript, $javaScript);
         }
 
         if (!empty($this->_javaScript)) {
             $items = array();
 
             foreach ($this->_javaScript as $javaScript) {
                 $jsCode = array(
                     'S'  => new Zend_Pdf_Element_Name('JavaScript'),
                     'JS' => new Zend_Pdf_Element_String($javaScript)
                 );
                 $items[] = new Zend_Pdf_Element_String('EmbeddedJS');
                 $items[] = $this->_objFactory->newObject(
                     new Zend_Pdf_Element_Dictionary($jsCode)
                 );
             }
 
             $jsRef = $this->_objFactory->newObject(
                 new Zend_Pdf_Element_Dictionary(
                     array('Names' => new Zend_Pdf_Element_Array($items))
                 )
             );
 
             if (null === $this->_trailer->Root->Names) {
                 $this->_trailer->Root->Names = new Zend_Pdf_Element_Dictionary();
             }
             $this->_trailer->Root->Names->JavaScript = $jsRef;
         }
     }

◆ extractFont()

extractFont ( $fontName )

Extract font attached to the page by specific font name

$fontName should be specified in UTF-8 encoding

Parameters

string $fontName

Returns: Zend_Pdf_Resource_Font_Extracted|null

Exceptions

Zend_Pdf_Exception

Definition at line 1275 of file Pdf.php.

     {
         $fontResourcesUnique = array();
         #require_once 'Zend/Pdf/Exception.php';
         foreach ($this->pages as $page) {
             $pageResources = $page->extractResources();
 
             if ($pageResources->Font === null) {
                 // Page doesn't contain have any font reference
                 continue;
             }
 
             $fontResources = $pageResources->Font;
 
             foreach ($fontResources->getKeys() as $fontResourceName) {
                 $fontDictionary = $fontResources->$fontResourceName;
 
                 if (! ($fontDictionary instanceof Zend_Pdf_Element_Reference  ||
                        $fontDictionary instanceof Zend_Pdf_Element_Object) ) {
                     #require_once 'Zend/Pdf/Exception.php';
                     throw new Zend_Pdf_Exception('Font dictionary has to be an indirect object or object reference.');
                 }
 
                 $resourceId = spl_object_hash($fontDictionary->getObject());
                 if (isset($fontResourcesUnique[$resourceId])) {
                     continue;
                 } else {
                     // Mark resource as processed
                     $fontResourcesUnique[$resourceId] = 1;
                 }
 
                 if ($fontDictionary->BaseFont->value != $fontName) {
                     continue;
                 }
 
                 try {
                     // Try to extract font
                     #require_once 'Zend/Pdf/Resource/Font/Extracted.php';
                     return new Zend_Pdf_Resource_Font_Extracted($fontDictionary);
                 } catch (Zend_Pdf_Exception $e) {
                     if ($e->getMessage() != 'Unsupported font type.') {
                         throw $e;
                     }
                     // Continue searhing
                 }
             }
         }
 
         return null;
     }

◆ extractFonts()

extractFonts ( )

Extract fonts attached to the document

returns array of Zend_Pdf_Resource_Font_Extracted objects

Returns: array

Exceptions

Zend_Pdf_Exception

Definition at line 1221 of file Pdf.php.

     {
         $fontResourcesUnique = array();
         foreach ($this->pages as $page) {
             $pageResources = $page->extractResources();
 
             if ($pageResources->Font === null) {
                 // Page doesn't contain have any font reference
                 continue;
             }
 
             $fontResources = $pageResources->Font;
 
             foreach ($fontResources->getKeys() as $fontResourceName) {
                 $fontDictionary = $fontResources->$fontResourceName;
 
                 if (! ($fontDictionary instanceof Zend_Pdf_Element_Reference  ||
                        $fontDictionary instanceof Zend_Pdf_Element_Object) ) {
                     #require_once 'Zend/Pdf/Exception.php';
                     throw new Zend_Pdf_Exception('Font dictionary has to be an indirect object or object reference.');
                 }
 
                 $fontResourcesUnique[spl_object_hash($fontDictionary->getObject())] = $fontDictionary;
             }
         }
 
         $fonts = array();
         #require_once 'Zend/Pdf/Exception.php';
         foreach ($fontResourcesUnique as $resourceId => $fontDictionary) {
             try {
                 // Try to extract font
                 #require_once 'Zend/Pdf/Resource/Font/Extracted.php';
                 $extractedFont = new Zend_Pdf_Resource_Font_Extracted($fontDictionary);
 
                 $fonts[$resourceId] = $extractedFont;
             } catch (Zend_Pdf_Exception $e) {
                 if ($e->getMessage() != 'Unsupported font type.') {
                     throw $e;
                 }
             }
         }
 
         return $fonts;
     }

◆ getJavaScript()

getJavaScript ( )

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

Returns: string

Definition at line 982 of file Pdf.php.

     {
         return $this->_javaScript;
     }

◆ getMemoryManager()

static getMemoryManager ( )

static

Request used memory manager

Returns: Zend_Memory_Manager

Definition at line 236 of file Pdf.php.

     {
         if (self::$_memoryManager === null) {
             #require_once 'Zend/Memory.php';
             self::$_memoryManager = Zend_Memory::factory('none');
         }
 
         return self::$_memoryManager;
     }

◆ getMetadata()

getMetadata ( )

Return the document-level Metadata or null Metadata stream is not presented

Returns: string

Definition at line 952 of file Pdf.php.

     {
         if ($this->_trailer->Root->Metadata !== null) {
             return $this->_trailer->Root->Metadata->value;
         } else {
             return null;
         }
     }

◆ getNamedDestination()

getNamedDestination ( $name )

Return specified named destination

Parameters

string $name

Returns: Zend_Pdf_Destination_Explicit|Zend_Pdf_Action_GoTo

Definition at line 1045 of file Pdf.php.

     {
         if (isset($this->_namedTargets[$name])) {
             return $this->_namedTargets[$name];
         } else {
             return null;
         }
     }

◆ getNamedDestinations()

getNamedDestinations ( )

Return an associative array containing all the named destinations (or GoTo actions) in the PDF. Named targets can be used to reference from outside the PDF, ex: 'http://www.something.com/mydocument.pdf#MyAction'

Returns: array

Definition at line 1034 of file Pdf.php.

     {
         return $this->_namedTargets;
     }

◆ getOpenAction()

getOpenAction ( )

Get open Action Returns Zend_Pdf_Target (Zend_Pdf_Destination or Zend_Pdf_Action object)

Returns: Zend_Pdf_Target

Definition at line 993 of file Pdf.php.

     {
         if ($this->_trailer->Root->OpenAction !== null) {
             #require_once 'Zend/Pdf/Target.php';
             return Zend_Pdf_Target::load($this->_trailer->Root->OpenAction);
         } else {
             return null;
         }
     }

◆ getTextFieldNames()

getTextFieldNames ( )

Retrieves a list with the names of the AcroForm textfields in the PDF

Returns: array of strings

Definition at line 655 of file Pdf.php.

     {
         return array_keys($this->_formFields);
     }

◆ load()

static load	(	$source = `null`,
		$revision = `null`
	)

static

Load PDF document from a file

Parameters

string	$source
integer	$revision

Returns: Zend_Pdf

Definition at line 276 of file Pdf.php.

     {
         return new Zend_Pdf($source, $revision, true);
     }

◆ markTextFieldAsReadOnly()

markTextFieldAsReadOnly ( $name )

Marks an AcroForm text field as read only

Parameters

string $name

Definition at line 711 of file Pdf.php.

     {
         $this->setTextFieldProperties($name, self::PDF_FORM_FIELD_READONLY);
     }

◆ newPage()

newPage	(	$param1,
		$param2 = `null`
	)

Create page object, attached to the PDF document. Method signatures:

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);

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);

Parameters

mixed	$param1
mixed	$param2

Returns: Zend_Pdf_Page

Definition at line 936 of file Pdf.php.

     {
         #require_once 'Zend/Pdf/Page.php';
         if ($param2 === null) {
             return new Zend_Pdf_Page($param1, $this->_objFactory);
         } else {
             return new Zend_Pdf_Page($param1, $param2, $this->_objFactory);
         }
     }

◆ parse()

static parse	(	&	$source = `null`,
			$revision = `null`
	)

static

Create new PDF document from a $source string

Parameters

string	$source
integer	$revision

Returns: Zend_Pdf

Definition at line 264 of file Pdf.php.

     {
         return new Zend_Pdf($source, $revision);
     }

◆ pdfDate()

static pdfDate ( $timestamp = null )

static

Convert date to PDF format (it's close to ASN.1 (Abstract Syntax Notation One) defined in ISO/IEC 8824).

Todo:: This really isn't the best location for this method. It should probably actually exist as Zend_Pdf_Element_Date or something like that.

Todo:: Address the following E_STRICT issue: PHP Strict Standards: date(): It is not safe to rely on the system's timezone settings. Please use the date.timezone setting, the TZ environment variable or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier.

Parameters

integer $timestamp (optional) If omitted, uses the current time.

Returns: string

Definition at line 1625 of file Pdf.php.

     {
         if ($timestamp === null) {
             $date = date('\D\:YmdHisO');
         } else {
             $date = date('\D\:YmdHisO', $timestamp);
         }
         return substr_replace($date, '\'', -2, 0) . '\'';
     }

◆ render()

render	(	$newSegmentOnly = `false`,
		$outputStream = `null`
	)

Render the completed PDF to a string. If $newSegmentOnly is true and it's not a new document, then only appended part of PDF is returned.

Parameters

boolean	$newSegmentOnly
resource	$outputStream

Returns: string

Exceptions

Zend_Pdf_Exception

Definition at line 1336 of file Pdf.php.

     {
         if ($this->_isNewDocument) {
             // Drop full document first time even $newSegmentOnly is set to true
             $newSegmentOnly = false;
             $this->_isNewDocument = false;
         }
 
         // Save document properties if necessary
         if ($this->properties != $this->_originalProperties) {
             $docInfo = $this->_objFactory->newObject(new Zend_Pdf_Element_Dictionary());
 
             foreach ($this->properties as $key => $value) {
                 switch ($key) {
                     case 'Trapped':
                         switch ($value) {
                             case true:
                                 $docInfo->$key = new Zend_Pdf_Element_Name('True');
                                 break;
 
                             case false:
                                 $docInfo->$key = new Zend_Pdf_Element_Name('False');
                                 break;
 
                             case null:
                                 $docInfo->$key = new Zend_Pdf_Element_Name('Unknown');
                                 break;
 
                             default:
                                 #require_once 'Zend/Pdf/Exception.php';
                                 throw new Zend_Pdf_Exception('Wrong Trapped document property vale: \'' . $value . '\'. Only true, false and null values are allowed.');
                                 break;
                         }
 
                     case 'CreationDate':
                         // break intentionally omitted
                     case 'ModDate':
                         $docInfo->$key = new Zend_Pdf_Element_String((string)$value);
                         break;
 
                     case 'Title':
                         // break intentionally omitted
                     case 'Author':
                         // break intentionally omitted
                     case 'Subject':
                         // break intentionally omitted
                     case 'Keywords':
                         // break intentionally omitted
                     case 'Creator':
                         // break intentionally omitted
                     case 'Producer':
                         if (extension_loaded('mbstring') === true) {
                             $detected = mb_detect_encoding($value);
                             if ($detected !== 'ASCII') {
                                 $value = "\xfe\xff" . mb_convert_encoding($value, 'UTF-16', $detected);
                             }
                         }
                         $docInfo->$key = new Zend_Pdf_Element_String((string)$value);
                         break;
 
                     default:
                         // Set property using PDF type based on PHP type
                         $docInfo->$key = Zend_Pdf_Element::phpToPdf($value);
                         break;
                 }
             }
 
             $this->_trailer->Info = $docInfo;
         }
 
         $this->_dumpPages();
         $this->_dumpNamedDestinations();
         $this->_dumpOutlines();
 
         // Check, that PDF file was modified
         // File is always modified by _dumpPages() now, but future implementations may eliminate this.
         if (!$this->_objFactory->isModified()) {
             if ($newSegmentOnly) {
                 // Do nothing, return
                 return '';
             }
 
             if ($outputStream === null) {
                 return $this->_trailer->getPDFString();
             } else {
                 $pdfData = $this->_trailer->getPDFString();
                 while ( strlen($pdfData) > 0 && ($byteCount = fwrite($outputStream, $pdfData)) != false ) {
                     $pdfData = substr($pdfData, $byteCount);
                 }
 
                 return '';
             }
         }
 
         // offset (from a start of PDF file) of new PDF file segment
         $offset = $this->_trailer->getPDFLength();
         // Last Object number in a list of free objects
         $lastFreeObject = $this->_trailer->getLastFreeObject();
 
         // Array of cross-reference table subsections
         $xrefTable = array();
         // Object numbers of first objects in each subsection
         $xrefSectionStartNums = array();
 
         // Last cross-reference table subsection
         $xrefSection = array();
         // Dummy initialization of the first element (specail case - header of linked list of free objects).
         $xrefSection[] = 0;
         $xrefSectionStartNums[] = 0;
         // Object number of last processed PDF object.
         // Used to manage cross-reference subsections.
         // Initialized by zero (specail case - header of linked list of free objects).
         $lastObjNum = 0;
 
         if ($outputStream !== null) {
             if (!$newSegmentOnly) {
                 $pdfData = $this->_trailer->getPDFString();
                 while ( strlen($pdfData) > 0 && ($byteCount = fwrite($outputStream, $pdfData)) != false ) {
                     $pdfData = substr($pdfData, $byteCount);
                 }
             }
         } else {
             $pdfSegmentBlocks = ($newSegmentOnly) ? array() : array($this->_trailer->getPDFString());
         }
 
         // Iterate objects to create new reference table
         foreach ($this->_objFactory->listModifiedObjects() as $updateInfo) {
             $objNum = $updateInfo->getObjNum();
 
             if ($objNum - $lastObjNum != 1) {
                 // Save cross-reference table subsection and start new one
                 $xrefTable[] = $xrefSection;
                 $xrefSection = array();
                 $xrefSectionStartNums[] = $objNum;
             }
 
             if ($updateInfo->isFree()) {
                 // Free object cross-reference table entry
                 $xrefSection[]  = sprintf("%010d %05d f \n", $lastFreeObject, $updateInfo->getGenNum());
                 $lastFreeObject = $objNum;
             } else {
                 // In-use object cross-reference table entry
                 $xrefSection[]  = sprintf("%010d %05d n \n", $offset, $updateInfo->getGenNum());
 
                 $pdfBlock = $updateInfo->getObjectDump();
                 $offset += strlen($pdfBlock);
 
                 if ($outputStream === null) {
                     $pdfSegmentBlocks[] = $pdfBlock;
                 } else {
                     while ( strlen($pdfBlock) > 0 && ($byteCount = fwrite($outputStream, $pdfBlock)) != false ) {
                         $pdfBlock = substr($pdfBlock, $byteCount);
                     }
                 }
             }
             $lastObjNum = $objNum;
         }
         // Save last cross-reference table subsection
         $xrefTable[] = $xrefSection;
 
         // Modify first entry (specail case - header of linked list of free objects).
         $xrefTable[0][0] = sprintf("%010d 65535 f \n", $lastFreeObject);
 
         $xrefTableStr = "xref\n";
         foreach ($xrefTable as $sectId => $xrefSection) {
             $xrefTableStr .= sprintf("%d %d \n", $xrefSectionStartNums[$sectId], count($xrefSection));
             foreach ($xrefSection as $xrefTableEntry) {
                 $xrefTableStr .= $xrefTableEntry;
             }
         }
 
         $this->_trailer->Size->value = $this->_objFactory->getObjectCount();
 
         $pdfBlock = $xrefTableStr
                  .  $this->_trailer->toString()
                  . "startxref\n" . $offset . "\n"
                  . "%%EOF\n";
 
         $this->_objFactory->cleanEnumerationShiftCache();
 
         if ($outputStream === null) {
             $pdfSegmentBlocks[] = $pdfBlock;
 
             return implode('', $pdfSegmentBlocks);
         } else {
             while ( strlen($pdfBlock) > 0 && ($byteCount = fwrite($outputStream, $pdfBlock)) != false ) {
                 $pdfBlock = substr($pdfBlock, $byteCount);
             }
 
             return '';
         }
     }

◆ resetJavaScript()

resetJavaScript ( )

Resets the document-level JavaScript

Definition at line 1546 of file Pdf.php.

     {
         $this->_javaScript = null;
 
         $root = $this->_trailer->Root;
         if (null === $root->Names || null === $root->Names->JavaScript) {
             return;
         }
         $root->Names->JavaScript = null;
     }

◆ resolveDestination()

resolveDestination	(	Zend_Pdf_Destination	$destination,
			$refreshPageCollectionHashes = `true`
	)

Resolve destination.

Returns Zend_Pdf_Page page object or null if destination is not found within PDF document.

Parameters

Zend_Pdf_Destination	$destination	Destination to resolve
bool	$refreshPageCollectionHashes	Refresh page collection hashes before processing

Returns: Zend_Pdf_Page|null

Exceptions

Zend_Pdf_Exception

Definition at line 1122 of file Pdf.php.

     {
         if ($this->_pageReferences === null  ||  $refreshPageCollectionHashes) {
             $this->_refreshPagesHash();
         }
 
         if ($destination instanceof Zend_Pdf_Destination_Named) {
             if (!isset($this->_namedTargets[$destination->getName()])) {
                 return null;
             }
             $destination = $this->getNamedDestination($destination->getName());
 
             if ($destination instanceof Zend_Pdf_Action) {
                 if (!$destination instanceof Zend_Pdf_Action_GoTo) {
                     return null;
                 }
                 $destination = $destination->getDestination();
             }
 
             if (!$destination instanceof Zend_Pdf_Destination_Explicit) {
                 #require_once 'Zend/Pdf/Exception.php';
                 throw new Zend_Pdf_Exception('Named destination target has to be an explicit destination.');
             }
         }
 
         // Named target is an explicit destination
         $pageElement = $destination->getResource()->items[0];
 
         if ($pageElement->getType() == Zend_Pdf_Element::TYPE_NUMERIC) {
             // Page reference is a PDF number
             if (!isset($this->_pageNumbers[$pageElement->value])) {
                 return null;
             }
 
             return $this->_pageNumbers[$pageElement->value];
         }
 
         // Page reference is a PDF page dictionary reference
         $pageDictionaryHashId = spl_object_hash($pageElement->getObject());
         if (!isset($this->_pageReferences[$pageDictionaryHashId])) {
             return null;
         }
         return $this->_pageReferences[$pageDictionaryHashId];
     }

◆ revisions()

revisions ( )

Retrive number of revisions.

Returns: integer

Definition at line 420 of file Pdf.php.

     {
         $revisions = 1;
         $currentTrailer = $this->_trailer;
 
         while ($currentTrailer->getPrev() !== null && $currentTrailer->getPrev()->Root !== null ) {
             $revisions++;
             $currentTrailer = $currentTrailer->getPrev();
         }
 
         return $revisions++;
     }

◆ rollback()

rollback ( $steps )

Rollback document $steps number of revisions. This method must be invoked before any changes, applied to the document. Otherwise behavior is undefined.

Parameters

integer $steps

Definition at line 440 of file Pdf.php.

     {
         for ($count = 0; $count < $steps; $count++) {
             if ($this->_trailer->getPrev() !== null && $this->_trailer->getPrev()->Root !== null) {
                 $this->_trailer = $this->_trailer->getPrev();
             } else {
                 break;
             }
         }
         $this->_objFactory->setObjectCount($this->_trailer->Size->value);
 
         // Mark content as modified to force new trailer generation at render time
         $this->_trailer->Root->touch();
 
         $this->pages = array();
         $this->_loadPages($this->_trailer->Root->Pages);
     }

◆ save()

save	(	$filename,
		$updateOnly = `false`
	)

Render PDF document and save it.

If $updateOnly is true and it's not a new document, then it only appends new section to the end of file.

Parameters

string	$filename
boolean	$updateOnly

Exceptions

Zend_Pdf_Exception

Definition at line 291 of file Pdf.php.

     {
         if (($file = @fopen($filename, $updateOnly ? 'ab':'wb')) === false ) {
             #require_once 'Zend/Pdf/Exception.php';
             throw new Zend_Pdf_Exception( "Can not open '$filename' file for writing." );
         }
 
         $this->render($updateOnly, $file);
 
         fclose($file);
     }

◆ setJavaScript()

setJavaScript ( $javaScript )

Sets the document-level JavaScript

Resets and appends

Parameters

string | array $javaScript

Definition at line 1536 of file Pdf.php.

     {
         $this->resetJavaScript();
 
         $this->addJavaScript($javaScript);
     }

◆ setMemoryManager()

static setMemoryManager ( Zend_Memory_Manager $memoryManager )

static

Set user defined memory manager

Parameters

Zend_Memory_Manager $memoryManager

Definition at line 251 of file Pdf.php.

     {
         self::$_memoryManager = $memoryManager;
     }

◆ setMetadata()

setMetadata ( $metadata )

Sets the document-level Metadata (mast be valid XMP document)

Parameters

string $metadata

Definition at line 966 of file Pdf.php.

     {
         $metadataObject = $this->_objFactory->newStreamObject($metadata);
         $metadataObject->dictionary->Type    = new Zend_Pdf_Element_Name('Metadata');
         $metadataObject->dictionary->Subtype = new Zend_Pdf_Element_Name('XML');
 
         $this->_trailer->Root->Metadata = $metadataObject;
         $this->_trailer->Root->touch();
     }

◆ setNamedDestination()

setNamedDestination	(	$name,
		$destination = `null`
	)

Set specified named destination

Parameters

string	$name
Zend_Pdf_Destination_Explicit \| Zend_Pdf_Action_GoTo	$destination

Exceptions

Zend_Pdf_Exception

Definition at line 1061 of file Pdf.php.

     {
         if ($destination !== null  &&
             !$destination instanceof Zend_Pdf_Action_GoTo  &&
             !$destination instanceof Zend_Pdf_Destination_Explicit) {
             #require_once 'Zend/Pdf/Exception.php';
             throw new Zend_Pdf_Exception('PDF named destination must refer an explicit destination or a GoTo PDF action.');
         }
 
         if ($destination !== null) {
            $this->_namedTargets[$name] = $destination;
         } else {
             unset($this->_namedTargets[$name]);
         }
     }

◆ setOpenAction()

setOpenAction ( Zend_Pdf_Target $openAction = null )

Set open Action which is actually Zend_Pdf_Destination or Zend_Pdf_Action object

Parameters

Zend_Pdf_Target $openAction

Returns: Zend_Pdf

Definition at line 1009 of file Pdf.php.

     {
         $root = $this->_trailer->Root;
         $root->touch();
 
         if ($openAction === null) {
             $root->OpenAction = null;
         } else {
             $root->OpenAction = $openAction->getResource();
 
             if ($openAction instanceof Zend_Pdf_Action)  {
                 $openAction->dumpAction($this->_objFactory);
             }
         }
 
         return $this;
     }

◆ setTextFieldProperties()

setTextFieldProperties	(	$name,
		$bitmask
	)

Sets the properties for an AcroForm text field

Parameters

string	$name
mixed	$bitmask

Exceptions

Zend_Pdf_Exception

Definition at line 690 of file Pdf.php.

     {
         if (!isset($this->_formFields[$name])) {
             throw new Zend_Pdf_Exception(
                 "Field '$name' does not exist or is not a textfield"
             );
         }
 
         $field = $this->_formFields[$name];
         $field->add(
             new Zend_Pdf_Element_Name('Ff'),
             new Zend_Pdf_Element_Numeric($bitmask)
         );
         $field->touch();
     }

Field Documentation

◆ $_formFields

$_formFields = array()

protected

Definition at line 221 of file Pdf.php.

◆ $_inheritableAttributes

$_inheritableAttributes = array('Resources', 'MediaBox', 'CropBox', 'Rotate')

staticprotected

Definition at line 214 of file Pdf.php.

◆ $_isNewDocument

$_isNewDocument = true

protected

Definition at line 229 of file Pdf.php.

◆ $_javaScript

$_javaScript = null

protected

Definition at line 147 of file Pdf.php.

◆ $_memoryManager

$_memoryManager = null

staticprotected

Definition at line 199 of file Pdf.php.

◆ $_namedTargets

$_namedTargets = array()

protected

Definition at line 155 of file Pdf.php.

◆ $_objFactory

$_objFactory = null

protected

Definition at line 192 of file Pdf.php.

◆ $_originalOpenOutlinesCount

$_originalOpenOutlinesCount = 0

protected

Definition at line 178 of file Pdf.php.

◆ $_originalOutlines

$_originalOutlines = array()

protected

Definition at line 170 of file Pdf.php.

◆ $_originalProperties

$_originalProperties = array()

protected

Definition at line 140 of file Pdf.php.

◆ $_pageNumbers

$_pageNumbers = null

protected

Definition at line 1091 of file Pdf.php.

◆ $_pageReferences

$_pageReferences = null

protected

Definition at line 1083 of file Pdf.php.

◆ $_parser

$_parser

protected

Definition at line 207 of file Pdf.php.

◆ $_trailer

$_trailer = null

protected

Definition at line 185 of file Pdf.php.

◆ $outlines

$outlines = array()

Definition at line 162 of file Pdf.php.

◆ $pages

$pages = array()

Definition at line 114 of file Pdf.php.

◆ $properties

$properties = array()

Definition at line 131 of file Pdf.php.

◆ PDF_FORM_FIELD_NOEXPORT

const PDF_FORM_FIELD_NOEXPORT = 4

Definition at line 103 of file Pdf.php.

◆ PDF_FORM_FIELD_READONLY

const PDF_FORM_FIELD_READONLY = 1

Form field options

Definition at line 101 of file Pdf.php.

◆ PDF_FORM_FIELD_REQUIRED

const PDF_FORM_FIELD_REQUIRED = 2

Definition at line 102 of file Pdf.php.

◆ PDF_HEADER

const PDF_HEADER = "%PDF-1.4\n%\xE2\xE3\xCF\xD3\n"

PDF file header.

Definition at line 96 of file Pdf.php.

◆ PDF_VERSION

const PDF_VERSION = '1.4'

Version number of generated PDF documents.

Definition at line 91 of file Pdf.php.

The documentation for this class was generated from the following file:

vendor/magento/zendframework1/library/Zend/Pdf.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _cleanUpAction()

◆ _dumpNamedDestinations()

◆ _dumpOutlines()

◆ _dumpPages()

◆ _loadFormFields()

◆ _loadJavaScript()

◆ _loadNamedDestinations()

◆ _loadOutlines()

◆ _loadPages()

◆ _refreshPagesHash()

◆ addJavaScript()

◆ extractFont()

◆ extractFonts()

◆ getJavaScript()

◆ getMemoryManager()

◆ getMetadata()

◆ getNamedDestination()

◆ getNamedDestinations()

◆ getOpenAction()

◆ getTextFieldNames()

◆ load()

◆ markTextFieldAsReadOnly()

◆ newPage()

included into output.

new Zend_Pdf_Page(string $pagesize);

included into output.

new Zend_Pdf_Page(numeric $width, numeric $height);

◆ parse()

◆ pdfDate()

◆ render()

◆ resetJavaScript()

◆ resolveDestination()

◆ revisions()

◆ rollback()

◆ save()

◆ setJavaScript()

◆ setMemoryManager()

◆ setMetadata()

◆ setNamedDestination()

◆ setOpenAction()

◆ setTextFieldProperties()

Field Documentation

◆ $_formFields

◆ $_inheritableAttributes

◆ $_isNewDocument

◆ $_javaScript

◆ $_memoryManager

◆ $_namedTargets

◆ $_objFactory

◆ $_originalOpenOutlinesCount

◆ $_originalOutlines

◆ $_originalProperties

◆ $_pageNumbers

◆ $_pageReferences

◆ $_parser

◆ $_trailer

◆ $outlines

◆ $pages

◆ $properties

◆ PDF_FORM_FIELD_NOEXPORT

◆ PDF_FORM_FIELD_READONLY

◆ PDF_FORM_FIELD_REQUIRED

◆ PDF_HEADER

◆ PDF_VERSION