3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
34 * @copyright CiviCRM LLC (c) 2004-2019
36 class CRM_Utils_PDF_Utils
{
40 * List of HTML snippets.
41 * @param string $fileName
42 * The logical filename to display.
43 * Ex: "HelloWorld.pdf".
45 * FALSE to display PDF. TRUE to return as string.
46 * @param null $pdfFormat
47 * Unclear. Possibly PdfFormat or formValues.
51 public static function html2pdf($text, $fileName = 'civicrm.pdf', $output = FALSE, $pdfFormat = NULL) {
52 if (is_array($text)) {
56 $pages = array($text);
58 // Get PDF Page Format
59 $format = CRM_Core_BAO_PdfFormat
::getDefaultValues();
60 if (is_array($pdfFormat)) {
61 // PDF Page Format parameters passed in
62 $format = array_merge($format, $pdfFormat);
64 elseif (!empty($pdfFormat)) {
65 // PDF Page Format ID passed in
66 $format = CRM_Core_BAO_PdfFormat
::getById($pdfFormat);
68 $paperSize = CRM_Core_BAO_PaperSize
::getByName($format['paper_size']);
69 $paper_width = self
::convertMetric($paperSize['width'], $paperSize['metric'], 'pt');
70 $paper_height = self
::convertMetric($paperSize['height'], $paperSize['metric'], 'pt');
71 // dompdf requires dimensions in points
72 $paper_size = array(0, 0, $paper_width, $paper_height);
73 $orientation = CRM_Core_BAO_PdfFormat
::getValue('orientation', $format);
74 $metric = CRM_Core_BAO_PdfFormat
::getValue('metric', $format);
75 $t = CRM_Core_BAO_PdfFormat
::getValue('margin_top', $format);
76 $r = CRM_Core_BAO_PdfFormat
::getValue('margin_right', $format);
77 $b = CRM_Core_BAO_PdfFormat
::getValue('margin_bottom', $format);
78 $l = CRM_Core_BAO_PdfFormat
::getValue('margin_left', $format);
80 $margins = array($metric, $t, $r, $b, $l);
82 // Add a special region for the HTML header of PDF files:
83 $pdfHeaderRegion = CRM_Core_Region
::instance('export-document-header', FALSE);
84 $htmlHeader = ($pdfHeaderRegion) ?
$pdfHeaderRegion->render('', FALSE) : '';
89 <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"/>
90 <style>@page { margin: {$t}{$metric} {$r}{$metric} {$b}{$metric} {$l}{$metric}; }</style>
91 <style type=\"text/css\">@import url(" . CRM_Core_Config
::singleton()->userFrameworkResourceURL
. "css/print.css);</style>
95 <div id=\"crm-container\">\n";
97 // Strip <html>, <header>, and <body> tags from each page
98 $htmlElementstoStrip = [
99 '@<head[^>]*?>.*?</head>@siu',
100 '@<script[^>]*?>.*?</script>@siu',
105 '@<!DOCTYPE[^>]*?>@siu',
107 $htmlElementsInstead = ['', '', '', '', '', ''];
108 foreach ($pages as & $page) {
109 $page = preg_replace($htmlElementstoStrip,
110 $htmlElementsInstead,
114 // Glue the pages together
115 $html .= implode("\n<div style=\"page-break-after: always\"></div>\n", $pages);
120 if (CRM_Core_Config
::singleton()->wkhtmltopdfPath
) {
121 return self
::_html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName);
124 return self
::_html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName);
129 * Convert html to tcpdf.
132 * @param $orientation
137 * @param $stationery_path
139 public static function _html2pdf_tcpdf($paper_size, $orientation, $margins, $html, $output, $fileName, $stationery_path) {
140 // Documentation on the TCPDF library can be found at: http://www.tcpdf.org
141 // This function also uses the FPDI library documented at: http://www.setasign.com/products/fpdi/about/
142 // Syntax borrowed from https://github.com/jake-mw/CDNTaxReceipts/blob/master/cdntaxreceipts.functions.inc
143 require_once 'tcpdf/tcpdf.php';
144 require_once 'FPDI/fpdi.php'; // This library is only in the 'packages' area as of version 4.5
146 $paper_size_arr = array($paper_size[2], $paper_size[3]);
148 $pdf = new TCPDF($orientation, 'pt', $paper_size_arr);
151 if (is_readable($stationery_path)) {
152 $pdf->SetStationery($stationery_path);
156 $pdf->SetKeywords('CiviCRM.org');
157 $pdf->setPageUnit($margins[0]);
158 $pdf->SetMargins($margins[4], $margins[1], $margins[2], TRUE);
160 $pdf->setJPEGQuality('100');
161 $pdf->SetAutoPageBreak(TRUE, $margins[3]);
171 // output the HTML content
172 $pdf->writeHTML($html, $ln, $fill, $reset_parm, $cell, $align);
174 // reset pointer to the last page
177 // close and output the PDF
179 $pdf_file = 'CiviLetter' . '.pdf';
180 $pdf->Output($pdf_file, 'D');
181 CRM_Utils_System
::civiExit();
186 * @param $orientation
189 * @param string $fileName
193 public static function _html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName) {
194 // CRM-12165 - Remote file support required for image handling.
195 $options = new Options();
196 $options->set('isRemoteEnabled', TRUE);
198 $dompdf = new DOMPDF($options);
199 $dompdf->set_paper($paper_size, $orientation);
200 $dompdf->load_html($html);
204 return $dompdf->output();
207 // CRM-19183 remove .pdf extension from filename
208 $fileName = basename($fileName, ".pdf");
209 $dompdf->stream($fileName);
215 * @param $orientation
219 * @param string $fileName
221 public static function _html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName) {
222 require_once 'packages/snappy/src/autoload.php';
223 $config = CRM_Core_Config
::singleton();
224 $snappy = new Knp\Snappy\
Pdf($config->wkhtmltopdfPath
);
225 $snappy->setOption("page-width", $paper_size[2] . "pt");
226 $snappy->setOption("page-height", $paper_size[3] . "pt");
227 $snappy->setOption("orientation", $orientation);
228 $snappy->setOption("margin-top", $margins[1] . $margins[0]);
229 $snappy->setOption("margin-right", $margins[2] . $margins[0]);
230 $snappy->setOption("margin-bottom", $margins[3] . $margins[0]);
231 $snappy->setOption("margin-left", $margins[4] . $margins[0]);
232 $pdf = $snappy->getOutputFromHtml($html);
237 CRM_Utils_System
::setHttpHeader('Content-Type', 'application/pdf');
238 CRM_Utils_System
::setHttpHeader('Content-Disposition', 'attachment; filename="' . $fileName . '"');
244 * convert value from one metric to another.
249 * @param null $precision
253 public static function convertMetric($value, $from, $to, $precision = NULL) {
254 switch ($from . $to) {
303 if (!is_null($precision)) {
304 $value = round($value, $precision);