EmbeddedFile
extends PdfStream
in package
Embedded file stream (/Type /EmbeddedFile) — ISO 32000-2 §7.11.4.
Carries the bytes of a file embedded in the PDF. The /Subtype holds the
MIME type (e.g. application/xml) with solidus characters escaped as
#2F per the /Name escaping rules.
Attributes
- #[RequiresPdfVersion]
- \Phpdftk\Pdf\Core\PdfVersion::V1_3
Table of Contents
Constants
- PDF_TYPE = 'EmbeddedFile'
Properties
- $data : string
- $dictionary : PdfDictionary
- $generationNumber : int
- $objectNumber : int
- $params : EmbeddedFileParams|null
- $subtype : PdfName|null
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.
Constants
PDF_TYPE
public
mixed
PDF_TYPE
= 'EmbeddedFile'
Properties
$data
public
string
$data
= ''
$dictionary
public
PdfDictionary
$dictionary
$generationNumber
public
int
$generationNumber
= 0
$objectNumber
public
int
$objectNumber
= 0
$params
public
EmbeddedFileParams|null
$params
= null
$subtype
public
PdfName|null
$subtype
= null
Methods
__construct()
public
__construct([string $data = '' ][, string|null $mimeType = null ]) : mixed
Parameters
- $data : string = ''
- $mimeType : string|null = null
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.