Changeset 693 for trunk/phpbms/modules/bms/report/invoices_pdfquote.php

Timestamp:

12/31/09 13:36:45 (2 years ago)

Author:

brieb

Message:

• Introduced administratively changeable settings to indvidual reports
• Modified all reports to work with new settings system
• Altered invoice and line item total reports to accept parameters from reportsettings: You can now bypass the grouping/column dialog by providing the infrmation administratively
• Altered all sales order PDF reports to accept parameters from reportsettings: You can now administratively change certain aspects of the print outs, including what parts of the top of the report to show, and what to title the report
• Altered label reports to accept parameters from reportsettings: printed data as well

as label measurements and layout are now defined by administratively

• Altered export and tableprint reports to accept parameters from reportsettings: You can specify individual columns and from table instead of just the defaults (all fields, main table only)
• Added var_dump-esque 'debug' function for development purposes to common functions
• Integrated FPDI functionality with sales order PDF reports: It is now possible to use a PDF saved in the files table as a background template for your invoices (e.g. watermarks)

Files:

• trunk/phpbms/modules/bms/report/invoices_pdfquote.php (modified) (1 diff)

trunk/phpbms/modules/bms/report/invoices_pdfquote.php

@@ -37 +37 @@
  +-------------------------------------------------------------------------+
 */
-if(!isset($_SESSION["userinfo"]["id"])){
-
-        //IE needs caching to be set to private in order to display PDFS
-        session_cache_limiter('private');
-
-        //set encoding to latin1 (fpdf doesnt like utf8)
-        $sqlEncoding = "latin1";
-        require_once("../../../include/session.php");
-
-}//end if
-
 if(!class_exists("invoicePDF"))
-        include("invoices_pdf_class.php");
+    include("invoices_pdf_class.php");
 
 class  quotePDF extends invoicePDF{
 
-        var $title = "Quote";
+    function quotePDF($db, $reportUUID, $tabledefUUID, $orientation='P', $unit='mm', $format='Letter'){
 
-        function quotePDF($db, $orientation='P', $unit='mm', $format='Letter'){
+        $this->invoicePDF($db, $reportUUID, $tabledefUUID, $orientation, $unit, $format);
 
-                $this->invoicePDF($db, $orientation, $unit, $format);
+    }//end method
 
-        }//end method
 
-        function initialize(){
-                parent::initialize();
+    /**
+     * function checkForDefaultSettings
+     *
+     * Checks to make sure loaded report Settings exist and are correct
+     */
+    function checkForDefaultSettings(){
 
-                unset($this->totalsinfo[5]);
+        if(!isset($this->settings["reportTitle"]))
+            $this->settings["reportTitle"] = "Quote";
 
-        }//end method
+        parent::checkForDefaultSettings();
+
+    }//end function checkForDefaultSettings
+
+
+    function initialize(){
+
+        parent::initialize();
+
+        unset($this->totalsinfo[5]);
+
+    }//end method
+
+
+    /**
+     * function addingRecordDefaultSettings
+     *
+     * Creates an array of settings associative arrays for use by the system when
+     * a new report record is added that references the file containing this class
+     *
+     * @retrun array of settings. Each setting should itself be
+     * an associative array containing the following
+     * name: name of the setting
+     * defaultvalue: default value for setting
+     * type: (string, int, real, bool) type for value of setting
+     * required: (0,1) whether the setting is required or not
+     * description: brief description for what this setting is used for.
+     */
+    function addingRecordDefaultSettings(){
+
+        $settings = parent::addingRecordDefaultSettings();
+
+        for($i=0; $i< count($settings); $i++){
+
+            switch($settings[$i]["name"]){
+
+                case "reportTitle":
+                    $settings[$i]["defaultValue"] = "Quote";
+
+            }//endswitch
+
+        }//end foreach
+
+        return $settings;
+
+    }//endfunction addingRecordDefaultSettings
 
 }//end class
 
-//PROCESSING
-//=============================================================================
+
+/**
+ * PROCESSING
+ * =============================================================================
+ */
 if(!isset($noOutput)){
 
-        $report = new quotePDF($db, 'P', 'in', 'Letter');
-        $report->showShipNameInShipTo = false;
+    //IE needs caching to be set to private in order to display PDFS
+    session_cache_limiter('private');
 
-        $report->setupFromPrintScreen();
-        $report->generate();
-        
-        $filename = "Quote";
-        if($report->count === 1){
-                
-                if($report->invoicerecord["company"])
-                        $filename .= "_".$report->invoicerecord["company"];
-                
-                $filename .= "_".$report->invoicerecord["id"];
-                
-        }elseif((int)$report->count)
-                $filename .= "_Multiple";
-        
-        $filename .= ".pdf";
-        
-        $report->output('screen', $filename);
+    //set encoding to latin1 (fpdf doesnt like utf8)
+    $sqlEncoding = "latin1";
+    require_once("../../../include/session.php");
+
+    checkForReportArguments();
+
+    $report = new quotePDF($db, $_GET["rid"], $_GET["tid"], 'P', 'in', 'Letter');
+    $report->showShipNameInShipTo = false;
+
+    $report->setupFromPrintScreen();
+    $report->generate();
+
+    $filename = "Quote";
+    if($report->count === 1){
+
+        if($report->invoicerecord["company"])
+            $filename .= "_".$report->invoicerecord["company"];
+
+        $filename .= "_".$report->invoicerecord["id"];
+
+    }elseif((int)$report->count)
+        $filename .= "_Multiple";
+
+    $filename .= ".pdf";
+
+    $report->output('screen', $filename);
 
 }//end if
 
 
+/**
+ * When adding a new report record, the add/edit needs to know what the class
+ * name is so that it can instantiate it, and grab it's default settings.
+ */
+if(isset($addingReportRecord))
+    $reportClass ="quotePDF";
 ?>