FileSpec
extends PdfObject
in package
File specification dictionary (/Type /Filespec) — ISO 32000-2 §7.11.3.
Identifies an external file or an embedded file stream. Used by FileAttachment annotations, embedded-file name trees, and the Launch, ImportData, SubmitForm, and GoToE actions.
Attributes
- #[RequiresPdfVersion]
- \Phpdftk\Pdf\Core\PdfVersion::V1_3
Table of Contents
Constants
- PDF_TYPE = 'Filespec'
Properties
- $afRelationship : PdfName|null
- $ci : PdfReference|null
- $desc : PdfString|null
- $dos : PdfString|null
- $ef : PdfDictionary|null
- $f : PdfString|null
- $fs : PdfName|null
- $generationNumber : int
- $id : PdfArray|null
- $mac : PdfString|null
- $objectNumber : int
- $rf : PdfDictionary|null
- $uf : PdfString|null
- $unix : PdfString|null
- $volatile : bool|null
Methods
- __construct() : mixed
- attachEmbeddedFile() : void
- Attach an embedded file stream under the /F key of /EF.
- toIndirectObject() : string
- Wrap the object in an indirect object structure: X Y obj ... endobj
- toPdf() : string
- Serialize the object's dictionary/value to PDF syntax.
Constants
PDF_TYPE
public
mixed
PDF_TYPE
= 'Filespec'
Properties
$afRelationship
public
PdfName|null
$afRelationship
= null
Attributes
- #[RequiresPdfVersion]
- \Phpdftk\Pdf\Core\PdfVersion::V2_0
$ci
public
PdfReference|null
$ci
= null
$desc
public
PdfString|null
$desc
= null
$dos
public
PdfString|null
$dos
= null
$ef
public
PdfDictionary|null
$ef
= null
$f
public
PdfString|null
$f
= null
$fs
public
PdfName|null
$fs
= null
$generationNumber
public
int
$generationNumber
= 0
$id
public
PdfArray|null
$id
= null
$mac
public
PdfString|null
$mac
= null
$objectNumber
public
int
$objectNumber
= 0
$rf
public
PdfDictionary|null
$rf
= null
$uf
public
PdfString|null
$uf
= null
$unix
public
PdfString|null
$unix
= null
$volatile
public
bool|null
$volatile
= null
Methods
__construct()
public
__construct([string|null $fileName = null ]) : mixed
Parameters
- $fileName : string|null = null
attachEmbeddedFile()
Attach an embedded file stream under the /F key of /EF.
public
attachEmbeddedFile(PdfReference $stream) : void
Parameters
- $stream : PdfReference
toIndirectObject()
Wrap the object in an indirect object structure: X Y obj ... endobj
public
toIndirectObject() : string
Return values
stringtoPdf()
Serialize the object's dictionary/value to PDF syntax.
public
toPdf() : string