From 3024efcca8d34a096956266a76ed5e7760d364dc Mon Sep 17 00:00:00 2001 From: Julio Montoya Date: Wed, 12 Nov 2014 11:58:27 +0100 Subject: [PATCH] Minor - format code. --- main/inc/lib/pdf.lib.php | 140 ++++++++++++++++++++++++++------------- 1 file changed, 94 insertions(+), 46 deletions(-) diff --git a/main/inc/lib/pdf.lib.php b/main/inc/lib/pdf.lib.php index 3a2b76b6df..3b3249871d 100755 --- a/main/inc/lib/pdf.lib.php +++ b/main/inc/lib/pdf.lib.php @@ -3,6 +3,7 @@ define('_MPDF_PATH', api_get_path(LIBRARY_PATH).'mpdf/'); require_once _MPDF_PATH.'mpdf.php'; + /** * Class PDF * @package chamilo.library @@ -17,11 +18,15 @@ class PDF /** * Creates the mPDF object - * @param string format A4 A4-L see http://mpdf1.com/manual/index.php?tid=184&searchstring=format - * @param string orientation "P" = Portrait "L" = Landscape + * @param string $page_format format A4 A4-L see http://mpdf1.com/manual/index.php?tid=184&searchstring=format + * @param string $orientation orientation "P" = Portrait "L" = Landscape + * @param array $params */ - public function __construct($page_format ='A4', $orientation = 'P', $params = array()) - { + public function __construct( + $page_format = 'A4', + $orientation = 'P', + $params = array() + ) { /* More info @ http://mpdf1.com/manual/index.php?tid=184&searchstring=mPDF * mPDF ([ string $mode [, mixed $format [, float $default_font_size [, string $default_font [, float $margin_left , float $margin_right , float $margin_top , float $margin_bottom , float $margin_header , float $margin_footer [, string $orientation ]]]]]]) */ @@ -121,18 +126,22 @@ class PDF /** * Converts HTML files to PDF * @param mixed could be an html file path or an array with paths example: - /var/www/myfile.html or - array('/myfile.html','myotherfile.html') or even an indexed array with both 'title' and 'path' indexes - for each element like + /var/www/myfile.html or + array('/myfile.html','myotherfile.html') or even an indexed array with both 'title' and 'path' indexes + for each element like * array(0=>array('title'=>'Hello','path'=>'file.html'),1=>array('title'=>'Bye','path'=>'file2.html')); * @param string pdf name * @param string course code (if you are using html that are located in the document tool you must provide this) * @param bool Whether to print the header, footer and watermark (true) or just the content (false) * @return bool */ - public function html_to_pdf($html_file_array, $pdf_name = '', $course_code = null, $print_title = false, $complete_style = true) - { - + public function html_to_pdf( + $html_file_array, + $pdf_name = '', + $course_code = null, + $print_title = false, + $complete_style = true + ) { if ($complete_style === false) { error_log(__FUNCTION__.' with no style'); } @@ -163,13 +172,11 @@ class PDF $clean_search = array ( '@]*?>.*?@si', '@]*?>.*?@si' - ); + ); // Formatting the pdf self::format_pdf($course_data, $complete_style); - $counter = 1; - foreach ($html_file_array as $file) { //Add a page break per file @@ -192,7 +199,10 @@ class PDF if (empty($file) && !empty($html_title)) { //this is a chapter, print title & skip the rest if ($print_title) { - $this->pdf->WriteHTML('

'.$html_title.'

'.$page_break, 2); + $this->pdf->WriteHTML( + '

'.$html_title.'

'.$page_break, + 2 + ); } continue; } @@ -204,7 +214,10 @@ class PDF //it's not a chapter but the file exists, print its title if ($print_title) { - $this->pdf->WriteHTML('

'.$html_title.'

',2); + $this->pdf->WriteHTML( + '

' . $html_title . '

', + 2 + ); } $file_info = pathinfo($file); @@ -296,7 +309,8 @@ class PDF $pdf_name = replace_dangerous_char($pdf_name); $output_file = $pdf_name.'.pdf'; } - $this->pdf->Output($output_file, 'D'); /// F to save the pdf in a file + // F to save the pdf in a file + $this->pdf->Output($output_file, 'D'); exit; } @@ -308,9 +322,12 @@ class PDF * @param string course code (if you are using html that are located in the document tool you must provide this) * @return string Web path */ - public function content_to_pdf($document_html, $css = '', $pdf_name = '', $course_code = null) - { - + public function content_to_pdf( + $document_html, + $css = '', + $pdf_name = '', + $course_code = null + ) { global $_configuration; if (empty($document_html)) { @@ -324,7 +341,7 @@ class PDF ); // Formatting the pdf - $course_data = api_get_course_info($course_code); + $course_data = api_get_course_info($course_code); self::format_pdf($course_data); @@ -421,7 +438,7 @@ class PDF /** * Deletes the watermark from the Platform or Course - * @param string course code (optional) + * @param string $course_code course code (optional) * @param mixed web path of the watermark image, false if there is nothing to return */ public function delete_watermark($course_code = null) @@ -444,9 +461,9 @@ class PDF /** * Uploads the pdf watermark in the main/default_course_document directory or in the course directory - * @param string filename - * @param string path of the file - * @param string course code + * @param string $filename filename + * @param string $source_file path of the file + * @param string $course_code * @return mixed web path of the file if sucess, false otherwise */ public function upload_watermark($filename, $source_file, $course_code = null) @@ -469,7 +486,7 @@ class PDF $my_image = new Image($source_file); $result = $my_image->send_image($course_image, -1, 'png'); if ($result) { - $result = $web_path; + $result = $web_path; } return $result; } @@ -500,26 +517,56 @@ class PDF $right_content = '{PAGENO} / {nb}'; //@todo remove this and use a simpler way - $footer = array ( - 'odd' => array ( - 'L' => array ( - 'content' => $left_content, 'font-size' => 10,'font-style' => 'B','font-family' => 'serif','color'=>'#000000'), - 'C' => array ( - 'content' => $center_content,'font-size' => 10,'font-style' => 'B','font-family' => 'serif','color'=>'#000000'), - 'R' => array ( - 'content' => $right_content, 'font-size' => 10,'font-style' => 'B','font-family' => 'serif','color'=>'#000000'), + $footer = array( + 'odd' => array( + 'L' => array( + 'content' => $left_content, + 'font-size' => 10, + 'font-style' => 'B', + 'font-family' => 'serif', + 'color' => '#000000' + ), + 'C' => array( + 'content' => $center_content, + 'font-size' => 10, + 'font-style' => 'B', + 'font-family' => 'serif', + 'color' => '#000000' + ), + 'R' => array( + 'content' => $right_content, + 'font-size' => 10, + 'font-style' => 'B', + 'font-family' => 'serif', + 'color' => '#000000' + ), 'line' => 1, - ), - 'even' => array ( - 'L' => array ( - 'content' => $left_content, 'font-size' => 10,'font-style' => 'B','font-family' => 'serif','color'=>'#000000'), - 'C' => array ( - 'content' => $center_content,'font-size' => 10,'font-style' => 'B','font-family' => 'serif','color'=>'#000000'), - 'R' => array ( - 'content' => $right_content, 'font-size' => 10,'font-style' => 'B','font-family' => 'serif','color'=>'#000000'), + ), + 'even' => array( + 'L' => array( + 'content' => $left_content, + 'font-size' => 10, + 'font-style' => 'B', + 'font-family' => 'serif', + 'color' => '#000000' + ), + 'C' => array( + 'content' => $center_content, + 'font-size' => 10, + 'font-style' => 'B', + 'font-family' => 'serif', + 'color' => '#000000' + ), + 'R' => array( + 'content' => $right_content, + 'font-size' => 10, + 'font-style' => 'B', + 'font-family' => 'serif', + 'color' => '#000000' + ), 'line' => 1, - ), - ); + ), + ); // defines footer for Odd and Even Pages - placed at Outer margin see http://mpdf1.com/manual/index.php?tid=151&searchstring=setfooter $this->pdf->SetFooter($footer); } @@ -646,14 +693,15 @@ class PDF $pdf->SetSubject('Exported from Chamilo Documents'); $pdf->SetKeywords('Chamilo Documents'); */ - $this->pdf->directionality = api_get_text_direction(); // TODO: To be read from the html document. - $this->pdf->useOnlyCoreFonts = true; + // TODO: To be read from the html document. + $this->pdf->directionality = api_get_text_direction(); + $this->pdf->useOnlyCoreFonts = true; // Use different Odd/Even headers and footers and mirror margins $this->pdf->mirrorMargins = 1; // Add decoration only if not stated otherwise if ($complete) { - //Adding watermark + // Adding watermark if (api_get_setting('pdf_export_watermark_enable') == 'true') { $watermark_file = self::get_watermark($course_code);