Pdf/Element/Object/Stream.php

Show:

inherited

Classes
- \Zend_Pdf_Element_Object_Stream

Table of Contents

Zend Framework

LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Pdf
Version: $Id$

\Zend_Pdf_Element_Object_Stream
jump to top

Package: Zend_Pdf

PDF file 'stream object' element implementation

Parent(s): \Zend_Pdf_Element_Object < \Zend_Pdf_Element
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

\Zend_Pdf_Element_Dictionary $_dictionary

StreamObject dictionary Required enries: Length

Details

Type: \Zend_Pdf_Element_Dictionary

array|null $_initialDictionaryData = null

Stored original stream object dictionary.

Used to decode stream at access time. The only properties affecting decoding are sored here.

Default valuenullDetails

Type: array | null

boolean $_streamDecoded

Flag which signals, that stream is decoded

Details

Type: boolean

Methods

__call(string $method, array $args) : mixed

Call handler

Parameters

Name	Type	Description
$method	string
$args	array

Returns

Type	Description
mixed

__construct(mixed $val, integer $objNum, integer $genNum, \Zend_Pdf_ElementFactory $factory, \Zend_Pdf_Element_Dictionary | null $dictionary = null) : void

Object constructor

Parameters

Name	Type	Description
$val	mixed
$objNum	integer
$genNum	integer
$factory	\Zend_Pdf_ElementFactory
$dictionary	\Zend_Pdf_Element_Dictionary \| null

Throws

Exception	Description
\Zend_Pdf_Exception

__get(string $property) : mixed

Get handler

Parameters

Name	Type	Description
$property	string

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Pdf_Exception

__set(string $property, mixed $value) : void

Set handler

Parameters

Name	Type	Description
$property	string
$value	mixed

_decodeStream() : void

Decode stream

Throws

Exception	Description
\Zend_Pdf_Exception

_encodeStream() : void

Encode stream

Throws

Exception	Description
\Zend_Pdf_Exception

_extractDictionaryData() : array

Extract dictionary data which are used to store information and to normalize filters information before defiltering.

Returns

Type	Description
array

cleanUp() : void

Clean up resources, used by object

dump(\Zend_Pdf_ElementFactory $factory) : string

Dump object to a string to save within PDF file

$factory parameter defines operation context.

Parameters

Name	Type	Description
$factory	\Zend_Pdf_ElementFactory

Returns

Type	Description
string

makeClone(\Zend_Pdf_ElementFactory $factory, $processed, integer $mode) : void

Detach PDF object from the factory (if applicable), clone it and attach to new factory.

Parameters

Name	Type	Description
$factory	\Zend_Pdf_ElementFactory	The factory to attach
$processed
$mode	integer	Cloning mode (defines filter for objects cloning)

Details

Returns: Zend_Pdf_Element

skipFilters() : void

Treat stream data as already encoded

Pdf/Element/Object/Stream.php

\Zend_Pdf_Element_Object_Streamjump to top

Properties

Methods

\Zend_Pdf_Element_Object_Stream
jump to top