Pdf/ElementFactory.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Pdf
version: $Id: ElementFactory.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Pdf_ElementFactory

Description

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.

Zend_Pdf_ElementFactory
jump to top

Implements: Zend_Pdf_ElementFactory_Interface
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Pdf
Properties: $_modifiedObjects; $_removedObjects; $_registeredObjects; $_objectCount; $_attachedFactories; $_factoryId; $_identity; $_shiftCalculationCache
Methods: __construct; createFactory; close; resolve; getId; setObjectCount; getObjectCount; attach; calculateShift; cleanEnumerationShiftCache; getEnumerationShift; markAsModified; remove; newObject; newStreamObject; listModifiedObjects; registerObject; fetchObject; isModified

Description

PDF element factory.

Responsibility is to log PDF changes

Properties

$_attachedFactories
jump to class

array $_attachedFactories = 'array'

List of the attached object factories.

Array of Zend_Pdf_ElementFactory_Interface objects

Details

$_attachedFactories: array
visibility: private
default: array
final: false
static: false

$_factoryId
jump to class

integer $_factoryId = ''

Factory internal id

Details

$_factoryId: integer
visibility: private
default
final: false
static: false

$_identity
jump to class

integer $_identity = '0'

Identity, used for factory id generation

Details

$_identity: integer
visibility: private
default: 0
final: false
static: true

$_modifiedObjects
jump to class

array $_modifiedObjects = 'array'

List of the modified objects.

Also contains new and removed objects

Array: ojbectNumber => Zend_Pdf_Element_Object

Details

$_modifiedObjects: array
visibility: private
default: array
final: false
static: false

$_objectCount
jump to class

integer $_objectCount = ''

PDF object counter.

Actually it's an object number for new PDF object

Details

$_objectCount: integer
visibility: private
default
final: false
static: false

$_registeredObjects
jump to class

array $_registeredObjects = 'array'

List of registered objects.

Used for resources clean up when factory is destroyed.

Array of Zend_Pdf_Element objects

Details

$_registeredObjects: array
visibility: private
default: array
final: false
static: false

$_removedObjects
jump to class

SplObjectStorage $_removedObjects = ''

List of the removed objects

Array: ojbectNumber => Zend_Pdf_Element_Object

Details

$_removedObjects: SplObjectStorage
visibility: private
default
final: false
static: false

$_shiftCalculationCache
jump to class

array $_shiftCalculationCache = 'array'

Internal cache to save calculated shifts

Details

$_shiftCalculationCache: array
visibility: private
default: array
final: false
static: false

Methods

__construct
jump to class

__construct(
          integer $objCount
          )
        
        :

Object constructor

Arguments

$objCount: integer

Details

visibility: public
final: false
static: false

attach
jump to class

attach(
          Zend_Pdf_ElementFactory_Interface $factory
          )
        
        :

Attach factory to the current;

Arguments

$factory: Zend_Pdf_ElementFactory_Interface

Details

visibility: public
final: false
static: false

calculateShift
jump to class

calculateShift(
          Zend_Pdf_ElementFactory_Interface $factory
          )
        
        :
        integer

Calculate object enumeration shift.

Arguments

$factory: Zend_Pdf_ElementFactory_Interface

Output

integer

Details

visibility: public
final: false
static: false

cleanEnumerationShiftCache
jump to class

cleanEnumerationShiftCache(
          
          )
        
        :

Clean enumeration shift cache.

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

Details

visibility: public
final: false
static: false

close
jump to class

Close factory and clean-up resources

Details

visibility: public
final: false
static: false
internal

createFactory
jump to class

createFactory(
          integer $objCount
          )
        
        :
        Zend_Pdf_ElementFactory_Interface

Factory generator

Arguments

$objCount: integer

Output

Zend_Pdf_ElementFactory_Interface

Details

visibility: public
final: false
static: true

fetchObject
jump to class

fetchObject(
          string $refString
          )
        
        :
        Zend_Pdf_Element_Object|null

Fetch object specified by reference

Arguments

$refString: string

Output

Zend_Pdf_Element_Object|null

Details

visibility: public
final: false
static: false

getEnumerationShift
jump to class

getEnumerationShift(
          Zend_Pdf_ElementFactory_Interface $factory
          )
        
        :
        integer

Retrive object enumeration shift.

Arguments

$factory: Zend_Pdf_ElementFactory_Interface

Output

integer

Details

visibility: public
final: false
static: false
throws

getId
jump to class

getId(
          
          )
        
        :
        integer

Get factory ID

Output

integer

Details

visibility: public
final: false
static: false

getObjectCount
jump to class

getObjectCount(
          
          )
        
        :
        integer

Get object counter

Output

integer

Details

visibility: public
final: false
static: false

isModified
jump to class

isModified(
          
          )
        
        :
        boolean

Check if PDF file was modified

Output

boolean

Details

visibility: public
final: false
static: false

listModifiedObjects
jump to class

listModifiedObjects(
          Zend_Pdf_ElementFactory_Interface $rootFactory
              =
              null
          )
        
        :
        array

Enumerate modified objects.

Returns array of Zend_Pdf_UpdateInfoContainer

Arguments

$rootFactory: Zend_Pdf_ElementFactory_Interface

Output

array

Details

visibility: public
final: false
static: false

markAsModified
jump to class

markAsModified(
          Zend_Pdf_Element_Object $obj
          )
        
        :

Mark object as modified in context of current factory.

Arguments

$obj: Zend_Pdf_Element_Object

Details

visibility: public
final: false
static: false
throws

newObject
jump to class

newObject(
          Zend_Pdf_Element $objectValue
          )
        
        :
        Zend_Pdf_Element_Object

Generate new Zend_Pdf_Element_Object

Arguments

$objectValue: Zend_Pdf_Element

Output

Zend_Pdf_Element_Object

Details

visibility: public
final: false
static: false
todo: Reusage of the freed object. It's not a support of new feature, but only improvement.

newStreamObject
jump to class

newStreamObject(
           $streamValue
          )
        
        :
        Zend_Pdf_Element_Object_Stream

Generate new Zend_Pdf_Element_Object_Stream

Arguments

$streamValue

Output

Zend_Pdf_Element_Object_Stream

Details

visibility: public
final: false
static: false
todo: Reusage of the freed object. It's not a support of new feature, but only improvement.

registerObject
jump to class

registerObject(
          Zend_Pdf_Element_Object $obj, string $refString
          )
        
        :

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

Arguments

$obj: Zend_Pdf_Element_Object
$refString: string

Details

visibility: public
final: false
static: false

remove
jump to class

remove(
          Zend_Pdf_Element_Object $obj
          )
        
        :

Remove object in context of current factory.

Arguments

$obj: Zend_Pdf_Element_Object

Details

visibility: public
final: false
static: false
throws

resolve
jump to class

resolve(
          
          )
        
        :
        Zend_Pdf_ElementFactory

Get source factory object

Output

Zend_Pdf_ElementFactory

Details

visibility: public
final: false
static: false

setObjectCount
jump to class

setObjectCount(
          integer $objCount
          )
        
        :

Set object counter

Arguments

$objCount: integer

Details

visibility: public
final: false
static: false

API Documentation

Pdf/ElementFactory.php

Description

Zend_Pdf_ElementFactoryjump to top

Description

Properties

$_attachedFactoriesjump to class

Details

$_factoryIdjump to class

Details

$_identityjump to class

Details

$_modifiedObjectsjump to class

Details

$_objectCountjump to class

Details

$_registeredObjectsjump to class

Details

$_removedObjectsjump to class

Details

$_shiftCalculationCachejump to class

Details

Methods

__constructjump to class

Arguments

Details

attachjump to class

Arguments

Details

calculateShiftjump to class

Arguments

Output

Details

cleanEnumerationShiftCachejump to class

Details

closejump to class

Details

createFactoryjump to class

Arguments

Output

Details

fetchObjectjump to class

Arguments

Output

Details

getEnumerationShiftjump to class

Arguments

Output

Details

getIdjump to class

Output

Details

getObjectCountjump to class

Output

Details

isModifiedjump to class

Output

Details

listModifiedObjectsjump to class

Arguments

Output

Details

markAsModifiedjump to class

Arguments

Details

newObjectjump to class

Arguments

Output

Details

newStreamObjectjump to class

Arguments

Output

Details

registerObjectjump to class

Arguments

Details

removejump to class

Arguments

Details

resolvejump to class

Zend_Pdf_ElementFactory
jump to top

$_attachedFactories
jump to class

$_factoryId
jump to class

$_identity
jump to class

$_modifiedObjects
jump to class

$_objectCount
jump to class

$_registeredObjects
jump to class

$_removedObjects
jump to class

$_shiftCalculationCache
jump to class

__construct
jump to class

attach
jump to class

calculateShift
jump to class

cleanEnumerationShiftCache
jump to class

close
jump to class

createFactory
jump to class

fetchObject
jump to class

getEnumerationShift
jump to class

getId
jump to class

getObjectCount
jump to class

isModified
jump to class

listModifiedObjects
jump to class

markAsModified
jump to class

newObject
jump to class

newStreamObject
jump to class

registerObject
jump to class

remove
jump to class

resolve
jump to class

setObjectCount
jump to class