Zend_Pdf_Element_Reference_Table Class Reference

Public Member Functions
	__construct ()
	addReference ($ref, $offset, $inuse=true)
	setParent (self $parent)
	getOffset ($ref)
	getNextFree ($ref)
	getNewGeneration ($objNum)

Detailed Description

Definition at line 31 of file Table.php.

Constructor & Destructor Documentation

__construct()

__construct

(

)

Object constructor

Definition at line 77 of file Table.php.

    {
        $this->_parent = null;
        $this->_free   = array();  $this->_generations = array();
        $this->_inuse  = array();  $this->_usedObjects = array();
    }

Member Function Documentation

addReference()

addReference	(		$ref,
			$offset,
			$inuse = true
	)

Add reference to the reference table

Parameters

string	$ref
integer	$offset
boolean	$inuse

Definition at line 92 of file Table.php.

    {
        $refElements = explode(' ', $ref);
        if (!is_numeric($refElements[0]) || !is_numeric($refElements[1]) || $refElements[2] != 'R') {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception("Incorrect reference: '$ref'");
        }
        $objNum = (int)$refElements[0];
        $genNum = (int)$refElements[1];

        if ($inuse) {
            $this->_inuse[$ref]          = $offset;
            $this->_usedObjects[$objNum] = $objNum;
        } else {
            $this->_free[$ref]           = $offset;
            $this->_generations[$objNum] = $genNum;
        }
    }

getNewGeneration()

getNewGeneration

(

$objNum

)

Get next generation number for free object

Parameters

integer

$objNum

Returns

unknown

Definition at line 180 of file Table.php.

    {
        if (isset($this->_usedObjects[$objNum])) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Object is not free');
        }

        if (isset($this->_generations[$objNum])) {
            return $this->_generations[$objNum];
        }

        if (isset($this->_parent)) {
            return $this->_parent->getNewGeneration($objNum);
        }

        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception('Object not found.');
    }

getNextFree()

getNextFree

(

$ref

)

Get next object from a list of free objects.

Parameters

string

$ref

Returns

integer

Exceptions

Zend_Pdf_Exception

Definition at line 154 of file Table.php.

    {
        if (isset($this->_inuse[$ref])) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Object is not free');
        }

        if (isset($this->_free[$ref])) {
            return $this->_free[$ref];
        }

        if (isset($this->_parent)) {
            return $this->_parent->getNextFree($ref);
        }

        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception('Object not found.');
    }

getOffset()

getOffset

(

$ref

)

Get object offset

Parameters

string

$ref

Returns

integer

Definition at line 129 of file Table.php.

    {
        if (isset($this->_inuse[$ref])) {
            return $this->_inuse[$ref];
        }

        if (isset($this->_free[$ref])) {
            return null;
        }

        if (isset($this->_parent)) {
            return $this->_parent->getOffset($ref);
        }

        return null;
    }

setParent()

setParent

(

self

$parent

)

Set parent reference table

Parameters

Zend_Pdf_Element_Reference_Table

$parent

Definition at line 117 of file Table.php.

    {
        $this->_parent = $parent;
    }

---

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

• vendor/magento/zendframework1/library/Zend/Pdf/Element/Reference/Table.php