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-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Pdf
Version: $Id: Stream.php 24593 2012-01-05 20:35:02Z matthew $

\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-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                TYPE_BOOL
                = 1

inheritedInherited from: \Zend_Pdf_Element::TYPE_BOOL \Zend_Pdf_Element_Object::TYPE_BOOL

Inherited_from: \Zend_Pdf_Element::TYPE_BOOL
Inherited_from: \Zend_Pdf_Element_Object::TYPE_BOOL

 
                TYPE_NUMERIC
                = 2

inheritedInherited from: \Zend_Pdf_Element::TYPE_NUMERIC \Zend_Pdf_Element_Object::TYPE_NUMERIC

Inherited_from: \Zend_Pdf_Element::TYPE_NUMERIC
Inherited_from: \Zend_Pdf_Element_Object::TYPE_NUMERIC

 
                TYPE_STRING
                = 3

inheritedInherited from: \Zend_Pdf_Element::TYPE_STRING \Zend_Pdf_Element_Object::TYPE_STRING

Inherited_from: \Zend_Pdf_Element::TYPE_STRING
Inherited_from: \Zend_Pdf_Element_Object::TYPE_STRING

 
                TYPE_NAME
                = 4

inheritedInherited from: \Zend_Pdf_Element::TYPE_NAME \Zend_Pdf_Element_Object::TYPE_NAME

Inherited_from: \Zend_Pdf_Element::TYPE_NAME
Inherited_from: \Zend_Pdf_Element_Object::TYPE_NAME

 
                TYPE_ARRAY
                = 5

inheritedInherited from: \Zend_Pdf_Element::TYPE_ARRAY \Zend_Pdf_Element_Object::TYPE_ARRAY

Inherited_from: \Zend_Pdf_Element::TYPE_ARRAY
Inherited_from: \Zend_Pdf_Element_Object::TYPE_ARRAY

 
                TYPE_DICTIONARY
                = 6

inheritedInherited from: \Zend_Pdf_Element::TYPE_DICTIONARY \Zend_Pdf_Element_Object::TYPE_DICTIONARY

Inherited_from: \Zend_Pdf_Element::TYPE_DICTIONARY
Inherited_from: \Zend_Pdf_Element_Object::TYPE_DICTIONARY

 
                TYPE_STREAM
                = 7

inheritedInherited from: \Zend_Pdf_Element::TYPE_STREAM \Zend_Pdf_Element_Object::TYPE_STREAM

Inherited_from: \Zend_Pdf_Element::TYPE_STREAM
Inherited_from: \Zend_Pdf_Element_Object::TYPE_STREAM

 
                TYPE_NULL
                = 11

inheritedInherited from: \Zend_Pdf_Element::TYPE_NULL \Zend_Pdf_Element_Object::TYPE_NULL

Inherited_from: \Zend_Pdf_Element::TYPE_NULL
Inherited_from: \Zend_Pdf_Element_Object::TYPE_NULL

 
                CLONE_MODE_SKIP_PAGES
                = 1

inheritedInherited from: \Zend_Pdf_Element::CLONE_MODE_SKIP_PAGES \Zend_Pdf_Element_Object::CLONE_MODE_SKIP_PAGES

Inherited_from: \Zend_Pdf_Element::CLONE_MODE_SKIP_PAGES
Inherited_from: \Zend_Pdf_Element_Object::CLONE_MODE_SKIP_PAGES

 
                CLONE_MODE_FORCE_CLONING
                = 2

inheritedInherited from: \Zend_Pdf_Element::CLONE_MODE_FORCE_CLONING \Zend_Pdf_Element_Object::CLONE_MODE_FORCE_CLONING

Inherited_from: \Zend_Pdf_Element::CLONE_MODE_FORCE_CLONING
Inherited_from: \Zend_Pdf_Element_Object::CLONE_MODE_FORCE_CLONING

Properties

\Zend_Pdf_Element_Dictionary $_dictionary

StreamObject dictionary Required enries: Length

Details

Type: \Zend_Pdf_Element_Dictionary

\Zend_Pdf_ElementFactory $_factory

inherited

Reference to the factory.

Inherited from: \Zend_Pdf_Element_Object::$$_factory

Details

Type: \Zend_Pdf_ElementFactory
Inherited_from: \Zend_Pdf_Element_Object::$$_factory

integer $_genNum

inherited

Generation number

Inherited from: \Zend_Pdf_Element_Object::$$_genNum

Details

Type: integer
Inherited_from: \Zend_Pdf_Element_Object::$$_genNum

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

integer $_objNum

inherited

Object number within PDF file

Inherited from: \Zend_Pdf_Element_Object::$$_objNum

Details

Type: integer
Inherited_from: \Zend_Pdf_Element_Object::$$_objNum

\Zend_Pdf_Element_Object $_parentObject = null

inherited

Reference to the top level indirect object, which contains this element.

Inherited from: \Zend_Pdf_Element::$$_parentObject \Zend_Pdf_Element_Object::$$_parentObject

Default valuenullDetails

Type: \Zend_Pdf_Element_Object
Inherited_from: \Zend_Pdf_Element::$$_parentObject
Inherited_from: \Zend_Pdf_Element_Object::$$_parentObject

boolean $_streamDecoded

Flag which signals, that stream is decoded

Details

Type: boolean

\Zend_Pdf_Element $_value

inherited

Object value

Inherited from: \Zend_Pdf_Element_Object::$$_value

Details

Type: \Zend_Pdf_Element
Inherited_from: \Zend_Pdf_Element_Object::$$_value

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

getFactory() : \Zend_Pdf_ElementFactory

inherited

Check, that object is generated by specified factory

Inherited from: \Zend_Pdf_Element_Object::getFactory()

Returns

Type	Description
\Zend_Pdf_ElementFactory

getGenNum() : integer

inherited

Get generation number

Inherited from: \Zend_Pdf_Element_Object::getGenNum()

Returns

Type	Description
integer

getObjNum() : integer

inherited

Get object number

Inherited from: \Zend_Pdf_Element_Object::getObjNum()

Returns

Type	Description
integer

getObject() : \Zend_Pdf_Element_Object

inherited

Return object, which can be used to identify object and its references identity

Inherited from: \Zend_Pdf_Element_Object::getObject()

Returns

Type	Description
\Zend_Pdf_Element_Object

getParentObject() : \Zend_Pdf_Element_Object

inherited

Get top level parent indirect object.

Inherited from: \Zend_Pdf_Element::getParentObject()\Zend_Pdf_Element_Object::getParentObject()

Returns

Type	Description
\Zend_Pdf_Element_Object

getType() : integer

inherited

Return type of the element.

Inherited from: \Zend_Pdf_Element_Object::getType()

See ZPdfPDFConst for possible values

Returns

Type	Description
integer

makeClone(\Zend_Pdf_ElementFactory $factory, array $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	array	&$processed List of already processed indirect objects, used to avoid objects duplication
$mode	integer	Cloning mode (defines filter for objects cloning)

Details

Returns: Zend_Pdf_Element

phpToPdf(mixed $input) : \Zend_Pdf_Element

staticinherited

Convert PHP value into PDF element.

Inherited from: \Zend_Pdf_Element::phpToPdf()\Zend_Pdf_Element_Object::phpToPdf()

Parameters

Name	Type	Description
$input	mixed

Returns

Type	Description
\Zend_Pdf_Element

setParentObject(\Zend_Pdf_Element_Object $parent) : void

inherited

Set top level parent indirect object.

Inherited from: \Zend_Pdf_Element::setParentObject()\Zend_Pdf_Element_Object::setParentObject()

Parameters

Name	Type	Description
$parent	\Zend_Pdf_Element_Object

skipFilters() : void

Treat stream data as already encoded

toPhp() : mixed

inherited

Convert PDF element to PHP type.

Inherited from: \Zend_Pdf_Element_Object::toPhp()

Returns

Type	Description
mixed

toString(\Zend_Pdf_Factory $factory = null) : string

inherited

Return reference to the object

Inherited from: \Zend_Pdf_Element_Object::toString()

$factory parameter defines operation context.

Parameters

Name	Type	Description
$factory	\Zend_Pdf_Factory

Returns

Type	Description
string

touch() : void

inherited

Mark object as modified, to include it into new PDF file segment

Inherited from: \Zend_Pdf_Element_Object::touch()

We don't automate this action to keep control on PDF update process. All new objects are treated as "modified" automatically.

Pdf/Element/Object/Stream.php

\Zend_Pdf_Element_Object_Streamjump to top

Constants

Properties

Methods

\Zend_Pdf_Element_Object_Stream
jump to top