API Documentation

Pdf/ElementFactory/Interface.php

Interfaces
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: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
Interfaces
Zend_Pdf_ElementFactory_Interface

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

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
Methods
close
resolve
getId
setObjectCount
getObjectCount
attach
calculateShift
cleanEnumerationShiftCache
getEnumerationShift
markAsModified
remove
newObject
newStreamObject
listModifiedObjects
isModified

Description

PDF element factory interface.

Responsibility is to log PDF changes

Methods

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

Clean enumeration shift cache.

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

Output
integer
Details
visibility
public
final
false
static
false

close
jump to class

close( ) :

Close factory and clean-up resources

Details
visibility
public
final
false
static
false
internal

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 $rootFactory = null ) : array

Enumerate modified objects.

Returns array of Zend_Pdf_UpdateInfoContainer

Arguments
$rootFactory
Zend_Pdf_ElementFactory
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.

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
Documentation was generated by DocBlox.