Zend_Pdf_ElementFactory_Proxy Class Reference

Inheritance diagram for Zend_Pdf_ElementFactory_Proxy:

Public Member Functions
	__construct (Zend_Pdf_ElementFactory_Interface $factory)
	__destruct ()
	getFactory ()
	close ()
	resolve ()
	getId ()
	setObjectCount ($objCount)
	getObjectCount ()
	attach (Zend_Pdf_ElementFactory_Interface $factory)
	calculateShift (Zend_Pdf_ElementFactory_Interface $factory)
	cleanEnumerationShiftCache ()
	getEnumerationShift (Zend_Pdf_ElementFactory_Interface $factory)
	markAsModified (Zend_Pdf_Element_Object $obj)
	remove (Zend_Pdf_Element_Object $obj)
	newObject (Zend_Pdf_Element $objectValue)
	newStreamObject ($streamValue)
	listModifiedObjects ($rootFactory=null)
	isModified ()

Detailed Description

Definition at line 33 of file Proxy.php.

Constructor & Destructor Documentation

__construct()

__construct

(

Zend_Pdf_ElementFactory_Interface

$factory

)

Object constructor

Parameters

Zend_Pdf_ElementFactory_Interface

$factory

Definition at line 48 of file Proxy.php.

    {
        $this->_factory = $factory;
    }

__destruct()

__destruct

(

)

Definition at line 53 of file Proxy.php.

    {
        $this->_factory->close();
        $this->_factory = null;
    }

Member Function Documentation

attach()

attach

(

Zend_Pdf_ElementFactory_Interface

$factory

)

Attach factory to the current;

Parameters

Zend_Pdf_ElementFactory_Interface

$factory

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 124 of file Proxy.php.

    {
        $this->_factory->attach($factory);
    }

calculateShift()

calculateShift

(

Zend_Pdf_ElementFactory_Interface

$factory

)

Calculate object enumeration shift.

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 136 of file Proxy.php.

    {
        return $this->_factory->calculateShift($factory);
    }

cleanEnumerationShiftCache()

cleanEnumerationShiftCache

(

)

Clean enumeration shift cache. Has to be used after PDF render operation to let followed updates be correct.

Parameters

Zend_Pdf_ElementFactory_Interface

$factory

Returns

integer

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 148 of file Proxy.php.

    {
        return $this->_factory->cleanEnumerationShiftCache();
    }

close()

close

(

)

Close factory and clean-up resources

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 74 of file Proxy.php.

    {
        // Do nothing
    }

getEnumerationShift()

getEnumerationShift

(

Zend_Pdf_ElementFactory_Interface

$factory

)

Retrive object enumeration shift.

Parameters

Zend_Pdf_ElementFactory_Interface

$factory

Returns

integer

Exceptions

Zend_Pdf_Exception

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 160 of file Proxy.php.

    {
        return $this->_factory->getEnumerationShift($factory);
    }

getFactory()

getFactory

(

)

Get factory

Returns

Zend_Pdf_ElementFactory_Interface

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 64 of file Proxy.php.

    {
        return $this->_factory->getFactory();
    }

getId()

getId

(

)

Get factory ID

Returns

integer

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 94 of file Proxy.php.

    {
        return $this->_factory->getId();
    }

getObjectCount()

getObjectCount

(

)

Get object counter

Returns

integer

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 114 of file Proxy.php.

    {
        return $this->_factory->getObjectCount();
    }

isModified()

isModified

(

)

Check if PDF file was modified

Returns

boolean

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 230 of file Proxy.php.

    {
        return $this->_factory->isModified();
    }

listModifiedObjects()

listModifiedObjects

(

$rootFactory = null

)

Enumerate modified objects. Returns array of Zend_Pdf_UpdateInfoContainer

Parameters

Zend_Pdf_ElementFactory

$rootFactory

Returns

array

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 220 of file Proxy.php.

    {
        return $this->_factory->listModifiedObjects($rootFactory);
    }

markAsModified()

markAsModified

(

Zend_Pdf_Element_Object

$obj

)

Mark object as modified in context of current factory.

Parameters

Zend_Pdf_Element_Object

$obj

Exceptions

Zend_Pdf_Exception

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 171 of file Proxy.php.

    {
        $this->_factory->markAsModified($obj);
    }

newObject()

newObject

(

Zend_Pdf_Element

$objectValue

)

Generate new Zend_Pdf_Element_Object

Todo:

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

Parameters

Zend_Pdf_Element

$objectValue

Returns

Zend_Pdf_Element_Object

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 195 of file Proxy.php.

    {
        return $this->_factory->newObject($objectValue);
    }

newStreamObject()

newStreamObject

(

$streamValue

)

Generate new Zend_Pdf_Element_Object_Stream

Todo:

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

Parameters

mixed

$objectValue

Returns

Zend_Pdf_Element_Object_Stream

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 208 of file Proxy.php.

    {
        return $this->_factory->newStreamObject($streamValue);
    }

remove()

remove

(

Zend_Pdf_Element_Object

$obj

)

Remove object in context of current factory.

Parameters

Zend_Pdf_Element_Object

$obj

Exceptions

Zend_Pdf_Exception

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 182 of file Proxy.php.

    {
        $this->_factory->remove($obj);
    }

resolve()

resolve

(

)

Get source factory object

Returns

Zend_Pdf_ElementFactory

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 84 of file Proxy.php.

    {
        return $this->_factory->resolve();
    }

setObjectCount()

setObjectCount

(

$objCount

)

Set object counter

Parameters

integer

$objCount

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 104 of file Proxy.php.

    {
        $this->_factory->setObjectCount($objCount);
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Pdf/ElementFactory/Proxy.php