Properties

$index

$index : integer

PDF stream object index

Type

integer

$data

$data : string

PDF object data

Type

string

$isImported

$isImported : string

Imported flag

Type

string

$definition

$definition : string

PDF stream object definition

Type

string

$stream

$stream : string

PDF stream object stream

Type

string

$encoding

$encoding : boolean

Encoding filter

Type

boolean

$isPalette

$isPalette : boolean

Palette object flag

Type

boolean

$isXObject

$isXObject : boolean

XObject object flag

Type

boolean

Methods

setImported()

setImported(boolean  $imported) : \Pop\Pdf\Build\Object\AbstractObject

Set whether the object is imported

Parameters

boolean $imported

Returns

\Pop\Pdf\Build\Object\AbstractObject

getIndex()

getIndex() : integer

Get the object index

Returns

integer

getData()

getData() : string

Get the object stream

Returns

string

isImported()

isImported() : boolean

Determine if the object is imported

Returns

boolean

getDictionaryReferences()

getDictionaryReferences(string  $dictionary) : array

Get the integer references within a dictionary stream

Parameters

string $dictionary

Returns

array

__toString()

__toString() : string

Method to print the PDF stream object.

Returns

string

__construct()

__construct(integer  $index = 5) 

Constructor

Instantiate a PDF stream object.

Parameters

integer $index

parse()

parse(string  $stream) : \Pop\Pdf\Build\Object\StreamObject

Parse a stream object from a string

Parameters

string $stream

Returns

\Pop\Pdf\Build\Object\StreamObject

setDefinition()

setDefinition(string  $definition) : \Pop\Pdf\Build\Object\StreamObject

Set the stream object definition

Parameters

string $definition

Returns

\Pop\Pdf\Build\Object\StreamObject

setStream()

setStream(string  $stream) : \Pop\Pdf\Build\Object\StreamObject

Set the stream object stream

Parameters

string $stream

Returns

\Pop\Pdf\Build\Object\StreamObject

appendStream()

appendStream(string  $stream) : \Pop\Pdf\Build\Object\StreamObject

Append to the stream the PDF stream object

Parameters

string $stream

Returns

\Pop\Pdf\Build\Object\StreamObject

getDefinition()

getDefinition() : string

Get the stream object definition

Returns

string

getStream()

getStream() : string

Get the PDF stream object stream

Returns

string

encode()

encode() : void

Method to encode the PDF stream object with FlateDecode (gzcompress)

isEncoded()

isEncoded() : boolean

Determine whether or not the PDF stream object is encoded

Returns

boolean

getEncoding()

getEncoding() : string

Get the encoding filter

Returns

string

setPalette()

setPalette(boolean  $isPalette) : void

Set whether the PDF stream object is a palette object

Parameters

boolean $isPalette

isPalette()

isPalette() : boolean

Get whether the PDF stream object is a palette object

Returns

boolean

isXObject()

isXObject() : boolean

Get whether the PDF stream object is an XObject

Returns

boolean

getByteLength()

getByteLength() : integer

Get the PDF stream object byte length

Returns

integer

calculateByteLength()

calculateByteLength(string  $string) : integer

Calculate the byte length of a string

Parameters

string $string

Returns

integer