PDF element factory.
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(integer $objCount)
Parameters
$objCount
integer
Attach factory to the current;
attach(\Zend_Pdf_ElementFactory_Interface $factory)
| inherited_from |
\Zend_Pdf_ElementFactory_Interface::attach() |
Parameters
$factory
\Zend_Pdf_ElementFactory_Interface
Calculate object enumeration shift.
calculateShift(\Zend_Pdf_ElementFactory_Interface $factory) : integer
| inherited_from |
\Zend_Pdf_ElementFactory_Interface::calculateShift() |
Parameters
$factory
\Zend_Pdf_ElementFactory_Interface
Returns
integer
Clean enumeration shift cache.
cleanEnumerationShiftCache()
Has to be used after PDF render operation to let followed updates be correct.
| inherited_from |
\Zend_Pdf_ElementFactory_Interface::cleanEnumerationShiftCache() |
Factory generator
createFactory(integer $objCount) : \Zend_Pdf_ElementFactory_Interface
Static
Parameters
$objCount
integer
Returns
\Zend_Pdf_ElementFactory_Interface
Fetch object specified by reference
fetchObject(string $refString) : \Zend_Pdf_Element_Object | null
Parameters
$refString
string
Returns
\Zend_Pdf_Element_Objectnull
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
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_Interface $rootFactory = null) : array
Returns array of Zend_Pdf_UpdateInfoContainer
| inherited_from |
\Zend_Pdf_ElementFactory_Interface::listModifiedObjects() |
Parameters
$rootFactory
\Zend_Pdf_ElementFactory_Interface
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
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
Register object in the factory
registerObject(\Zend_Pdf_Element_Object $obj, string $refString)
It's used to clear "parent object" referencies when factory is closed and clean up resources
Parameters
$obj
\Zend_Pdf_Element_Object
$refString
string
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
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
List of the attached object factories.
$_attachedFactories : array
Array of Zend_Pdf_ElementFactory_Interface objects
Factory internal id
$_factoryId : integer
Identity, used for factory id generation
$_identity : integer
Static
List of the modified objects.
$_modifiedObjects : array
Also contains new and removed objects
Array: ojbectNumber => Zend_Pdf_Element_Object
PDF object counter.
$_objectCount : integer
Actually it's an object number for new PDF object
List of registered objects.
$_registeredObjects : array
Used for resources clean up when factory is destroyed.
Array of Zend_Pdf_Element objects
List of the removed objects
$_removedObjects : \SplObjectStorage
Array: ojbectNumber => Zend_Pdf_Element_Object
Internal cache to save calculated shifts
$_shiftCalculationCache : array