Справочник Enums
TCPDF-Next использует backed enums PHP 8.1+ по всей библиотеке для замены слаботипизированных строковых и целочисленных констант. На этой странице описан каждый enum, его case-ы и типичное использование.
Orientation
Namespace: TcpdfNext\Contracts\Orientation
Ориентация страницы.
| Case | Описание |
|---|---|
Portrait | Выше, чем шире (по умолчанию) |
Landscape | Шире, чем выше |
use TcpdfNext\Contracts\Orientation;
$pdf->addPage(orientation: Orientation::Landscape);Alignment
Namespace: TcpdfNext\Contracts\Alignment
Горизонтальное выравнивание текста и контента.
| Case | Описание |
|---|---|
Left | Выравнивание по левому полю |
Center | По центру между полями |
Right | Выравнивание по правому полю |
Justified | Растягивание текста на всю ширину |
use TcpdfNext\Contracts\Alignment;
$pdf->multiCell(width: 0, height: 10, text: $paragraph, align: Alignment::Justified);OutputDestination
Namespace: TcpdfNext\Contracts\OutputDestination
Куда отправить отрендеренный PDF.
| Case | Описание |
|---|---|
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
Namespace: TcpdfNext\Contracts\SignatureLevel
Уровень соответствия цифровой подписи PAdES по ETSI EN 319 142.
| Case | Описание |
|---|---|
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
Namespace: TcpdfNext\Graphics\BlendMode
Режимы наложения прозрачности PDF по ISO 32000-2 Section 11.3.5.
| Case | Описание |
|---|---|
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
Namespace: TcpdfNext\Barcode\BarcodeType
Поддерживаемые символики 1D-штрихкодов.
| Case | Описание |
|---|---|
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 (Interleaved 2 of 5) |
CODABAR | Codabar |
PHARMACODE | Pharmacode |
MSI | MSI Plessey |
POSTNET | POSTNET (почтовый США) |
Barcode2DType
Namespace: TcpdfNext\Barcode\Barcode2DType
Поддерживаемые символики 2D-штрихкодов.
| Case | Описание |
|---|---|
QR_CODE | QR Code (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
Namespace: TcpdfNext\Form\FormFieldType
Типы полей AcroForm.
| Case | Описание |
|---|---|
TEXT | Однострочное текстовое поле ввода |
PASSWORD | Текстовое поле пароля (маскированное) |
TEXTAREA | Многострочное текстовое поле ввода |
CHECKBOX | Переключатель чекбокс |
RADIO | Радиокнопка (часть группы) |
LISTBOX | Прокручиваемый список выбора |
COMBOBOX | Выпадающий список выбора |
BUTTON | Кнопка с опциональным JavaScript-действием |
PdfAVersion
Namespace: TcpdfNext\Archive\PdfAVersion
Версии соответствия PDF/A, поддерживаемые TCPDF-Next.
| Case | Описание |
|---|---|
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
Namespace: TcpdfNext\Typography\FontType
Поддерживаемые типы форматов шрифтов.
| Case | Описание |
|---|---|
TrueType | Шрифты TrueType (.ttf) |
OpenType | Шрифты OpenType (.otf, контуры CFF или glyf) |
Type1 | Шрифты PostScript Type 1 (.pfb/.pfm) |
Core | Один из 14 стандартных (Base 14) шрифтов PDF -- встраивание не требуется |
ColorSpace
Namespace: TcpdfNext\Graphics\ColorSpace
Идентификаторы цветовых пространств PDF.
| Case | Описание |
|---|---|
DeviceRGB | Red / Green / Blue (экран) |
DeviceCMYK | Cyan / Magenta / Yellow / Key (печать) |
DeviceGray | Одноканальные оттенки серого |
Separation | Именованный канал плашечного цвета |
use TcpdfNext\Graphics\ColorSpace;
$color = Color::fromSpace(ColorSpace::DeviceCMYK, [100, 0, 0, 0]);ObjectEntryType
Namespace: TcpdfNext\Core\ObjectEntryType
Классифицирует вид косвенного объекта PDF в ObjectRegistry.
| Case |
|---|
Catalog |
Pages |
Page |
Font |
FontDescriptor |
Image |
XObject |
ExtGState |
ColorSpace |
Pattern |
Shading |
Annotation |
Bookmark |
AcroField |
Signature |
Metadata |
OutputIntent |
StructElement |
Stream |
Generic |
AnnotationType
Namespace: TcpdfNext\Navigation\AnnotationType
Типы аннотаций разметки по ISO 32000-2 Section 12.5.6.
| Case | Описание |
|---|---|
Text | Иконка заметки |
Highlight | Выделение текстовой разметки |
Underline | Подчёркивание текстовой разметки |
StrikeOut | Зачёркивание текстовой разметки |
Squiggly | Волнистое подчёркивание текстовой разметки |
FreeText | Инлайн текстовая выноска |
LineCapStyle
Namespace: TcpdfNext\Graphics\LineCapStyle
Стили окончания линий по ISO 32000-2 Section 8.4.3.3.
| Case | Значение | Описание |
|---|---|---|
Butt | 0 | Квадратное окончание вровень с конечной точкой |
Round | 1 | Полукруглое окончание, выступающее за конечную точку |
Square | 2 | Квадратное окончание, выступающее за конечную точку |
LineJoinStyle
Namespace: TcpdfNext\Graphics\LineJoinStyle
Стили соединения линий по ISO 32000-2 Section 8.4.3.4.
| Case | Значение | Описание |
|---|---|---|
Miter | 0 | Острый угол |
Round | 1 | Скруглённый угол |
Bevel | 2 | Диагональный плоский угол |
TextDirection
Namespace: TcpdfNext\Typography\TextDirection
Направление текста для двунаправленного (BiDi) рендеринга.
| Case | Описание |
|---|---|
LeftToRight | По умолчанию (LTR) |
RightToLeft | Справа налево (арабский, иврит) |
Auto | Определение по первому сильному символу |
HashAlgorithm
Namespace: TcpdfNext\Security\HashAlgorithm
Алгоритмы хеширования, используемые в подписях и шифровании.
| Case | Описание |
|---|---|
SHA256 | SHA-256 (по умолчанию, рекомендуемый) |
SHA384 | SHA-384 |
SHA512 | SHA-512 |
PermissionFlag
Namespace: TcpdfNext\Security\PermissionFlag
Флаги разрешений документа для setProtection().
| Case | Описание |
|---|---|
Print | Разрешить печать |
PrintHighRes | Разрешить высококачественную печать |
Modify | Разрешить модификацию документа |
Copy | Разрешить извлечение текста и изображений |
AnnotForms | Разрешить аннотации и заполнение форм |
FillForms | Разрешить только заполнение форм |
Extract | Разрешить извлечение текста для доступности |
Assemble | Разрешить вставку, поворот, удаление страниц |
ErrorCorrectionLevel
Namespace: TcpdfNext\Barcode\ErrorCorrectionLevel
Уровни коррекции ошибок QR Code по ISO 18004.
| Case | Восстановительная способность |
|---|---|
Low | ~7% |
Medium | ~15% |
Quartile | ~25% |
High | ~30% |
См. также
- Обзор API -- Все пакеты одним взглядом
- API документа -- Методы, принимающие эти enum-ы как параметры
- Справочник интерфейсов -- Контракты, ссылающиеся на эти enum-ы