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                         references::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 exists($type, $reference)
  35         {
  36                 return (find_reference($type, $reference) != null);
  37         }
  38
  39         function save_last($reference, $type)
  40         {
  41                 $next = references::increment($reference);
  42                 save_next_reference($type, $next);
  43         }
  44
  45         function get_next($type)
  46         {
  47                 return get_next_reference($type);
  48         }
  49
  50         //------------------------------------
  51
  52         function is_valid($reference)
  53         {
  54                 return strlen(trim($reference)) > 0;
  55         }
  56
  57         function increment($reference)
  58         {
  59                 // New method done by Pete. So f.i. WA036 will increment to WA037 and so on.
  60         // If $reference is trailed by digits, and digits only,
  61         // extract them and add 1, then put the alpha prefix back on
  62         // NB. preg_match returns 1 if the regex matches completely
  63         // also $result[0] holds entire string, 1 the first captured, 2 the 2nd etc.
  64         if (preg_match('/^(.*?)(\d+)$/', $reference, $result) == 1)
  65         {
  66             $dig_count = strlen($result[2]); // How many digits? eg. 0003 = 4
  67             $fmt = '%0' . $dig_count . 'd'; // Make a format string - leading zeroes
  68             $nextval =  $result[1] . sprintf($fmt, intval($result[2] + 1)); // Add one on, and put prefix back on
  69             return $nextval;
  70         }
  71         else
  72             return $reference;
  73         }
  74
  75         //------------------------------------
  76 }
  77
  78 //----------------------------------------------------------------------------
  79
  80 function is_new_reference($ref, $type)
  81 {
  82         $db_info = get_systype_db_info($type);
  83         $db_name = $db_info[0];
  84         $db_type = $db_info[1];
  85         $db_ref = $db_info[3];
  86
  87         if ($db_ref != null)
  88         {
  89                 $sql = "SELECT $db_ref FROM $db_name WHERE $db_ref='$ref'";
  90                 if ($db_type != null)
  91                         $sql .= " AND $db_type=$type";
  92
  93                 $result = db_query($sql, "could not test for unique reference");
  94
  95                 return (db_num_rows($result) == 0);
  96         }
  97
  98         // it's a type that doesn't use references - shouldn't be calling here, but say yes anyways
  99         return true;
 100 }
 101
 102 ?>