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