Skip to content

Таблица маппинга API

Эта страница предоставляет исчерпывающий маппинг каждого часто используемого метода TCPDF на его эквивалент в TCPDF-Next. Используйте её как справочник при миграции существующего кода.

Настройка документа

Устаревший TCPDFTCPDF-NextПримечания
new TCPDF($orientation, $unit, $format)PdfDocument::create()->setOrientation(...)->setPageFormat(...)->build()Именованные параметры, fluent builder
SetCreator($creator)->setCreator($creator)
SetAuthor($author)->setAuthor($author)
SetTitle($title)->setTitle($title)
SetSubject($subject)->setSubject($subject)
SetKeywords($keywords)->setKeywords([...])Массив вместо строки с запятыми
SetMargins($left, $top, $right)->setMargins(new Margins($left, $right, $top, $bottom))Value object
SetCellMargins($l, $t, $r, $b)TextBlock::create()->setPadding(...)Отступ для каждого элемента
SetAutoPageBreak($auto, $margin)->setAutoPageBreak($auto, bottomMargin: $margin)Именованный параметр
setLanguageArray($lang)->setLocale($locale)Стандартная строка локали
setFontSubsetting($enable)->getFontManager()->setSubsetting($enable)
SetDefaultMonospacedFont($font)$renderer->setDefaultMonoFont($font)
SetDisplayMode($zoom, $layout)->setViewerPreferences(zoom: $zoom, layout: $layout)
setImageScale($scale)Не требуетсяРазмеры на основе DPI
SetHeaderMargin($margin)->setMargins(new Margins(..., header: $margin))
SetFooterMargin($margin)->setMargins(new Margins(..., footer: $margin))
setPrintHeader($enable)Пропустить callback onPageHeader()
setPrintFooter($enable)Пропустить callback onPageFooter()

Управление страницами

Устаревший TCPDFTCPDF-NextПримечания
AddPage($orientation, $format)$pdf->addPage($format, $orientation)
endPage()АвтоматическиНеявно при следующем addPage()
getPage()$pdf->getCurrentPageNumber()
setPage($page)$pdf->getPage($pageNumber)
getNumPages()$pdf->getPageCount()
deletePage($page)$pdf->removePage($pageNumber)
movePage($from, $to)$pdf->movePage($from, $to)
copyPage($page)$pdf->duplicatePage($pageNumber)
lastPage()$pdf->getPage($pdf->getPageCount())
getPageWidth()$page->getWidth()
getPageHeight()$page->getHeight()
SetXY($x, $y)->setPosition($x, $y)Позиционирование для каждого элемента
GetX() / GetY()$page->getCursorX() / $page->getCursorY()
SetX($x) / SetY($y)$page->setCursor($x, $y)
getBreakMargin()$page->getBottomMargin()

Операции со шрифтами

Устаревший TCPDFTCPDF-NextПримечания
SetFont($family, $style, $size)$page->setFont($family, size: $size, style: FontStyle::BOLD)Enum для стиля
SetFontSize($size)$page->setFont(..., size: $size)
addTTFfont($fontfile)$pdf->getFontManager()->registerFont($path, $name)Стандартный TTF/OTF
getFontFamilyName()$page->getCurrentFont()->getFamily()
getFontSize()$page->getCurrentFont()->getSize()
getFontSizePt()$page->getCurrentFont()->getSizeInPoints()
isCharDefined($char)$font->hasGlyph($char)
GetStringWidth($string)$font->measureText($string, $size)->getWidth()
GetCharWidth($char)$font->getGlyphWidth($char, $size)
getNumLines($text, $width)$font->calculateLines($text, $width, $size)

Вывод текста

Устаревший TCPDFTCPDF-NextПримечания
Cell($w, $h, $txt, $border, $ln, $align)$page->addText($txt)->setSize($w, $h)->setAlignment(...)Fluent API
MultiCell($w, $h, $txt, $border, $align)$page->addParagraph($txt)->setWidth($w)->setAlignment(...)
Write($h, $txt, $link)$page->addText($txt)->setLineHeight($h)->setLink($link)
writeHTML($html)$renderer->writeHtml($html)Парсер на основе DOM
writeHTMLCell($w, $h, $x, $y, $html)$renderer->writeHtml($html, position: [$x, $y], width: $w)
Text($x, $y, $txt)$page->addText($txt)->setPosition($x, $y)
Ln($h)$page->advanceCursor($h)
SetTextColor($r, $g, $b)->setColor(Color::rgb($r, $g, $b))Value object
SetTextColorArray($color)->setColor(Color::fromArray($color))

Изображения

Устаревший TCPDFTCPDF-NextПримечания
Image($file, $x, $y, $w, $h, $type)$page->addImage($file)->setPosition($x,$y)->setSize($w,$h)Автоопределение формата
ImageEps($file, $x, $y, $w, $h)$page->addImage($file)->setPosition($x,$y)->setSize($w,$h)Единый API
ImageSVG($file, $x, $y, $w, $h)$page->addImage($file)->setPosition($x,$y)->setSize($w,$h)Единый API
setImageBuffer($image, $data)$page->addImage($binaryData, format: $fmt)
setJPEGQuality($quality)ImagePolicy::create()->setJpegQuality($quality)

Рисование и графика

Устаревший TCPDFTCPDF-NextПримечания
Line($x1, $y1, $x2, $y2)$canvas->drawLine($x1, $y1, $x2, $y2)->stroke()
Rect($x, $y, $w, $h, $style)$canvas->drawRect($x, $y, $w, $h)->fill() или ->stroke()
RoundedRect($x, $y, $w, $h, $r)$canvas->drawRoundedRect($x, $y, $w, $h, $r)
Circle($x, $y, $r)$canvas->drawCircle($x, $y, $r)
Ellipse($x, $y, $rx, $ry)$canvas->drawEllipse($x, $y, $rx, $ry)
Curve($x0,$y0,$x1,$y1,$x2,$y2,$x3,$y3)$canvas->moveTo($x0,$y0)->curveTo($x1,$y1,$x2,$y2,$x3,$y3)
Polygon($points)$canvas->drawPolygon($points)
RegularPolygon($x, $y, $r, $sides)$canvas->drawRegularPolygon($x, $y, $r, $sides)
Arrow($x0, $y0, $x1, $y1)$canvas->drawArrow($x0, $y0, $x1, $y1)
SetDrawColor($r, $g, $b)$canvas->setStrokeColor(Color::rgb($r, $g, $b))
SetFillColor($r, $g, $b)$canvas->setFillColor(Color::rgb($r, $g, $b))
SetDrawColorArray($color)$canvas->setStrokeColor(Color::fromArray($color))
SetFillColorArray($color)$canvas->setFillColor(Color::fromArray($color))
SetLineWidth($width)$canvas->setLineWidth($width)
SetLineStyle($style)$canvas->setLineStyle(LineStyle::from($style))
SetAlpha($alpha, $blend)$canvas->setOpacity($alpha)->setBlendMode($blend)

Трансформации

Устаревший TCPDFTCPDF-NextПримечания
StartTransform()$canvas->saveState()
StopTransform()$canvas->restoreState()
Translate($tx, $ty)$canvas->translate($tx, $ty)
Rotate($angle, $x, $y)$canvas->rotate($angle, $x, $y)
Scale($sx, $sy, $x, $y)$canvas->scale($sx, $sy, $x, $y)
MirrorH($x)$canvas->scale(-1, 1, $x, 0)
MirrorV($y)$canvas->scale(1, -1, 0, $y)
Skew($xAngle, $yAngle)$canvas->skew($xAngle, $yAngle)

Ссылки и закладки

Устаревший TCPDFTCPDF-NextПримечания
SetLink($link, $y, $page)$pdf->createInternalLink($page, $y)
AddLink()$pdf->createLink()
Link($x, $y, $w, $h, $link)$page->addLink($url)->setRect($x, $y, $w, $h)
Annotation($x, $y, $w, $h, $text)$page->addAnnotation($text)->setRect($x, $y, $w, $h)
Bookmark($txt, $level)$pdf->addBookmark($txt, level: $level)

Штрих-коды

Устаревший TCPDFTCPDF-NextПримечания
write1DBarcode($code, $type, ...)$page->addBarcode(BarcodeFactory::$type($code))->setPosition(...)Типобезопасная фабрика
write2DBarcode($code, 'QRCODE', ...)$page->addBarcode(BarcodeFactory::qrCode($code))->setPosition(...)
write2DBarcode($code, 'DATAMATRIX', ...)$page->addBarcode(BarcodeFactory::dataMatrix($code))->setPosition(...)
write2DBarcode($code, 'PDF417', ...)$page->addBarcode(BarcodeFactory::pdf417($code))->setPosition(...)

Шифрование и безопасность

Устаревший TCPDFTCPDF-NextПримечания
SetProtection($perms, $uPass, $oPass, $mode)$pdf->setEncryption()->setPermissions(...)->apply()Только AES-256
setSignature($cert, $key, $pass, $extra)$signer = new PdfSigner($pdf); $signer->setCertificate(...)Полная поддержка PAdES
setSignatureAppearance($x, $y, $w, $h)$signer->setSignatureField(new SignatureField(...))

TIP

Метод setSignature() TCPDF создаёт только базовые подписи PKCS#7. TCPDF-Next поддерживает полный PAdES B-B до B-LTA с интеграцией меток времени, встраиванием OCSP и Document Security Store. См. PAdES B-LTA.

Вывод

Устаревший TCPDFTCPDF-NextПримечания
Output($name, 'F')$pdf->save($path)Сохранение в файл
Output($name, 'D')Ответ фреймворка с Content-Disposition: attachment
Output($name, 'I')Ответ фреймворка с Content-Disposition: inline
Output($name, 'S')$pdf->toString()Возврат как бинарная строка
Output($name, 'FI')$pdf->save($path) + inline-ответ
Output($name, 'FD')$pdf->save($path) + download-ответ
Output($name, 'E')base64_encode($pdf->toString())

PDF/A и метаданные

Устаревший TCPDFTCPDF-NextПримечания
setPDFVersion($version)Всегда PDF 2.0Не настраивается
Не доступно->setPdfALevel(PdfALevel::PDF_A_4)Новая возможность
Не доступно->setPdfALevel(PdfALevel::PDF_A_4F)Новая возможность
setExtraXMP($xmp)$pdf->getMetadata()->setXmpProperty(...)

Методы без прямого эквивалента

Эти устаревшие методы TCPDF обрабатываются иначе в TCPDF-Next:

Устаревший TCPDFПримечания
setRTL($enable)Автоматически через алгоритм Unicode BiDi (UAX #9)
setTempPath($path)PdfDocument::create()->setTempDir(...)
setCellHeightRatio($ratio)Используйте явную высоту строки в текстовых блоках
setListIndentWidth($width)CSS padding-left для списков
setOpenCell($isopen)Не применимо (другая модель ячеек)
getHTMLUnitToUnits()Не применимо (автоматическое преобразование единиц)
pixelsToUnits($px)Units::pixelsToMm($px, $dpi)
unhtmlentities($text)htmlspecialchars_decode() (встроенная функция PHP)

Дополнительные материалы

Распространяется по лицензии LGPL-3.0-or-later.