API Documentation

Pdf/Element/Object/Stream.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Pdf  
version
$Id: Stream.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Pdf_Element_Object_Stream

PDF file 'stream object' element implementation

Extends from
\Zend_Pdf_Element_Object
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Pdf  

Properties

Propertyprivate\Zend_Pdf_Element_Dictionary  $_dictionary= ''

StreamObject dictionary Required enries: Length

Propertyprivatearray|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
arraynull
Propertyprivateboolean  $_streamDecoded= ''

Flag which signals, that stream is decoded

Details
Type
boolean

Methods

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

Call handler

Parameters
Name Type Description
$method string
$args array
Returns
Type Description
mixed
methodpublic__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
methodpublic__get( string $property ) : mixed

Get handler

Parameters
Name Type Description
$property string
Returns
Type Description
mixed
Throws
Exception Description
\Zend_Pdf_Exception
methodpublic__set( string $property, mixed $value ) : void

Set handler

Parameters
Name Type Description
$property string
$value mixed
methodprivate_decodeStream( ) : void

Decode stream

Throws
Exception Description
\Zend_Pdf_Exception
methodprivate_encodeStream( ) : void

Encode stream

Throws
Exception Description
\Zend_Pdf_Exception
methodprivate_extractDictionaryData( ) : array

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

Returns
Type Description
array
methodpubliccleanUp( ) : void

Clean up resources, used by object

methodpublicdump( \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
methodpublicgetFactory( ) : \Zend_Pdf_ElementFactory

Check, that object is generated by specified factory

Inherited from: \Zend_Pdf_Element_Object::getFactory()
Returns
Type Description
\Zend_Pdf_ElementFactory
methodpublicgetGenNum( ) : integer

Get generation number

Inherited from: \Zend_Pdf_Element_Object::getGenNum()
Returns
Type Description
integer
methodpublicgetObjNum( ) : integer

Get object number

Inherited from: \Zend_Pdf_Element_Object::getObjNum()
Returns
Type Description
integer
methodpublicgetObject( ) : \Zend_Pdf_Element_Object

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
methodpublicgetParentObject( ) : \Zend_Pdf_Element_Object

Get top level parent indirect object.

Inherited from: \Zend_Pdf_Element::getParentObject()
Returns
Type Description
\Zend_Pdf_Element_Object
methodpublicgetType( ) : integer

Return type of the element.

Inherited from: \Zend_Pdf_Element_Object::getType()

See ZPdfPDFConst for possible values

Returns
Type Description
integer
methodpublicmakeClone( \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  
methodpublicphpToPdf( mixed $input ) : \Zend_Pdf_Element
static

Convert PHP value into PDF element.

Inherited from: \Zend_Pdf_Element::phpToPdf()
Parameters
Name Type Description
$input mixed
Returns
Type Description
\Zend_Pdf_Element
methodpublicsetParentObject( \Zend_Pdf_Element_Object $parent ) : void

Set top level parent indirect object.

Inherited from: \Zend_Pdf_Element::setParentObject()
Parameters
Name Type Description
$parent \Zend_Pdf_Element_Object
methodpublicskipFilters( ) : void

Treat stream data as already encoded

methodpublictoPhp( ) : mixed

Convert PDF element to PHP type.

Inherited from: \Zend_Pdf_Element_Object::toPhp()
Returns
Type Description
mixed
methodpublictoString( \Zend_Pdf_Factory $factory = null ) : string

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
methodpublictouch( ) : void

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.

Documentation was generated by DocBlox 0.13.3.