3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Utils_PDF_Utils
{
39 * @param string $fileName
41 * @param null $pdfFormat
45 static function html2pdf(&$text, $fileName = 'civicrm.pdf', $output = FALSE, $pdfFormat = NULL) {
46 if (is_array($text)) {
50 $pages = array($text);
52 // Get PDF Page Format
53 $format = CRM_Core_BAO_PdfFormat
::getDefaultValues();
54 if (is_array($pdfFormat)) {
55 // PDF Page Format parameters passed in
56 $format = array_merge($format, $pdfFormat);
59 // PDF Page Format ID passed in
60 $format = CRM_Core_BAO_PdfFormat
::getById($pdfFormat);
62 $paperSize = CRM_Core_BAO_PaperSize
::getByName($format['paper_size']);
63 $paper_width = self
::convertMetric($paperSize['width'], $paperSize['metric'], 'pt');
64 $paper_height = self
::convertMetric($paperSize['height'], $paperSize['metric'], 'pt');
65 // dompdf requires dimensions in points
66 $paper_size = array(0, 0, $paper_width, $paper_height);
67 $orientation = CRM_Core_BAO_PdfFormat
::getValue('orientation', $format);
68 $metric = CRM_Core_BAO_PdfFormat
::getValue('metric', $format);
69 $t = CRM_Core_BAO_PdfFormat
::getValue('margin_top', $format);
70 $r = CRM_Core_BAO_PdfFormat
::getValue('margin_right', $format);
71 $b = CRM_Core_BAO_PdfFormat
::getValue('margin_bottom', $format);
72 $l = CRM_Core_BAO_PdfFormat
::getValue('margin_left', $format);
73 $margins = array($metric,$t,$r,$b,$l);
75 $config = CRM_Core_Config
::singleton();
79 <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"/>
80 <style>@page { margin: {$t}{$metric} {$r}{$metric} {$b}{$metric} {$l}{$metric}; }</style>
81 <style type=\"text/css\">@import url({$config->userFrameworkResourceURL}css/print.css);</style>
84 <div id=\"crm-container\">\n";
86 // Strip <html>, <header>, and <body> tags from each page
87 $htmlElementstoStrip = array(
88 '@<head[^>]*?>.*?</head>@siu',
93 '@<!DOCTYPE[^>]*?>@siu',
95 $htmlElementsInstead = array('', '', '', '', '', '');
96 foreach ($pages as & $page) {
97 $page = preg_replace($htmlElementstoStrip,
102 // Glue the pages together
103 $html .= implode("\n<div style=\"page-break-after: always\"></div>\n", $pages);
108 if ($config->wkhtmltopdfPath
) {
109 return self
::_html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName);
112 return self
::_html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName);
118 * @param $orientation
125 static function _html2pdf_dompdf($paper_size, $orientation, $html, $output, $fileName) {
126 require_once 'packages/dompdf/dompdf_config.inc.php';
127 spl_autoload_register('DOMPDF_autoload');
128 $dompdf = new DOMPDF();
129 $dompdf->set_paper($paper_size, $orientation);
130 $dompdf->load_html($html);
134 return $dompdf->output();
137 $dompdf->stream($fileName);
143 * @param $orientation
149 static function _html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName) {
150 require_once 'packages/snappy/src/autoload.php';
151 $config = CRM_Core_Config
::singleton();
152 $snappy = new Knp\Snappy\
Pdf($config->wkhtmltopdfPath
);
153 $snappy->setOption("page-width", $paper_size[2] . "pt");
154 $snappy->setOption("page-height", $paper_size[3] . "pt");
155 $snappy->setOption("orientation", $orientation);
156 $snappy->setOption("margin-top", $margins[1] . $margins[0]);
157 $snappy->setOption("margin-right", $margins[2] . $margins[0]);
158 $snappy->setOption("margin-bottom", $margins[3] . $margins[0]);
159 $snappy->setOption("margin-left", $margins[4] . $margins[0]);
160 $pdf = $snappy->getOutputFromHtml($html);
165 header('Content-Type: application/pdf');
166 header('Content-Disposition: attachment; filename="' . $fileName . '"');
172 * function to convert value from one metric to another
178 * @param null $precision
182 static function convertMetric($value, $from, $to, $precision = NULL) {
183 switch ($from . $to) {
232 if (!is_null($precision)) {
233 $value = round($value, $precision);
242 * @param int $numPages
244 * @param string $output
245 * @param string $creator
246 * @param string $author
247 * @param string $title
249 static function &pdflib($fileName,
254 $output = 'College_Match_App',
255 $creator = 'CiviCRM',
256 $author = 'http://www.civicrm.org/',
257 $title = '2006 College Match Scholarship Application'
261 $pdf->set_parameter("compatibility", "1.6");
262 $pdf->set_parameter("licensefile", "/home/paras/bin/license/pdflib.txt");
264 if ($pdf->begin_document('', '') == 0) {
265 CRM_Core_Error
::statusBounce("PDFlib Error: " . $pdf->get_errmsg());
268 $config = CRM_Core_Config
::singleton();
269 $pdf->set_parameter('resourcefile', $config->templateDir
. '/Quest/pdf/pdflib.upr');
270 $pdf->set_parameter('textformat', 'utf8');
272 /* Set the search path for fonts and PDF files */
274 $pdf->set_parameter('SearchPath', $searchPath);
276 /* This line is required to avoid problems on Japanese systems */
278 $pdf->set_parameter('hypertextencoding', 'winansi');
280 $pdf->set_info('Creator', $creator);
281 $pdf->set_info('Author', $author);
282 $pdf->set_info('Title', $title);
284 $blockContainer = $pdf->open_pdi($fileName, '', 0);
285 if ($blockContainer == 0) {
286 CRM_Core_Error
::statusBounce('PDFlib Error: ' . $pdf->get_errmsg());
289 for ($i = 1; $i <= $numPages; $i++
) {
290 $page = $pdf->open_pdi_page($blockContainer, $i, '');
292 CRM_Core_Error
::statusBounce('PDFlib Error: ' . $pdf->get_errmsg());
295 /* dummy page size */
296 $pdf->begin_page_ext(20, 20, '');
298 /* This will adjust the page size to the block container's size. */
300 $pdf->fit_pdi_page($page, 0, 0, 'adjustpage');
304 /* Fill all text blocks with dynamic data */
306 foreach ($values as $key => $value) {
307 if (is_array($value)) {
311 // pdflib does like the forward slash character, hence convert
312 $value = str_replace('/', '_', $value);
314 $res = $pdf->fill_textblock($page,
317 'embedding encoding=winansi'
322 CRM_Core_Error::debug( "$key, $value: $res", $pdf->get_errmsg( ) );
324 CRM_Core_Error::debug( "SUCCESS: $key, $value", null );
329 $pdf->end_page_ext('');
330 $pdf->close_pdi_page($page);
333 $pdf->end_document('');
334 $pdf->close_pdi($blockContainer);
336 $buf = $pdf->get_buffer();
340 header('Content-type: application/pdf');
341 header("Content-Length: $len");
342 header("Content-Disposition: inline; filename={$output}.pdf");
344 CRM_Utils_System
::civiExit();
350 catch(PDFlibException
$excp) {
351 CRM_Core_Error
::statusBounce('PDFlib Error: Exception' .
352 "[" . $excp->get_errnum() . "] " . $excp->get_apiname() . ": " .
356 catch(Exception
$excp) {
357 CRM_Core_Error
::statusBounce("PDFlib Error: " . $excp->get_errmsg());