3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
36 class CRM_Utils_PDF_Utils
{
40 * @param string $fileName
42 * @param null $pdfFormat
46 public static function html2pdf(&$text, $fileName = 'civicrm.pdf', $output = FALSE, $pdfFormat = NULL) {
47 if (is_array($text)) {
51 $pages = array($text);
53 // Get PDF Page Format
54 $format = CRM_Core_BAO_PdfFormat
::getDefaultValues();
55 if (is_array($pdfFormat)) {
56 // PDF Page Format parameters passed in
57 $format = array_merge($format, $pdfFormat);
60 // PDF Page Format ID passed in
61 $format = CRM_Core_BAO_PdfFormat
::getById($pdfFormat);
63 $paperSize = CRM_Core_BAO_PaperSize
::getByName($format['paper_size']);
64 $paper_width = self
::convertMetric($paperSize['width'], $paperSize['metric'], 'pt');
65 $paper_height = self
::convertMetric($paperSize['height'], $paperSize['metric'], 'pt');
66 // dompdf requires dimensions in points
67 $paper_size = array(0, 0, $paper_width, $paper_height);
68 $orientation = CRM_Core_BAO_PdfFormat
::getValue('orientation', $format);
69 $metric = CRM_Core_BAO_PdfFormat
::getValue('metric', $format);
70 $t = CRM_Core_BAO_PdfFormat
::getValue('margin_top', $format);
71 $r = CRM_Core_BAO_PdfFormat
::getValue('margin_right', $format);
72 $b = CRM_Core_BAO_PdfFormat
::getValue('margin_bottom', $format);
73 $l = CRM_Core_BAO_PdfFormat
::getValue('margin_left', $format);
75 $stationery_path_partial = CRM_Core_BAO_PdfFormat
::getValue('stationery', $format);
77 $stationery_path = NULL;
78 if (strlen($stationery_path_partial)) {
79 $doc_root = $_SERVER['DOCUMENT_ROOT'];
80 $stationery_path = $doc_root . "/" . $stationery_path_partial;
83 $margins = array($metric, $t, $r, $b, $l);
85 $config = CRM_Core_Config
::singleton();
87 // Add a special region for the HTML header of PDF files:
88 $pdfHeaderRegion = CRM_Core_Region
::instance('export-document-header', FALSE);
89 $htmlHeader = ($pdfHeaderRegion) ?
$pdfHeaderRegion->render('', FALSE) : '';
94 <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"/>
95 <style>@page { margin: {$t}{$metric} {$r}{$metric} {$b}{$metric} {$l}{$metric}; }</style>
96 <style type=\"text/css\">@import url({$config->userFrameworkResourceURL}css/print.css);</style>
100 <div id=\"crm-container\">\n";
102 // Strip <html>, <header>, and <body> tags from each page
103 $htmlElementstoStrip = array(
104 '@<head[^>]*?>.*?</head>@siu',
105 '@<script[^>]*?>.*?</script>@siu',
110 '@<!DOCTYPE[^>]*?>@siu',
112 $htmlElementsInstead = array('', '', '', '', '', '');
113 foreach ($pages as & $page) {
114 $page = preg_replace($htmlElementstoStrip,
115 $htmlElementsInstead,
119 // Glue the pages together
120 $html .= implode("\n<div style=\"page-break-after: always\"></div>\n", $pages);
125 if ($config->wkhtmltopdfPath
) {
126 return self
::_html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName);
129 return self
::_html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName);
130 //return self::_html2pdf_tcpdf($paper_size, $orientation, $margins, $html, $output, $fileName, $stationery_path);
135 * Convert html to tcpdf.
138 * @param $orientation
143 * @param $stationery_path
145 public static function _html2pdf_tcpdf($paper_size, $orientation, $margins, $html, $output, $fileName, $stationery_path) {
146 // Documentation on the TCPDF library can be found at: http://www.tcpdf.org
147 // This function also uses the FPDI library documented at: http://www.setasign.com/products/fpdi/about/
148 // Syntax borrowed from https://github.com/jake-mw/CDNTaxReceipts/blob/master/cdntaxreceipts.functions.inc
149 require_once 'tcpdf/tcpdf.php';
150 require_once 'FPDI/fpdi.php'; // This library is only in the 'packages' area as of version 4.5
152 $paper_size_arr = array($paper_size[2], $paper_size[3]);
154 $pdf = new TCPDF($orientation, 'pt', $paper_size_arr);
157 if (is_readable($stationery_path)) {
158 $pdf->SetStationery($stationery_path);
162 $pdf->SetKeywords('CiviCRM.org');
163 $pdf->setPageUnit($margins[0]);
164 $pdf->SetMargins($margins[4], $margins[1], $margins[2], TRUE);
166 $pdf->setJPEGQuality('100');
167 $pdf->SetAutoPageBreak(TRUE, $margins[3]);
177 // output the HTML content
178 $pdf->writeHTML($html, $ln, $fill, $reset_parm, $cell, $align);
180 // reset pointer to the last page
183 // close and output the PDF
185 $pdf_file = 'CiviLetter' . '.pdf';
186 $pdf->Output($pdf_file, 'D');
187 CRM_Utils_System
::civiExit(1);
192 * @param $orientation
195 * @param string $fileName
199 public static function _html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName) {
200 // CRM-12165 - Remote file support required for image handling.
201 $options = new Options();
202 $options->set('isRemoteEnabled', TRUE);
204 $dompdf = new DOMPDF($options);
205 $dompdf->set_paper($paper_size, $orientation);
206 $dompdf->load_html($html);
210 return $dompdf->output();
213 // CRM-19183 remove .pdf extension from filename
214 $fileName = basename($fileName, ".pdf");
215 $dompdf->stream($fileName);
221 * @param $orientation
225 * @param string $fileName
227 public static function _html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName) {
228 require_once 'packages/snappy/src/autoload.php';
229 $config = CRM_Core_Config
::singleton();
230 $snappy = new Knp\Snappy\
Pdf($config->wkhtmltopdfPath
);
231 $snappy->setOption("page-width", $paper_size[2] . "pt");
232 $snappy->setOption("page-height", $paper_size[3] . "pt");
233 $snappy->setOption("orientation", $orientation);
234 $snappy->setOption("margin-top", $margins[1] . $margins[0]);
235 $snappy->setOption("margin-right", $margins[2] . $margins[0]);
236 $snappy->setOption("margin-bottom", $margins[3] . $margins[0]);
237 $snappy->setOption("margin-left", $margins[4] . $margins[0]);
238 $pdf = $snappy->getOutputFromHtml($html);
243 CRM_Utils_System
::setHttpHeader('Content-Type', 'application/pdf');
244 CRM_Utils_System
::setHttpHeader('Content-Disposition', 'attachment; filename="' . $fileName . '"');
250 * convert value from one metric to another.
255 * @param null $precision
259 public static function convertMetric($value, $from, $to, $precision = NULL) {
260 switch ($from . $to) {
309 if (!is_null($precision)) {
310 $value = round($value, $precision);