includes/references.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/db/references_db.inc");
  13
  14 class references
  15 {
  16
  17         function save($type, $id, $reference)
  18         {
  19                 add_reference($type, $id, $reference);
  20                 if ($reference != 'auto')
  21                         $this->save_last($reference, $type);
  22         }
  23
  24         function get($type, $id)
  25         {
  26                 return get_reference($type, $id);
  27         }
  28
  29         function delete($type, $id)
  30         {
  31                 delete_reference($type, $id);
  32         }
  33
  34         function update($type, $id, $reference)
  35         {
  36             update_reference($type, $id, $reference);
  37         }
  38         // check if reference is used for any non voided transaction (used for ST_JOURNALENTRY type)
  39         function exists($type, $reference)
  40         {
  41                 return (find_reference($type, $reference) != null);
  42         }
  43
  44         function save_last($reference, $type)
  45         {
  46                 $next = $this->increment($reference);
  47                 save_next_reference($type, $next);
  48         }
  49
  50         function get_next($type)
  51         {
  52                 return get_next_reference($type);
  53         }
  54         //
  55         //      Restore previous reference if voided trans ref was the last one.
  56         //
  57         function restore_last($type, $id)
  58         {
  59                 $reference = $this->get($type, $id);
  60                 $last = $this->increment($this->get_next($type), true); //decrement
  61                 if ($reference==$last) {
  62                         save_next_reference($type, $last);
  63                 }
  64         }
  65
  66         //------------------------------------
  67
  68         function is_valid($reference)
  69         {
  70                 return strlen(trim($reference)) > 0;
  71         }
  72         //
  73         //      Increments (or decrements if $back==true) reference template
  74         //
  75         function increment($reference, $back=false)
  76         {
  77                 // New method done by Pete. So f.i. WA036 will increment to WA037 and so on.
  78         // If $reference contains at least one group of digits,
  79         // extract first didgits group and add 1, then put all together.
  80         // NB. preg_match returns 1 if the regex matches completely
  81         // also $result[0] holds entire string, 1 the first captured, 2 the 2nd etc.
  82         //
  83         if (preg_match('/^(\D*?)(\d+)(.*)/', $reference, $result) == 1)
  84         {
  85                         list($all, $prefix, $number, $postfix) = $result;
  86                         $dig_count = strlen($number); // How many digits? eg. 0003 = 4
  87                         $fmt = '%0' . $dig_count . 'd'; // Make a format string - leading zeroes
  88                         $val = intval($number + ($back ? ($number<1 ? 0 : -1) : 1));
  89                         $nextval =  sprintf($fmt, $val); // Add one on, and put prefix back on
  90
  91                         return $prefix.$nextval.$postfix;
  92         }
  93         else
  94             return $reference;
  95         }
  96         //------------------------------------
  97 }
  98
  99 //----------------------------------------------------------------------------
 100
 101 function is_new_reference($ref, $type)
 102 {
 103         $db_info = get_systype_db_info($type);
 104         $db_name = $db_info[0];
 105         $db_type = $db_info[1];
 106         $db_trans = $db_info[2];
 107         $db_ref = $db_info[3];
 108
 109         if ($db_ref != null)
 110         {
 111                 if ($db_type != null) {
 112                         $sql = "SELECT $db_ref FROM $db_name
 113                                 LEFT JOIN ".TB_PREF."voided v ON
 114                                         $db_name.$db_type=v.type AND $db_name.$db_trans=v.id
 115                                 WHERE $db_name.$db_ref='$ref' AND ISNULL(v.id)
 116                                         AND $db_name.$db_type=$type";
 117                 } else {
 118                         $sql = "SELECT $db_ref FROM $db_name
 119                                 LEFT JOIN ".TB_PREF."voided v ON
 120                                         v.type=$type AND $db_name.$db_trans=v.id
 121                                 WHERE $db_ref='$ref' AND ISNULL(v.id)";
 122                 }
 123                 $result = db_query($sql, "could not test for unique reference");
 124
 125                 return (db_num_rows($result) == 0);
 126         }
 127
 128         // it's a type that doesn't use references - shouldn't be calling here, but say yes anyways
 129         return true;
 130 }
 131
 132
 133 ?>