* * @var string */ public $alignRTL = 'left'; /** * LTR or RTL entity * * @var string */ public $entityRTL = '‎'; /** * Largest Font Height is used by TextBox etc. * * Use this to calculate a the text height. * This makes sure that the text fits into the cell/box when different font sizes are used * * @var float */ public $largestFontHeight = 0; /** * Keep track of the highest Y position * * Used with Header div / Body div / Footer div / "addpage" / The bottom of the last image etc. * * @var float */ public $maxY = 0; /** @var ReportHtmlFootnote[] Array of elements in the footer notes */ public $printedfootnotes = []; /** * HTML Setup - ReportHtml * * @return void */ public function setup(): void { parent::setup(); // Setting up the correct dimensions if Portrait (default) or Landscape if ($this->orientation === 'landscape') { $tmpw = $this->page_width; $this->page_width = $this->page_height; $this->page_height = $tmpw; } // Store the pagewidth without margins $this->noMarginWidth = $this->page_width - $this->left_margin - $this->right_margin; // If RTL if ($this->rtl) { $this->alignRTL = 'right'; $this->entityRTL = '‏'; } // Change the default HTML font name $this->default_font = 'Arial'; if ($this->show_generated_by) { // The default style name for Generated by.... is 'genby' $element = new ReportHtmlCell(0, 10, 0, 'C', '', 'genby', 1, ReportBaseElement::CURRENT_POSITION, ReportBaseElement::CURRENT_POSITION, 0, 0, '', '', true); $element->addText($this->generated_by); $element->setUrl(Webtrees::URL); $this->footerElements[] = $element; } } /** * Generate footnotes * * @return void */ public function footnotes(): void { $this->currentStyle = ''; if (!empty($this->printedfootnotes)) { foreach ($this->printedfootnotes as $element) { $element->renderFootnote($this); } } } /** * Run the report. * * @return void */ public function run(): void { // Setting up the styles echo '', PHP_EOL; echo ''; echo ''; echo ''; echo ''; echo ''; echo ''; echo ''; echo ''; echo ''; } /** * Create a new Cell object. * * @param int $width cell width (expressed in points) * @param int $height cell height (expressed in points) * @param mixed $border Border style * @param string $align Text alignement * @param string $bgcolor Background color code * @param string $style The name of the text style * @param int $ln Indicates where the current position should go after the call * @param mixed $top Y-position * @param mixed $left X-position * @param int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 1 * @param int $stretch Stretch character mode * @param string $bocolor Border color * @param string $tcolor Text color * @param bool $reseth * * @return ReportBaseCell */ public function createCell(int $width, int $height, $border, string $align, string $bgcolor, string $style, int $ln, $top, $left, int $fill, int $stretch, string $bocolor, string $tcolor, bool $reseth): ReportBaseCell { return new ReportHtmlCell($width, $height, $border, $align, $bgcolor, $style, $ln, $top, $left, $fill, $stretch, $bocolor, $tcolor, $reseth); } /** * Create a new TextBox object. * * @param float $width Text box width * @param float $height Text box height * @param bool $border * @param string $bgcolor Background color code in HTML * @param bool $newline * @param float $left * @param float $top * @param bool $pagecheck * @param string $style * @param bool $fill * @param bool $padding * @param bool $reseth * * @return ReportBaseTextbox */ public function createTextBox( float $width, float $height, bool $border, string $bgcolor, bool $newline, float $left, float $top, bool $pagecheck, string $style, bool $fill, bool $padding, bool $reseth ): ReportBaseTextbox { return new ReportHtmlTextbox($width, $height, $border, $bgcolor, $newline, $left, $top, $pagecheck, $style, $fill, $padding, $reseth); } /** * Create a text element. * * @param string $style * @param string $color * * @return ReportBaseText */ public function createText(string $style, string $color): ReportBaseText { return new ReportHtmlText($style, $color); } /** * Create a new Footnote object. * * @param string $style Style name * * @return ReportBaseFootnote */ public function createFootnote(string $style): ReportBaseFootnote { return new ReportHtmlFootnote($style); } /** * Create a new image object. * * @param string $file Filename * @param float $x * @param float $y * @param float $w Image width * @param float $h Image height * @param string $align L:left, C:center, R:right or empty to use x/y * @param string $ln T:same line, N:next line * * @return ReportBaseImage */ public function createImage(string $file, float $x, float $y, float $w, float $h, string $align, string $ln): ReportBaseImage { return new ReportHtmlImage($file, $x, $y, $w, $h, $align, $ln); } /** * Create a new image object from Media Object. * * @param MediaFile $media_file * @param float $x * @param float $y * @param float $w Image width * @param float $h Image height * @param string $align L:left, C:center, R:right or empty to use x/y * @param string $ln T:same line, N:next line * @param FilesystemOperator $data_filesystem * * @return ReportBaseImage */ public function createImageFromObject( MediaFile $media_file, float $x, float $y, float $w, float $h, string $align, string $ln, FilesystemOperator $data_filesystem ): ReportBaseImage { return new ReportHtmlImage($media_file->imageUrl((int) $w, (int) $h, 'crop'), $x, $y, $w, $h, $align, $ln); } /** * Create a line. * * @param float $x1 * @param float $y1 * @param float $x2 * @param float $y2 * * @return ReportBaseLine */ public function createLine(float $x1, float $y1, float $x2, float $y2): ReportBaseLine { return new ReportHtmlLine($x1, $y1, $x2, $y2); } /** * Clear the Header * * @return void */ public function clearHeader(): void { $this->headerElements = []; } /** * Update the Page Number and set a new Y if max Y is larger - ReportHtml * * @return void */ public function addPage(): void { $this->pageN++; // Add a little margin to max Y "between pages" $this->maxY += 10; // If Y is still heigher by any reason... if ($this->maxY < $this->Y) { // ... update max Y $this->maxY = $this->Y; } else { // else update Y so that nothing will be overwritten, like images or cells... $this->Y = $this->maxY; } } /** * Uppdate max Y to keep track it incase of a pagebreak - ReportHtml * * @param float $y * * @return void */ public function addMaxY($y): void { if ($this->maxY < $y) { $this->maxY = $y; } } /** * Checks the Footnote and numbers them - ReportHtml * * @param ReportHtmlFootnote $footnote * * @return ReportHtmlFootnote|bool object if already numbered, false otherwise */ public function checkFootnote(ReportHtmlFootnote $footnote) { $ct = count($this->printedfootnotes); $i = 0; $val = $footnote->getValue(); while ($i < $ct) { if ($this->printedfootnotes[$i]->getValue() === $val) { // If this footnote already exist then set up the numbers for this object $footnote->setNum($i + 1); $footnote->setAddlink((string) ($i + 1)); return $this->printedfootnotes[$i]; } $i++; } // If this Footnote has not been set up yet $footnote->setNum($ct + 1); $footnote->setAddlink((string) ($ct + 1)); $this->printedfootnotes[] = $footnote; return false; } /** * Count the number of lines - ReportHtml * * @param string $str * * @return int Number of lines. 0 if empty line */ public function countLines($str): int { if ($str === '') { return 0; } return substr_count($str, "\n") + 1; } /** * Get the current style. * * @return string */ public function getCurrentStyle(): string { return $this->currentStyle; } /** * Get the current style height. * * @return float */ public function getCurrentStyleHeight(): float { if (empty($this->currentStyle)) { return $this->default_font_size; } $style = $this->getStyle($this->currentStyle); return (float) $style['size']; } /** * Get the current footnotes height. * * @param float $cellWidth * * @return float */ public function getFootnotesHeight(float $cellWidth): float { $h = 0; foreach ($this->printedfootnotes as $element) { $h += $element->getFootnoteHeight($this, $cellWidth); } return $h; } /** * Get the maximum width from current position to the margin - ReportHtml * * @return float */ public function getRemainingWidth(): float { return $this->noMarginWidth - $this->X; } /** * Get the page height. * * @return float */ public function getPageHeight(): float { return $this->page_height - $this->top_margin; } /** * Get the width of a string. * * @param string $text * * @return float */ public function getStringWidth(string $text): float { $style = $this->getStyle($this->currentStyle); return mb_strlen($text) * ($style['size'] / 2); } /** * Get a text height in points - ReportHtml * * @param string $str * * @return float */ public function getTextCellHeight(string $str): float { // Count the number of lines to calculate the height $nl = $this->countLines($str); // Calculate the cell height return ceil($this->getCurrentStyleHeight() * $this->cellHeightRatio * $nl); } /** * Get the current X position - ReportHtml * * @return float */ public function getX(): float { return $this->X; } /** * Get the current Y position - ReportHtml * * @return float */ public function getY(): float { return $this->Y; } /** * Get the current page number - ReportHtml * * @return int */ public function pageNo(): int { return $this->pageN; } /** * Set the current style. * * @param string $s * * @void */ public function setCurrentStyle(string $s): void { $this->currentStyle = $s; } /** * Set the X position - ReportHtml * * @param float $x * * @return void */ public function setX(float $x): void { $this->X = $x; } /** * Set the Y position - ReportHtml * * Also updates Max Y position * * @param float $y * * @return void */ public function setY(float $y): void { $this->Y = $y; if ($this->maxY < $y) { $this->maxY = $y; } } /** * Set the X and Y position - ReportHtml * * Also updates Max Y position * * @param float $x * @param float $y * * @return void */ public function setXy(float $x, float $y): void { $this->setX($x); $this->setY($y); } /** * Wrap text - ReportHtml * * @param string $str Text to wrap * @param float $width Width in points the text has to fit into * * @return string */ public function textWrap(string $str, float $width): string { $line_width = (int) ($width / ($this->getCurrentStyleHeight() / 2)); $lines = explode("\n", $str); $lines = array_map(fn (string $string): string => $this->utf8WordWrap($string, $line_width), $lines); return implode("\n", $lines); } /** * Wrap text, similar to the PHP wordwrap() function. * * @param string $string * @param int $width * * @return string */ private function utf8WordWrap(string $string, int $width): string { $out = ''; while ($string) { if (mb_strlen($string) <= $width) { // Do not wrap any text that is less than the output area. $out .= $string; $string = ''; } else { $sub1 = mb_substr($string, 0, $width + 1); if (mb_substr($string, mb_strlen($sub1) - 1, 1) === ' ') { // include words that end by a space immediately after the area. $sub = $sub1; } else { $sub = mb_substr($string, 0, $width); } $spacepos = strrpos($sub, ' '); if ($spacepos === false) { // No space on line? $out .= $sub . "\n"; $string = mb_substr($string, mb_strlen($sub)); } else { // Split at space; $out .= substr($string, 0, $spacepos) . "\n"; $string = substr($string, $spacepos + 1); } } } return $out; } /** * Write text - ReportHtml * * @param string $text Text to print * @param string $color HTML RGB color code (Ex: #001122) * @param bool $useclass * * @return void */ public function write(string $text, string $color = '', bool $useclass = true): void { $style = $this->getStyle($this->getCurrentStyle()); $htmlcode = ''; $htmlcode = str_replace([ "\n", '> ', ' <', ], [ '
', '> ', ' <', ], $htmlcode); echo $htmlcode; } }