Docs For Class Zend_Pdf

Zend_Pdf_ElementFactory

Description

Implements interfaces:

Zend_Pdf_ElementFactory_Interface

PDF element factory.

Responsibility is to log PDF changes

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Pdf/ElementFactory.php (line 34)

Method Summary

static Zend_Pdf_ElementFactory_Interface createFactory (integer $objCount)

Zend_Pdf_ElementFactory __construct (integer $objCount)

void attach (Zend_Pdf_ElementFactory_Interface $factory)

integer calculateShift (Zend_Pdf_ElementFactory_Interface $factory)

void cleanEnumerationShiftCache ()

void close ()

Zend_Pdf_Element_Object|null fetchObject (string $refString)

integer getEnumerationShift (Zend_Pdf_ElementFactory_Interface $factory)

integer getId ()

integer getObjectCount ()

boolean isModified ()

array listModifiedObjects ([Zend_Pdf_ElementFactory_Interface $rootFactory = null])

void markAsModified (Zend_Pdf_Element_Object $obj)

Zend_Pdf_Element_Object newObject (Zend_Pdf_Element $objectValue)

Zend_Pdf_Element_Object_Stream newStreamObject ( $streamValue, mixed $objectValue)

void registerObject (Zend_Pdf_Element_Object $obj, string $refString)

void remove (Zend_Pdf_Element_Object $obj)

Zend_Pdf_ElementFactory resolve ()

void setObjectCount (integer $objCount)

Methods

static createFactory (line 125)

Factory generator

access: public

static Zend_Pdf_ElementFactory_Interface createFactory (integer $objCount)

integer $objCount

Constructor __construct (line 111)

Object constructor

access: public

Zend_Pdf_ElementFactory __construct (integer $objCount)

integer $objCount

attach (line 200)

Attach factory to the current;

access: public

void attach (Zend_Pdf_ElementFactory_Interface $factory)

Zend_Pdf_ElementFactory_Interface $factory

Implementation of:

Zend_Pdf_ElementFactory_Interface::attach(): Attach factory to the current;

calculateShift (line 222)

Calculate object enumeration shift.

access: public

integer calculateShift (Zend_Pdf_ElementFactory_Interface $factory)

Zend_Pdf_ElementFactory_Interface $factory

Implementation of:

Zend_Pdf_ElementFactory_Interface::calculateShift(): Calculate object enumeration shift.

cleanEnumerationShiftCache (line 254)

Clean enumeration shift cache.

Has to be used after PDF render operation to let followed updates be correct.

access: public

void cleanEnumerationShiftCache ()

Implementation of:

Zend_Pdf_ElementFactory_Interface::cleanEnumerationShiftCache(): Clean enumeration shift cache.

close (line 136)

Close factory and clean-up resources

access: public

void close ()

Implementation of:

Zend_Pdf_ElementFactory_Interface::close(): Close factory and clean-up resources

fetchObject (line 407)

Fetch object specified by reference

access: public

Zend_Pdf_Element_Object|null fetchObject (string $refString)

string $refString

getEnumerationShift (line 270)

Retrive object enumeration shift.

throws: Zend_Pdf_Exception
access: public

integer getEnumerationShift (Zend_Pdf_ElementFactory_Interface $factory)

Zend_Pdf_ElementFactory_Interface $factory

Implementation of:

Zend_Pdf_ElementFactory_Interface::getEnumerationShift(): Retrive object enumeration shift.

getId (line 163)

Get factory ID

access: public

integer getId ()

Implementation of:

Zend_Pdf_ElementFactory_Interface::getId(): Get factory ID

getObjectCount (line 183)

Get object counter

access: public

integer getObjectCount ()

Implementation of:

Zend_Pdf_ElementFactory_Interface::getObjectCount(): Get object counter

isModified (line 421)

Check if PDF file was modified

access: public

boolean isModified ()

Implementation of:

Zend_Pdf_ElementFactory_Interface::isModified(): Check if PDF file was modified

listModifiedObjects (line 355)

Enumerate modified objects.

Returns array of Zend_Pdf_UpdateInfoContainer

access: public

array listModifiedObjects ([Zend_Pdf_ElementFactory_Interface $rootFactory = null])

Zend_Pdf_ElementFactory_Interface $rootFactory

Implementation of:

Zend_Pdf_ElementFactory_Interface::listModifiedObjects(): Enumerate modified objects.

markAsModified (line 286)

Mark object as modified in context of current factory.

throws: Zend_Pdf_Exception
access: public

void markAsModified (Zend_Pdf_Element_Object $obj)

Zend_Pdf_Element_Object $obj

Implementation of:

Zend_Pdf_ElementFactory_Interface::markAsModified(): Mark object as modified in context of current factory.

newObject (line 323)

Generate new Zend_Pdf_Element_Object

todo: Reusage of the freed object. It's not a support of new feature, but only improvement.
access: public

Zend_Pdf_Element_Object newObject (Zend_Pdf_Element $objectValue)

Zend_Pdf_Element $objectValue

Implementation of:

Zend_Pdf_ElementFactory_Interface::newObject(): Generate new Zend_Pdf_Element_Object

newStreamObject (line 339)

Generate new Zend_Pdf_Element_Object_Stream

todo: Reusage of the freed object. It's not a support of new feature, but only improvement.
access: public

Zend_Pdf_Element_Object_Stream newStreamObject ( $streamValue, mixed $objectValue)

mixed $objectValue
$streamValue

Implementation of:

Zend_Pdf_ElementFactory_Interface::newStreamObject(): Generate new Zend_Pdf_Element_Object_Stream

registerObject (line 396)

It's used to clear "parent object" referencies when factory is closed and clean up resources

access: public

void registerObject (Zend_Pdf_Element_Object $obj, string $refString)

string $refString
Zend_Pdf_Element_Object $obj

remove (line 303)

Remove object in context of current factory.

throws: Zend_Pdf_Exception
access: public

void remove (Zend_Pdf_Element_Object $obj)

Zend_Pdf_Element_Object $obj

Implementation of:

Zend_Pdf_ElementFactory_Interface::remove(): Remove object in context of current factory.

resolve (line 153)

Get source factory object

access: public

Zend_Pdf_ElementFactory resolve ()

Implementation of:

Zend_Pdf_ElementFactory_Interface::resolve(): Get source factory object

setObjectCount (line 173)

Set object counter

access: public

void setObjectCount (integer $objCount)

integer $objCount

Implementation of:

Zend_Pdf_ElementFactory_Interface::setObjectCount(): Set object counter

Documentation generated on Mon, 21 Jun 2010 15:18:52 -0400 by phpDocumentor 1.4.3