includes/ui/items_cart.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 include_once($path_to_root . "/includes/prefs/sysprefs.inc");
  13 include_once($path_to_root . "/inventory/includes/inventory_db.inc");
  14
  15 class items_cart
  16 {
  17         var $trans_type;
  18         var $line_items;
  19         var $gl_items;
  20
  21         var     $order_id;
  22
  23         var $editing_item, $deleting_item;
  24
  25         var $from_loc;
  26         var $to_loc;
  27         var $tran_date;
  28         var $transfer_type;
  29         var $increase;
  30         var $memo_;
  31         var $person_id;
  32         var $branch_id;
  33         var $reference;
  34
  35         function items_cart($type)
  36         {
  37                 $this->trans_type = $type;
  38                 $this->clear_items();
  39         }
  40
  41         // --------------- line item functions
  42
  43         function add_to_cart($line_no, $stock_id, $qty, $standard_cost, $description=null)
  44         {
  45
  46                 if (isset($stock_id) && $stock_id != "" && isset($qty))
  47                 {
  48                         $this->line_items[$line_no] = new line_item($stock_id, $qty,
  49                                 $standard_cost, $description);
  50                         return true;
  51                 }
  52                 else
  53                 {
  54                         // shouldn't come here under normal circumstances
  55                         display_db_error("unexpected - adding an invalid item or null quantity", "", true);
  56                 }
  57
  58                 return false;
  59         }
  60
  61         function find_cart_item($stock_id)
  62         {
  63                 foreach($this->line_items as $line_no=>$line) {
  64                         if ($line->stock_id == $stock_id)
  65                                 return $this->line_items[$line_no];
  66                 }
  67                 return null;
  68         }
  69
  70         function update_cart_item($line_no, $qty, $standard_cost)
  71         {
  72                 $this->line_items[$line_no]->quantity = $qty;
  73                 $this->line_items[$line_no]->standard_cost = $standard_cost;
  74         }
  75
  76         function remove_from_cart($line_no)
  77         {
  78                 array_splice($this->line_items, $line_no, 1);
  79         }
  80
  81         function count_items()
  82         {
  83                 return count($this->line_items);
  84         }
  85
  86         function check_qoh($location, $date_, $reverse=false)
  87         {
  88                 foreach ($this->line_items as $line_no => $line_item)
  89                 {
  90                         $item_ret = $line_item->check_qoh($location, $date_, $reverse);
  91                         if ($item_ret != null)
  92                                 return $line_no;
  93                 }
  94                 return -1;
  95         }
  96
  97         // ----------- GL item functions
  98
  99         function add_gl_item($code_id, $dimension_id, $dimension2_id, $amount, $reference, $description=null)
 100         {
 101                 if (isset($code_id) && $code_id != "" && isset($amount) && isset($dimension_id)  &&
 102                         isset($dimension2_id))
 103                 {
 104                         $this->gl_items[] = new gl_item($code_id, $dimension_id, $dimension2_id, $amount, $reference, $description);
 105                         return true;
 106                 }
 107                 else
 108                 {
 109                         // shouldn't come here under normal circumstances
 110                         display_db_error("unexpected - invalid parameters in add_gl_item($code_id, $dimension_id, $dimension2_id, $amount,...)", "", true);
 111                 }
 112
 113                 return false;
 114         }
 115
 116         function update_gl_item($index, $dimension_id, $dimension2_id, $amount, $reference, $description=null)
 117         {
 118                 $this->gl_items[$index]->dimension_id = $dimension_id;
 119                 $this->gl_items[$index]->dimension2_id = $dimension2_id;
 120                 $this->gl_items[$index]->amount = $amount;
 121                 $this->gl_items[$index]->reference = $reference;
 122                 if ($description != null)
 123                         $this->gl_items[$index]->description = $description;
 124
 125         }
 126
 127         function remove_gl_item($index)
 128         {
 129                 array_splice($this->gl_items, $index, 1);
 130         }
 131
 132         function count_gl_items()
 133         {
 134                 return count($this->gl_items);
 135         }
 136
 137         function gl_items_total()
 138         {
 139                 $total = 0;
 140                 foreach ($this->gl_items as $gl_item)
 141                         $total += $gl_item->amount;
 142                 return $total;
 143         }
 144
 145         function gl_items_total_debit()
 146         {
 147                 $total = 0;
 148                 foreach ($this->gl_items as $gl_item)
 149                 {
 150                         if ($gl_item->amount > 0)
 151                                 $total += $gl_item->amount;
 152                 }
 153                 return $total;
 154         }
 155
 156         function gl_items_total_credit()
 157         {
 158                 $total = 0;
 159                 foreach ($this->gl_items as $gl_item)
 160                 {
 161                         if ($gl_item->amount < 0)
 162                                 $total += $gl_item->amount;
 163                 }
 164                 return $total;
 165         }
 166
 167         // ------------ common functions
 168
 169         function clear_items()
 170         {
 171         unset($this->line_items);
 172                 $this->line_items = array();
 173
 174         unset($this->gl_items);
 175                 $this->gl_items = array();
 176
 177         }
 178 }
 179
 180 //--------------------------------------------------------------------------------------------
 181
 182 class line_item
 183 {
 184         var $stock_id;
 185         var $item_description;
 186         var $units;
 187         var $mb_flag;
 188
 189         var $quantity;
 190         var $price;
 191         var $standard_cost;
 192
 193         function line_item ($stock_id, $qty, $standard_cost=null, $description=null)
 194         {
 195                 $item_row = get_item($stock_id);
 196
 197                 if ($item_row == null)
 198                         display_db_error("invalid item added to order : $stock_id", "");
 199
 200                 $this->mb_flag = $item_row["mb_flag"];
 201                 $this->units = $item_row["units"];
 202
 203                 if ($description == null)
 204                         $this->item_description = $item_row["description"];
 205                 else
 206                         $this->item_description = $description;
 207
 208                 if ($standard_cost == null)
 209                         $this->standard_cost = $item_row["actual_cost"];
 210                 else
 211                         $this->standard_cost = $standard_cost;
 212
 213                 $this->stock_id = $stock_id;
 214                 $this->quantity = $qty;
 215                 //$this->price = $price;
 216                 $this->price = 0;
 217         }
 218
 219         function check_qoh($location, $date_, $reverse)
 220         {
 221         if (!sys_prefs::allow_negative_stock())
 222         {
 223                         if (has_stock_holding($this->mb_flag))
 224                         {
 225                                 $quantity = $this->quantity;
 226                                 if ($reverse)
 227                                         $quantity = -$this->quantity;
 228
 229                                 if ($quantity >= 0)
 230                                         return null;
 231
 232                                 $qoh = get_qoh_on_date($this->stock_id, $location, $date_);
 233                         if ($quantity + $qoh < 0)
 234                         {
 235                                 return $this;
 236                         }
 237                 }
 238         }
 239
 240         return null;
 241         }
 242 }
 243
 244 //---------------------------------------------------------------------------------------
 245
 246 class gl_item
 247 {
 248
 249         var $code_id;
 250         var $dimension_id;
 251         var $dimension2_id;
 252         var $amount;
 253         var $reference;
 254         var $description;
 255
 256         function gl_item($code_id, $dimension_id, $dimension2_id, $amount, $reference,
 257                 $description=null)
 258         {
 259                 //echo "adding $index, $code_id, $dimension_id, $amount, $reference<br>";
 260
 261                 if ($description == null)
 262                         $this->description = get_gl_account_name($code_id);
 263                 else
 264                         $this->description = $description;
 265
 266                 $this->code_id = $code_id;
 267                 $this->dimension_id = $dimension_id;
 268                 $this->dimension2_id = $dimension2_id;
 269                 $this->amount = $amount;
 270                 $this->reference = $reference;
 271         }
 272 }
 273
 274 //---------------------------------------------------------------------------------------
 275
 276 ?>