Added db_write/db_void hooks.
[fa-stable.git] / purchasing / includes / db / po_db.inc
1 <?php
2 /**********************************************************************
3     Copyright (C) FrontAccounting, LLC.
4         Released under the terms of the GNU General Public License, GPL, 
5         as published by the Free Software Foundation, either version 3 
6         of the License, or (at your option) any later version.
7     This program is distributed in the hope that it will be useful,
8     but WITHOUT ANY WARRANTY; without even the implied warranty of
9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
10     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
11 ***********************************************************************/
12 //----------------------------------------------------------------------------------------
13
14 function delete_po($po)
15 {
16         hook_db_prevoid($po, ST_PURCHORDER);
17         $sql = "DELETE FROM ".TB_PREF."purch_orders WHERE order_no=".db_escape($po);
18         db_query($sql, "The order header could not be deleted");
19
20         $sql = "DELETE FROM ".TB_PREF."purch_order_details WHERE order_no =".db_escape($po);
21         db_query($sql, "The order detail lines could not be deleted");
22 }
23
24 //----------------------------------------------------------------------------------------
25
26 function add_po(&$po_obj)
27 {
28         global $Refs;
29
30         begin_transaction();
31         hook_db_prewrite($po_obj, ST_PURCHORDER);
32
33      /*Insert to purchase order header record */
34      $sql = "INSERT INTO ".TB_PREF."purch_orders (supplier_id, Comments, ord_date, reference, 
35         requisition_no, into_stock_location, delivery_address, total, tax_included) VALUES(";
36      $sql .= db_escape($po_obj->supplier_id) . "," .
37          db_escape($po_obj->Comments) . ",'" .
38          date2sql($po_obj->orig_order_date) . "', " .
39                  db_escape($po_obj->reference) . ", " .
40          db_escape($po_obj->supp_ref) . ", " .
41          db_escape($po_obj->Location) . ", " .
42          db_escape($po_obj->delivery_address) . ", " .
43          db_escape($po_obj->get_trans_total()). ", " .
44          db_escape($po_obj->tax_included) . ")";
45
46         db_query($sql, "The purchase order header record could not be inserted");
47
48      /*Get the auto increment value of the order number created from the sql above */
49      $po_obj->order_no = db_insert_id();
50
51      /*Insert the purchase order detail records */
52      foreach ($po_obj->line_items as $line_no => $po_line)
53      {
54                 $sql = "INSERT INTO ".TB_PREF."purch_order_details (order_no, item_code, description, delivery_date,    unit_price,     quantity_ordered) VALUES (";
55                 $sql .= $po_obj->order_no . ", " . db_escape($po_line->stock_id). "," .
56                 db_escape($po_line->item_description). ",'" .
57                 date2sql($po_line->req_del_date) . "'," .
58                 db_escape($po_line->price) . ", " .
59                 db_escape($po_line->quantity). ")";
60                 db_query($sql, "One of the purchase order detail records could not be inserted");
61                 $po_obj->line_items[$line_no]->po_detail_rec = db_insert_id();
62      }
63
64         $Refs->save(ST_PURCHORDER, $po_obj->order_no, $po_obj->reference);
65
66         //add_comments(ST_PURCHORDER, $po_obj->order_no, $po_obj->orig_order_date, $po_obj->Comments);
67
68         add_audit_trail(ST_PURCHORDER, $po_obj->order_no, $po_obj->orig_order_date);
69         hook_db_postwrite($po_obj, ST_PURCHORDER);
70         commit_transaction();
71
72         return $po_obj->order_no;
73 }
74
75 //----------------------------------------------------------------------------------------
76
77 function update_po(&$po_obj)
78 {
79         begin_transaction();
80         hook_db_prewrite($po_obj, ST_PURCHORDER);
81
82     /*Update the purchase order header with any changes */
83     $sql = "UPDATE ".TB_PREF."purch_orders SET Comments=" . db_escape($po_obj->Comments) . ",
84                 requisition_no= ". db_escape( $po_obj->supp_ref). ",
85                 into_stock_location=" . db_escape($po_obj->Location). ",
86                 ord_date='" . date2sql($po_obj->orig_order_date) . "',
87                 delivery_address=" . db_escape($po_obj->delivery_address).",
88                 total=". db_escape($po_obj->get_trans_total()).",
89                 tax_included=". db_escape($po_obj->tax_included);
90     $sql .= " WHERE order_no = " . $po_obj->order_no;
91         db_query($sql, "The purchase order could not be updated");
92
93         $sql = "DELETE FROM ".TB_PREF."purch_order_details WHERE order_no="
94                 .db_escape($po_obj->order_no);
95         db_query($sql, "could not delete old purch order details");
96
97     /*Now Update the purchase order detail records */
98     foreach ($po_obj->line_items as $po_line)
99     {
100         $sql = "INSERT INTO ".TB_PREF."purch_order_details (po_detail_item, order_no, item_code, 
101                 description, delivery_date, unit_price, quantity_ordered) VALUES ("
102                         .db_escape($po_line->po_detail_rec ? $po_line->po_detail_rec : 0). ","
103                         .$po_obj->order_no . ","
104                         .db_escape($po_line->stock_id). ","
105                         .db_escape($po_line->item_description). ",'"
106                         .date2sql($po_line->req_del_date) . "',"
107                         .db_escape($po_line->price) . ", "
108                         .db_escape($po_line->quantity) . ")";
109                 
110                 db_query($sql, "One of the purchase order detail records could not be updated");
111     }
112
113         // add_comments(ST_PURCHORDER, $po_obj->order_no, $po_obj->orig_order_date, $po_obj->Comments);
114
115         add_audit_trail($po_obj->trans_type, $po_obj->order_no, Today(), _("Updated."));
116         hook_db_postwrite($po_obj, ST_PURCHORDER);
117         commit_transaction();
118
119         return $po_obj->order_no;
120 }
121
122 //----------------------------------------------------------------------------------------
123
124 function read_po_header($order_no, &$order)
125 {
126         $sql = "SELECT ".TB_PREF."purch_orders.*, ".TB_PREF."suppliers.supp_name, ".TB_PREF."suppliers.tax_group_id,
127                 ".TB_PREF."suppliers.curr_code, ".TB_PREF."locations.location_name
128                 FROM ".TB_PREF."purch_orders, ".TB_PREF."suppliers, ".TB_PREF."locations
129                 WHERE ".TB_PREF."purch_orders.supplier_id = ".TB_PREF."suppliers.supplier_id
130                 AND ".TB_PREF."locations.loc_code = into_stock_location
131                 AND ".TB_PREF."purch_orders.order_no = ".db_escape($order_no);
132
133         $result = db_query($sql, "The order cannot be retrieved");
134
135         if (db_num_rows($result) == 1)
136         {
137
138         $myrow = db_fetch($result);
139
140         $order->order_no = $order_no;
141         
142         $order->set_supplier($myrow["supplier_id"], $myrow["supp_name"], $myrow["curr_code"],
143                 $myrow['tax_group_id'], $myrow["tax_included"]);
144
145                 $order->credit = get_current_supp_credit($order->supplier_id);
146
147         $order->orig_order_date = sql2date($myrow["ord_date"]);
148         $order->Comments = $myrow["comments"];
149         $order->Location = $myrow["into_stock_location"];
150         $order->supp_ref = $myrow["requisition_no"];
151         $order->reference = $myrow["reference"];
152         $order->delivery_address = $myrow["delivery_address"];
153
154         return true;
155         }
156
157         display_db_error("FATAL : duplicate purchase order found", "", true);
158         return false;
159 }
160
161 //----------------------------------------------------------------------------------------
162
163 function read_po_items($order_no, &$order, $open_items_only=false)
164 {
165         /*now populate the line po array with the purchase order details records */
166
167         $sql = "SELECT ".TB_PREF."purch_order_details.*, units
168                 FROM ".TB_PREF."purch_order_details
169                 LEFT JOIN ".TB_PREF."stock_master
170                 ON ".TB_PREF."purch_order_details.item_code=".TB_PREF."stock_master.stock_id
171                 WHERE order_no =".db_escape($order_no);
172
173     if ($open_items_only)
174                 $sql .= " AND (".TB_PREF."purch_order_details.quantity_ordered > ".TB_PREF."purch_order_details.quantity_received) ";
175
176         $sql .= " ORDER BY po_detail_item";
177
178         $result = db_query($sql, "The lines on the purchase order cannot be retrieved");
179
180     if (db_num_rows($result) > 0)
181     {
182                 while ($myrow = db_fetch($result))
183         {
184                 $data = get_purchase_data($order->supplier_id, $myrow['item_code']);
185                 if ($data !== false)
186                 {
187                         if ($data['supplier_description'] != "")
188                                 $myrow['description'] = $data['supplier_description'];
189                         //if ($data['suppliers_uom'] != "")
190                         //      $myrow['units'] = $data['suppliers_uom'];
191                 }               
192             if (is_null($myrow["units"]))
193             {
194                         $units = "";
195             }
196             else
197             {
198                 $units = $myrow["units"];
199             }
200
201             if ($order->add_to_order($order->lines_on_order, $myrow["item_code"],
202                 $myrow["quantity_ordered"],$myrow["description"],
203                 $myrow["unit_price"],$units, sql2date($myrow["delivery_date"]),
204                 $myrow["qty_invoiced"], $myrow["quantity_received"])) {
205                         $newline = &$order->line_items[$order->lines_on_order-1];
206                                         $newline->po_detail_rec = $myrow["po_detail_item"];
207                                         $newline->standard_cost = $myrow["std_cost_unit"];  /*Needed for receiving goods and GL interface */
208                                 // set for later GRN edition
209 //                      $newline->receive_qty = $newline->quantity - $newline->qty_dispatched;
210                         }
211         } /* line po from purchase order details */
212     } //end of checks on returned data set
213 }
214
215 //----------------------------------------------------------------------------------------
216
217 function read_po($order_no, &$order, $open_items_only=false)
218 {
219         $result = read_po_header($order_no, $order);
220
221         if ($result)
222                 read_po_items($order_no, $order, $open_items_only);
223 }
224
225 //----------------------------------------------------------------------------------------
226
227 function get_po_items($order_no)
228 {
229         $sql = "SELECT item_code, quantity_ordered, quantity_received, qty_invoiced
230                 FROM ".TB_PREF."purch_order_details
231                 WHERE order_no=".db_escape($order_no)
232                 ." ORDER BY po_detail_item";
233
234         $result = db_query($sql, "could not query purch order details");
235     check_db_error("Could not check that the details of the purchase order had not been changed by another user ", $sql);
236     return $result;
237 }
238 //----------------------------------------------------------------------------------------
239
240 function get_short_info($stock_id)
241 {
242         $sql = "SELECT description, units, mb_flag
243                 FROM ".TB_PREF."stock_master WHERE stock_id = ".db_escape($stock_id);
244
245         return db_query($sql,"The stock details for " . $stock_id . " could not be retrieved");
246 }
247
248 function get_sql_for_po_search_completed()
249 {
250         global $order_number, $selected_stock_item;;
251
252         $sql = "SELECT 
253                 porder.order_no, 
254                 porder.reference, 
255                 supplier.supp_name, 
256                 location.location_name,
257                 porder.requisition_no, 
258                 porder.ord_date, 
259                 supplier.curr_code, 
260                 Sum(line.unit_price*line.quantity_ordered) AS OrderValue,
261                 porder.into_stock_location
262                 FROM ".TB_PREF."purch_orders as porder, "
263                         .TB_PREF."purch_order_details as line, "
264                         .TB_PREF."suppliers as supplier, "
265                         .TB_PREF."locations as location
266                 WHERE porder.order_no = line.order_no
267                 AND porder.supplier_id = supplier.supplier_id
268                 AND location.loc_code = porder.into_stock_location ";
269
270         if (isset($order_number) && $order_number != "")
271         {
272                 $sql .= "AND porder.reference LIKE ".db_escape('%'. $order_number . '%');
273         }
274         else
275         {
276
277                 $data_after = date2sql($_POST['OrdersAfterDate']);
278                 $date_before = date2sql($_POST['OrdersToDate']);
279
280                 $sql .= " AND porder.ord_date >= '$data_after'";
281                 $sql .= " AND porder.ord_date <= '$date_before'";
282
283                 if (isset($_POST['StockLocation']) && $_POST['StockLocation'] != ALL_TEXT)
284                 {
285                         $sql .= " AND porder.into_stock_location = ".db_escape($_POST['StockLocation']);
286                 }
287                 if (isset($selected_stock_item))
288                 {
289                         $sql .= " AND line.item_code=".db_escape($selected_stock_item);
290                 }
291
292         } //end not order number selected
293
294         $sql .= " GROUP BY porder.order_no";
295         return $sql;
296 }       
297
298 function get_sql_for_po_search()
299 {
300         global $all_items, $order_number, $selected_stock_item;;
301         
302         $sql = "SELECT 
303                 porder.order_no, 
304                 porder.reference,
305                 supplier.supp_name, 
306                 location.location_name,
307                 porder.requisition_no, 
308                 porder.ord_date,
309                 supplier.curr_code,
310                 Sum(line.unit_price*line.quantity_ordered) AS OrderValue,
311                 Sum(line.delivery_date < '". date2sql(Today()) ."'
312                 AND (line.quantity_ordered > line.quantity_received)) As OverDue
313                 FROM "
314                         .TB_PREF."purch_orders as porder, "
315                         .TB_PREF."purch_order_details as line, "
316                         .TB_PREF."suppliers as supplier, "
317                         .TB_PREF."locations as location
318                 WHERE porder.order_no = line.order_no
319                 AND porder.supplier_id = supplier.supplier_id
320                 AND location.loc_code = porder.into_stock_location
321                 AND (line.quantity_ordered > line.quantity_received) ";
322
323         if (isset($order_number) && $order_number != "")
324         {
325                 $sql .= "AND porder.reference LIKE ".db_escape('%'. $order_number . '%');
326         }
327         else
328         {
329                 $data_after = date2sql($_POST['OrdersAfterDate']);
330                 $data_before = date2sql($_POST['OrdersToDate']);
331
332                 $sql .= "  AND porder.ord_date >= '$data_after'";
333                 $sql .= "  AND porder.ord_date <= '$data_before'";
334
335                 if (isset($_POST['StockLocation']) && $_POST['StockLocation'] != $all_items)
336                 {
337                         $sql .= " AND porder.into_stock_location = ".db_escape($_POST['StockLocation']);
338                 }
339
340                 if (isset($selected_stock_item))
341                 {
342                         $sql .= " AND line.item_code=".db_escape($selected_stock_item);
343                 }
344         } //end not order number selected
345
346         $sql .= " GROUP BY porder.order_no";
347         return $sql;
348 }
349 ?>