Zend_Pdf_Element_Object_Stream Class Reference

Inheritance diagram for Zend_Pdf_Element_Object_Stream:

Public Member Functions
	__construct ($val, $objNum, $genNum, Zend_Pdf_ElementFactory $factory, $dictionary=null)
	__get ($property)
	__set ($property, $value)
	skipFilters ()
	__call ($method, $args)
	makeClone (Zend_Pdf_ElementFactory $factory, array &$processed, $mode)
	dump (Zend_Pdf_ElementFactory $factory)
	cleanUp ()
Public Member Functions inherited from Zend_Pdf_Element_Object
	__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 ()

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
Protected Attributes inherited from Zend_Pdf_Element_Object
	$_value
	$_objNum
	$_genNum
	$_factory

Detailed Description

Definition at line 40 of file Stream.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$val,
			$objNum,
			$genNum,
		Zend_Pdf_ElementFactory	$factory,
			$dictionary = null
	)

Object constructor

Parameters

mixed	$val
integer	$objNum
integer	$genNum
Zend_Pdf_ElementFactory	$factory
Zend_Pdf_Element_Dictionary | null	$dictionary

Exceptions

Zend_Pdf_Exception

Definition at line 78 of file Stream.php.

    {
        parent::__construct(new Zend_Pdf_Element_Stream($val), $objNum, $genNum, $factory);

        if ($dictionary === null) {
            $this->_dictionary    = new Zend_Pdf_Element_Dictionary();
            $this->_dictionary->Length = new Zend_Pdf_Element_Numeric(strlen( $val ));
            $this->_streamDecoded = true;
        } else {
            $this->_dictionary    = $dictionary;
            $this->_streamDecoded = false;
        }
    }

Member Function Documentation

__call()

__call	(		$method,
			$args
	)

Call handler

Parameters

string	$method
array	$args

Returns

mixed

Definition at line 362 of file Stream.php.

    {
        if (!$this->_streamDecoded) {
            $this->_decodeStream();
        }

        switch (count($args)) {
            case 0:
                return $this->_value->$method();
            case 1:
                return $this->_value->$method($args[0]);
            default:
                #require_once 'Zend/Pdf/Exception.php';
                throw new Zend_Pdf_Exception('Unsupported number of arguments');
        }
    }

__get()

__get

(

$property

)

Get handler

Parameters

string

$property

Returns

mixed

Exceptions

Zend_Pdf_Exception

If stream is not decoded yet, then store original decoding options (do it only once).

Definition at line 297 of file Stream.php.

    {
        if ($property == 'dictionary') {
            if (( !$this->_streamDecoded ) && ($this->_initialDictionaryData === null)) {
                $this->_initialDictionaryData = $this->_extractDictionaryData();
            }

            return $this->_dictionary;
        }

        if ($property == 'value') {
            if (!$this->_streamDecoded) {
                $this->_decodeStream();
            }

            return $this->_value->value->getRef();
        }

        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception('Unknown stream object property requested.');
    }

__set()

__set	(		$property,
			$value
	)

Set handler

Parameters

string	$property
mixed	$value

Definition at line 329 of file Stream.php.

    {
        if ($property == 'value') {
            $valueRef = &$this->_value->value->getRef();
            $valueRef = $value;
            $this->_value->value->touch();

            $this->_streamDecoded = true;

            return;
        }

        #require_once 'Zend/Pdf/Exception.php';
        throw new Zend_Pdf_Exception('Unknown stream object property: \'' . $property . '\'.');
    }

cleanUp()

cleanUp

(

)

Clean up resources, used by object

Definition at line 448 of file Stream.php.

    {
        $this->_dictionary = null;
        $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 419 of file Stream.php.

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

        if ($this->_streamDecoded) {
            $this->_initialDictionaryData = $this->_extractDictionaryData();
            $this->_encodeStream();
        } else if ($this->_initialDictionaryData != null) {
            $newDictionary   = $this->_extractDictionaryData();

            if ($this->_initialDictionaryData !== $newDictionary) {
                $this->_decodeStream();
                $this->_initialDictionaryData = $newDictionary;
                $this->_encodeStream();
            }
        }

        // Update stream length
        $this->dictionary->Length->value = $this->_value->length();

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

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 387 of file Stream.php.

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

        $streamValue      = $this->_value;
        $streamDictionary = $this->_dictionary->makeClone($factory, $processed, $mode);

        // Make new empty instance of stream object and register it in $processed container
        $processed[$id] = $clonedObject = $factory->newStreamObject('');

        // Copy current object data and state
        $clonedObject->_dictionary            = $this->_dictionary->makeClone($factory, $processed, $mode);
        $clonedObject->_value                 = $this->_value->makeClone($factory, $processed, $mode);
        $clonedObject->_initialDictionaryData = $this->_initialDictionaryData;
        $clonedObject->_streamDecoded         = $this->_streamDecoded;

        return  $clonedObject;
    }

skipFilters()

skipFilters

(

)

Treat stream data as already encoded

Definition at line 349 of file Stream.php.

    {
        $this->_streamDecoded = false;
    }

---

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

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