Zend_Pdf_ElementFactory Class Reference

Public Member Functions
	__construct ($objCount)
	Object constructor.
	getFactory ()
	Get factory.
	close ()
	Close factory and clean-up resources.
	resolve ()
	Get source factory object.
	getId ()
	Get factory ID.
	setObjectCount ($objCount)
	Set object counter.
	getObjectCount ()
	Get object counter.
	attach (Zend_Pdf_ElementFactory_Interface $factory)
	Attach factory to the current;.
	calculateShift (Zend_Pdf_ElementFactory_Interface $factory)
	Calculate object enumeration shift.
	cleanEnumerationShiftCache ()
	Clean enumeration shift cache.
	getEnumerationShift (Zend_Pdf_ElementFactory_Interface $factory)
	Retrive object enumeration shift.
	markAsModified (Zend_Pdf_Element_Object $obj)
	Mark object as modified in context of current factory.
	remove (Zend_Pdf_Element_Object $obj)
	Remove object in context of current factory.
	newObject (Zend_Pdf_Element $objectValue)
	Generate new Zend_Pdf_Element_Object.
	newStreamObject ($streamValue)
	Generate new Zend_Pdf_Element_Object_Stream.
	listModifiedObjects ($rootFactory=null)
	Enumerate modified objects.
	registerObject (Zend_Pdf_Element_Object $obj, $refString)
	Register object in the factory.
	fetchObject ($refString)
	Fetch object specified by reference.
	isModified ()
	Check if PDF file was modified.

Static Public Member Functions
static	createFactory ($objCount)
	Factory generator.

Constructor & Destructor Documentation

__construct

(

$objCount

)

Object constructor.

Parameters

integer

$objCount

Member Function Documentation

attach

(

Zend_Pdf_ElementFactory_Interface

$factory

)

Attach factory to the current;.

Parameters

Zend_Pdf_ElementFactory_Interface

$factory

Don't attach factory twice. We do not check recusively because of nature of attach operation (Pages are always attached to the Documents, Fonts are always attached to the pages even if pages already use Document level object factory and so on)

Implements Zend_Pdf_ElementFactory_Interface.

calculateShift

(

Zend_Pdf_ElementFactory_Interface

$factory

)

Calculate object enumeration shift.

Parameters

Zend_Pdf_ElementFactory_Interface

$factory

Returns

integer

Implements Zend_Pdf_ElementFactory_Interface.

cleanEnumerationShiftCache

(

)

Clean enumeration shift cache.

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

Implements Zend_Pdf_ElementFactory_Interface.

close

(

)

Close factory and clean-up resources.

Implements Zend_Pdf_ElementFactory_Interface.

static createFactory (   $objCount )

static

Factory generator.

Parameters

integer

$objCount

Returns

Zend_Pdf_ElementFactory_Interface

fetchObject

(

$refString

)

Fetch object specified by reference.

Parameters

string

$refString

Returns

Zend_Pdf_Element_Object|null

getEnumerationShift

(

Zend_Pdf_ElementFactory_Interface

$factory

)

Retrive object enumeration shift.

Parameters

Zend_Pdf_ElementFactory_Interface

$factory

Returns

integer

Exceptions

Zend_Pdf_Exception

Implements Zend_Pdf_ElementFactory_Interface.

getFactory

(

)

Get factory.

Returns

Zend_Pdf_ElementFactory_Interface

Implements Zend_Pdf_ElementFactory_Interface.

getId

(

)

Get factory ID.

Returns

integer

Implements Zend_Pdf_ElementFactory_Interface.

getObjectCount

(

)

Get object counter.

Returns

integer

Implements Zend_Pdf_ElementFactory_Interface.

isModified

(

)

Check if PDF file was modified.

Returns

boolean

Implements Zend_Pdf_ElementFactory_Interface.

listModifiedObjects

(

$rootFactory = null

)

Enumerate modified objects.

Returns array of Zend_Pdf_UpdateInfoContainer

Parameters

Zend_Pdf_ElementFactory_Interface

$rootFactory

Returns

array

Implements Zend_Pdf_ElementFactory_Interface.

markAsModified

(

Zend_Pdf_Element_Object

$obj

)

Mark object as modified in context of current factory.

Parameters

Zend_Pdf_Element_Object

$obj

Exceptions

Zend_Pdf_Exception

Implements Zend_Pdf_ElementFactory_Interface.

newObject

(

Zend_Pdf_Element

$objectValue

)

Generate new Zend_Pdf_Element_Object.

Todo:

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

Parameters

Zend_Pdf_Element

$objectValue

Returns

Zend_Pdf_Element_Object

Implements Zend_Pdf_ElementFactory_Interface.

newStreamObject

(

$streamValue

)

Generate new Zend_Pdf_Element_Object_Stream.

Todo:

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

Parameters

mixed

$objectValue

Returns

Zend_Pdf_Element_Object_Stream

Implements Zend_Pdf_ElementFactory_Interface.

registerObject	(	Zend_Pdf_Element_Object	$obj,
			$refString
	)

Register object in the factory.

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

Parameters

string	$refString
Zend_Pdf_Element_Object	$obj

remove

(

Zend_Pdf_Element_Object

$obj

)

Remove object in context of current factory.

Parameters

Zend_Pdf_Element_Object

$obj

Exceptions

Zend_Pdf_Exception

Implements Zend_Pdf_ElementFactory_Interface.

resolve

(

)

Get source factory object.

Returns

Zend_Pdf_ElementFactory

Implements Zend_Pdf_ElementFactory_Interface.

setObjectCount

(

$objCount

)

Set object counter.

Parameters

integer

$objCount

Implements Zend_Pdf_ElementFactory_Interface.