Zend_Pdf_Element_Reference Class Reference

Inheritance diagram for Zend_Pdf_Element_Reference:

Public Member Functions
	__construct ($objNum, $genNum=0, Zend_Pdf_Element_Reference_Context $context, Zend_Pdf_ElementFactory $factory)
	getFactory ()
	getType ()
	toString ($factory=null)
	makeClone (Zend_Pdf_ElementFactory $factory, array &$processed, $mode)
	touch ()
	getObject ()
	__get ($property)
	__set ($property, $value)
	__call ($method, $args)
	cleanUp ()
	toPhp ()
Public Member Functions inherited from Zend_Pdf_Element
	getType ()
	toString ($factory=null)
	makeClone (Zend_Pdf_ElementFactory $factory, array &$processed, $mode)
	setParentObject (Zend_Pdf_Element_Object $parent)
	getParentObject ()
	touch ()
	cleanUp ()
	toPhp ()

Additional Inherited Members
Static Public Member Functions inherited from Zend_Pdf_Element
static	phpToPdf ($input)
Data Fields inherited from Zend_Pdf_Element
const	TYPE_BOOL = 1
const	TYPE_NUMERIC = 2
const	TYPE_STRING = 3
const	TYPE_NAME = 4
const	TYPE_ARRAY = 5
const	TYPE_DICTIONARY = 6
const	TYPE_STREAM = 7
const	TYPE_NULL = 11
const	CLONE_MODE_SKIP_PAGES = 1
const	CLONE_MODE_FORCE_CLONING = 2

Detailed Description

Definition at line 38 of file Reference.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$objNum,
			$genNum = 0,
		Zend_Pdf_Element_Reference_Context	$context,
		Zend_Pdf_ElementFactory	$factory
	)

Object constructor:

Parameters

integer	$objNum
integer	$genNum
Zend_Pdf_Element_Reference_Context	$context
Zend_Pdf_ElementFactory	$factory

Exceptions

Zend_Pdf_Exception

Definition at line 91 of file Reference.php.

    {
        if ( !(is_integer($objNum) && $objNum > 0) ) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Object number must be positive integer');
        }
        if ( !(is_integer($genNum) && $genNum >= 0) ) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Generation number must be non-negative integer');
        }

        $this->_objNum  = $objNum;
        $this->_genNum  = $genNum;
        $this->_ref     = null;
        $this->_context = $context;
        $this->_factory = $factory;
    }

Member Function Documentation

__call()

__call	(		$method,
			$args
	)

Call handler

Parameters

string	$method
array	$args

Returns

mixed

Definition at line 273 of file Reference.php.

    {
        if ($this->_ref === null) {
            $this->_dereference();
        }

        return call_user_func_array(array($this->_ref, $method), $args);
    }

__get()

__get

(

$property

)

Get handler

Parameters

string

$property

Returns

mixed

Definition at line 242 of file Reference.php.

    {
        if ($this->_ref === null) {
            $this->_dereference();
        }

        return $this->_ref->$property;
    }

__set()

__set	(		$property,
			$value
	)

Set handler

Parameters

string	$property
mixed	$value

Definition at line 257 of file Reference.php.

    {
        if ($this->_ref === null) {
            $this->_dereference();
        }

        $this->_ref->$property = $value;
    }

cleanUp()

cleanUp

(

)

Clean up resources

Definition at line 285 of file Reference.php.

    {
        $this->_ref = null;
    }

getFactory()

getFactory

(

)

Check, that object is generated by specified factory

Returns

Zend_Pdf_ElementFactory

Definition at line 114 of file Reference.php.

    {
        return $this->_factory;
    }

getObject()

getObject

(

)

Return object, which can be used to identify object and its references identity

Returns

Zend_Pdf_Element_Object

Definition at line 227 of file Reference.php.

    {
        if ($this->_ref === null) {
            $this->_dereference();
        }

        return $this->_ref;
    }

getType()

getType

(

)

Return type of the element.

Returns

integer

Definition at line 125 of file Reference.php.

    {
        if ($this->_ref === null) {
            $this->_dereference();
        }

        return $this->_ref->getType();
    }

makeClone()

makeClone	(	Zend_Pdf_ElementFactory	$factory,
		array &	$processed,
			$mode
	)

Detach PDF object from the factory (if applicable), clone it and attach to new factory.

Parameters

Zend_Pdf_ElementFactory	$factory	The factory to attach
array	&$processed	List of already processed indirect objects, used to avoid objects duplication
integer	$mode	Cloning mode (defines filter for objects cloning)

Returns

Zend_Pdf_Element

Definition at line 192 of file Reference.php.

    {
        if ($this->_ref === null) {
            $this->_dereference();
        }

        // This code duplicates code in Zend_Pdf_Element_Object class,
        // but allows to avoid unnecessary method call in most cases
        $id = spl_object_hash($this->_ref);
        if (isset($processed[$id])) {
            // Do nothing if object is already processed
            // return it
            return $processed[$id];
        }

        return $this->_ref->makeClone($factory, $processed, $mode);
    }

toPhp()

toPhp

(

)

Convert PDF element to PHP type.

Returns

mixed

Definition at line 295 of file Reference.php.

    {
        if ($this->_ref === null) {
            $this->_dereference();
        }

        return $this->_ref->toPhp();
    }

toString()

toString

(

$factory = null

)

Return reference to the object

Parameters

Zend_Pdf_Factory

$factory

Returns

string

Definition at line 141 of file Reference.php.

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

        return $this->_objNum + $shift . ' ' . $this->_genNum . ' R';
    }

touch()

touch

(

)

Mark object as modified, to include it into new PDF file segment.

Definition at line 213 of file Reference.php.

    {
        if ($this->_ref === null) {
            $this->_dereference();
        }

        $this->_ref->touch();
    }

---

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

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