Zend_Pdf_Element_Dictionary Class Reference

Inheritance diagram for Zend_Pdf_Element_Dictionary:

Public Member Functions
	__construct ($val=null)
Zend_Pdf_Element_Name $name
Add element to an array Parameters Zend_Pdf_Element $val - Zend_Pdf_Element object Exceptions Zend_Pdf_Exception
	add (Zend_Pdf_Element_Name $name, Zend_Pdf_Element $val)
	getKeys ()
	__get ($item)
	__set ($item, $value)
	getType ()
	toString ($factory=null)
	makeClone (Zend_Pdf_ElementFactory $factory, array &$processed, $mode)
	setParentObject (Zend_Pdf_Element_Object $parent)
	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 Dictionary.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$val = null

)

Object constructor

Parameters

array

$val

- array of Zend_Pdf_Element objects

Exceptions

Zend_Pdf_Exception

Definition at line 55 of file Dictionary.php.

    {
        if ($val === null) {
            return;
        } else if (!is_array($val)) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Argument must be an array');
        }

        foreach ($val as $name => $element) {
            if (!$element instanceof Zend_Pdf_Element) {
                #require_once 'Zend/Pdf/Exception.php';
                throw new Zend_Pdf_Exception('Array elements must be Zend_Pdf_Element objects');
            }
            if (!is_string($name)) {
                #require_once 'Zend/Pdf/Exception.php';
                throw new Zend_Pdf_Exception('Array keys must be strings');
            }
            $this->_items[$name] = $element;
        }
    }

Member Function Documentation

__get()

__get

(

$item

)

Get handler

Parameters

string

$property

Returns

Zend_Pdf_Element | null

Definition at line 107 of file Dictionary.php.

    {
        $element = isset($this->_items[$item]) ? $this->_items[$item]
                                               : null;

        return $element;
    }

__set()

__set	(		$item,
			$value
	)

Set handler

Parameters

string	$property
mixed	$value

Definition at line 121 of file Dictionary.php.

    {
        if ($value === null) {
            unset($this->_items[$item]);
        } else {
            $this->_items[$item] = $value;
        }
    }

add()

add	(	Zend_Pdf_Element_Name	$name,
		Zend_Pdf_Element	$val
	)

Definition at line 85 of file Dictionary.php.

    {
        $this->_items[$name->value] = $val;
    }

getKeys()

getKeys

(

)

Return dictionary keys

Returns

array

Definition at line 95 of file Dictionary.php.

    {
        return array_keys($this->_items);
    }

getType()

getType

(

)

Return type of the element.

Returns

integer

Definition at line 135 of file Dictionary.php.

    {
        return Zend_Pdf_Element::TYPE_DICTIONARY;
    }

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

Exceptions

Zend_Pdf_Exception

Definition at line 180 of file Dictionary.php.

    {
        if (isset($this->_items['Type'])) {
            if ($this->_items['Type']->value == 'Pages') {
                // It's a page tree node
                // skip it and its children
                return new Zend_Pdf_Element_Null();
            }

            if ($this->_items['Type']->value == 'Page'  &&
                $mode == Zend_Pdf_Element::CLONE_MODE_SKIP_PAGES
            ) {
                // It's a page node, skip it
                return new Zend_Pdf_Element_Null();
            }
        }

        $newDictionary = new self();
        foreach ($this->_items as $key => $value) {
            $newDictionary->_items[$key] = $value->makeClone($factory, $processed, $mode);
        }

        return $newDictionary;
    }

setParentObject()

setParentObject

(

Zend_Pdf_Element_Object

$parent

)

Set top level parent indirect object.

Parameters

Zend_Pdf_Element_Object

$parent

Definition at line 210 of file Dictionary.php.

    {
        parent::setParentObject($parent);

        foreach ($this->_items as $item) {
            $item->setParentObject($parent);
        }
    }

toPhp()

toPhp

(

)

Convert PDF element to PHP type.

Dictionary is returned as an associative array

Returns

mixed

Definition at line 226 of file Dictionary.php.

    {
        $phpArray = array();

        foreach ($this->_items as $itemName => $item) {
            $phpArray[$itemName] = $item->toPhp();
        }

        return $phpArray;
    }

toString()

toString

(

$factory = null

)

Return object as string

Parameters

Zend_Pdf_Factory

$factory

Returns

string

Definition at line 147 of file Dictionary.php.

    {
        $outStr = '<<';
        $lastNL = 0;

        foreach ($this->_items as $name => $element) {
            if (!is_object($element)) {
                #require_once 'Zend/Pdf/Exception.php';
                throw new Zend_Pdf_Exception('Wrong data');
            }

            if (strlen($outStr) - $lastNL > 128)  {
                $outStr .= "\n";
                $lastNL = strlen($outStr);
            }

            $nameObj = new Zend_Pdf_Element_Name($name);
            $outStr .= $nameObj->toString($factory) . ' ' . $element->toString($factory) . ' ';
        }
        $outStr .= '>>';

        return $outStr;
    }

---

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

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