Справочник API
Полный справочник API для каждого пакета экосистемы TCPDF-Next. Ниже перечислены все пакеты с их ключевыми классами и интерфейсами. Перейдите на специализированные страницы для получения информации о сигнатурах методов, параметрах и примерах использования.
Core
Пакет: tcpdf-next/core
| Класс | Описание |
|---|---|
Document | Центральная точка входа — fluent-фасад, делегирующий 12 трейтам |
ObjectRegistry | Отслеживает все косвенные объекты PDF и назначает уникальные номера объектов |
TransactionManager | Семантика точек сохранения / отката для сложных операций компоновки |
CrossReferenceStream | Строит бинарный поток перекрёстных ссылок PDF 2.0 |
Contracts
Пакет: tcpdf-next/contracts
| Интерфейс / Enum | Вид | Описание |
|---|---|---|
PdfDocumentInterface | Интерфейс | Основной API-контракт для любой реализации PDF-документа |
FontManagerInterface | Интерфейс | Контракт загрузки, регистрации и подмножественного встраивания шрифтов |
SignerInterface | Интерфейс | Абстракция провайдера цифровой подписи |
HsmSignerInterface | Интерфейс | Расширенный интерфейс подписи для аппаратных модулей безопасности |
Orientation | Enum | Ориентация страницы (Portrait, Landscape) |
Alignment | Enum | Выравнивание текста (Left, Center, Right, Justified) |
OutputDestination | Enum | Назначение вывода (Inline, Download, File, String) |
SignatureLevel | Enum | Уровень соответствия PAdES (B-B до B-LTA) |
Value Objects
Пакет: tcpdf-next/value-objects
| Класс | Описание |
|---|---|
PageSize | Именованный или пользовательский размер страницы с фабричными пресетами (A0 -- A6, Letter, Legal, Tabloid) |
Margin | Четырёхсторонние поля страницы (верх, право, низ, лево) |
Position | Неизменяемая координата x--y |
Dimension | Неизменяемая пара ширина--высота |
Unit | Хелперы преобразования единиц (мм, пт, см, дюйм) |
Graphics
Пакет: tcpdf-next/graphics
| Класс | Описание |
|---|---|
Color | Неизменяемое представление цвета (RGB, CMYK, Gray, Spot) |
ColorSpace | Enum для DeviceRGB, DeviceCMYK, DeviceGray, Separation |
BlendMode | Enum режимов наложения прозрачности (Normal, Multiply, Screen, Overlay, ...) |
LayerManager | Управление необязательными группами контента (OCG) |
GradientManager | Создание линейных и радиальных градиентов |
Typography
Пакет: tcpdf-next/typography
| Класс | Описание |
|---|---|
FontManager | Центральный реестр загрузки и управления шрифтами |
FontSubsetter | Создаёт минимальные подмножества шрифтов, содержащие только используемые глифы |
FontInfo | Readonly-объект данных, предоставляющий метрики глифов, ascender, descender |
BiDiResolver | Реализация алгоритма двунаправленного текста Unicode (UAX #9) |
Content
Пакет: tcpdf-next/content
| Класс | Описание |
|---|---|
TextRenderer | Высокоуровневый рендеринг текста с тенями и эффектами |
JavaScriptManager | Встраивает JavaScript-действия на уровне документа |
Layout
Пакет: tcpdf-next/layout
| Класс | Описание |
|---|---|
PageManager | Отслеживает страницы, обрабатывает разрывы, управляет состоянием текущей страницы |
HeaderFooterManager | Управление повторяющимся содержимым колонтитулов |
ColumnManager | Многоколоночный поток контента |
BookletManager | Импозиция страниц для печати брошюр с прошивкой внакидку |
Html
Пакет: tcpdf-next/html
| Класс | Описание |
|---|---|
HtmlParser | Парсит HTML-разметку в дерево DOM для рендеринга |
CssRule | Представляет одно разрешённое CSS-правило со специфичностью |
TableParser | Специализированный парсер для компоновки HTML-таблиц |
Form
Пакет: tcpdf-next/form
| Класс | Описание |
|---|---|
FormFieldManager | Создаёт и управляет полями AcroForm |
FormFieldType | Enum типов полей (Text, Password, Textarea, Checkbox, Radio, Listbox, Combobox, Button) |
Navigation
Пакет: tcpdf-next/navigation
| Класс | Описание |
|---|---|
BookmarkManager | Создаёт и вкладывает записи оглавления документа |
AnnotationManager | Добавляет аннотации разметки (выделение, заметка, подчёркивание) |
FileAttachment | Встраивает файловые вложения в документ |
TocManager | Автоматическая генерация оглавления |
Barcode
Пакет: tcpdf-next/barcode
| Класс | Описание |
|---|---|
BarcodeGenerator | Единая фабрика для всех типов штрихкодов |
BarcodeType | Enum для 1D-штрихкодов (CODE_39, CODE_128, EAN_13, ...) |
Barcode2DType | Enum для 2D-штрихкодов (QR_CODE, DATAMATRIX, PDF417) |
Security
Пакет: tcpdf-next/security
| Класс | Описание |
|---|---|
Aes256Encryptor | Шифрование AES-256 с обработчиком AESV3 |
DigitalSigner | Создание цифровых подписей PAdES |
TsaClient | Клиент RFC 3161 Time Stamping Authority |
LtvManager | Долгосрочная валидация через DSS, OCSP stapling и встраивание CRL |
DssBuilder | Строит словарь Document Security Store |
Archive
Пакет: tcpdf-next/archive
| Класс | Описание |
|---|---|
PdfAManager | Обеспечение и валидация соответствия PDF/A-4 |
XmpMetadata | Генерирует пакеты метаданных XMP (ISO 16684) |
OutputIntent | Управляет профилями назначения вывода ICC |
Accessibility
Пакет: tcpdf-next/accessibility
| Класс | Описание |
|---|---|
StructureTreeManager | Управляет деревом структуры тегированного PDF |
RoleMap | Отображает пользовательские теги на стандартные типы структуры PDF |
Writer
Пакет: tcpdf-next/writer
| Класс | Описание |
|---|---|
PdfWriter | Оркестрирует бинарный вывод PDF из реестра объектов |
Linearizer | Создаёт линеаризированный (оптимизированный для веба) PDF-вывод |
Laravel
Пакет: tcpdf-next/laravel
| Класс | Описание |
|---|---|
TcpdfServiceProvider | Регистрирует привязки и публикует конфигурацию |
Pdf (Facade) | Статический фасад для Document::createStandalone() |
PdfResponse | Возвращает PDF как HTTP-ответ Laravel |
GeneratePdfJob | Задание для очереди для фоновой генерации PDF |
Symfony
Пакет: tcpdf-next/symfony
| Класс | Описание |
|---|---|
TcpdfNextBundle | Регистрация бандла Symfony и подключение сервисов |
PdfFactory | DI-совместимая фабрика для создания PDF-документов |
PdfResponse | Возвращает PDF как HTTP-ответ Symfony |
GeneratePdfMessage | Сообщение Messenger для асинхронной генерации PDF |
CodeIgniter
Пакет: tcpdf-next/codeigniter
| Класс | Описание |
|---|---|
TcpdfNextService | Регистрация сервиса CodeIgniter |
PdfLibrary | Класс библиотеки для использования в контроллерах CodeIgniter |
PdfResponse | Возвращает PDF как HTTP-ответ CodeIgniter |
GeneratePdfJob | Задание для очереди для фоновой генерации PDF |
Artisan
Пакет: tcpdf-next/artisan
| Класс | Описание |
|---|---|
HtmlRenderer | Рендерит Blade / HTML-шаблоны в PDF через Chrome CDP |
ChromeBridge | Интеграция с Headless Chrome для попиксельного рендеринга |
RenderOptions | DTO конфигурации для команд рендеринга Artisan |
Adaptation
Пакет: tcpdf-next/adaptation
| Класс | Описание |
|---|---|
TCPDF | Non-final адаптер, отображающий 252 устаревших метода TCPDF на TCPDF-Next |
TCPDF_STATIC | Слой совместимости статических хелперов |
TCPDF_FONTS | Слой совместимости хелперов шрифтов |
TCPDF_COLORS | Слой совместимости хелперов цветов |
TCPDF_IMAGES | Слой совместимости хелперов изображений |
Дополнительное чтение
- API документа -- Каждый публичный метод класса
Document - Справочник Enums -- Все 22 enum-а со значениями и примерами
- Справочник интерфейсов -- Контрактные интерфейсы для DI и тестирования
- API объектов значений -- Фабричные методы, свойства и преобразования