includes/types.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 //----------------------------------------------------------------------------------
  13 //      FrontAccounting system transaction types
  14 //
  15 define('ST_JOURNAL', 0);
  16
  17 define('ST_BANKPAYMENT', 1);
  18 define('ST_BANKDEPOSIT', 2);
  19 define('ST_BANKTRANSFER', 4);
  20
  21 define('ST_SALESINVOICE', 10);
  22 define('ST_CUSTCREDIT', 11);
  23 define('ST_CUSTPAYMENT', 12);
  24 define('ST_CUSTDELIVERY', 13);
  25
  26 define('ST_LOCTRANSFER', 16);
  27 define('ST_INVADJUST', 17);
  28
  29 define('ST_PURCHORDER', 18);
  30 define('ST_SUPPINVOICE', 20);
  31 define('ST_SUPPCREDIT', 21);
  32 define('ST_SUPPAYMENT', 22);
  33 define('ST_SUPPRECEIVE', 25);
  34
  35 define('ST_WORKORDER', 26);
  36 define('ST_MANUISSUE', 28);
  37 define('ST_MANURECEIVE', 29);
  38
  39 //
  40 //      Depreciation period types
  41 //
  42 define('FA_MONTHLY', 0);
  43 define('FA_YEARLY', 1);
  44
  45 define('ST_SALESORDER', 30);
  46 define('ST_SALESQUOTE', 32);
  47 define('ST_COSTUPDATE', 35);
  48 define('ST_DIMENSION', 40);
  49 define('ST_CUSTOMER', 41);
  50 define('ST_SUPPLIER', 42);
  51
  52 // Don't include these defines in the $systypes_array.
  53 // They are used for documents only.
  54 define ('ST_STATEMENT', 91);
  55 define ('ST_CHEQUE', 92);
  56
  57 // document inheritance
  58 $document_child_types = array(
  59                 ST_SALESQUOTE => ST_SALESORDER,
  60                 ST_SALESORDER => ST_CUSTDELIVERY,
  61                 ST_CUSTDELIVERY => ST_SALESINVOICE,
  62                 ST_SALESINVOICE => ST_CUSTCREDIT,
  63
  64                 ST_PURCHORDER => ST_SUPPRECEIVE,
  65                 ST_SUPPRECEIVE => ST_SUPPINVOICE,
  66                 ST_SUPPINVOICE => ST_SUPPCREDIT,
  67 );
  68
  69 function get_child_type($type)
  70 {
  71         global $document_child_types;
  72         return isset($document_child_types[$type]) ? $document_child_types[$type] : 0;
  73 }
  74
  75 function get_parent_type($type)
  76 {
  77         global $document_child_types;
  78         $child = array_search($type, $document_child_types);
  79         return $child ? $child : 0;
  80 }
  81
  82 //----------------------------------------------------------------------------------
  83 //              Bank transaction types
  84 //
  85 define('BT_TRANSFER', 0);
  86 define('BT_CHEQUE', 1);
  87 define('BT_CREDIT', 2);
  88 define('BT_CASH', 3);
  89
  90 include_once($path_to_root . "/manufacturing/includes/manufacturing_db.inc");
  91 include_once($path_to_root . "/purchasing/includes/purchasing_db.inc");
  92 include_once($path_to_root . "/sales/includes/sales_db.inc");
  93 include_once($path_to_root . "/dimensions/includes/dimensions_db.inc");
  94 //----------------------------------------------------------------------------------
  95 //      Payment types
  96 //
  97 define('PT_MISC', 0);
  98 define('PT_WORKORDER', 1);
  99 define('PT_CUSTOMER', 2);
 100 define('PT_SUPPLIER', 3);
 101 define('PT_QUICKENTRY', 4);
 102 define('PT_DIMESION', 5);
 103
 104 function payment_person_currency($type, $person_id)  {
 105         switch ($type)
 106         {
 107                 case PT_MISC :
 108                 case PT_QUICKENTRY :
 109                 case PT_WORKORDER :
 110                         return get_company_currency();
 111
 112                 case PT_CUSTOMER :
 113                         return get_customer_currency($person_id);
 114
 115                 case PT_SUPPLIER :
 116                         return get_supplier_currency($person_id);
 117
 118                 default :
 119                         return get_company_currency();
 120         }
 121 }
 122
 123 function payment_person_name($type, $person_id, $full=true) {
 124         global $payment_person_types;
 125
 126         switch ($type)
 127         {
 128                 case PT_MISC :
 129                         return $person_id;
 130                 case PT_QUICKENTRY :
 131                         $qe = get_quick_entry($person_id);
 132                         return ($full ? $payment_person_types[$type] . " ":"") . $qe["description"];
 133                 case PT_WORKORDER :
 134                         global $wo_cost_types;
 135                         return (!$full ? _('Work Order').' '.$person_id : get_trans_view_str(ST_WORKORDER, $person_id, _('Work Order').' '.$person_id));
 136                 case PT_CUSTOMER :
 137                         return ($full ?$payment_person_types[$type] . " ":"") . sprintf("[%05s] %s", $person_id, get_customer_name($person_id));
 138                 case PT_SUPPLIER :
 139                         return ($full ? $payment_person_types[$type] . " ":"") . sprintf("[%05s] %s", $person_id, get_supplier_name($person_id));
 140                 default :
 141                         return '';
 142         }
 143 }
 144
 145 function payment_person_has_items($type) {
 146         switch ($type)
 147         {
 148                 case PT_MISC :
 149                         return true;
 150                 case PT_QUICKENTRY :
 151                         return db_has_quick_entries();
 152                 case PT_WORKORDER : // 070305 changed to open workorders JH
 153                         return db_has_open_workorders();
 154                 case PT_CUSTOMER :
 155                         return db_has_customers();
 156                 case PT_SUPPLIER :
 157                         return db_has_suppliers();
 158                 default :
 159                         display_db_error("Invalid type sent to has_items", "");
 160                         return false;
 161         }
 162 }
 163 //----------------------------------------------------------------------------------
 164 //      Payment terms categories
 165 //
 166 define('PM_ANY', 0);
 167 define('PM_CASH', 1);
 168 define('PM_CREDIT', 2);
 169
 170 //----------------------------------------------------------------------------------
 171 //      Manufacturing types
 172 //
 173 define('WO_ASSEMBLY', 0);
 174 define('WO_UNASSEMBLY', 1);
 175 define('WO_ADVANCED', 2);
 176
 177 define('WO_LABOUR', 0);
 178 define('WO_OVERHEAD', 1);
 179 define('WO_MATERIALS', 2);
 180
 181 //----------------------------------------------------------------------------------
 182 //      GL account classes
 183 //
 184 define('CL_NONE', 0); // for backward compatibility
 185 define('CL_ASSETS', 1);
 186 define('CL_LIABILITIES', 2);
 187 define('CL_EQUITY', 3);
 188 define('CL_INCOME', 4);
 189 define('CL_COGS', 5);
 190 define('CL_EXPENSE', 6);
 191
 192 function get_class_type_convert($ctype)
 193 {
 194         global $SysPrefs;
 195
 196         if (isset($SysPrefs->use_oldstyle_convert) && $SysPrefs->use_oldstyle_convert == 1)
 197                 return (($ctype >= CL_INCOME || $ctype == CL_NONE) ? -1 : 1);
 198         else
 199                 return ((($ctype >= CL_LIABILITIES && $ctype <= CL_INCOME) || $ctype == CL_NONE) ? -1 : 1);
 200 }
 201 //----------------------------------------------------------------------------------
 202 //      Quick entry types
 203 //
 204 define('QE_PAYMENT', '1');
 205 define('QE_DEPOSIT', '2');
 206 define('QE_JOURNAL', '3');
 207 define('QE_SUPPINV', '4');
 208
 209 //----------------------------------------------------------------------------------
 210 //      Special option values for various list selectors.
 211 //
 212 define('ANY_TEXT', '');
 213 define('ANY_NUMERIC', -1);
 214 define('ALL_TEXT', '');
 215 define('ALL_NUMERIC', -1);
 216
 217 //----------------------------------------------------------------------------------
 218 // Special class values for tables (start_table())
 219 define('TABLESTYLE',  1);
 220 define('TABLESTYLE2', 2);
 221 define('TABLESTYLE_NOBORDER', 3);
 222
 223 //----------------------------------------------------------------------------------
 224
 225 define('TAG_ACCOUNT',   1);
 226 define('TAG_DIMENSION', 2);
 227
 228 //----------------------------------------------------------------------------------
 229 // Payment term types
 230
 231 define('PTT_PRE', 1);
 232 define('PTT_CASH', 2);
 233 define('PTT_DAYS', 3);
 234 define('PTT_FOLLOWING', 4);
 235
 236 //----------------------------------------------------------------------------------
 237 // Tax calculation algorithms used in als and purchase (depends on supplier's invoicing software)
 238
 239 define('TCA_TOTALS', 1); // taxes are calculated from respective net totals for all lines
 240 define('TCA_LINES', 2); // taxes calculated for every line, then summed
 241 //
 242 //      Bank account owner types
 243 //
 244 define('BO_UNKNOWN', 0);
 245 define('BO_COMPANY', 1);
 246 define('BO_CUSTBRANCH', 2);
 247 define('BO_SUPPLIER', 3);
 248
 249 include_once($path_to_root . '/includes/sysnames.inc');
 250
 251 // tax register type
 252 define('TR_OUTPUT', 0); // sales
 253 define('TR_INPUT', 1);  // purchase
 254 //---------------------------------------------------------------------------------
 255 // Constants optionally redefined locally
 256 //
 257 defined('ICON_EDIT') || define('ICON_EDIT', 'edit.gif');
 258 defined('ICON_DELETE') || define('ICON_DELETE', 'delete.gif');
 259 defined('ICON_ADD')     || define('ICON_ADD', 'ok.gif');
 260 defined('ICON_UPDATE') || define('ICON_UPDATE', 'ok.gif');
 261 defined('ICON_OK') || define('ICON_OK', 'ok.gif');
 262 defined('ICON_CANCEL') || define('ICON_CANCEL', 'cancel.png');
 263 defined('ICON_GL') || define('ICON_GL', 'gl.png');
 264 defined('ICON_PRINT') || define('ICON_PRINT', 'print.png');
 265 defined('ICON_PDF') || define('ICON_PDF', 'pdf.gif');
 266 defined('ICON_DOC') || define('ICON_DOC', 'invoice.gif');
 267 defined('ICON_CREDIT') || define('ICON_CREDIT', 'credit.gif');
 268 defined('ICON_RECEIVE') || define('ICON_RECEIVE', 'receive.gif');
 269 defined('ICON_DOWN') || define('ICON_DOWN', 'download.gif');
 270 defined('ICON_MONEY') || define('ICON_MONEY', 'money.png');
 271 defined('ICON_REMOVE') || define('ICON_REMOVE', 'remove.png');
 272 defined('ICON_REPORT') || define('ICON_REPORT', 'report.png');
 273 defined('ICON_VIEW') || define('ICON_VIEW', 'view.gif');
 274 defined('ICON_SUBMIT') || define('ICON_SUBMIT', 'ok.gif');
 275 defined('ICON_ESCAPE') || define('ICON_ESCAPE', 'escape.png');
 276 defined('ICON_ALLOC') || define('ICON_ALLOC', 'alloc.png');
 277 defined('ICON_CLOSED') || define('ICON_CLOSED', 'closed.png');
 278