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 include_once($path_to_root . "/includes/prefs/sysprefs.inc");
13 include_once($path_to_root . "/inventory/includes/inventory_db.inc");
34 function items_cart($type)
36 $this->trans_type = $type;
40 // --------------- line item functions
42 function add_to_cart($line_no, $stock_id, $qty, $standard_cost, $description=null)
45 if (isset($stock_id) && $stock_id != "" && isset($qty))
47 $this->line_items[$line_no] = new line_item($stock_id, $qty,
48 $standard_cost, $description);
53 // shouldn't come here under normal circumstances
54 display_error("unexpected - adding an invalid item or null quantity", "", true);
60 function find_cart_item($stock_id)
62 foreach($this->line_items as $line_no=>$line) {
63 if ($line->stock_id == $stock_id)
64 return $this->line_items[$line_no];
69 function update_cart_item($line_no, $qty, $standard_cost)
71 $this->line_items[$line_no]->quantity = $qty;
72 $this->line_items[$line_no]->standard_cost = $standard_cost;
75 function remove_from_cart($line_no)
77 array_splice($this->line_items, $line_no, 1);
80 function count_items()
82 return count($this->line_items);
86 Checks cart quantities on document_date.
87 Returns array of stock_ids which stock quantities would go negative on some day.
89 function check_qoh($location, $date_, $reverse=false)
93 // collect quantities by stock_id
95 foreach ($this->line_items as $line_no => $line_item)
97 $qty = $reverse ? -$line_item->quantity : $line_item->quantity;
99 $qtys[$line_item->stock_id]['qty'] = $qty + @$qtys[$line_item->stock_id]['qty'];
100 $qtys[$line_item->stock_id]['line'] = $line_no;
103 foreach($qtys as $stock_id => $sum)
105 $fail = check_negative_stock($stock_id, $sum['qty'], $location, $date_);
107 $low_stock[] = $stock_id;
113 // ----------- GL item functions
115 function add_gl_item($code_id, $dimension_id, $dimension2_id, $amount, $reference, $description=null)
117 if (isset($code_id) && $code_id != "" && isset($amount) && isset($dimension_id) &&
118 isset($dimension2_id))
120 $this->gl_items[] = new gl_item($code_id, $dimension_id, $dimension2_id, $amount, $reference, $description);
125 // shouldn't come here under normal circumstances
126 display_error("unexpected - invalid parameters in add_gl_item($code_id, $dimension_id, $dimension2_id, $amount,...)", "", true);
132 function update_gl_item($index, $code_id, $dimension_id, $dimension2_id, $amount, $reference, $description=null)
134 $this->gl_items[$index]->code_id = $code_id;
135 $this->gl_items[$index]->dimension_id = $dimension_id;
136 $this->gl_items[$index]->dimension2_id = $dimension2_id;
137 $this->gl_items[$index]->amount = $amount;
138 $this->gl_items[$index]->reference = $reference;
139 if ($description == null)
140 $this->gl_items[$index]->description = get_gl_account_name($code_id);
142 $this->gl_items[$index]->description = $description;
146 function remove_gl_item($index)
148 array_splice($this->gl_items, $index, 1);
151 function count_gl_items()
153 return count($this->gl_items);
156 function gl_items_total()
159 foreach ($this->gl_items as $gl_item)
160 $total += $gl_item->amount;
164 function gl_items_total_debit()
167 foreach ($this->gl_items as $gl_item)
169 if ($gl_item->amount > 0)
170 $total += $gl_item->amount;
175 function gl_items_total_credit()
178 foreach ($this->gl_items as $gl_item)
180 if ($gl_item->amount < 0)
181 $total += $gl_item->amount;
186 // ------------ common functions
188 function clear_items()
190 unset($this->line_items);
191 $this->line_items = array();
193 unset($this->gl_items);
194 $this->gl_items = array();
199 //--------------------------------------------------------------------------------------------
204 var $item_description;
212 function line_item ($stock_id, $qty, $standard_cost=null, $description=null)
214 $item_row = get_item($stock_id);
216 if ($item_row == null)
217 display_error("invalid item added to order : $stock_id", "");
219 $this->mb_flag = $item_row["mb_flag"];
220 $this->units = $item_row["units"];
222 if ($description == null)
223 $this->item_description = $item_row["description"];
225 $this->item_description = $description;
227 if ($standard_cost == null)
228 $this->standard_cost = $item_row["actual_cost"];
230 $this->standard_cost = $standard_cost;
232 $this->stock_id = $stock_id;
233 $this->quantity = $qty;
234 //$this->price = $price;
239 This method is generally obsolete and subject to removal in FA 2.4 (preserved for now to support 2.3 extensions).
240 Use items_cart::check_qoh instead.
242 function check_qoh($location, $date_, $reverse)
246 if (!$SysPrefs->allow_negative_stock())
248 if (has_stock_holding($this->mb_flag))
250 $quantity = $this->quantity;
252 $quantity = -$this->quantity;
257 $fail = check_negative_stock($this->stock_id, $quantity, $location, $date_);
267 //---------------------------------------------------------------------------------------
279 function gl_item($code_id, $dimension_id, $dimension2_id, $amount, $reference,
282 //echo "adding $index, $code_id, $dimension_id, $amount, $reference<br>";
284 if ($description == null)
285 $this->description = get_gl_account_name($code_id);
287 $this->description = $description;
289 $this->code_id = $code_id;
290 $this->dimension_id = $dimension_id;
291 $this->dimension2_id = $dimension2_id;
292 $this->amount = $amount;
293 $this->reference = $reference;
297 //---------------------------------------------------------------------------------------