purchasing/includes/po_class.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 /* Definition of the purch_order class to hold all the information for a purchase order and delivery
  13 */
  14
  15 class purch_order
  16 {
  17
  18         var $trans_type; // order/grn/invoice (direct)
  19         var $line_items;
  20         var $curr_code;
  21         var $supp_ref;
  22         var $delivery_address;
  23         var $Comments;
  24         var $Location;
  25         var $supplier_id;
  26         var $supplier_name;
  27         var $orig_order_date;
  28         var $due_date;
  29         var $order_no; /*Only used for modification of existing orders otherwise only established when order committed */
  30         var $lines_on_order = 0;
  31         var $credit;
  32         var $tax_group_id;
  33         var $tax_group_array = null; // saves db queries
  34         var $tax_included; // type of prices
  35         var $terms;
  36         var $ex_rate;
  37         var $cash_account;
  38         var $dimension,
  39                 $dimension2;
  40
  41         var $reference;
  42         var $tax_overrides = array();           // array of taxes manually inserted during sales invoice entry (direct invoice)
  43
  44         var $prep_amount = 0; // prepayment required
  45         var $alloc; // sum of payments allocated
  46         var $prepayments = array();
  47
  48         function purch_order()
  49         {
  50                 /*Constructor function initialises a new purchase order object */
  51                 $this->line_items = array();
  52                 $this->lines_on_order = $this->order_no = $this->supplier_id = 0;
  53         }
  54
  55         function set_supplier($supplier_id, $supplier_name, $curr_code, $tax_group_id, $tax_included)
  56         {
  57                 $this->supplier_id = $supplier_id;
  58                 $this->supplier_name = $supplier_name;
  59                 $this->curr_code = $curr_code;
  60                 $this->tax_group_id = $tax_group_id;
  61                 $this->tax_included = $tax_included;
  62                 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
  63         }
  64
  65         function add_to_order($line_no, $stock_id, $qty, $item_descr, $price, $uom, $req_del_date, $qty_inv, $qty_recd)
  66         {
  67                 if (isset($qty) && $qty != 0)
  68                 {
  69                         $this->line_items[$line_no] = new po_line_details($line_no, $stock_id, $item_descr, $qty, $price, $uom,
  70                                 $req_del_date, $qty_inv, $qty_recd);
  71                         $this->lines_on_order++;
  72                         return 1;
  73                 }
  74                 return 0;
  75         }
  76
  77         function update_order_item($line_no, $qty, $price, $req_del_date, $description="")
  78         {
  79                 if ($description != "")
  80                         $this->line_items[$line_no]->item_description = $description;
  81                 $this->line_items[$line_no]->quantity = $qty;
  82                 $this->line_items[$line_no]->price = $price;
  83                 $this->line_items[$line_no]->req_del_date = $req_del_date;
  84                 $this->line_items[$line_no]->item_description = $description;
  85         }
  86
  87         function remove_from_order($line_no)
  88         {
  89                 array_splice($this->line_items, $line_no, 1);
  90         }
  91
  92         function order_has_items()
  93         {
  94                 return count($this->line_items) != 0;
  95         }
  96
  97         function clear_items()
  98         {
  99         unset($this->line_items);
 100                 $this->line_items = array();
 101
 102                 $this->lines_on_order = 0;
 103                 $this->order_no = 0;
 104         }
 105
 106
 107         function any_already_received()
 108         {
 109                 /* Checks if there have been deliveries or invoiced entered against any of the line items */
 110                 if (count($this->line_items) > 0)
 111                 {
 112                         foreach ($this->line_items as $ordered_items)
 113                         {
 114                                 if ($ordered_items->qty_received != 0 || $ordered_items->qty_inv != 0)
 115                                 {
 116                                         return 1;
 117                                 }
 118                         }
 119                 }
 120                 return 0;
 121         }
 122
 123         function some_already_received($line_no)
 124         {
 125                 /* Checks if there have been deliveries or amounts invoiced against a specific line item */
 126                 if (count($this->line_items) > 0)
 127                 {
 128                         if ($this->line_items[$line_no]->qty_received != 0 ||
 129                                 $this->line_items[$line_no]->qty_inv != 0)
 130                         {
 131                                 return 1;
 132                         }
 133                 }
 134                 return 0;
 135         }
 136
 137         //
 138         //      Returns taxes for PO/GRN.
 139         //      $receival=true in purchase receive context.
 140         //
 141         function get_taxes($shipping_cost=null, $receival=false)
 142         {
 143                 $items = array();
 144                 $prices = array();
 145                 if($shipping_cost==null)
 146                         $shipping_cost = 0;//$this->freight_cost;
 147
 148                 foreach ($this->line_items as $ln_itm) {
 149                         $items[] = $ln_itm->stock_id;
 150                         $prices[] = round($ln_itm->price * ($receival ? $ln_itm->receive_qty : $ln_itm->quantity),  user_price_dec());
 151                 }
 152                 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
 153                   $this->tax_group_id, $this->tax_included,  $this->tax_group_array);
 154
 155         // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
 156             if ($this->curr_code == 'CHF') {
 157                         $val = $taxes['1']['Value'];
 158                         $val1 = (floatval((intval(round(($val*20),0)))/20));
 159                         $taxes['1']['Value'] = $val1;
 160                 }
 161                 foreach($this->tax_overrides as $id => $value) // add values entered manually
 162                 {
 163                         $taxes[$id]['Override'] = $value;
 164                 }
 165                 return $taxes;
 166         }
 167
 168         /*
 169                 Returns order value including all taxes
 170         */
 171         function get_trans_total() {
 172
 173                 $total = 0;
 174                 $dec = user_price_dec();
 175
 176                 foreach ($this->line_items as $ln_itm) {
 177                         $items[] = $ln_itm->stock_id;
 178                         $value = round($ln_itm->quantity * $ln_itm->price, $dec);
 179                         $prices[] =$value;
 180                         $total += $value;
 181                 }
 182
 183                 if (!$this->tax_included ) {
 184                         $taxes = get_tax_for_items($items, $prices, 0, $this->tax_group_id,
 185                         $this->tax_included,  $this->tax_group_array);
 186
 187                         foreach($taxes as $tax)
 188                                 $total += round($tax['Value'], $dec);
 189                 }
 190                 return $total;
 191         }
 192
 193 } /* end of class defintion */
 194
 195 class po_line_details
 196 {
 197
 198         var $line_no;
 199         var $po_detail_rec;
 200         var $grn_item_id;
 201         var $stock_id;
 202         var $item_description;
 203         var $price;
 204         var $units;
 205         var $req_del_date;
 206         var $tax_type;
 207         var $tax_type_name;
 208
 209         var $quantity;          // current/entry quantity of PO line
 210         var $qty_inv;   // quantity already invoiced against this line
 211         var $receive_qty;       // current/entry GRN quantity
 212         var $qty_received;      // quantity already received against this line
 213
 214         var $standard_cost;
 215         var $descr_editable;
 216
 217         function po_line_details($line_no, $stock_item, $item_descr, $qty, $prc, $uom, $req_del_date,
 218                 $qty_inv, $qty_recd, $grn_item_id=0)
 219         {
 220
 221                 /* Constructor function to add a new LineDetail object with passed params */
 222                 $this->line_no = $line_no;
 223                 $this->stock_id = $stock_item;
 224                 $item_row = get_item($stock_item);
 225                 if (!$item_row)
 226                         return;
 227
 228                 $this->descr_editable = $item_row["editable"];
 229                 if ($item_descr == null || !$this->descr_editable)
 230                         $this->item_description = $item_row["description"];
 231                 else
 232                         $this->item_description = $item_descr;
 233                 $this->quantity = $qty;
 234                 $this->req_del_date = $req_del_date;
 235                 $this->price = $prc;
 236 //              $this->units = $uom;
 237                 $this->tax_type = $item_row["tax_type_id"];
 238                 $this->tax_type_name = $item_row["tax_type_name"];
 239                 $this->units = $item_row["units"];
 240                 $this->qty_received = $qty_recd;
 241                 $this->qty_inv = $qty_inv;
 242                 $this->receive_qty = 0; /*initialise these last two only */
 243                 $this->standard_cost =0;
 244                 $this->grn_item_id = $grn_item_id;
 245         }
 246
 247         function taxfree_charge_price($po)
 248         {
 249                 return get_tax_free_price_for_item($this->stock_id, $this->price,
 250                   $po->tax_group_id, $po->tax_included, $po->tax_group_array);
 251         }
 252 }
 253