X-Git-Url: https://delta.frontaccounting.com/gitweb/?a=blobdiff_plain;ds=inline;f=reporting%2Fincludes%2Fpdf_report.inc;h=c8bd32550b1204d028fdf0305cf1ff34b2af6c35;hb=7561718ee5113232ce917f63085d272884b0929c;hp=e1455554def1682038dffbb58d0d03faaae73135;hpb=c03782de5d6c3b11008ec8b84cce6f7e1b33f0b1;p=fa-stable.git diff --git a/reporting/includes/pdf_report.inc b/reporting/includes/pdf_report.inc index e1455554..c8bd3255 100644 --- a/reporting/includes/pdf_report.inc +++ b/reporting/includes/pdf_report.inc @@ -1,8 +1,30 @@ . +***********************************************************************/ +/* + TODO: + . add StartReport/EndReport handlers for better bulk report support, with + . email/printer destination option should be selected on class creation instead + of End() + . add/use setter function for Header2 parameters (currently passed globally) + . in report files pass already prepared options to SetCommonData() to avoid need for + selection inside FrontReport generic class. +*/ +include_once(dirname(__FILE__)."/class.pdf.inc"); +include_once(dirname(__FILE__)."/printer_class.inc"); +include_once($path_to_root . "/reporting/includes/reporting.inc"); +include_once($path_to_root . "/admin/db/company_db.inc"); +include_once($path_to_root . "/admin/db/fiscalyears_db.inc"); +include_once($path_to_root . "/admin/db/printers_db.inc"); +include_once($path_to_root . "/config.php"); class FrontReport extends Cpdf { @@ -21,8 +43,9 @@ class FrontReport extends Cpdf var $rightMargin; var $endLine; var $lineHeight; - var $rtl; + //var $rtl; + var $row; var $cols; var $params; var $headers; @@ -30,137 +53,213 @@ class FrontReport extends Cpdf var $headers2; var $aligns2; var $cols2; - var $companyCol; - var $titleCol; var $pageNumber; var $fontSize; + var $oldFontSize; var $currency; + var $companyLogoEnable; // select whether to use a company logo graphic in some header templates + var $scaleLogoWidth; + var $footerEnable; // select whether to print a page footer or not + var $footerText; // store user-generated footer text + var $headerTmpl; // store the name of the currently selected header template + var $tmplSize; // pdf header template size in pages - function FrontReport($title, $filename, $size = 'A4', $fontsize = 9) + var $rep_id; + var $formData; // common data used for printing headers footers etc. + var $contactData; // contact data for sending emials/reportlanguage selection + + var $dest; // destination: email or printer + + function FrontReport($title, $filename, $size = 'A4', $fontsize = 9, $orientation = 'P', $margins = NULL, $excelColWidthFactor = NULL) { - switch ($size) - { + global $page_security; + $this->rep_id = $_POST['REP_ID']; // FIXME + + if (!$_SESSION["wa_current_user"]->can_access_page($page_security)) + { + display_error(_("The security settings on your account do not permit you to print this report")); + end_page(); + exit; + } + // Page margins - if user-specified, use those. Otherwise, use defaults below. + if (isset($margins)) + { + $this->topMargin = $margins['top']; + $this->bottomMargin = $margins['bottom']; + $this->leftMargin = $margins['left']; + $this->rightMargin = $margins['right']; + } + // Page orientation - P: portrait, L: landscape + $orientation = strtoupper($orientation); + // Page size name + switch (strtoupper($size)) + { + default: case 'A4': - case 'a4': - $this->pageWidth=595; - $this->pageHeight=842; - $this->topMargin=40; - $this->bottomMargin=30; - $this->leftMargin=40; - $this->rightMargin=30; - break; - case 'A4_Landscape': - $this->pageWidth=842; - $this->pageHeight=595; - $this->topMargin=30; - $this->bottomMargin=30; - $this->leftMargin=40; - $this->rightMargin=30; + // Portrait + if ($orientation == 'P') + { + $this->pageWidth=595; + $this->pageHeight=842; + if (!isset($margins)) + { + $this->topMargin=40; + $this->bottomMargin=30; + $this->leftMargin=40; + $this->rightMargin=30; + } + } + // Landscape + else + { + $this->pageWidth=842; + $this->pageHeight=595; + if (!isset($margins)) + { + $this->topMargin=30; + $this->bottomMargin=30; + $this->leftMargin=40; + $this->rightMargin=30; + } + } break; case 'A3': - $this->pageWidth=842; - $this->pageHeight=1190; - $this->topMargin=50; - $this->bottomMargin=50; - $this->leftMargin=50; - $this->rightMargin=40; - break; - case 'A3_landscape': - $this->pageWidth=1190; - $this->pageHeight=842; - $this->topMargin=50; - $this->bottomMargin=50; - $this->leftMargin=50; - $this->rightMargin=40; + // Portrait + if ($orientation == 'P') + { + $this->pageWidth=842; + $this->pageHeight=1190; + if (!isset($margins)) + { + $this->topMargin=50; + $this->bottomMargin=50; + $this->leftMargin=50; + $this->rightMargin=40; + } + } + // Landscape + else + { + $this->pageWidth=1190; + $this->pageHeight=842; + if (!isset($margins)) + { + $this->topMargin=50; + $this->bottomMargin=50; + $this->leftMargin=50; + $this->rightMargin=40; + } + } break; - case 'letter': - case 'Letter': - $this->pageWidth=612; - $this->pageHeight=792; - $this->topMargin=30; - $this->bottomMargin=30; - $this->leftMargin=30; - $this->rightMargin=25; + case 'LETTER': + // Portrait + if ($orientation == 'P') + { + $this->pageWidth=612; + $this->pageHeight=792; + if (!isset($margins)) + { + $this->topMargin=30; + $this->bottomMargin=30; + $this->leftMargin=30; + $this->rightMargin=25; + } + } + // Landscape + else + { + $this->pageWidth=792; + $this->pageHeight=612; + if (!isset($margins)) + { + $this->topMargin=30; + $this->bottomMargin=30; + $this->leftMargin=30; + $this->rightMargin=25; + } + } break; - case 'letter_landscape': - $this->pageWidth=792; - $this->pageHeight=612; - $this->topMargin=30; - $this->bottomMargin=30; - $this->leftMargin=30; - $this->rightMargin=25; - break; - case 'legal': - $this->pageWidth=612; - $this->pageHeight=1008; - $this->topMargin=50; - $this->bottomMargin=40; - $this->leftMargin=30; - $this->rightMargin=25; - break; - case 'legal_landscape': - $this->pageWidth=1008; - $this->pageHeight=612; - $this->topMargin=50; - $this->bottomMargin=40; - $this->leftMargin=30; - $this->rightMargin=25; + case 'LEGAL': + // Portrait + if ($orientation == 'P') + { + $this->pageWidth=612; + $this->pageHeight=1008; + if (!isset($margins)) + { + $this->topMargin=50; + $this->bottomMargin=40; + $this->leftMargin=30; + $this->rightMargin=25; + } + } + // Landscape + else + { + $this->pageWidth=1008; + $this->pageHeight=612; + if (!isset($margins)) + { + $this->topMargin=50; + $this->bottomMargin=40; + $this->leftMargin=30; + $this->rightMargin=25; + } + } break; } $this->size = array(0, 0, $this->pageWidth, $this->pageHeight); $this->title = $title; - $this->filename = $filename; + $this->filename = $filename.".pdf"; $this->pageNumber = 0; $this->endLine = $this->pageWidth - $this->rightMargin; - $this->companyCol = $this->endLine - 150; - $this->titleCol = $this->leftMargin + 100; $this->lineHeight = 12; $this->fontSize = $fontsize; + $this->oldFontSize = 0; + $this->row = $this->pageHeight - $this->topMargin; $this->currency = ''; - $this->rtl = ($_SESSION['language']->dir == 'rtl'); - // for quick testing - //$this->rtl = true; - $this->Cpdf($this->size); - } + $this->scaleLogoWidth = false; // if Logo, scale on width (else height). + $this->SetHeaderType('Header'); // default - function Font($style = 'normal') + $this->Cpdf($size, $_SESSION['language']->code, $orientation); + } + + /* + * Select the font and style to use for following output until + * it's changed again. + * + * $style is either: + * * a special case string (for backwards compatible with older code): + * * bold + * * italic + * * or a case-insensitive string where each char represents a style choice + * and you can use more than one or none at all. Possible choices: + * * empty string: regular + * * B: bold + * * I: italic + * * U: underline + * * D: line trough (aka "strike through") + * $fontname should be a standard PDF font (like 'times', 'helvetica' or 'courier') + * or one that's been installed on your system (see TCPDF docs for details). + * An empty string can also be used which will retain the font currently in use if + * you just want to change the style. + */ + function Font($style = '', $fontname = '') { - global $path_to_root; - $own = false; - $locale = $path_to_root . "lang/" . $_SESSION['language']->code . "/locale.inc"; - if (file_exists($locale)) - { - $fontinclude = true; - include($locale); - } - //if ($this->rtl) // this is good for presentation only - if (!$own) - { - if (user_price_dec() == 3) // only for presentation of farsi - { - $this->rtl = true; - $path = $path_to_root . 'reporting/fonts/farsi_1.afm'; - } - elseif ($style == 'italic') - $path = $path_to_root . 'reporting/fonts/Helvetica-Oblique.afm'; - elseif ($style == 'bold') - $path = $path_to_root . 'reporting/fonts/Helvetica-Bold.afm'; - else // even take misspelled styles - $path = $path_to_root . 'reporting/fonts/Helvetica.afm'; - } - $this->selectFont($path, 'WinAnsiEncoding'); + $this->selectFont($fontname, $style); } function Info($params, $cols, $headers, $aligns, - $cols2 = null, $headers2 = null, $aligns2 = null) + $cols2 = null, $headers2 = null, $aligns2 = null, + $companylogoenable = false, $footerenable = false, $footertext = '') { - global $app_title, $version, $power_by, $power_url, $path_to_root, $db_connections; + global $SysPrefs, $version; - $this->addinfo('Title', $this->title); - $this->addinfo('Subject', $this->title); - $this->addinfo('Author', $app_title . ' ' . $version); - $this->addinfo('Creator',$power_by . ' - ' . $power_url); + $this->addInfo('Title', $this->title); + $this->addInfo('Subject', $this->title); + $this->addInfo('Author', $SysPrefs->app_title . ' ' . $version); + $this->addInfo('Creator',$SysPrefs->power_by . ' - ' . $SysPrefs->power_url); $year = get_current_fiscalyear(); if ($year['closed'] == 0) $how = _("Active"); @@ -169,7 +268,6 @@ class FrontReport extends Cpdf $this->fiscal_year = sql2date($year['begin']) . " - " . sql2date($year['end']) . " " . "(" . $how . ")"; $this->company = get_company_prefs(); $this->user = $_SESSION["wa_current_user"]->name; - //$this->host = $db_connections[$_SESSION["wa_current_user"]->company]["host"]; $this->host = $_SERVER['SERVER_NAME']; $this->params = $params; $this->cols = $cols; @@ -185,13 +283,22 @@ class FrontReport extends Cpdf } $this->headers2 = $headers2; $this->aligns2 = $aligns2; - } + // Set whether to display company logo in some header templates + $this->companyLogoEnable = $companylogoenable; + + // Store footer settings + $this->footerEnable = $footerenable; + $this->footerText = $footertext; + } + // + // Header for listings + // function Header() { - $this->pageNumber++; - if ($this->pageNumber > 1) - $this->newPage(); + $companyCol = $this->endLine - 150; + $titleCol = $this->leftMargin + 100; + $this->row = $this->pageHeight - $this->topMargin; $this->SetDrawColor(128, 128, 128); @@ -201,48 +308,50 @@ class FrontReport extends Cpdf $this->fontSize += 4; $this->Font('bold'); - $this->Text($this->leftMargin, $this->title, $this->companyCol); + $this->Text($this->leftMargin, $this->title, $companyCol); $this->Font(); $this->fontSize -= 4; - $this->Text($this->companyCol, $this->company['coy_name']); + $this->Text($companyCol, $this->company['coy_name']); $this->row -= ($this->lineHeight + 4); $str = _("Print Out Date") . ':'; - $this->Text($this->leftMargin, $str, $this->titleCol); + $this->Text($this->leftMargin, $str, $titleCol); $str = Today() . ' ' . Now(); - $this->Text($this->titleCol, $str, $this->companyCol); - $this->Text($this->companyCol, $this->host); + if ($this->company['time_zone']) + $str .= ' ' . date('O') . ' GMT'; + $this->Text($titleCol, $str, $companyCol); + $this->Text($companyCol, $this->host); $this->NewLine(); $str = _("Fiscal Year") . ':'; - $this->Text($this->leftMargin, $str, $this->titleCol); + $this->Text($this->leftMargin, $str, $titleCol); $str = $this->fiscal_year; - $this->Text($this->titleCol, $str, $this->companyCol); - $this->Text($this->companyCol, $this->user); + $this->Text($titleCol, $str, $companyCol); + $this->Text($companyCol, $this->user); for ($i = 1; $i < count($this->params); $i++) { if ($this->params[$i]['from'] != '') { $this->NewLine(); $str = $this->params[$i]['text'] . ':'; - $this->Text($this->leftMargin, $str, $this->titleCol); + $this->Text($this->leftMargin, $str, $titleCol); $str = $this->params[$i]['from']; if ($this->params[$i]['to'] != '') $str .= " - " . $this->params[$i]['to']; - $this->Text($this->titleCol, $str, $this->companyCol); + $this->Text($titleCol, $str, $companyCol); } - } + } if ($this->params[0] != '') // Comments { $this->NewLine(); $str = _("Comments") . ':'; - $this->Text($this->leftMargin, $str, $this->titleCol); + $this->Text($this->leftMargin, $str, $titleCol); $this->Font('bold'); - $this->Text($this->titleCol, $this->params[0], $this->endLine - 35); + $this->Text($titleCol, $this->params[0], $this->endLine - 35); $this->Font(); } $str = _("Page") . ' ' . $this->pageNumber; - $this->Text($this->endLine - 35, $str); + $this->Text($this->endLine - 38, $str); $this->Line($this->row - 5, 1); $this->row -= ($this->lineHeight + 6); @@ -262,432 +371,722 @@ class FrontReport extends Cpdf $this->NewLine(2); } + /* + Transition function + */ + function SetCommonData($myrow, $branch, $sales_order, $bankaccount, $doctype, $contacts) + { +// $this->formData = array_merge($myrow, $branch, $sales_order, +// $bank_account, array('doctype' => $doctype)); + + $this->formData = array(); + $datnames = array( + 'myrow' => array('ord_date', 'date_', 'tran_date', + 'order_no','reference', 'id', 'trans_no', 'name', 'location_name', + 'delivery_address', 'supp_name', 'address', + 'DebtorName', 'supp_account_no', 'wo_ref', 'debtor_ref','type', 'trans_no', + 'StockItemName', 'tax_id', 'order_', 'delivery_date', 'units_issued', + 'due_date', 'required_by', 'payment_terms', 'curr_code', + 'ov_freight', 'ov_gst', 'ov_amount', 'prepaid', 'requisition_no', 'contact'), + 'branch' => array('br_address', 'br_name', 'salesman', 'disable_branch'), + 'sales_order' => array('deliver_to', 'delivery_address', 'customer_ref'), + 'bankaccount' => array('bank_name', 'bank_account_number', 'payment_service') + ); - function Header2($myrow, $branch, $sales_order, $bankaccount, $doctype) + foreach($datnames as $var => $fields) { + if (isset($$var)) { + foreach($fields as $locname) { + if (isset(${$var}[$locname]) && (${$var}[$locname]!==null)) { + $this->formData[$locname] = ${$var}[$locname]; + } + } + } + } + $this->formData['doctype'] = $doctype; + $this->formData['document_amount'] = @$this->formData['ov_amount']+@$this->formData['ov_freight']+@$this->formData['ov_gst']; + if (count($contacts)) { + if (!is_array($contacts[0])) + $contacts = array($contacts); // change to array when single contact passed + $this->contactData = $contacts; + // as report is currently generated once despite number of email recipients + // we select language for the first recipient as report language + $this->formData['rep_lang'] = $contacts[0]['lang']; + } + } + /* + Set header handler + */ + function SetHeaderType($name) { + $this->headerTmpl = $name; + } + /* + Header for sales/purchase documents + */ + function Header2() { - global $path_to_root, $print_as_quote; - - $this->pageNumber++; - if ($this->pageNumber > 1) - $this->newPage(); + global $dflt_lang; // FIXME should be passed as params + + $this->SetLang(@$this->formData['rep_lang'] ? $this->formData['rep_lang'] : $dflt_lang); + $doctype = $this->formData['doctype']; $header2type = true; - if ($this->currency != $myrow['curr_code']) - { - include($path_to_root . "reporting/includes/doctext2.inc"); - } - else + + $lang = user_language(); + $this->SetLang(@$this->formData['rep_lang'] ? $this->formData['rep_lang'] + : ( $lang ? $lang : $dflt_lang)); + + // leave layout files names without path to enable including + // modified versions from company/x/reporting directory + include("includes/doctext.inc"); + include("includes/header2.inc"); + + $this->row = $temp; + } + + // Alternate header style which also supports a simple footer + function Header3() + { + // Turn off cell padding for the main report header, restoring the current setting later + $oldcMargin = $this->cMargin; + $this->SetCellPadding(0); + + // Set some constants which control header item layout + // only set them once or the PHP interpreter gets angry + if ($this->pageNumber == 1) { - include($path_to_root . "reporting/includes/doctext.inc"); - } + define('COMPANY_WIDTH', 150); + define('LOGO_HEIGHT', 50); + define('LOGO_Y_POS_ADJ_FACTOR', 0.74); + define('LABEL_WIDTH', 80); + define('PAGE_NUM_WIDTH', 60); + define('TITLE_FONT_SIZE', 14); + define('HEADER1_FONT_SIZE', 10); + define('HEADER2_FONT_SIZE', 9); + define('FOOTER_FONT_SIZE', 10); + define('FOOTER_MARGIN', 4); + } + // Set some variables which control header item layout + $companyCol = $this->endLine - COMPANY_WIDTH; + $headerFieldCol = $this->leftMargin + LABEL_WIDTH; + $pageNumCol = $this->endLine - PAGE_NUM_WIDTH; + $footerCol = $this->leftMargin + PAGE_NUM_WIDTH; + $footerRow = $this->bottomMargin - FOOTER_MARGIN; + + // Calling this function generates a new PDF page after the first instance +// { +// // TODO: experimenting with line drawing to highlight current period +// $this->SetLineWidth(1); +// $this->LineTo($this->cols[3], 33, $this->cols[3], 534); +// $this->LineTo($this->cols[4], 33, $this->cols[4], 534); +// $this->SetLineWidth(0.1); + +// $this->newPage(); +// } $this->row = $this->pageHeight - $this->topMargin; - - $upper = $this->row - 2 * $this->lineHeight; - $lower = $this->bottomMargin + 6 * $this->lineHeight; - $iline1 = $upper - 4 * $this->lineHeight; - $iline2 = $iline1 - 8 * $this->lineHeight; - $iline3 = $iline2 - 8 * $this->lineHeight; - $iline4 = $iline3 - 2 * $this->lineHeight; - $iline5 = $lower + 5 * $this->lineHeight; - $icol = $this->pageWidth / 2; - $ccol = $this->cols[0] + 4; - $ccol2 = $icol / 2; - $mcol = $icol + 8; - $mcol2 = $this->pageWidth - $ccol2; + // Set the color of dividing lines we'll draw + $oldDrawColor = $this->GetDrawColor(); $this->SetDrawColor(128, 128, 128); - $this->LineTo($this->pageWidth - $this->rightMargin, $upper ,$this->leftMargin, $upper); - $this->LineTo($this->leftMargin, $upper ,$this->leftMargin, $lower); - $this->LineTo($this->pageWidth - $this->rightMargin, $lower ,$this->leftMargin, $lower); - $this->LineTo($this->pageWidth - $this->rightMargin, $lower ,$this->pageWidth - $this->rightMargin, $upper); - $this->Line($iline1); - $this->Line($iline2); - $this->Line($iline3); - $this->Line($iline4); - $this->Line($iline5); - $this->LineTo($icol, $upper ,$icol, $iline1); - $this->NewLine(); - $this->fontSize += 4; - $this->Font('bold'); - $this->Text($mcol, $this->title); - $this->Font(); - $this->fontSize -= 4; - if ($this->pageNumber > 1 && !strstr($this->filename, "Bulk")) - $this->Text($this->endLine - 35, _("Page") . ' ' . $this->pageNumber); - $this->fontSize -= 4; - $this->row = $upper - 5; + // Tell TCPDF that we want to use its alias system to track the total number of pages + $this->AliasNbPages(); - $this->Text($mcol, $doc_Invoice_no, $mcol + 90); - $this->Text($mcol + 90, $doc_Cust_no, $mcol + 180); - $this->Text($mcol + 180, $doc_Date); - $this->fontSize += 4; - - $this->row = $upper - 2 * $this->lineHeight - 2; - if ($this->company['coy_logo'] != '') - { - $logo = $path_to_root . "themes/default/images/" . $this->company['coy_logo']; - $this->AddImage($logo, $ccol, $iline1 + 5, 220, 40); - } - else + // Footer + if ($this->footerEnable) { - $this->fontSize += 4; - $this->Font('bold'); - $this->Text($ccol, $this->company['coy_name'], $icol); - $this->Font(); - $this->fontSize -= 4; + $this->Line($footerRow, 1); + $prevFontSize = $this->fontSize; + $this->fontSize = FOOTER_FONT_SIZE; + $this->TextWrap($footerCol, $footerRow - ($this->fontSize + 1), + $pageNumCol - $footerCol, $this->footerText, $align = 'center', + $border = 0, $fill = 0, $link = NULL, $stretch = 1); + $this->TextWrap($pageNumCol, $footerRow - ($this->fontSize + 1), + PAGE_NUM_WIDTH, _("Page") . ' ' . $this->pageNumber . '/' . $this->getAliasNbPages(), + $align = 'right', $border = 0, $fill = 0, $link = NULL, $stretch = 1); + $this->fontSize = $prevFontSize; } - if ($doctype == 8) // PO - $this->Text($mcol, $myrow['order_no'], $mcol + 90); - else if ($doctype == 9) // SO - $this->Text($mcol, $myrow['order_no'] ." ".$myrow['customer_ref'], $mcol + 90); - else // INV/CRE/STA - $this->Text($mcol, $myrow['reference'], $mcol + 90); - $this->Text($mcol + 90, $myrow['debtor_no'], $mcol + 180); - if ($doctype == 8 || $doctype == 9) - $this->Text($mcol + 180, sql2date($myrow['ord_date'])); - else - $this->Text($mcol + 180, sql2date($myrow['tran_date'])); - $this->fontSize -= 4; - $this->row = $iline1 - 5; - $this->Text($ccol, $doc_Charge_To, $icol); - $this->Text($mcol, $doc_Delivered_To); - $this->fontSize += 4; + // + // Header + // - $this->NewLine(2); - $temp = $this->row; - if ($doctype == 9) - { - $this->Text($ccol, $myrow['name'], $icol); - //$adr = ?; - } - else + // Print gray line across the page + $this->Line($this->row + 8, 1); + + $this->NewLine(); + + // Print the report title nice and big + $oldFontSize = $this->fontSize; + $this->fontSize = TITLE_FONT_SIZE; + $this->Font('B'); + $this->Text($this->leftMargin, $this->title, $companyCol); + $this->fontSize = HEADER1_FONT_SIZE; + + // Print company logo if present and requested, or else just print company name + // Build a string specifying the location of the company logo file + $logo = company_path() . "/images/" . $this->company['coy_logo']; + if ($this->companyLogoEnable && ($this->company['coy_logo'] != '') && file_exists($logo)) { - if ($doctype == 8) - $this->Text($ccol, $myrow['supp_name'], $icol); + // Width being zero means that the image will be scaled to the specified height + // keeping its aspect ratio intact. + if ($this->scaleLogoWidth) + $this->AddImage($logo, $companyCol, $this->row + 15, COMPANY_WIDTH, 0); else - $this->Text($ccol, $myrow['DebtorName'], $icol); - $adr = explode("\n", $myrow['address']); - } - for ($i = 0; $i < count($adr); $i++) - { - $this->NewLine(); - $this->Text($ccol, $adr[$i], $icol); + $this->AddImage($logo, $companyCol, $this->row - (LOGO_HEIGHT * LOGO_Y_POS_ADJ_FACTOR), 0, LOGO_HEIGHT); } - if ($sales_order != NULL) - { - $this->row = $temp; - if ($doctype == 8) - $this->Text($mcol, $this->company['coy_name']); - else - $this->Text($mcol, $sales_order['deliver_to']); - $adr = explode("\n", $sales_order['delivery_address']); - for ($i = 0; $i < count($adr); $i++) - { - $this->NewLine(); - $this->Text($mcol, $adr[$i]); + else + $this->Text($companyCol, $this->company['coy_name']); + + // Dimension 1 - optional + // - only print if available and not blank + if (count($this->params) > 3) + if ($this->params[3]['from'] != '') + { + $this->NewLine(1, 0, $this->fontSize + 2); + $str = $this->params[3]['text'] . ':'; + $this->Text($this->leftMargin, $str, $headerFieldCol); + $str = $this->params[3]['from']; + $this->Text($headerFieldCol, $str, $companyCol); } - } - $this->row = $iline2 - 2 * $this->lineHeight; - $this->Text($ccol, $doc_Shipping_Company . ":", $ccol2); - if ($doctype != 8) - $this->Text($ccol2, $myrow['shipper_name'], $mcol); - $this->Text($mcol, $doc_Due_Date . ":", $mcol2); - if ($doctype == 9) - $this->Text($mcol2, sql2date($myrow['delivery_date'])); - else if ($doctype != 8) - $this->Text($mcol2, sql2date($myrow['due_date'])); - if ($branch != null) - { - $this->NewLine(); - $this->Text($ccol, $doc_Your_Ref . ":", $ccol2); - $this->Text($ccol2, $branch['contact_name'], $mcol); - $this->Text($mcol, $doc_Our_Ref . ":", $mcol2); - $id = $branch['salesman']; - $sql = "SELECT salesman_name FROM ".TB_PREF."salesman WHERE salesman_code='$id'"; - $result = db_query($sql,"could not get sales person"); - $row = db_fetch($result); + // Dimension 2 - optional + // - only print if available and not blank + if (count($this->params) > 4) + if ($this->params[4]['from'] != '') + { + $this->NewLine(1, 0, $this->fontSize + 2); + $str = $this->params[4]['text'] . ':'; + $this->Text($this->leftMargin, $str, $headerFieldCol); + $str = $this->params[4]['from']; + $this->Text($headerFieldCol, $str, $companyCol); + } - $this->Text($mcol2, $row['salesman_name']); - } - $this->NewLine(); - $this->Text($ccol, $doc_Your_VAT_no . ":", $ccol2); - if ($doctype != 8) - $this->Text($ccol2, $myrow['tax_id'], $mcol); - $this->Text($mcol, $doc_Our_VAT_no . ":", $mcol2); - $this->Text($mcol2, $this->company['gst_no']); - $this->NewLine(); - $this->Text($ccol, $doc_Payment_Terms . ":", $ccol2); + // Tags - optional + // if present, it's an array of tag names + if (count($this->params) > 5) + if ($this->params[5]['from'] != '') + { + $this->NewLine(1, 0, $this->fontSize + 2); + $str = $this->params[5]['text'] . ':'; + $this->Text($this->leftMargin, $str, $headerFieldCol); + $str = ''; + for ($i = 0; $i < count($this->params[5]['from']); $i++) + { + if($i != 0) + $str .= ', '; + $str .= $this->params[5]['from'][$i]; + } + $this->Text($headerFieldCol, $str, $companyCol); + } - $id = $myrow['payment_terms']; - $sql = "SELECT terms FROM ".TB_PREF."payment_terms WHERE terms_indicator='$id'"; - $result = db_query($sql,"could not get paymentterms"); - $row = db_fetch($result); + // Report Date - time period covered + // - can specify a range, or just the end date (and the report contents + // should make it obvious what the beginning date is) + $this->NewLine(1, 0, $this->fontSize + 2); + $str = _("Report Period") . ':'; + $this->Text($this->leftMargin, $str, $headerFieldCol); + $str = ''; + if (isset($this->params[1]['from']) && $this->params[1]['from'] != '') + $str = $this->params[1]['from'] . ' - '; + $str .= $this->params[1]['to']; + $this->Text($headerFieldCol, $str, $companyCol); - $this->Text($ccol2, $row["terms"], $mcol); - $this->Text($mcol, $doc_Our_Order_No . ":", $mcol2); - $this->Text($mcol2, $myrow['order_']); - - $locale = $path_to_root . "lang/" . $_SESSION['language']->code . "/locale.inc"; - if (file_exists($locale)) - { - $header2include = true; - include($locale); - } - $this->row = $iline3 - $this->lineHeight - 2; - $this->Font('bold'); - $count = count($this->headers); - for ($i = 0; $i < $count; $i++) - $this->TextCol($i, $i + 1, $this->headers[$i], -2); + // Turn off Bold $this->Font(); - $temp = $this->row - 2 * $this->lineHeight; - $this->row = $iline5 - $this->lineHeight - 6; - $this->Text($ccol, $doc_Please_Quote . " - " . $myrow['curr_code']); - if ($this->params['comments'] != '') + + $this->NewLine(1, 0, $this->fontSize + 1); + + // Make the remaining report headings a little less important + $this->fontSize = HEADER2_FONT_SIZE; + + // Timestamp of when this copy of the report was generated + $str = _("Generated At") . ':'; + $this->Text($this->leftMargin, $str, $headerFieldCol); + $str = Today() . ' ' . Now(); + if ($this->company['time_zone']) + $str .= ' ' . date('O') . ' GMT'; + $this->Text($headerFieldCol, $str, $companyCol); + + // Name of the user that generated this copy of the report + $this->NewLine(1, 0, $this->fontSize + 1); + $str = _("Generated By") . ':'; + $this->Text($this->leftMargin, $str, $headerFieldCol); + $str = $this->user; + $this->Text($headerFieldCol, $str, $companyCol); + + // Display any user-generated comments for this copy of the report + if ($this->params[0] != '') // Comments { - $this->NewLine(2); - $this->Font('bold'); - $this->Text($ccol, $this->params['comments']); + $this->NewLine(1, 0, $this->fontSize + 1); + $str = _("Comments") . ':'; + $this->Text($this->leftMargin, $str, $headerFieldCol); + $this->Font('B'); + $this->Text($headerFieldCol, $this->params[0], $companyCol, 0, 0, 'left', 0, 0, $link=NULL, 1); $this->Font(); } + + // Add page numbering to header if footer is turned off + if (!$this->footerEnable) + { + $str = _("Page") . ' ' . $this->pageNumber . '/' . $this->getAliasNbPages(); + $this->Text($pageNumCol, $str, 0, 0, 0, 'right', 0, 0, NULL, 1); + } - $this->row = $lower - 5; - $this->fontSize -= 4; - - $this->Text($ccol, $doc_Address, $ccol2 + 40); - $this->Text($ccol2 + 30, $doc_Phone_Fax_Email, $mcol); - $this->Text($mcol , $doc_Bank, $mcol2); - $this->Text($mcol2, $doc_Bank_Account); - $this->fontSize += 4; - $this->NewLine(); - $adrline = $this->row; - - $adr = explode("\n", $this->company['postal_address']); - for ($i = 0; $i < count($adr); $i++) - { - $this->Text($ccol, $adr[$i], $ccol2 + 40); + // Print gray line across the page + $this->Line($this->row - 5, 1); + + // Restore font size to user-defined size + $this->fontSize = $oldFontSize; + + // restore user-specified cell padding for column headers + $this->SetCellPadding($oldcMargin); + + // scoot down the page a bit + $oldLineHeight = $this->lineHeight; + $this->lineHeight = $this->fontSize + 1; + $this->row -= ($this->lineHeight + 6); + $this->lineHeight = $oldLineHeight; + + // Print the column headers! + $this->Font('I'); + if ($this->headers2 != null) + { + $count = count($this->headers2); + for ($i = 0; $i < $count; $i++) + $this->TextCol2($i, $i + 1, $this->headers2[$i], $corr=0, $r=0, $border=0, $fill=0, $link=NULL, $stretch=1); $this->NewLine(); } - $this->row = $adrline; - $this->Text($ccol2 + 30, $this->company['phone'], $mcol); - $this->NewLine(); - $this->Text($ccol2 + 30, $this->company['fax'], $mcol); - $this->NewLine(); - $this->Text($ccol2 + 30, $this->company['email'], $mcol); - // fetch this later - $this->row = $adrline; - $this->Text($mcol, $bankaccount['bank_name'], $mcol2); - $adr = explode("\n", $bankaccount['bank_address']); - for ($i = 0; $i < count($adr); $i++) - { - $this->NewLine(); - $this->Text($mcol, $adr[$i], $mcol2); + $count = count($this->headers); + for ($i = 0; $i < $count; $i++) + $this->TextCol($i, $i + 1, $this->headers[$i], $corr=0, $r=0, $border=0, $fill=0, $link=NULL, $stretch=1); + $this->Font(); + + $this->NewLine(2); + + // restore user-specified draw color + $this->SetDrawColor($oldDrawColor[0], $oldDrawColor[1], $oldDrawColor[2]); + } + + /** + * Format a numeric string date into something nicer looking. + * + * @param string $date Date string to be formatted. + * @param int $input_format Format of the input string. Possible values are: