PdfStream Class Reference

Class representing a PDF stream object. More...

Inheritance diagram for PdfStream:

Public Member Functions
	getFilters ()
	Get all filters defined for this stream.
	getStream ($cache=false)
	Get the stream data.
	getUnfilteredStream ()
	Get the unfiltered stream data.

Static Public Member Functions
static	create (PdfDictionary $dictionary, $stream)
	Helper method to create an instance.
static	ensure ($stream)
	Ensures that the passed value is a PdfStream instance.
static	flatten (PdfType $value, PdfParser $parser)
	Flatten indirect object references to direct objects.
static	parse (PdfDictionary $dictionary, StreamReader $reader, PdfParser $parser=null)
	Parses a stream from a stream reader.
static	resolve (PdfType $value, PdfParser $parser, $stopAtIndirectObject=false)
	Resolves a PdfType value to its value.

Public Attributes
mixed	$value
	The value of the PDF type.

Protected Member Functions
	extractStream ()
	Extract the stream "manually".

Static Protected Member Functions
static	ensureType ($type, $value, $errorMessage)
	Ensure that a value is an instance of a specific PDF type.

Protected Attributes
PdfParser	$parser
	The PDF parser instance.
StreamReader null	$reader
	The stream reader instance.
int string	$stream
	The stream or its byte-offset position.

Detailed Description

Class representing a PDF stream object.

Member Function Documentation

create()

static PdfStream::create ( PdfDictionary $dictionary, $stream )

static

Helper method to create an instance.

Parameters

PdfDictionary	$dictionary
string	$stream

Return values

self

ensure()

static PdfStream::ensure ( $stream )

static

Ensures that the passed value is a PdfStream instance.

Parameters

mixed

$stream

Return values

self

Exceptions

PdfTypeException

ensureType()

static PdfType::ensureType ( $type, $value, $errorMessage )

staticprotectedinherited

Ensure that a value is an instance of a specific PDF type.

Parameters

string	$type
PdfType	$value
string	$errorMessage

Return values

mixed

Exceptions

PdfTypeException

extractStream()

PdfStream::extractStream ( )

protected

Extract the stream "manually".

Return values

string

Exceptions

PdfTypeException

flatten()

static PdfType::flatten ( PdfType $value, PdfParser $parser )

staticinherited

Flatten indirect object references to direct objects.

Parameters

PdfType	$value
PdfParser	$parser

Return values

PdfType

Exceptions

CrossReferenceException
PdfParserException

getFilters()

PdfStream::getFilters

(

)

Get all filters defined for this stream.

Return values

PdfType[]

Exceptions

PdfTypeException

getStream()

PdfStream::getStream

(

$cache = false

)

Get the stream data.

Parameters

bool

$cache

Whether cache the stream data or not.

Return values

bool|string

Exceptions

PdfTypeException
CrossReferenceException
PdfParserException

getUnfilteredStream()

PdfStream::getUnfilteredStream

(

)

Get the unfiltered stream data.

Return values

string

Exceptions

FilterException
PdfParserException

parse()

static PdfStream::parse ( PdfDictionary $dictionary, StreamReader $reader, PdfParser $parser = null )

static

Parses a stream from a stream reader.

Parameters

PdfDictionary	$dictionary
StreamReader	$reader
PdfParser	$parser	Optional to keep backwards compatibility

Return values

self

Exceptions

PdfTypeException

resolve()

static PdfType::resolve ( PdfType $value, PdfParser $parser, $stopAtIndirectObject = false )

staticinherited

Resolves a PdfType value to its value.

This method is used to evaluate indirect and direct object references until a final value is reached.

Parameters

PdfType	$value
PdfParser	$parser
bool	$stopAtIndirectObject

Return values

PdfType

Exceptions

CrossReferenceException
PdfParserException

---

The documentation for this class was generated from the following file:

• mod/assign/feedback/editpdf/fpdi/PdfParser/Type/PdfStream.php