API Documentation

Zend/Pdf/ElementFactory/Proxy.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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Pdf  
Version
$Id: Proxy.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Pdf_ElementFactory_Proxy

Package: Zend\Pdf

PDF element factory interface.

Responsibility is to log PDF changes

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

Properties

Propertyprivate\Zend_Pdf_ElementFactory_Interface  $_factory= ''

Factory object

Methods

methodpublic__construct( \Zend_Pdf_ElementFactory_Interface $factory ) : void

Object constructor

Parameters
Name Type Description
$factory \Zend_Pdf_ElementFactory_Interface
methodpublic__destruct( ) : void

methodpublicattach( \Zend_Pdf_ElementFactory_Interface $factory ) : void

Attach factory to the current;

Parameters
Name Type Description
$factory \Zend_Pdf_ElementFactory_Interface
methodpubliccleanEnumerationShiftCache( ) : integer

Clean enumeration shift cache.

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

Returns
Type Description
integer
methodpublicgetEnumerationShift( \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
methodpublicgetFactory( ) : \Zend_Pdf_ElementFactory_Interface

Get factory

Returns
Type Description
\Zend_Pdf_ElementFactory_Interface
methodpublicgetId( ) : integer

Get factory ID

Returns
Type Description
integer
methodpublicgetObjectCount( ) : integer

Get object counter

Returns
Type Description
integer
methodpublicisModified( ) : boolean

Check if PDF file was modified

Returns
Type Description
boolean
methodpubliclistModifiedObjects( \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
methodpublicmarkAsModified( \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
methodpublicnewObject( \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.  
methodpublicnewStreamObject(  $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.  
methodpublicremove( \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
methodpublicresolve( ) : \Zend_Pdf_ElementFactory

Get source factory object

Returns
Type Description
\Zend_Pdf_ElementFactory
methodpublicsetObjectCount( integer $objCount ) : void

Set object counter

Parameters
Name Type Description
$objCount integer
Documentation was generated by DocBlox 0.15.1.