Zend_Pdf_Element_Array Class Reference

Inheritance diagram for Zend_Pdf_Element_Array:

Public Member Functions
	__construct ($val=null)
	__get ($property)
	__set ($property, $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 ()

Data Fields
	$items
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

Additional Inherited Members
Static Public Member Functions inherited from Zend_Pdf_Element
static	phpToPdf ($input)

Detailed Description

Definition at line 35 of file Array.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 53 of file Array.php.

    {
        $this->items = new ArrayObject();

        if ($val !== null  &&  is_array($val)) {
            foreach ($val as $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');
                }
                $this->items[] = $element;
            }
        } else if ($val !== null){
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Argument must be an array');
        }
    }

Member Function Documentation

__get()

__get

(

$property

)

Getter

Parameters

string

$property

Exceptions

Zend_Pdf_Exception

Definition at line 78 of file Array.php.

                                     {
        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception('Undefined property: Zend_Pdf_Element_Array::$' . $property);
    }

__set()

__set	(		$property,
			$value
	)

Setter

Parameters

mixed	$offset
mixed	$value

Exceptions

Zend_Pdf_Exception

Definition at line 91 of file Array.php.

                                             {
        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception('Undefined property: Zend_Pdf_Element_Array::$' . $property);
    }

getType()

getType

(

)

Return type of the element.

Returns

integer

Definition at line 101 of file Array.php.

    {
        return Zend_Pdf_Element::TYPE_ARRAY;
    }

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 139 of file Array.php.

    {
        $newArray = new self();

        foreach ($this->items as $key => $value) {
            $newArray->items[$key] = $value->makeClone($factory, $processed, $mode);
        }

        return $newArray;
    }

setParentObject()

setParentObject

(

Zend_Pdf_Element_Object

$parent

)

Set top level parent indirect object.

Parameters

Zend_Pdf_Element_Object

$parent

Definition at line 155 of file Array.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 171 of file Array.php.

    {
        $phpArray = array();

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

        return $phpArray;
    }

toString()

toString

(

$factory = null

)

Return object as string

Parameters

Zend_Pdf_Factory

$factory

Returns

string

Definition at line 113 of file Array.php.

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

        foreach ($this->items as $element) {
            if (strlen($outStr) - $lastNL > 128)  {
                $outStr .= "\n";
                $lastNL = strlen($outStr);
            }

            $outStr .= $element->toString($factory) . ' ';
        }
        $outStr .= ']';

        return $outStr;
    }

Field Documentation

$items

$items

Definition at line 44 of file Array.php.

---

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

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