3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
19 * @copyright CiviCRM LLC https://civicrm.org/licensing
21 class CRM_Utils_PDF_Utils
{
25 * List of HTML snippets.
26 * @param string $fileName
27 * The logical filename to display.
28 * Ex: "HelloWorld.pdf".
30 * FALSE to display PDF. TRUE to return as string.
31 * @param null $pdfFormat
32 * Unclear. Possibly PdfFormat or formValues.
36 public static function html2pdf($text, $fileName = 'civicrm.pdf', $output = FALSE, $pdfFormat = NULL) {
37 if (is_array($text)) {
43 // Get PDF Page Format
44 $format = CRM_Core_BAO_PdfFormat
::getDefaultValues();
45 if (is_array($pdfFormat)) {
46 // PDF Page Format parameters passed in
47 $format = array_merge($format, $pdfFormat);
49 elseif (!empty($pdfFormat)) {
50 // PDF Page Format ID passed in
51 $format = CRM_Core_BAO_PdfFormat
::getById($pdfFormat);
53 $paperSize = CRM_Core_BAO_PaperSize
::getByName($format['paper_size']);
54 $paper_width = self
::convertMetric($paperSize['width'], $paperSize['metric'], 'pt');
55 $paper_height = self
::convertMetric($paperSize['height'], $paperSize['metric'], 'pt');
56 // dompdf requires dimensions in points
57 $paper_size = [0, 0, $paper_width, $paper_height];
58 $orientation = CRM_Core_BAO_PdfFormat
::getValue('orientation', $format);
59 $metric = CRM_Core_BAO_PdfFormat
::getValue('metric', $format);
60 $t = CRM_Core_BAO_PdfFormat
::getValue('margin_top', $format);
61 $r = CRM_Core_BAO_PdfFormat
::getValue('margin_right', $format);
62 $b = CRM_Core_BAO_PdfFormat
::getValue('margin_bottom', $format);
63 $l = CRM_Core_BAO_PdfFormat
::getValue('margin_left', $format);
65 $margins = [$metric, $t, $r, $b, $l];
67 // Add a special region for the HTML header of PDF files:
68 $pdfHeaderRegion = CRM_Core_Region
::instance('export-document-header', FALSE);
69 $htmlHeader = ($pdfHeaderRegion) ?
$pdfHeaderRegion->render('', FALSE) : '';
74 <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"/>
75 <style>@page { margin: {$t}{$metric} {$r}{$metric} {$b}{$metric} {$l}{$metric}; }</style>
76 <style type=\"text/css\">@import url(" . CRM_Core_Config
::singleton()->userFrameworkResourceURL
. "css/print.css);</style>
80 <div id=\"crm-container\">\n";
82 // Strip <html>, <header>, and <body> tags from each page
84 $htmlElementstoStrip = [
85 '<head[^>]*?>.*?</head>',
86 '<script[^>]*?>.*?</script>',
93 foreach ($pages as & $page) {
94 foreach ($htmlElementstoStrip as $pattern) {
95 $page = mb_eregi_replace($pattern, '', $page);
98 // Glue the pages together
99 $html .= implode("\n<div style=\"page-break-after: always\"></div>\n", $pages);
104 if (CRM_Core_Config
::singleton()->wkhtmltopdfPath
) {
105 return self
::_html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName);
108 return self
::_html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName);
113 * Convert html to tcpdf.
116 * @param $orientation
121 * @param $stationery_path
123 public static function _html2pdf_tcpdf($paper_size, $orientation, $margins, $html, $output, $fileName, $stationery_path) {
124 // Documentation on the TCPDF library can be found at: http://www.tcpdf.org
125 // This function also uses the FPDI library documented at: http://www.setasign.com/products/fpdi/about/
126 // Syntax borrowed from https://github.com/jake-mw/CDNTaxReceipts/blob/master/cdntaxreceipts.functions.inc
127 require_once 'tcpdf/tcpdf.php';
128 // This library is only in the 'packages' area as of version 4.5
129 require_once 'FPDI/fpdi.php';
131 $paper_size_arr = [$paper_size[2], $paper_size[3]];
133 $pdf = new TCPDF($orientation, 'pt', $paper_size_arr);
136 if (is_readable($stationery_path)) {
137 $pdf->SetStationery($stationery_path);
141 $pdf->SetKeywords('CiviCRM.org');
142 $pdf->setPageUnit($margins[0]);
143 $pdf->SetMargins($margins[4], $margins[1], $margins[2], TRUE);
145 $pdf->setJPEGQuality('100');
146 $pdf->SetAutoPageBreak(TRUE, $margins[3]);
156 // output the HTML content
157 $pdf->writeHTML($html, $ln, $fill, $reset_parm, $cell, $align);
159 // reset pointer to the last page
162 // close and output the PDF
164 $pdf_file = 'CiviLetter' . '.pdf';
165 $pdf->Output($pdf_file, 'D');
166 CRM_Utils_System
::civiExit();
171 * @param $orientation
174 * @param string $fileName
178 public static function _html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName) {
179 // CRM-12165 - Remote file support required for image handling.
180 $options = new Options();
181 $options->set('isRemoteEnabled', TRUE);
183 $dompdf = new DOMPDF($options);
184 $dompdf->set_paper($paper_size, $orientation);
185 $dompdf->load_html($html);
189 return $dompdf->output();
192 // CRM-19183 remove .pdf extension from filename
193 $fileName = basename($fileName, ".pdf");
194 $dompdf->stream($fileName);
200 * @param $orientation
204 * @param string $fileName
206 public static function _html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName) {
207 require_once 'packages/snappy/src/autoload.php';
208 $config = CRM_Core_Config
::singleton();
209 $snappy = new Knp\Snappy\
Pdf($config->wkhtmltopdfPath
);
210 $snappy->setOption("page-width", $paper_size[2] . "pt");
211 $snappy->setOption("page-height", $paper_size[3] . "pt");
212 $snappy->setOption("orientation", $orientation);
213 $snappy->setOption("margin-top", $margins[1] . $margins[0]);
214 $snappy->setOption("margin-right", $margins[2] . $margins[0]);
215 $snappy->setOption("margin-bottom", $margins[3] . $margins[0]);
216 $snappy->setOption("margin-left", $margins[4] . $margins[0]);
217 $pdf = $snappy->getOutputFromHtml($html);
222 CRM_Utils_System
::setHttpHeader('Content-Type', 'application/pdf');
223 CRM_Utils_System
::setHttpHeader('Content-Disposition', 'attachment; filename="' . $fileName . '"');
229 * convert value from one metric to another.
234 * @param null $precision
238 public static function convertMetric($value, $from, $to, $precision = NULL) {
239 switch ($from . $to) {
288 if (!is_null($precision)) {
289 $value = round($value, $precision);