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; /*array of objects of class line_details using the product id as the pointer */
  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 $order_no; /*Only used for modification of existing orders otherwise only established when order committed */
  29         var $lines_on_order;
  30
  31         var $reference;
  32
  33         function purch_order()
  34         {
  35                 /*Constructor function initialises a new purchase order object */
  36                 $this->line_items = array();
  37                 $this->lines_on_order = $this->order_no = $this->supplier_id = 0;
  38         }
  39
  40         function add_to_order($line_no, $stock_id, $qty, $item_descr, $price, $uom, $req_del_date, $qty_inv, $qty_recd)
  41         {
  42                 if ($qty != 0 && isset($qty))
  43                 {
  44                         $this->line_items[$line_no] = new line_details($line_no, $stock_id, $item_descr, $qty, $price, $uom,
  45                                 $req_del_date, $qty_inv, $qty_recd);
  46                         $this->lines_on_order++;
  47                         return 1;
  48                 }
  49                 return 0;
  50         }
  51
  52         function update_order_item($line_no, $qty, $price, $req_del_date, $description="")
  53         {
  54                 if ($description != "")
  55                         $this->line_items[$line_no]->item_description = $description;
  56                 $this->line_items[$line_no]->quantity = $qty;
  57                 $this->line_items[$line_no]->price = $price;
  58                 $this->line_items[$line_no]->req_del_date = $req_del_date;
  59                 $this->line_items[$line_no]->price = $price;
  60         }
  61
  62         function remove_from_order($line_no)
  63         {
  64                 array_splice($this->line_items, $line_no, 1);
  65         }
  66
  67         function order_has_items()
  68         {
  69                 return count($this->line_items) != 0;
  70         }
  71
  72         function clear_items()
  73         {
  74         unset($this->line_items);
  75                 $this->line_items = array();
  76
  77                 $this->lines_on_order = 0;
  78                 $this->order_no = 0;
  79         }
  80
  81
  82         function any_already_received()
  83         {
  84                 /* Checks if there have been deliveries or invoiced entered against any of the line items */
  85                 if (count($this->line_items) > 0)
  86                 {
  87                         foreach ($this->line_items as $ordered_items)
  88                         {
  89                                 if ($ordered_items->qty_received != 0 || $ordered_items->qty_inv != 0)
  90                                 {
  91                                         return 1;
  92                                 }
  93                         }
  94                 }
  95                 return 0;
  96         }
  97
  98         function some_already_received($line_no)
  99         {
 100                 /* Checks if there have been deliveries or amounts invoiced against a specific line item */
 101                 if (count($this->line_items) > 0)
 102                 {
 103                         if ($this->line_items[$line_no]->qty_received != 0 ||
 104                                 $this->line_items[$line_no]->qty_inv != 0)
 105                         {
 106                                 return 1;
 107                         }
 108                 }
 109                 return 0;
 110         }
 111 } /* end of class defintion */
 112
 113 class line_details
 114 {
 115
 116         var $line_no;
 117         var $po_detail_rec;
 118         var $grn_item_id;
 119         var $stock_id;
 120         var $item_description;
 121         var $quantity;
 122         var $price;
 123         var $units;
 124         var $req_del_date;
 125         var $qty_inv;
 126         var $qty_received;
 127         var $standard_cost;
 128         var $receive_qty;
 129         var $descr_editable;
 130
 131         function line_details($line_no, $stock_item, $item_descr, $qty, $prc, $uom, $req_del_date,
 132                 $qty_inv, $qty_recd, $grn_item_id=0)
 133         {
 134
 135                 /* Constructor function to add a new LineDetail object with passed params */
 136                 $this->line_no = $line_no;
 137                 $this->stock_id = $stock_item;
 138                 $item_row = get_item($stock_item);
 139                 if (!$item_row)
 140                         return;
 141
 142                 $this->descr_editable = $item_row["editable"];
 143                 if ($item_descr == null || !$this->descr_editable)
 144                         $this->item_description = $item_row["description"];
 145                 else
 146                         $this->item_description = $item_descr;
 147                 $this->quantity = $qty;
 148                 $this->req_del_date = $req_del_date;
 149                 $this->price = $prc;
 150 //              $this->units = $uom;
 151                 $this->units = $item_row["units"];
 152                 $this->qty_received = $qty_recd;
 153                 $this->qty_inv = $qty_inv;
 154                 $this->receive_qty = 0; /*initialise these last two only */
 155                 $this->standard_cost =0;
 156                 $this->grn_item_id = $grn_item_id;
 157         }
 158 }
 159
 160 ?>