Pdf/ElementFactory/Proxy.php
Show:
inherited
inherited
Classes
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Pdf
- Version
- $Id$
\Zend_Pdf_ElementFactory_Proxy
Package: Zend_Pdf
Returns
PDF element factory interface.
Responsibility is to log PDF changes
- Implements
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
__construct(\Zend_Pdf_ElementFactory_Interface $factory) : voidObject constructor
Parameters
| Name | Type | Description |
|---|---|---|
| $factory | \Zend_Pdf_ElementFactory_Interface |
__destruct() : voidattach(\Zend_Pdf_ElementFactory_Interface $factory) : voidAttach factory to the current;
Parameters
| Name | Type | Description |
|---|---|---|
| $factory | \Zend_Pdf_ElementFactory_Interface |
cleanEnumerationShiftCache() : integerClean enumeration shift cache.
Has to be used after PDF render operation to let followed updates be correct.
Returns| Type | Description |
|---|---|
| integer |
getEnumerationShift(\Zend_Pdf_ElementFactory_Interface $factory) : integerRetrive object enumeration shift.
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $factory | \Zend_Pdf_ElementFactory_Interface |
| Type | Description |
|---|---|
| integer |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
getFactory() : \Zend_Pdf_ElementFactory_InterfaceGet factory
Returns
| Type | Description |
|---|---|
| \Zend_Pdf_ElementFactory_Interface |
getId() : integerGet factory ID
Returns
| Type | Description |
|---|---|
| integer |
getObjectCount() : integerGet object counter
Returns
| Type | Description |
|---|---|
| integer |
isModified() : booleanCheck if PDF file was modified
Returns
| Type | Description |
|---|---|
| boolean |
listModifiedObjects(\Zend_Pdf_ElementFactory $rootFactory = null) : arrayEnumerate modified objects.
Returns array of Zend_Pdf_UpdateInfoContainer
Parameters| Name | Type | Description |
|---|---|---|
| $rootFactory | \Zend_Pdf_ElementFactory |
| Type | Description |
|---|---|
| array |
markAsModified(\Zend_Pdf_Element_Object $obj) : voidMark object as modified in context of current factory.
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $obj | \Zend_Pdf_Element_Object |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
newObject(\Zend_Pdf_Element $objectValue) : \Zend_Pdf_Element_ObjectGenerate new Zend_Pdf_Element_Object
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $objectValue | \Zend_Pdf_Element |
| Type | Description |
|---|---|
| \Zend_Pdf_Element_Object |
- Todo
- Reusage of the freed object. It's not a support of new feature, but only improvement.
newStreamObject( $streamValue) : \Zend_Pdf_Element_Object_StreamGenerate new Zend_Pdf_Element_Object_Stream
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $streamValue |
| Type | Description |
|---|---|
| \Zend_Pdf_Element_Object_Stream |
- Todo
- Reusage of the freed object. It's not a support of new feature, but only improvement.
remove(\Zend_Pdf_Element_Object $obj) : voidRemove object in context of current factory.
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $obj | \Zend_Pdf_Element_Object |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
resolve() : \Zend_Pdf_ElementFactoryGet source factory object
Returns
| Type | Description |
|---|---|
| \Zend_Pdf_ElementFactory |
setObjectCount(integer $objCount) : voidSet object counter
Parameters
| Name | Type | Description |
|---|---|---|
| $objCount | integer |