Inventory Transfer: removed movement type from transfer form, cleanups.
[fa-stable.git] / inventory / includes / db / items_transfer_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 add_stock_transfer($Items, $location_from, $location_to, $date_, $reference, $memo_)
15 {
16         global $SysPrefs, $path_to_root, $Refs;
17
18         begin_transaction();
19         $args = func_get_args();
20         $args = (object)array_combine(array('Items', 'location_from', 'location_to', 
21         'date_', 'reference', 'memo_'), $args);
22         $args->trans_no = 0;
23         hook_db_prewrite($args, ST_LOCTRANSFER);
24
25         $transfer_id = get_next_trans_no(ST_LOCTRANSFER);
26
27         if ($SysPrefs->loc_notification() == 1)
28         {
29                 include_once($path_to_root . "/inventory/includes/inventory_db.inc");
30                 $st_ids = array();
31                 $st_names = array();
32                 $st_num = array();
33                 $st_reorder = array();
34         }
35         foreach ($Items as $line_item)
36         {
37                 if ($SysPrefs->loc_notification() == 1)
38                         $loc = calculate_reorder_level($location_from, $line_item, $st_ids, $st_names, $st_num, $st_reorder); 
39                 add_stock_transfer_item($transfer_id, $line_item->stock_id, $location_from,
40                         $location_to, $date_, $reference, $line_item->quantity);
41         }
42
43         add_comments(ST_LOCTRANSFER, $transfer_id, $date_, $memo_);
44
45         $Refs->save(ST_LOCTRANSFER, $transfer_id, $reference);
46         add_audit_trail(ST_LOCTRANSFER, $transfer_id, $date_);
47
48         $args->trans_no = $transfer_id;
49         hook_db_postwrite($args, ST_LOCTRANSFER);
50
51         commit_transaction();
52         
53         if ($SysPrefs->loc_notification() == 1 && count($st_ids) > 0)
54                 send_reorder_email($loc, $st_ids, $st_names, $st_num, $st_reorder);
55
56         return $transfer_id;
57 }
58
59 //-------------------------------------------------------------------------------------------------------------
60
61 // add 2 stock_moves entries for a stock transfer
62 // $date_ is display date (not sql)
63 // std_cost is in HOME currency
64 // it seems the standard_cost field is not used at all
65
66 function add_stock_transfer_item($transfer_id, $stock_id, $location_from, $location_to,
67         $date_, $reference, $quantity)
68 {
69         add_stock_move(ST_LOCTRANSFER, $stock_id, $transfer_id, $location_from,
70         $date_, $reference, -$quantity, 0);
71
72         add_stock_move(ST_LOCTRANSFER, $stock_id, $transfer_id, $location_to,
73                 $date_, $reference, $quantity, 0);
74
75 }
76
77 //-------------------------------------------------------------------------------------------------------------
78
79 function get_stock_transfer($trans_no)
80 {
81         $result = get_stock_transfer_items($trans_no);
82         if (db_num_rows($result) < 2)
83         {
84                 display_db_error("transfer with less than 2 items : $trans_no", "");
85         }
86
87         // this function is very bad that it assumes that 1st record and 2nd record contain the
88         // from and to locations - if get_stock_moves uses a different ordering than trans_no then
89         // it will bomb
90         $move1 = db_fetch($result);
91         $move2 = db_fetch($result);
92
93         // return an array of (From, To)
94         if ($move1['qty'] < 0)
95                 return array($move1, $move2);
96         else
97                 return array($move2, $move1);
98 }
99
100 //-------------------------------------------------------------------------------------------------------------
101
102 function get_stock_transfer_items($trans_no)
103 {
104         $result = get_stock_moves(ST_LOCTRANSFER, $trans_no);
105
106         if (db_num_rows($result) == 0)
107         {
108                 return null;
109         }
110
111         return $result;
112 }
113
114 //-------------------------------------------------------------------------------------------------------------
115
116 function void_stock_transfer($type_no)
117 {
118         hook_db_prevoid(ST_LOCTRANSFER, $type_no);
119         void_stock_move(ST_LOCTRANSFER, $type_no);
120 }
121