Zend_Pdf_Element_Stream Class Reference

Inheritance diagram for Zend_Pdf_Element_Stream:

Public Member Functions
	__construct ($val)
	getType ()
	length ()
	clear ()
	append ($val)
	makeClone (Zend_Pdf_ElementFactory $factory, array &$processed, $mode)
	toString ($factory=null)
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
	$value
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 38 of file Stream.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$val

)

Object constructor

Parameters

string

$val

Definition at line 53 of file Stream.php.

    {
        $this->value = Zend_Pdf::getMemoryManager()->create($val);
    }

Member Function Documentation

append()

append

(

$val

)

Append value to a stream

Parameters

mixed

$val

Definition at line 99 of file Stream.php.

    {
        $ref = &$this->value->getRef();
        $ref .= (string)$val;
        $this->value->touch();
    }

clear()

clear

(

)

Clear stream

Definition at line 86 of file Stream.php.

    {
        $ref = &$this->value->getRef();
        $ref = '';
        $this->value->touch();
    }

getType()

getType

(

)

Return type of the element.

Returns

integer

Definition at line 64 of file Stream.php.

    {
        return Zend_Pdf_Element::TYPE_STREAM;
    }

length()

length

(

)

Stream length. (Method is used to avoid string copying, which may occurs in some cases)

Returns

integer

Definition at line 76 of file Stream.php.

    {
        return strlen($this->value->getRef());
    }

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

    {
        return new self($this->value->getRef());
    }

toString()

toString

(

$factory = null

)

Return object as string

Parameters

Zend_Pdf_Factory

$factory

Returns

string

Definition at line 126 of file Stream.php.

    {
        return "stream\n" . $this->value->getRef() . "\nendstream";
    }

Field Documentation

$value

$value

Definition at line 45 of file Stream.php.

---

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

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