Zend_Pdf_Element_Object Class Reference

Inheritance diagram for Zend_Pdf_Element_Object:

Public Member Functions
	__construct (Zend_Pdf_Element $val, $objNum, $genNum, Zend_Pdf_ElementFactory $factory)
	getFactory ()
	getType ()
	getObjNum ()
	getGenNum ()
	toString ($factory=null)
	dump (Zend_Pdf_ElementFactory $factory)
	__get ($property)
	__set ($property, $value)
	__call ($method, $args)
	makeClone (Zend_Pdf_ElementFactory $factory, array &$processed, $mode)
	touch ()
	getObject ()
	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 ()

Protected Attributes
	$_value
	$_objNum
	$_genNum
	$_factory

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 35 of file Object.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Zend_Pdf_Element	$val,
			$objNum,
			$genNum,
		Zend_Pdf_ElementFactory	$factory
	)

Object constructor

Parameters

Zend_Pdf_Element	$val
integer	$objNum
integer	$genNum
Zend_Pdf_ElementFactory	$factory

Exceptions

Zend_Pdf_Exception

Definition at line 74 of file Object.php.

    {
        if ($val instanceof self) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Object number must not be an instance of Zend_Pdf_Element_Object.');
        }

        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->_value   = $val;
        $this->_objNum  = $objNum;
        $this->_genNum  = $genNum;
        $this->_factory = $factory;

        $this->setParentObject($this);

        $factory->registerObject($this, $objNum . ' ' . $genNum);
    }

Member Function Documentation

__call()

__call	(		$method,
			$args
	)

Call handler

Parameters

string	$method
array	$args

Returns

mixed

Definition at line 209 of file Object.php.

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

__get()

__get

(

$property

)

Get handler

Parameters

string

$property

Returns

mixed

Definition at line 186 of file Object.php.

    {
        return $this->_value->$property;
    }

__set()

__set	(		$property,
			$value
	)

Set handler

Parameters

string	$property
mixed	$value

Definition at line 197 of file Object.php.

    {
        $this->_value->$property = $value;
    }

cleanUp()

cleanUp

(

)

Clean up resources, used by object

Definition at line 270 of file Object.php.

    {
        $this->_value = null;
    }

dump()

dump

(

Zend_Pdf_ElementFactory

$factory

)

Dump object to a string to save within PDF file.

$factory parameter defines operation context.

Parameters

Zend_Pdf_ElementFactory

$factory

Returns

string

Definition at line 171 of file Object.php.

    {
        $shift = $factory->getEnumerationShift($this->_factory);

        return  $this->_objNum + $shift . " " . $this->_genNum . " obj \n"
             .  $this->_value->toString($factory) . "\n"
             . "endobj\n";
    }

getFactory()

getFactory

(

)

Check, that object is generated by specified factory

Returns

Zend_Pdf_ElementFactory

Definition at line 107 of file Object.php.

    {
        return $this->_factory;
    }

getGenNum()

getGenNum

(

)

Get generation number

Returns

integer

Definition at line 139 of file Object.php.

    {
        return $this->_genNum;
    }

getObject()

getObject

(

)

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

Returns

Zend_Pdf_Element_Object

Definition at line 262 of file Object.php.

    {
        return $this;
    }

getObjNum()

getObjNum

(

)

Get object number

Returns

integer

Definition at line 128 of file Object.php.

    {
        return $this->_objNum;
    }

getType()

getType

(

)

Return type of the element.

Returns

integer

Definition at line 117 of file Object.php.

    {
        return $this->_value->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 222 of file Object.php.

    {
        $id = spl_object_hash($this);
        if (isset($processed[$id])) {
            // Do nothing if object is already processed
            // return it
            return $processed[$id];
        }

        // Create obect with null value and register it in $processed container
        $processed[$id] = $clonedObject = $factory->newObject(new Zend_Pdf_Element_Null());

        // Pecursively process actual data
        $clonedObject->_value = $this->_value->makeClone($factory, $processed, $mode);

        if ($clonedObject->_value instanceof Zend_Pdf_Element_Null) {
            // Do not store null objects within $processed container since it may be filtered
            // by $mode parameter but used in some future pass
            unset($processed[$id]);

            // Return direct null object
            return $clonedObject->_value;
        }

        return $clonedObject;
    }

toPhp()

toPhp

(

)

Convert PDF element to PHP type.

Returns

mixed

Definition at line 280 of file Object.php.

    {
        return $this->_value->toPhp();
    }

toString()

toString

(

$factory = null

)

Return reference to the object

Parameters

Zend_Pdf_Factory

$factory

Returns

string

Definition at line 151 of file Object.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 252 of file Object.php.

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

Field Documentation

$_factory

$_factory

protected

Definition at line 63 of file Object.php.

$_genNum

$_genNum

protected

Definition at line 56 of file Object.php.

$_objNum

$_objNum

protected

Definition at line 49 of file Object.php.

$_value

$_value

protected

Definition at line 42 of file Object.php.

---

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

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