PdfStream
extends PdfObject
in package
Represents a PDF stream object: a dictionary + binary/text data.
The /Length entry in the dictionary is set automatically when toPdf() is called.
Table of Contents
Properties
- $data : string
- $dictionary : PdfDictionary
- $generationNumber : int
- $objectNumber : int
Methods
- __construct() : mixed
- setFilter() : void
- Set a filter to encode/decode the stream data.
- toIndirectObject() : string
- Wrap the object in an indirect object structure: X Y obj ... endobj
- toPdf() : string
- Returns the stream body: dictionary, stream keyword, data, endstream.
Properties
$data
public
string
$data
= ''
$dictionary
public
PdfDictionary
$dictionary
$generationNumber
public
int
$generationNumber
= 0
$objectNumber
public
int
$objectNumber
= 0
Methods
__construct()
public
__construct([PdfDictionary $dictionary = new PdfDictionary() ][, string $data = '' ]) : mixed
Parameters
- $dictionary : PdfDictionary = new PdfDictionary()
- $data : string = ''
setFilter()
Set a filter to encode/decode the stream data.
public
setFilter(FilterInterface $filter, string $pdfFilterName) : void
Parameters
- $filter : FilterInterface
-
The filter implementation
- $pdfFilterName : string
-
The PDF filter name (e.g. 'FlateDecode', 'ASCII85Decode')
toIndirectObject()
Wrap the object in an indirect object structure: X Y obj ... endobj
public
toIndirectObject() : string
Return values
stringtoPdf()
Returns the stream body: dictionary, stream keyword, data, endstream.
public
toPdf() : string
/Length is injected into the dictionary at serialization time. If a filter is set, the data is encoded before writing.