views/pdfLayouts/IPdfWriterEngine.php
Rama main · réplica de lectura del repositorio original.
<?php
namespace app\views\pdfLayouts;
use app\components\HTMLTools;
use Com\Tecnick\Pdf\CSS\ListStyle;
/**
* Extends the tc-lib-pdf rendering engine used by the TCPDF legacy facade to support
* Antragsgrün's non-standard list rendering (see HTMLTools for the reference implementation):
*
* - <ol> list styles set via class attribute (decimalDot, decimalCircle, lowerAlpha, upperAlpha),
* e.g. rendering "(1)" instead of "1." for decimalCircle.
* - Explicitly set values on <li> tags, including non-standard values like "1b".
* Numbers and single letters (a/A=1, b/B=2, ...) set the list counter, so counting
* continues from there; other values leave the counter unaffected.
* - The markers are still rendered separately, left of the actual text block.
*
* Additionally, some vertical spacing behaviors of TCPDF 6 that IPdfWriter::printMotionSection()
* and the PDF layouts rely on are restored.
*
* @phpstan-import-type THTMLRenderContext from \Com\Tecnick\Pdf\HTML
* @phpstan-import-type THTMLDOMNode from \Com\Tecnick\Pdf\HTML
*/
class IPdfWriterEngine extends \TCPDF_ENGINE
{
/** Block tags that should share the line with the list marker when they are the first child of a <li> */
private const LI_INLINE_BLOCK_TAGS = ['p', 'div', 'blockquote', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'pre'];
/** @var string|null The value attribute of the list item currently being opened, to be rendered verbatim */
private ?string $currentLiValue = null;
/**
* TCPDF 6 swallowed a <br> at the very beginning of a written cell (more precisely: a <br>
* that was only preceded by opening block tags). The markup created for line-numbered motion
* sections relies on this: IPdfWriter::printMotionSection() inserts an empty slot into the
* line number column for every line starting a list, pairing with the <br>-joined text lines.
*
* @param THTMLRenderContext $hrc
*/
protected function shouldSkipHTMLBrAdvance(array &$hrc, int $key, float $tpx): bool
{
if ($this->isBrOnlyPrecededByOpeningTags($hrc, $key)) {
return true;
}
return parent::shouldSkipHTMLBrAdvance($hrc, $key, $tpx);
}
/**
* @param THTMLRenderContext $hrc
*/
private function isBrOnlyPrecededByOpeningTags(array &$hrc, int $key): bool
{
// Read into a plain local variable first: PHPStan cannot keep the precise THTMLDOMNode
// shape for a chained access like $hrc['dom'][$k] inside a loop, since $hrc is by-ref
// and could in theory be mutated through another alias between iterations.
$dom = $hrc['dom'];
$ancestors = [];
$parent = $dom[$key]['parent'] ?? -1;
$guard = 0;
while ($parent >= 0 && $guard < 256) {
$ancestors[$parent] = true;
$next = $dom[$parent]['parent'] ?? -1;
if ($next === $parent) {
break;
}
$parent = $next;
$guard++;
}
for ($k = $key - 1; $k >= 0; $k--) {
$node = $dom[$k] ?? null;
if ($node === null) {
return true;
}
if (!$node['tag']) {
if (trim($node['value']) === '') {
continue; // whitespace between tags
}
return false;
}
if (!$node['opening'] || !isset($ancestors[$k])) {
return false;
}
}
return true;
}
/**
* The parent method applies a default 1em top/bottom margin to p/ol/ul/dl/blockquote/pre.
* Legacy TCPDF semantics, which the PDF layouts (and the line numbering next to motion texts)
* rely on: for tags explicitly configured through setHtmlVSpace(), that configuration defines
* the full vertical spacing - no default margins are added on top.
*
* @param array<int, THTMLDOMNode> $dom
*/
protected function parseHTMLAttributesBlockMargins(array &$dom, int $key): void
{
$node = $dom[$key] ?? null;
if ($node !== null && isset($this->tagvspaces[$node['value']])) {
return;
}
parent::parseHTMLAttributesBlockMargins($dom, $key);
}
/**
* The parent method starts a new line for every block element unless it is at the very top
* of the rendered cell. For a block element (like <p>) that is the first child of a <li>,
* this would place the text one line below the list marker. Suppress the vertical advance
* in this case, so the text starts on the same line as the marker.
* Nested <ol>/<ul> as the first child keep the line break, so their markers do not collide
* with the parent list's marker.
*
* @param THTMLRenderContext $hrc
*/
protected function openHTMLBlock(array &$hrc, int $key, float &$tpx, float &$tpy, float &$tpw): string
{
if ($this->isFirstBlockOfListItem($hrc, $key)) {
$prevOriginY = $hrc['cellctx']['originy'];
// Replicate the top-of-cell situation, in which the parent method applies no advance
$hrc['cellctx']['originy'] = $tpy;
$hrc['cellctx']['lineadvance'] = 0.0;
$hrc['cellctx']['linebottom'] = 0.0;
try {
return parent::openHTMLBlock($hrc, $key, $tpx, $tpy, $tpw);
} finally {
$hrc['cellctx']['originy'] = $prevOriginY;
}
}
return parent::openHTMLBlock($hrc, $key, $tpx, $tpy, $tpw);
}
/**
* @param THTMLRenderContext $hrc
*/
private function isFirstBlockOfListItem(array &$hrc, int $key): bool
{
// See isBrOnlyPrecededByOpeningTags() for why $hrc['dom'] is copied into a local
// variable before being indexed with a loop variable.
$dom = $hrc['dom'];
$elm = $dom[$key] ?? null;
if ($elm === null || !in_array($elm['value'], self::LI_INLINE_BLOCK_TAGS, true)) {
return false;
}
$parent = $dom[$elm['parent']] ?? null;
if ($parent === null || $parent['value'] !== 'li' || !$parent['tag']) {
return false;
}
// Only if nothing except whitespace comes between the <li> and this element
for ($k = $elm['parent'] + 1; $k < $key; $k++) {
$node = $dom[$k] ?? null;
if ($node === null || $node['tag'] || trim($node['value']) !== '') {
return false;
}
}
return true;
}
/**
* @param THTMLRenderContext $hrc
*/
protected function getHTMLListMarkerType(array &$hrc, int $key, bool $ordered): string
{
if ($ordered) {
$elm = $hrc['dom'][$key] ?? null;
if ($elm !== null && isset($elm['attribute']['class']) && is_string($elm['attribute']['class'])) {
$classes = explode(' ', $elm['attribute']['class']);
foreach (HTMLTools::KNOWN_OL_CLASSES as $olClass) {
if (in_array($olClass, $classes, true)) {
return $olClass;
}
}
}
}
return parent::getHTMLListMarkerType($hrc, $key, $ordered);
}
/**
* @param THTMLRenderContext $hrc
*/
protected function getHTMLListItemCounter(array &$hrc, int $key): int
{
$this->currentLiValue = null;
// The parent handles the regular counting, including numeric value attributes
$count = parent::getHTMLListItemCounter($hrc, $key);
$depth = $this->getHTMLListDepth($hrc);
if ($depth < 1) {
return $count;
}
$idx = $depth - 1;
if (!$this->isOrderedMarkerType($hrc['liststack'][$idx]['type'] ?? '')) {
return $count;
}
$elm = $hrc['dom'][$key] ?? null;
$value = ($elm !== null && isset($elm['attribute']['value']) && is_string($elm['attribute']['value'])) ? $elm['attribute']['value'] : '';
if ($value === '') {
return $count;
}
// Same semantics as HTMLTools::getNextLiCounter(): numbers (handled by the parent)
// and single letters set the counter, any other value (like "1b") leaves it unaffected
if (!is_numeric($value) && preg_match('/^[a-zA-Z]$/', $value)) {
$count = ord(strtolower($value)) - ord('a') + 1;
$hrc['liststack'][$idx]['count'] = $count;
}
// Explicitly set values are always rendered verbatim, as in HTMLTools::getLiValue()
$this->currentLiValue = $value;
return $count;
}
/**
* True for marker types rendering a counter, as opposed to bullets, images and no marker at all.
*/
private function isOrderedMarkerType(string $type): bool
{
if ($type === '' || $type === '!' || $type === '^' || str_starts_with($type, 'img|')) {
return false;
}
return !ListStyle::isUnordered($type);
}
/**
* @param array<string, mixed> $markerStyles
*/
protected function getHTMLliBullet(
int $depth,
int $count,
float $posx = 0,
float $posy = 0,
string $type = '',
array $markerStyles = [],
bool $inside = false,
float &$advance = 0.0,
): string {
$explicitValue = $this->currentLiValue;
$this->currentLiValue = null;
$isCustomFormat = in_array($type, HTMLTools::KNOWN_OL_CLASSES, true);
if ($explicitValue === null && !$isCustomFormat) {
return parent::getHTMLliBullet($depth, $count, $posx, $posy, $type, $markerStyles, $inside, $advance);
}
$advance = 0.0;
$format = $isCustomFormat ? $type : HTMLTools::OL_DECIMAL_DOT;
$text = HTMLTools::getLiValueFormatted($count, $explicitValue, $format);
// Replicates the text marker rendering of the parent method for ordered lists,
// drawing the marker left of the list item's text block
$markerState = [];
$markerPrefix = '';
if ($markerStyles !== []) {
$markerPrefix = $this->getStartMarkerStyle($markerStyles, $markerState);
}
$markerx = $this->placeHTMLliMarker($posx, $this->getStringWidth(' '), $this->getStringWidth($text), $inside, $advance);
$out = $this->getTextLine($text, $markerx, $posy);
if ($markerPrefix !== '') {
$out = $markerPrefix . $out;
}
if ($markerStyles !== []) {
$out .= $this->getStopMarkerStyle($markerState);
}
return $out;
}
}