添付ファイル

TCPDF-Nextは、PDFドキュメント内に任意のファイルを埋め込むことができます。添付ファイルシステムは Navigation\FileAttachment を通じて管理され、Document のフルーエントAPIからアクセスできます。添付ファイルはPDFと一緒に移動します。受信者はビューアから直接埋め込みファイルを取り出すことができます。

すべてのメソッドは static を返すため、メソッドチェーンが可能です。

クイックリファレンス

メソッド	用途
`addFileAttachment()`	PDFドキュメントにファイルを埋め込む

基本的な使用例

php

use Yeeefang\TcpdfNext\Core\Document;

$pdf = Document::create()
    ->addPage()
    ->setFont('Helvetica', '', 12)
    ->cell(0, 10, 'Invoice #2026-001', newLine: true)
    ->cell(0, 10, 'The original spreadsheet is attached to this PDF.', newLine: true)

    // サポートファイルを添付
    ->addFileAttachment('/path/to/invoice-data.xlsx', 'invoice-data.xlsx', 'Original invoice data')
    ->addFileAttachment('/path/to/zugferd.xml', 'factur-x.xml', 'Factur-X e-invoice XML')

    ->save('invoice-with-attachments.pdf');

addFileAttachment()

php

$pdf->addFileAttachment(
    string $file,
    string $name = '',
    string $desc = '',
    string $mimeType = '',
    string $relationship = 'Unspecified'
): static

パラメータ	型	説明
`$file`	`string`	埋め込むファイルの絶対パス
`$name`	`string`	ビューアの添付ファイルパネルに表示される名前（デフォルトは元のファイル名）
`$desc`	`string`	添付ファイルの人間が読める説明
`$mimeType`	`string`	MIMEタイプ（空の場合は自動検出）
`$relationship`	`string`	PDF 2.0関連ファイルの関係性（`Data`、`Source`、`Alternative`、`Supplement`、`Unspecified`）

一般的なユースケース

ソースデータ、補足ドキュメント、または高解像度オリジナルを添付します：

php

$pdf->addFileAttachment('/path/to/report-data.csv', 'report-data.csv', 'Raw CSV export')
    ->addFileAttachment('/path/to/terms.pdf', 'terms-and-conditions.pdf', 'Terms & Conditions')
    ->addFileAttachment('/path/to/photo-full.tiff', 'photo-full.tiff', 'Full-resolution original');

PDF/A-3およびPDF/A-4準拠

PDF/A-3およびPDF/A-4のアーカイブ標準では埋め込みファイルが許可されており、構造化データ交換に添付ファイルが不可欠です。最も代表的なユースケースは ZUGFeRD / Factur-X の電子インボイスで、機械可読なXMLインボイスが人間可読なPDFとともに埋め込まれます。

php

use Yeeefang\TcpdfNext\Core\Document;

$pdf = Document::create()
    ->setPDFVersion('2.0')
    ->addPage()
    ->setFont('Helvetica', '', 12)
    ->cell(0, 10, 'Electronic Invoice', newLine: true)
    ->cell(0, 10, 'This PDF contains a Factur-X XML attachment.', newLine: true)

    // Factur-X / ZUGFeRD 電子インボイスの添付
    ->addFileAttachment(
        '/path/to/factur-x.xml',
        'factur-x.xml',
        'Factur-X BASIC invoice data',
        'text/xml',
        'Data'
    )

    ->save('e-invoice.pdf');

TIP

PDF/A-3またはPDF/A-4を対象とする場合は、$relationship パラメータを設定して添付ファイルとドキュメントの関係を説明してください。一般的な値は Data（構造化データ表現）、Source（元のソースファイル）、Alternative（代替表現）です。