Pdf/ElementFactory/Interface.php

Show:

inherited

Table of Contents

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_Interface
jump to top

Package: Zend_Pdf

PDF element factory interface.

Responsibility is to log PDF changes

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

Methods

attach(\Zend_Pdf_ElementFactory_Interface $factory) : void

Attach factory to the current;

Parameters

Name	Type	Description
$factory	\Zend_Pdf_ElementFactory_Interface

calculateShift(\Zend_Pdf_ElementFactory_Interface $factory) : integer

Calculate object enumeration shift.

Parameters

Name	Type	Description
$factory	\Zend_Pdf_ElementFactory_Interface

Returns

Type	Description
integer

cleanEnumerationShiftCache() : integer

Clean 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) : integer

Retrive object enumeration shift.

Parameters

Name	Type	Description
$factory	\Zend_Pdf_ElementFactory_Interface

Returns

Type	Description
integer

Throws

Exception	Description
\Zend_Pdf_Exception

getFactory() : \Zend_Pdf_ElementFactory_Interface

Get factory

Returns

Type	Description
\Zend_Pdf_ElementFactory_Interface

getId() : integer

Get factory ID

Returns

Type	Description
integer

getObjectCount() : integer

Get object counter

Returns

Type	Description
integer

isModified() : boolean

Check if PDF file was modified

Returns

Type	Description
boolean

listModifiedObjects(\Zend_Pdf_ElementFactory $rootFactory = null) : array

Enumerate modified objects.

Returns array of Zend_Pdf_UpdateInfoContainer

Parameters

Name	Type	Description
$rootFactory	\Zend_Pdf_ElementFactory

Returns

Type	Description
array

markAsModified(\Zend_Pdf_Element_Object $obj) : void

Mark object as modified in context of current factory.

Parameters

Name	Type	Description
$obj	\Zend_Pdf_Element_Object

Throws

Exception	Description
\Zend_Pdf_Exception

newObject(\Zend_Pdf_Element $objectValue) : \Zend_Pdf_Element_Object

Generate new Zend_Pdf_Element_Object

Parameters

Name	Type	Description
$objectValue	\Zend_Pdf_Element

Returns

Type	Description
\Zend_Pdf_Element_Object

Details

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

newStreamObject( $streamValue) : \Zend_Pdf_Element_Object_Stream

Generate new Zend_Pdf_Element_Object_Stream

Parameters

Name	Type	Description
$streamValue

Returns

Type	Description
\Zend_Pdf_Element_Object_Stream

Details

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

remove(\Zend_Pdf_Element_Object $obj) : void

Remove object in context of current factory.

Parameters

Name	Type	Description
$obj	\Zend_Pdf_Element_Object

Throws

Exception	Description
\Zend_Pdf_Exception

resolve() : \Zend_Pdf_ElementFactory

Get source factory object

Returns

Type	Description
\Zend_Pdf_ElementFactory

setObjectCount(integer $objCount) : void

Set object counter

Parameters

Name	Type	Description
$objCount	integer

Pdf/ElementFactory/Interface.php

\Zend_Pdf_ElementFactory_Interfacejump to top

Methods

\Zend_Pdf_ElementFactory_Interface
jump to top