列挙型リファレンス
TCPDF-Nextは、緩い型の文字列や整数定数を置き換えるために、ライブラリ全体でPHP 8.1+の値付き列挙型を使用しています。このページでは、すべての列挙型、そのケース、および典型的な使い方を説明します。
Orientation
名前空間: TcpdfNext\Contracts\Orientation
ページの向き。
| ケース | 説明 |
|---|---|
Portrait | 幅より高い（デフォルト） |
Landscape | 高さより広い |
use TcpdfNext\Contracts\Orientation;
$pdf->addPage(orientation: Orientation::Landscape);Alignment
名前空間: TcpdfNext\Contracts\Alignment
水平方向のテキストおよびコンテンツの配置。
| ケース | 説明 |
|---|---|
Left | 左マージンに揃える |
Center | マージン間で中央揃え |
Right | 右マージンに揃える |
Justified | テキストを全幅に伸ばして配置 |
use TcpdfNext\Contracts\Alignment;
$pdf->multiCell(width: 0, height: 10, text: $paragraph, align: Alignment::Justified);OutputDestination
名前空間: TcpdfNext\Contracts\OutputDestination
レンダリングされたPDFの送信先。
| ケース | 説明 |
|---|---|
Inline | Content-Disposition: inlineでブラウザに送信 |
Download | Content-Disposition: attachmentでブラウザに送信 |
File | ディスク上のファイルに書き込み |
String | 生のバイナリを文字列として返却 |
use TcpdfNext\Contracts\OutputDestination;
$binary = $pdf->output(OutputDestination::String);
$pdf->output(OutputDestination::File, path: '/reports/q4.pdf');SignatureLevel
名前空間: TcpdfNext\Contracts\SignatureLevel
ETSI EN 319 142に準拠したPAdESデジタル署名の適合レベル。
| ケース | 説明 |
|---|---|
PAdES_B_B | 署名証明書付きの基本署名 |
PAdES_B_T | 信頼されたRFC 3161タイムスタンプを追加 |
PAdES_B_LT | 長期検証用の検証データ（DSS、OCSP、CRL）を追加 |
PAdES_B_LTA | 無期限検証用のアーカイブタイムスタンプを追加 |
use TcpdfNext\Contracts\SignatureLevel;
$pdf->security()->sign(
certFile: '/certs/signer.p12',
password: 'secret',
level: SignatureLevel::PAdES_B_LTA,
);BlendMode
名前空間: TcpdfNext\Graphics\BlendMode
ISO 32000-2 セクション11.3.5に準拠したPDF透過ブレンドモード。
| ケース | 説明 |
|---|---|
Normal | デフォルトの合成 |
Multiply | 色を乗算して暗くする |
Screen | 反転、乗算、再反転して明るくする |
Overlay | ベース色に基づきMultiplyとScreenを組み合わせ |
Darken | ベース色とブレンド色の暗い方を選択 |
Lighten | ベース色とブレンド色の明るい方を選択 |
ColorDodge | ブレンド色を反映してベース色を明るくする |
ColorBurn | ブレンド色を反映してベース色を暗くする |
HardLight | ブレンド色に基づきMultiplyとScreenを組み合わせ |
SoftLight | 微妙な暗化または明化 |
Difference | 明るい色から暗い色を引く |
Exclusion | Differenceに似ているがコントラストが低い |
use TcpdfNext\Graphics\BlendMode;
$pdf->setAlpha(0.5, blendMode: BlendMode::Multiply);BarcodeType
名前空間: TcpdfNext\Barcode\BarcodeType
サポートされる1Dバーコードシンボロジー。
| ケース | 説明 |
|---|---|
CODE_39 | Code 39（英数字） |
CODE_39E | Code 39 Extended（全ASCII） |
CODE_93 | Code 93 |
CODE_128 | Code 128（自動モード切替） |
CODE_128A | Code 128 サブセットA |
CODE_128B | Code 128 サブセットB |
CODE_128C | Code 128 サブセットC（数字ペア） |
EAN_8 | EAN-8 |
EAN_13 | EAN-13 |
UPC_A | UPC-A |
UPC_E | UPC-E |
ITF_14 | ITF-14（インターリーブド2 of 5） |
CODABAR | Codabar |
PHARMACODE | Pharmacode |
MSI | MSI Plessey |
POSTNET | POSTNET（米国郵便） |
Barcode2DType
名前空間: TcpdfNext\Barcode\Barcode2DType
サポートされる2Dバーコードシンボロジー。
| ケース | 説明 |
|---|---|
QR_CODE | QRコード（ISO 18004）、設定可能な誤り訂正レベル（L/M/Q/H） |
DATAMATRIX | Data Matrix ECC 200（ISO 16022） |
PDF417 | PDF417（ISO 15438） |
use TcpdfNext\Barcode\Barcode2DType;
$pdf->barcode2D('https://example.com', Barcode2DType::QR_CODE, w: 30, h: 30);FormFieldType
名前空間: TcpdfNext\Form\FormFieldType
AcroFormフィールドタイプ。
| ケース | 説明 |
|---|---|
TEXT | 単一行テキスト入力 |
PASSWORD | パスワードテキスト入力（マスク表示） |
TEXTAREA | 複数行テキスト入力 |
CHECKBOX | チェックボックストグル |
RADIO | ラジオボタン（グループの一部） |
LISTBOX | スクロール可能なリスト選択 |
COMBOBOX | ドロップダウン選択 |
BUTTON | オプションのJavaScriptアクション付きプッシュボタン |
PdfAVersion
名前空間: TcpdfNext\Archive\PdfAVersion
TCPDF-Nextがサポートするpdf/A準拠バージョン。
| ケース | 説明 |
|---|---|
A4 | PDF/A-4（ISO 19005-4:2020）-- 基本準拠 |
A4f | PDF/A-4f -- 埋め込みファイルを許可 |
A4e | PDF/A-4e -- 3Dおよびリッチメディアコンテンツを許可 |
use TcpdfNext\Archive\PdfAVersion;
$pdf->archive()->enablePdfA(PdfAVersion::A4f);FontType
名前空間: TcpdfNext\Typography\FontType
サポートされるフォント形式タイプ。
| ケース | 説明 |
|---|---|
TrueType | TrueTypeフォント（.ttf） |
OpenType | OpenTypeフォント（.otf、CFFまたはglyfアウトライン） |
Type1 | PostScript Type 1フォント（.pfb/.pfm） |
Core | PDF標準（Base 14）フォントの1つ -- 埋め込み不要 |
ColorSpace
名前空間: TcpdfNext\Graphics\ColorSpace
PDFカラースペース識別子。
| ケース | 説明 |
|---|---|
DeviceRGB | 赤 / 緑 / 青（画面） |
DeviceCMYK | シアン / マゼンタ / イエロー / キー（印刷） |
DeviceGray | 単一チャネルグレースケール |
Separation | 名前付きスポットカラーチャネル |
use TcpdfNext\Graphics\ColorSpace;
$color = Color::fromSpace(ColorSpace::DeviceCMYK, [100, 0, 0, 0]);ObjectEntryType
名前空間: TcpdfNext\Core\ObjectEntryType
ObjectRegistry内のPDF間接オブジェクトの種類を分類します。
| ケース |
|---|
Catalog |
Pages |
Page |
Font |
FontDescriptor |
Image |
XObject |
ExtGState |
ColorSpace |
Pattern |
Shading |
Annotation |
Bookmark |
AcroField |
Signature |
Metadata |
OutputIntent |
StructElement |
Stream |
Generic |
AnnotationType
名前空間: TcpdfNext\Navigation\AnnotationType
ISO 32000-2 セクション12.5.6に準拠したマークアップ注釈タイプ。
| ケース | 説明 |
|---|---|
Text | 付箋アイコン |
Highlight | ハイライトテキストマークアップ |
Underline | 下線テキストマークアップ |
StrikeOut | 取り消し線テキストマークアップ |
Squiggly | 波線下線テキストマークアップ |
FreeText | インラインテキスト吹き出し |
LineCapStyle
名前空間: TcpdfNext\Graphics\LineCapStyle
ISO 32000-2 セクション8.4.3.3に準拠した線端スタイル。
| ケース | 値 | 説明 |
|---|---|---|
Butt | 0 | エンドポイントと同じ位置の四角キャップ |
Round | 1 | エンドポイントを超えて伸びる半円キャップ |
Square | 2 | エンドポイントを超えて伸びる四角キャップ |
LineJoinStyle
名前空間: TcpdfNext\Graphics\LineJoinStyle
ISO 32000-2 セクション8.4.3.4に準拠した線結合スタイル。
| ケース | 値 | 説明 |
|---|---|---|
Miter | 0 | 鋭角のコーナー |
Round | 1 | 丸いコーナー |
Bevel | 2 | 対角線の平らなコーナー |
TextDirection
名前空間: TcpdfNext\Typography\TextDirection
双方向（BiDi）レンダリング用のテキスト方向。
| ケース | 説明 |
|---|---|
LeftToRight | デフォルト（LTR） |
RightToLeft | 右から左（アラビア語、ヘブライ語） |
Auto | 最初の強い文字から検出 |
HashAlgorithm
名前空間: TcpdfNext\Security\HashAlgorithm
署名と暗号化で使用されるダイジェストアルゴリズム。
| ケース | 説明 |
|---|---|
SHA256 | SHA-256（デフォルト、推奨） |
SHA384 | SHA-384 |
SHA512 | SHA-512 |
PermissionFlag
名前空間: TcpdfNext\Security\PermissionFlag
setProtection()用のドキュメント権限フラグ。
| ケース | 説明 |
|---|---|
Print | 印刷を許可 |
PrintHighRes | 高解像度印刷を許可 |
Modify | ドキュメントの変更を許可 |
Copy | テキストと画像の抽出を許可 |
AnnotForms | 注釈とフォーム入力を許可 |
FillForms | フォーム入力のみを許可 |
Extract | アクセシビリティテキスト抽出を許可 |
Assemble | ページの挿入、回転、削除を許可 |
ErrorCorrectionLevel
名前空間: TcpdfNext\Barcode\ErrorCorrectionLevel
ISO 18004に準拠したQRコード誤り訂正レベル。
| ケース | 復元能力 |
|---|---|
Low | 約7% |
Medium | 約15% |
Quartile | 約25% |
High | 約30% |
関連項目
- API概要 -- すべてのパッケージを一覧で確認
- Document API -- これらの列挙型をパラメータとして受け取るメソッド
- インターフェースリファレンス -- これらの列挙型を参照するコントラクト