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