API Documentation

Pdf/Element/Object/Stream.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
version
$Id: Stream.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Pdf_Element_Object_Stream

Description

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.

Zend_Pdf_Element_Object_Stream

Extends from
Zend_Pdf_Element_Object
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
Properties
$_dictionary
$_streamDecoded
$_originalDictionary
Methods
__construct
_storeOriginalDictionary
_decodeStream
_encodeStream
__get
__set
skipFilters
__call
dump
cleanUp

Description

PDF file 'stream object' element implementation

Properties

$_dictionary

Zend_Pdf_Element_Dictionary $_dictionary = ''

StreamObject dictionary Required enries: Length

Details

$_dictionary
Zend_Pdf_Element_Dictionary
visibility
private
default
final
false
static
false

$_originalDictionary

array|null $_originalDictionary = 'null'

Stored original stream object dictionary.

Used to decode stream during an access time.

The only properties, which affect decoding, are sored here.

Details

$_originalDictionary
array|null
visibility
private
default
null
final
false
static
false

$_streamDecoded

boolean $_streamDecoded = ''

Flag which signals, that stream is decoded

Details

$_streamDecoded
boolean
visibility
private
default
final
false
static
false

Methods

__call

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

Call handler

Arguments
$method
string
$args
array
Output
mixed
Details
visibility
public
final
false
static
false

__construct

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

Object constructor

Arguments
$val
mixed
$objNum
integer
$genNum
integer
$factory
Zend_Pdf_ElementFactory
$dictionary
Zend_Pdf_Element_Dictionarynull
Details
visibility
public
final
false
static
false
throws

__get

__get( string $property ) : mixed

Get handler

Arguments
$property
string
Output
mixed
Details
visibility
public
final
false
static
false
throws

__set

__set( string $property, mixed $value ) :

Set handler

Arguments
$property
string
$value
mixed
Details
visibility
public
final
false
static
false

_decodeStream

_decodeStream( ) :

Decode stream

Details
visibility
private
final
false
static
false
throws

_encodeStream

_encodeStream( ) :

Encode stream

Details
visibility
private
final
false
static
false
throws

_storeOriginalDictionary

_storeOriginalDictionary( ) :

Store original dictionary information in $_originalDictionary class member.

Used to store information and to normalize filters information before defiltering.

Details
visibility
private
final
false
static
false

cleanUp

cleanUp( ) :

Clean up resources, used by object

Details
visibility
public
final
false
static
false

dump

dump( Zend_Pdf_ElementFactory $factory ) : string

Dump object to a string to save within PDF file

$factory parameter defines operation context.

Arguments
$factory
Zend_Pdf_ElementFactory
Output
string
Details
visibility
public
final
false
static
false

skipFilters

skipFilters( ) :

Treat stream data as already encoded

Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.