setasign\Fpdi\PdfParser\Type
PdfStream Class representing a PDF stream object
File: /FPDI v2/PdfParser/Type/PdfStream.php
Class hierarchy
Summary
Properties
$parser
The PDF parser instance.
$reader
The stream reader instance.
Static Methods
create()
ensure()
Ensures that the passed value is a PdfStream instance.
Parameters
- $stream : mixed
Exceptions
Throws PdfTypeException
ensureType()
Ensure that a value is an instance of a specific PDF type.
Parameters
- $type : string
- $value : PdfType
- $errorMessage : string
Exceptions
Throws PdfTypeException
flatten()
Flatten indirect object references to direct objects.
Parameters
- $value : PdfType
- $parser : \setasign\Fpdi\PdfParser\PdfParser
Exceptions
Throws \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
parse()
Parses a stream from a stream reader.
Parameters
- $dictionary : PdfDictionary
- $reader : \setasign\Fpdi\PdfParser\StreamReader
- $parser : \setasign\Fpdi\PdfParser\PdfParser
Optional to keep backwards compatibility
Exceptions
Throws PdfTypeException
resolve()
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
- $value : PdfType
- $parser : \setasign\Fpdi\PdfParser\PdfParser
- $stopAtIndirectObject : bool
Exceptions
Throws \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Methods
extractStream()
getFilters()
getStream()
Get the stream data.
Parameters
- $cache : bool
Whether cache the stream data or not.
Exceptions
Throws PdfTypeException
Throws \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException