Zend_Pdf_ElementFactory Class Reference

Inheritance diagram for Zend_Pdf_ElementFactory:

Public Member Functions
	__construct ($objCount)
	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)
	registerObject (Zend_Pdf_Element_Object $obj, $refString)
	fetchObject ($refString)
	isModified ()

Static Public Member Functions
static	createFactory ($objCount)

Detailed Description

Definition at line 34 of file ElementFactory.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$objCount

)

Object constructor

Parameters

integer

$objCount

Definition at line 111 of file ElementFactory.php.

    {
        $this->_objectCount    = (int)$objCount;
        $this->_factoryId      = self::$_identity++;
        $this->_removedObjects = new SplObjectStorage();
    }

Member Function Documentation

attach()

attach

(

Zend_Pdf_ElementFactory_Interface

$factory

)

Attach factory to the current;

Parameters

Zend_Pdf_ElementFactory_Interface

$factory

Don't attach factory twice. We do not check recusively because of nature of attach operation (Pages are always attached to the Documents, Fonts are always attached to the pages even if pages already use Document level object factory and so on)

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 210 of file ElementFactory.php.

    {
        if ( $factory === $this || isset($this->_attachedFactories[$factory->getId()])) {
            return;
        }

        $this->_attachedFactories[$factory->getId()] = $factory;
    }

calculateShift()

calculateShift

(

Zend_Pdf_ElementFactory_Interface

$factory

)

Calculate object enumeration shift.

Parameters

Zend_Pdf_ElementFactory_Interface

$factory

Returns

integer

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 232 of file ElementFactory.php.

    {
        if ($factory === $this) {
            return 0;
        }

        if (isset($this->_shiftCalculationCache[$factory->_factoryId])) {
            return $this->_shiftCalculationCache[$factory->_factoryId];
        }

        $shift = $this->_objectCount - 1;

        foreach ($this->_attachedFactories as $subFactory) {
            $subFactoryShift = $subFactory->calculateShift($factory);

            if ($subFactoryShift != -1) {
                // context found
                $this->_shiftCalculationCache[$factory->_factoryId] = $shift + $subFactoryShift;
                return $shift + $subFactoryShift;
            } else {
                $shift += $subFactory->getObjectCount()-1;
            }
        }

        $this->_shiftCalculationCache[$factory->_factoryId] = -1;
        return -1;
    }

cleanEnumerationShiftCache()

cleanEnumerationShiftCache

(

)

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

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 264 of file ElementFactory.php.

    {
        $this->_shiftCalculationCache = array();

        foreach ($this->_attachedFactories as $attached) {
            $attached->cleanEnumerationShiftCache();
        }
    }

close()

close

(

)

Close factory and clean-up resources

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 146 of file ElementFactory.php.

    {
        $this->_modifiedObjects   = null;
        $this->_removedObjects    = null;
        $this->_attachedFactories = null;

        foreach ($this->_registeredObjects as $obj) {
            $obj->cleanUp();
        }
        $this->_registeredObjects = null;
    }

createFactory()

static createFactory (   $objCount )

static

Factory generator

Parameters

integer

$objCount

Returns

Zend_Pdf_ElementFactory_Interface

Definition at line 135 of file ElementFactory.php.

    {
        #require_once 'Zend/Pdf/ElementFactory/Proxy.php';
        return new Zend_Pdf_ElementFactory_Proxy(new Zend_Pdf_ElementFactory($objCount));
    }

fetchObject()

fetchObject

(

$refString

)

Fetch object specified by reference

Parameters

string

$refString

Returns

Zend_Pdf_Element_Object|null

Definition at line 417 of file ElementFactory.php.

    {
        if (!isset($this->_registeredObjects[$refString])) {
            return null;
        }
        return $this->_registeredObjects[$refString];
    }

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 280 of file ElementFactory.php.

    {
        if (($shift = $this->calculateShift($factory)) == -1) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Wrong object context');
        }

        return $shift;
    }

getFactory()

getFactory

(

)

Get factory

Returns

Zend_Pdf_ElementFactory_Interface

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 124 of file ElementFactory.php.

    {
        return $this;
    }

getId()

getId

(

)

Get factory ID

Returns

integer

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 173 of file ElementFactory.php.

    {
        return $this->_factoryId;
    }

getObjectCount()

getObjectCount

(

)

Get object counter

Returns

integer

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 193 of file ElementFactory.php.

    {
        $count = $this->_objectCount;

        foreach ($this->_attachedFactories as $attached) {
            $count += $attached->getObjectCount() - 1; // -1 as "0" object is a special case and shared between factories
        }

        return $count;
    }

isModified()

isModified

(

)

Check if PDF file was modified

Returns

boolean

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 431 of file ElementFactory.php.

    {
        if (count($this->_modifiedObjects) != 0) {
            return true;
        }

        foreach ($this->_attachedFactories as $subFactory) {
            if ($subFactory->isModified()) {
                return true;
            }
        }

        return false;
    }

listModifiedObjects()

listModifiedObjects

(

$rootFactory = null

)

Enumerate modified objects. Returns array of Zend_Pdf_UpdateInfoContainer

Parameters

Zend_Pdf_ElementFactory_Interface

$rootFactory

Returns

array

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 365 of file ElementFactory.php.

    {
        if ($rootFactory == null) {
            $rootFactory = $this;
            $shift = 0;
        } else {
            $shift = $rootFactory->getEnumerationShift($this);
        }

        ksort($this->_modifiedObjects);

        $result = array();
        #require_once 'Zend/Pdf/UpdateInfoContainer.php';
        foreach ($this->_modifiedObjects as $objNum => $obj) {
            if ($this->_removedObjects->contains($obj)) {
                            $result[$objNum+$shift] = new Zend_Pdf_UpdateInfoContainer($objNum + $shift,
                                                                           $obj->getGenNum()+1,
                                                                           true);
            } else {
                $result[$objNum+$shift] = new Zend_Pdf_UpdateInfoContainer($objNum + $shift,
                                                                           $obj->getGenNum(),
                                                                           false,
                                                                           $obj->dump($rootFactory));
            }
        }

        foreach ($this->_attachedFactories as $factory) {
            $result += $factory->listModifiedObjects($rootFactory);
        }

        return $result;
    }

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 296 of file ElementFactory.php.

    {
        if ($obj->getFactory() !== $this) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Object is not generated by this factory');
        }

        $this->_modifiedObjects[$obj->getObjNum()] = $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 333 of file ElementFactory.php.

    {
        #require_once 'Zend/Pdf/Element/Object.php';
        $obj = new Zend_Pdf_Element_Object($objectValue, $this->_objectCount++, 0, $this);
        $this->_modifiedObjects[$obj->getObjNum()] = $obj;
        return $obj;
    }

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 349 of file ElementFactory.php.

    {
        #require_once 'Zend/Pdf/Element/Object/Stream.php';
        $obj = new Zend_Pdf_Element_Object_Stream($streamValue, $this->_objectCount++, 0, $this);
        $this->_modifiedObjects[$obj->getObjNum()] = $obj;
        return $obj;
    }

registerObject()

registerObject	(	Zend_Pdf_Element_Object	$obj,
			$refString
	)

Register object in the factory

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

Parameters

string	$refString
Zend_Pdf_Element_Object	$obj

Definition at line 406 of file ElementFactory.php.

    {
        $this->_registeredObjects[$refString] = $obj;
    }

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 313 of file ElementFactory.php.

    {
        if (!$obj->compareFactory($this)) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Object is not generated by this factory');
        }

        $this->_modifiedObjects[$obj->getObjNum()] = $obj;
        $this->_removedObjects->attach($obj);
    }

resolve()

resolve

(

)

Get source factory object

Returns

Zend_Pdf_ElementFactory

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 163 of file ElementFactory.php.

    {
        return $this;
    }

setObjectCount()

setObjectCount

(

$objCount

)

Set object counter

Parameters

integer

$objCount

Implements Zend_Pdf_ElementFactory_Interface.

Definition at line 183 of file ElementFactory.php.

    {
        $this->_objectCount = (int)$objCount;
    }

---

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

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