PDF element factory interface.

Responsibility is to log PDF changes

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

 Methods

Object constructor

__construct(\Zend_Pdf_ElementFactory_Interface $factory) 

Parameters

$factory

\Zend_Pdf_ElementFactory_Interface

__destruct()

__destruct() 

Attach factory to the current;

attach(\Zend_Pdf_ElementFactory_Interface $factory) 
inherited_from \Zend_Pdf_ElementFactory_Interface::attach()

Parameters

$factory

\Zend_Pdf_ElementFactory_Interface

Clean enumeration shift cache.

cleanEnumerationShiftCache() : integer

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

inherited_from \Zend_Pdf_ElementFactory_Interface::cleanEnumerationShiftCache()

Returns

integer

Retrive object enumeration shift.

getEnumerationShift(\Zend_Pdf_ElementFactory_Interface $factory) : integer
inherited_from \Zend_Pdf_ElementFactory_Interface::getEnumerationShift()

Parameters

$factory

\Zend_Pdf_ElementFactory_Interface

Exceptions

\Zend_Pdf_Exception

Returns

integer

Get factory

getFactory() : \Zend_Pdf_ElementFactory_Interface
inherited_from \Zend_Pdf_ElementFactory_Interface::getFactory()

Returns

\Zend_Pdf_ElementFactory_Interface

Get factory ID

getId() : integer
inherited_from \Zend_Pdf_ElementFactory_Interface::getId()

Returns

integer

Get object counter

getObjectCount() : integer
inherited_from \Zend_Pdf_ElementFactory_Interface::getObjectCount()

Returns

integer

Check if PDF file was modified

isModified() : boolean
inherited_from \Zend_Pdf_ElementFactory_Interface::isModified()

Returns

boolean

Enumerate modified objects.

listModifiedObjects(\Zend_Pdf_ElementFactory $rootFactory = null) : array

Returns array of Zend_Pdf_UpdateInfoContainer

inherited_from \Zend_Pdf_ElementFactory_Interface::listModifiedObjects()

Parameters

$rootFactory

\Zend_Pdf_ElementFactory

Returns

array

Mark object as modified in context of current factory.

markAsModified(\Zend_Pdf_Element_Object $obj) 
inherited_from \Zend_Pdf_ElementFactory_Interface::markAsModified()

Parameters

$obj

\Zend_Pdf_Element_Object

Exceptions

\Zend_Pdf_Exception

Generate new Zend_Pdf_Element_Object

newObject(\Zend_Pdf_Element $objectValue) : \Zend_Pdf_Element_Object
todo Reusage of the freed object. It's not a support of new feature, but only improvement.
inherited_from \Zend_Pdf_ElementFactory_Interface::newObject()

Parameters

$objectValue

\Zend_Pdf_Element

Returns

\Zend_Pdf_Element_Object

Generate new Zend_Pdf_Element_Object_Stream

newStreamObject($streamValue) : \Zend_Pdf_Element_Object_Stream
todo Reusage of the freed object. It's not a support of new feature, but only improvement.
inherited_from \Zend_Pdf_ElementFactory_Interface::newStreamObject()

Parameters

$streamValue

Returns

\Zend_Pdf_Element_Object_Stream

Remove object in context of current factory.

remove(\Zend_Pdf_Element_Object $obj) 
inherited_from \Zend_Pdf_ElementFactory_Interface::remove()

Parameters

$obj

\Zend_Pdf_Element_Object

Exceptions

\Zend_Pdf_Exception

Get source factory object

resolve() : \Zend_Pdf_ElementFactory
inherited_from \Zend_Pdf_ElementFactory_Interface::resolve()

Returns

\Zend_Pdf_ElementFactory

Set object counter

setObjectCount(integer $objCount) 
inherited_from \Zend_Pdf_ElementFactory_Interface::setObjectCount()

Parameters

$objCount

integer

 Properties

 

Factory object

$_factory : \Zend_Pdf_ElementFactory_Interface

Default