Extended the Report Engine to better support own reports
[fa-stable.git] / reporting / includes / excel_report.inc
index fb7ed1be71b04b370e26c1d26eefa4e53c96a073..dde397bd8d9764bd64060c303fdd221220f26151 100644 (file)
@@ -42,7 +42,8 @@ class FrontReport extends Spreadsheet_Excel_Writer_Workbook
        var $row = 9999999;
        var $y;
        var $numcols;
-       
+       var $excelColWidthFactor;
+
        var $formatTitle;
        var $formatDateTime;
        var $formatDate;
@@ -53,7 +54,7 @@ class FrontReport extends Spreadsheet_Excel_Writer_Workbook
        
        var $sheet;
 
-       function FrontReport($title, $filename, $size = 'A4', $fontsize = 9)
+       function FrontReport($title, $filename, $size = 'A4', $fontsize = 9, $orientation = 'P', $margins = NULL, $excelColWidthFactor = 6.5)
        {
                global $comp_path, $dateseps, $page_security;
                if (!$_SESSION["wa_current_user"]->can_access_page($page_security))
@@ -69,6 +70,7 @@ class FrontReport extends Spreadsheet_Excel_Writer_Workbook
                $this->oldFontSize = 0;
                $this->y = 1;
                $this->currency = '';
+               $this->excelColWidthFactor = $excelColWidthFactor;
                $rtl = ($_SESSION['language']->dir == 'rtl');
                $this->code = strtolower($_SESSION['language']->encoding);
                $this->filename = $filename.".xls";
@@ -78,7 +80,7 @@ class FrontReport extends Spreadsheet_Excel_Writer_Workbook
                //$this->setCountry(48);
                if ($this->code != "iso-8859-1")
                        $this->setVersion(8); // set biff version to 8 (0x0006 internal)
-               $this->sheet =& $this->addWorksheet($this->title);
+               $this->sheet =& $this->addWorksheet($this->worksheetNameGenerator($this->title));
                if ($this->code != "iso-8859-1")
                        $this->sheet->setInputEncoding($this->code); // set sheet encoding
                if ($rtl)
@@ -127,6 +129,16 @@ class FrontReport extends Spreadsheet_Excel_Writer_Workbook
                $this->formatHeaderLeft->setBottom(2);
                $this->formatHeaderLeft->setBottomColor('gray');
                $this->formatHeaderLeft->setAlign('vcenter');
+               $this->formatTopHeaderLeft =& $this->addFormat();
+               $this->formatTopHeaderLeft->setItalic();
+               $this->formatTopHeaderLeft->setTop(2);
+               $this->formatTopHeaderLeft->setTopColor('gray');
+               $this->formatTopHeaderLeft->setAlign('vcenter');
+               $this->formatBottomHeaderLeft =& $this->addFormat();
+               $this->formatBottomHeaderLeft->setItalic();
+               $this->formatBottomHeaderLeft->setBottom(2);
+               $this->formatBottomHeaderLeft->setBottomColor('gray');
+               $this->formatBottomHeaderLeft->setAlign('vcenter');
                $this->formatDate->setAlign($rtl ? 'right' : 'left');
                $this->formatHeaderRight =& $this->addFormat();
                $this->formatHeaderRight->setItalic();
@@ -136,11 +148,38 @@ class FrontReport extends Spreadsheet_Excel_Writer_Workbook
                $this->formatHeaderRight->setBottomColor('gray');
                $this->formatHeaderRight->setAlign('vcenter');
                $this->formatHeaderRight->setAlign('right');
+               $this->formatTopHeaderRight =& $this->addFormat();
+               $this->formatTopHeaderRight->setItalic();
+               $this->formatTopHeaderRight->setTop(2);
+               $this->formatTopHeaderRight->setTopColor('gray');
+               $this->formatTopHeaderRight->setAlign('vcenter');
+               $this->formatTopHeaderRight->setAlign('right');
+               $this->formatBottomHeaderRight =& $this->addFormat();
+               $this->formatBottomHeaderRight->setItalic();
+               $this->formatBottomHeaderRight->setBottom(2);
+               $this->formatBottomHeaderRight->setBottomColor('gray');
+               $this->formatBottomHeaderRight->setAlign('vcenter');
+               $this->formatBottomHeaderRight->setAlign('right');
                $this->formatFooter =& $this->addFormat();
                $this->formatFooter->setTop(2);
                $this->formatFooter->setTopColor('gray');
        }
        
+
+       // Check a given name to see if it's a valid Excel worksheet name,
+       // and fix if necessary
+       function worksheetNameGenerator($name)
+       {
+               // First, strip out characters which aren't allowed
+               $illegal_chars = array(':', '\\', '/', '?', '*', '[', ']');
+               for ($i = 0; $i < count($illegal_chars); $i++)
+                       $name = str_replace($illegal_chars[$i], '', $name);
+               // Now, if name is longer than 31 chars, truncate it
+               if (strlen($name) > 31)
+                       $name = substr($name, 0, 31);
+               return $name;
+       }
+       
        function NumFormat($dec) 
        {
                if (!isset($this->formatAmount[$dec]))
@@ -161,7 +200,7 @@ class FrontReport extends Spreadsheet_Excel_Writer_Workbook
                return $this->formatAmount[$dec];
        }
 
-       function Font($style = 'normal')
+       function Font($fontname = '', $style = 'normal')
        {
        }
 
@@ -278,6 +317,168 @@ class FrontReport extends Spreadsheet_Excel_Writer_Workbook
                return;
        }
 
+       // Alternate header style - primary differences are for PDFs
+       function Header3()
+       {
+               // Flag to make sure we only print the company name once
+               $companyNamePrinted = false;
+               
+               $this->y = 0;
+               $tcol = $this->numcols - 1;
+               $this->sheet->setRow($this->y, 20);
+               // Title
+               for ($i = 0; $i < $this->numcols; $i++)
+                       $this->sheet->writeBlank($this->y, $i, $this->formatTitle);
+               $this->sheet->writeString($this->y, 0, $this->title, $this->formatTitle);
+               $this->sheet->mergeCells($this->y, 0, $this->y, $tcol);
+
+               // Dimension 1 - optional
+               // - only print if available and not blank
+               if (count($this->params) > 3)
+                       if ($this->params[3]['from'] != '')
+                       {
+                               $this->NewLine();
+                               $str = $this->params[3]['text'] . ':';
+                               $this->sheet->writeString($this->y, 0, $str, $this->formatLeft);
+                               $this->sheet->writeString($this->y, 1, $this->params[3]['from'], $this->formatLeft);
+                               // Company Name - at end of this row
+                               if (!$companyNamePrinted)
+                               {
+                                       $this->sheet->writeString($this->y, $tcol-1, $this->company['coy_name'], $this->formatLeft);
+                                       $this->sheet->mergeCells($this->y, $tcol-1, $this->y, $tcol);
+                                       $companyNamePrinted = true;
+                               }
+                       }
+
+
+               // Dimension 2 - optional
+               // - only print if available and not blank
+               if (count($this->params) > 4)
+                       if ($this->params[4]['from'] != '')
+                       {
+                               $this->NewLine();
+                               $str = $this->params[4]['text'] . ':';
+                               $this->sheet->writeString($this->y, 0, $str, $this->formatLeft);
+                               $this->sheet->writeString($this->y, 1, $this->params[4]['from'], $this->formatLeft);
+                               // Company Name - at end of this row
+                               if (!$companyNamePrinted)
+                               {
+                                       $this->sheet->writeString($this->y, $tcol-1, $this->company['coy_name'], $this->formatLeft);
+                                       $this->sheet->mergeCells($this->y, $tcol-1, $this->y, $tcol);
+                                       $companyNamePrinted = true;
+                               }
+                       }
+                       
+               // Tags - optional
+               // TBD!!!               
+       
+               // 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();
+               $str = _("Report Date") . ':';
+               $this->sheet->writeString($this->y, 0, $str, $this->formatLeft);
+               $str = '';
+               if ($this->params[1]['from'] != '')
+                       $str = $this->params[1]['from'] . ' - ';
+               $str .= $this->params[1]['to'];
+               $this->sheet->writeString($this->y, 1, $str, $this->formatLeft);
+               // Company Name - at end of this row
+               if (!$companyNamePrinted)
+               {
+                       $this->sheet->writeString($this->y, $tcol-1, $this->company['coy_name'], $this->formatLeft);
+                       $this->sheet->mergeCells($this->y, $tcol-1, $this->y, $tcol);
+                       $companyNamePrinted = true;
+               }
+                       
+               // Timestamp of when this copy of the report was generated 
+               $this->NewLine();
+               $str = _("Generated At") . ':';
+               $this->sheet->writeString($this->y, 0, $str, $this->formatLeft);
+               $this->sheet->writeString($this->y, 1, Today() . "  ".Now(), $this->formatLeft);
+
+               // Name of the user that generated this copy of the report
+               $this->NewLine();
+               $str = _("Generated By") . ':';
+               $this->sheet->writeString($this->y, 0, $str, $this->formatLeft);
+               $str = $this->user;
+               $this->sheet->writeString($this->y, 1, $str, $this->formatLeft);
+
+               // Comments - display any user-generated comments for this copy of the report
+               if ($this->params[0] != '')
+               {
+                       $this->NewLine();
+                       $str = _("Comments") . ':';
+                       $this->sheet->writeString($this->y, 0, $str, $this->formatLeft);
+                       $this->sheet->writeString($this->y, 1, $this->params[0], $this->formatLeft);
+               }
+               $this->NewLine();
+
+               if ($this->headers2 != null)
+               {
+                       for ($i = 0, $j = 0; $i < $this->numcols; $i++)
+                       {
+                               if ($this->cols2[$j] >= $this->cols[$i] && $this->cols2[$j] <= $this->cols[$i + 1])
+                               {
+                                       if ($this->aligns2[$j] == "right")
+                                               $this->sheet->writeString($this->y, $i, $this->headers2[$j], $this->formatTopHeaderRight);
+                                       else    
+                                               $this->sheet->writeString($this->y, $i, $this->headers2[$j], $this->formatTopHeaderLeft);
+                                       $j++;   
+                               }
+                               else
+                                       $this->sheet->writeString($this->y, $i, "", $this->formatTopHeaderLeft);
+                       }               
+                       $this->NewLine();
+               }
+
+               for ($i = 0; $i < $this->numcols; $i++)
+               {
+                       if (!isset($this->headers[$i]))
+                               $header = "";
+                       else
+                               $header = $this->headers[$i];
+                       if ($this->aligns[$i] == "right")
+                               if ($this->headers2 == null)
+                                       $this->sheet->writeString($this->y, $i, $header, $this->formatHeaderRight);
+                               else
+                                       $this->sheet->writeString($this->y, $i, $header, $this->formatBottomHeaderRight);
+                       else    
+                               if ($this->headers2 == null)
+                                       $this->sheet->writeString($this->y, $i, $header, $this->formatHeaderLeft);
+                               else
+                                       $this->sheet->writeString($this->y, $i, $header, $this->formatBottomHeaderLeft);
+               }
+               $this->NewLine();
+       }
+
+       /**
+        * 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:<ul><li>0: user's default (default)</li></ul>
+        * @param int $output_format Format of the output string.  Possible values are:<ul><li>0: Month (word) Day (numeric), 4-digit Year - Example: January 1, 2000 (default)</li><li>1: Month 4-digit Year - Example: January 2000</li><li>2: Month Abbreviation 4-digit Year - Example: Jan 2000</li></ul>
+        * @access public
+        */
+       function DatePrettyPrint($date, $input_format = 0, $output_format = 0)
+       {
+               if ($date != '')
+               {
+                       $date = date2sql($date);
+                       $year = (int) (substr($date, 0, 4));
+                       $month = (int) (substr($date, 5, 2));
+                       $day = (int) (substr($date, 8, 2));
+                       if ($output_format == 0)
+                               return(date('F j, Y', mktime(12, 0, 0, $month, $day, $year)));
+                       elseif ($output_format == 1)
+                               return(date('F Y', mktime(12, 0, 0, $month, $day, $year)));
+                       elseif ($output_format == 2)
+                               return(date('M Y', mktime(12, 0, 0, $month, $day, $year)));
+               }
+               else
+                       return $date;
+       }
+               
        function AddImage($logo, $x, $y, $w, $h)
        {
                return;
@@ -293,17 +494,32 @@ class FrontReport extends Spreadsheet_Excel_Writer_Workbook
                return;
        }
 
-       function Text($c, $txt, $n=0, $corr=0, $r=0)
+       function SetFillColor($r, $g, $b)
+       {
+               return;
+       }
+       
+       function GetCellPadding()
+       {
+               return 0;
+       }
+       
+       function SetCellPadding($pad)
+       {
+               return;
+       }
+       
+       function Text($c, $txt, $n=0, $corr=0, $r=0, $align='left', $border=0, $fill=0, $link=NULL, $stretch=0)
        {
                return;
        }
 
-       function TextWrap($xpos, $ypos, $len, $str, $align = 'left')
+       function TextWrap($xpos, $ypos, $len, $str, $align = 'left', $border = 0, $fill = 0, $link = NULL, $stretch = 0)
        {
                return;
        }
 
-       function TextCol($c, $n, $txt, $corr=0, $r=0)
+       function TextCol($c, $n, $txt, $corr=0, $r=0, $border=0, $fill=0, $link=NULL, $stretch=0)
        {
                if ($this->aligns[$c] == 'right')
                        $this->sheet->writeString($this->y, $c, $txt, $this->formatRight);
@@ -313,14 +529,21 @@ class FrontReport extends Spreadsheet_Excel_Writer_Workbook
                        $this->sheet->mergeCells($this->y, $c, $this->y, $n - 1);
        }
 
-       function AmountCol($c, $n, $txt, $dec=0, $corr=0, $r=0) 
+       function AmountCol($c, $n, $txt, $dec=0, $corr=0, $r=0, $border=0, $fill=0, $link=NULL, $stretch=0) 
+       { 
+               if (!is_numeric($txt))
+                       $txt = 0;
+               $this->sheet->writeNumber($this->y, $c, $txt, $this->NumFormat($dec)); 
+       }
+       
+       function AmountCol2($c, $n, $txt, $dec=0, $corr=0, $r=0, $border=0, $fill=0, $link=NULL, $stretch=0, $amount_locale = NULL, $amount_format = NULL) 
        { 
                if (!is_numeric($txt))
                        $txt = 0;
                $this->sheet->writeNumber($this->y, $c, $txt, $this->NumFormat($dec)); 
        }
        
-       function DateCol($c, $n, $txt, $conv=false, $corr=0, $r=0) 
+       function DateCol($c, $n, $txt, $conv=false, $corr=0, $r=0, $border=0, $fill=0, $link=NULL, $stretch=0
        {
                if (!$conv)
                        $txt = date2sql($txt);
@@ -329,23 +552,62 @@ class FrontReport extends Spreadsheet_Excel_Writer_Workbook
                $this->sheet->writeNumber($this->y, $c, $date, $this->formatDate);
        }
 
-       function TextCol2($c, $n, $txt, $corr=0, $r=0)
+       function TextCol2($c, $n, $txt, $corr=0, $r=0, $border=0, $fill=0, $link=NULL, $stretch=0)
        {
                $this->sheet->writeString($this->y, $c, $txt, $this->formatLeft);
                if ($n - $c > 1)
                        $this->sheet->mergeCells($this->y, $c, $this->y, $n - 1);
        }
 
-       function TextColLines($c, $n, $txt, $corr=0, $r=0)
+       function TextColLines($c, $n, $txt, $corr=0, $r=0, $border=0, $fill=0, $link=NULL, $stretch=0)
        {
                return;
        }
 
-       function TextWrapLines($c, $width, $txt, $align='left')
+       function TextWrapLines($c, $width, $txt, $align='left', $border=0, $fill=0, $link=NULL, $stretch=0)
        {
                return;
        }
 
+       /**
+        * Crude text wrap calculator based on PDF version.
+        */
+       function TextWrapCalc($txt, $width, $spacebreak=false)
+       {
+               // Assume an average character width
+               $avg_char_width = 5;
+               $ret = "";
+               $txt2 = $txt;
+               $w = strlen($txt) * $avg_char_width;
+               if ($w > $width && $w > 0 && $width != 0)
+               {
+                       $n = strlen($txt);
+                       $k = intval($n * $width / $w);
+                       if ($k > 0 && $k < $n)
+                       {
+                               $txt2 = substr($txt, 0, $k);
+                               if ($spacebreak && (($pos = strrpos($txt2, " ")) !== false))
+                               {
+                                       $txt2 = substr($txt2, 0, $pos);
+                                       $ret = substr($txt, $pos+1);
+                               }
+                               else
+                                       $ret = substr($txt, $k);
+                       }
+               }
+               return array($txt2, $ret);
+       }
+
+       function SetLineStyle($style)
+       {
+               return;
+       }
+
+       function SetLineWidth($width)
+       {
+               return;
+       }
+       
        function LineTo($from, $row, $to, $row2)
        {
                return;
@@ -356,7 +618,12 @@ class FrontReport extends Spreadsheet_Excel_Writer_Workbook
                return;
        }
 
-       function NewLine($l=1, $np=0)
+       function UnderlineCell($c, $r = 0, $type = 1, $linewidth = 0, $style = array())
+       {
+               return;
+       }
+       
+       function NewLine($l=1, $np=0, $h=NULL)
        {
                $this->y += $l;
        }
@@ -397,7 +664,7 @@ class FrontReport extends Spreadsheet_Excel_Writer_Workbook
        function px2units($px) // XLS app conversion. Not bulletproof.
        {
                $excel_column_width_factor = 256;
-               $unit_offset_length = 6.5;
+               $unit_offset_length = $this->excelColWidthFactor;
                return ($px / $unit_offset_length);
        }