dolibarr 21.0.0-beta
commonobject.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2006-2015 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) 2005-2013 Regis Houssin <regis.houssin@inodbox.com>
4 * Copyright (C) 2010-2020 Juanjo Menent <jmenent@2byte.es>
5 * Copyright (C) 2012-2013 Christophe Battarel <christophe.battarel@altairis.fr>
6 * Copyright (C) 2011-2022 Philippe Grand <philippe.grand@atoo-net.com>
7 * Copyright (C) 2012-2015 Marcos García <marcosgdf@gmail.com>
8 * Copyright (C) 2012-2015 Raphaël Doursenaud <rdoursenaud@gpcsolutions.fr>
9 * Copyright (C) 2012 Cedric Salvador <csalvador@gpcsolutions.fr>
10 * Copyright (C) 2015-2022 Alexandre Spangaro <aspangaro@open-dsi.fr>
11 * Copyright (C) 2016 Bahfir abbes <bafbes@gmail.com>
12 * Copyright (C) 2017 ATM Consulting <support@atm-consulting.fr>
13 * Copyright (C) 2017-2019 Nicolas ZABOURI <info@inovea-conseil.com>
14 * Copyright (C) 2017 Rui Strecht <rui.strecht@aliartalentos.com>
15 * Copyright (C) 2018-2024 Frédéric France <frederic.france@free.fr>
16 * Copyright (C) 2018 Josep Lluís Amador <joseplluis@lliuretic.cat>
17 * Copyright (C) 2023 Gauthier VERDOL <gauthier.verdol@atm-consulting.fr>
18 * Copyright (C) 2021 Grégory Blémand <gregory.blemand@atm-consulting.fr>
19 * Copyright (C) 2023 Lenin Rivas <lenin.rivas777@gmail.com>
20 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
21 * Copyright (C) 2024 William Mead <william.mead@manchenumerique.fr>
22 *
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 3 of the License, or
26 * (at your option) any later version.
27 *
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
32 *
33 * You should have received a copy of the GNU General Public License
34 * along with this program. If not, see <https://www.gnu.org/licenses/>.
35 */
36
43require_once DOL_DOCUMENT_ROOT.'/core/class/doldeprecationhandler.class.php';
44
50abstract class CommonObject
51{
52 use DolDeprecationHandler;
53
54 const TRIGGER_PREFIX = ''; // to be overridden in child class implementations, i.e. 'BILL', 'TASK', 'PROPAL', etc.
55
59 public $module;
60
64 public $db;
65
69 public $id;
70
74 public $entity;
75
80 public $error;
81
85 public $errorhidden;
86
90 public $errors = array();
91
95 private $validateFieldsErrors = array();
96
100 public $element;
101
106 public $fk_element;
107
113 public $element_for_permission;
114
118 public $table_element;
119
123 public $table_element_line = '';
124
129 public $ismultientitymanaged;
130
134 public $import_key;
135
139 public $array_options = array();
140
141
145 public $fields = array();
146
152 public $array_languages = null; // Value is array() when load already tried
153
157 public $contacts_ids;
158
162 public $linked_objects;
163
167 public $linkedObjectsIds;
168
172 public $linkedObjects;
173
177 private $linkedObjectsFullLoaded = array();
178
182 public $oldcopy;
183
187 public $oldref;
188
192 protected $table_ref_field = '';
193
197 public $restrictiononfksoc = 0;
198
199
200 // The following vars are used by some objects only.
201 // We keep these properties in CommonObject in order to provide common methods using them.
202
206 public $context = array();
207
211 public $actionmsg;
215 public $actionmsg2;
216
220 public $canvas;
221
226 public $project;
227
232 public $fk_project;
233
239 private $projet;
240
246 public $fk_projet;
247
252 public $contact;
253
258 public $contact_id;
259
264 public $thirdparty;
265
270 public $user;
271
276 public $origin_type;
277
282 public $origin_id;
283
288
294 public $origin;
295
304 private $expedition;
305
311 private $livraison;
312
318 private $commandeFournisseur;
319
320
324 public $ref;
325
329 public $ref_ext;
330
334 public $ref_previous;
335
339 public $ref_next;
340
344 public $newref;
345
352 public $statut;
353
362 public $status;
363
364
369 public $country;
370
375 public $country_id;
376
381 public $country_code;
382
387 public $state;
388
393 public $state_id;
394
399 public $fk_departement;
400
405 public $state_code;
406
411 public $region_id;
412
417 public $region_code;
418
423 public $region;
424
425
430 public $barcode_type;
431
436 public $barcode_type_code;
437
442 public $barcode_type_label;
443
448 public $barcode_type_coder;
449
454 public $mode_reglement_id;
455
460 public $cond_reglement_id;
461
465 public $demand_reason_id;
466
471 public $transport_mode_id;
472
480 private $cond_reglement; // Private to call DolDeprecationHandler
484 protected $depr_cond_reglement; // Internal value for deprecation
485
491 public $fk_delivery_address;
492
497 public $shipping_method_id;
498
503 public $shipping_method;
504
505 // Multicurrency
509 public $fk_multicurrency;
510
515 public $multicurrency_code;
516
521 public $multicurrency_tx;
522
526 public $multicurrency_total_ht;
527
531 public $multicurrency_total_tva;
532
536 public $multicurrency_total_ttc;
537
541 public $multicurrency_total_localtax1; // not in database
542
546 public $multicurrency_total_localtax2; // not in database
547
552 public $model_pdf;
553
558 public $last_main_doc;
559
565 public $fk_bank;
566
571 public $fk_account;
572
577 public $note_public;
578
583 public $note_private;
584
590 public $note;
591
596 public $total_ht;
597
602 public $total_tva;
603
608 public $total_localtax1;
609
614 public $total_localtax2;
615
620 public $total_ttc;
621
622
626 public $lines;
627
631 public $actiontypecode;
632
637 public $comments = array();
638
642 public $name;
643
647 public $lastname;
648
652 public $firstname;
653
657 public $civility_id;
658
659 // Dates
663 public $date_creation;
664
668 public $date_validation;
669
673 public $date_modification;
674
680 public $tms;
681
687 private $date_update;
688
692 public $date_cloture;
693
698 public $user_author;
699
704 public $user_creation;
705
709 public $user_creation_id;
710
715 public $user_valid;
716
721 public $user_validation;
722
726 public $user_validation_id;
727
731 public $user_closing_id;
732
737 public $user_modification;
738
742 public $user_modification_id;
743
748 public $fk_user_creat;
749
754 public $fk_user_modif;
755
756
760 public $next_prev_filter;
761
765 public $specimen = 0;
766
770 public $sendtoid;
771
776 public $alreadypaid;
777
782 public $totalpaid;
783
787 public $labelStatus = array();
788
792 public $labelStatusShort = array();
793
797 public $tpl;
798
799
803 public $showphoto_on_popup;
804
808 public $nb = array();
809
813 public $nbphoto;
814
818 public $output;
819
823 public $extraparams = array();
824
828 protected $childtables = array();
829
835 protected $childtablesoncascade = array();
836
840 public $product;
841
845 public $cond_reglement_supplier_id;
846
852 public $deposit_percent;
853
854
858 public $retained_warranty_fk_cond_reglement;
859
863 public $warehouse_id;
864
868 public $isextrafieldmanaged = 0;
869
870
871 // No constructor as it is an abstract class
872
878 protected function deprecatedProperties()
879 {
880 return array(
881 'alreadypaid' => 'totalpaid',
882 'cond_reglement' => 'depr_cond_reglement',
883 //'note' => 'note_private', // Some classes needs ->note and others need ->note_public/private so we can't manage deprecation for this field with dolDeprecationHandler
884 'commandeFournisseur' => 'origin_object',
885 'expedition' => 'origin_object',
886 'fk_project' => 'fk_project',
887 'livraison' => 'origin_object',
888 'projet' => 'project',
889 'statut' => 'status',
890 );
891 }
892
893
904 public static function isExistingObject($element, $id, $ref = '', $ref_ext = '')
905 {
906 global $db, $conf;
907
908 $sql = "SELECT rowid, ref, ref_ext";
909 $sql .= " FROM ".$db->prefix().$element;
910 $sql .= " WHERE entity IN (".getEntity($element).")";
911
912 if ($id > 0) {
913 $sql .= " AND rowid = ".((int) $id);
914 } elseif ($ref) {
915 $sql .= " AND ref = '".$db->escape($ref)."'";
916 } elseif ($ref_ext) {
917 $sql .= " AND ref_ext = '".$db->escape($ref_ext)."'";
918 } else {
919 $error = 'ErrorWrongParameters';
920 dol_syslog(get_class()."::isExistingObject ".$error, LOG_ERR);
921 return -1;
922 }
923 if ($ref || $ref_ext) { // Because the same ref can exists in 2 different entities, we force the current one in priority
924 $sql .= " AND entity = ".((int) $conf->entity);
925 }
926
927 dol_syslog(get_class()."::isExistingObject", LOG_DEBUG);
928 $resql = $db->query($sql);
929 if ($resql) {
930 $num = $db->num_rows($resql);
931 if ($num > 0) {
932 return 1;
933 } else {
934 return 0;
935 }
936 }
937 return -1;
938 }
939
945 public function isEmpty()
946 {
947 return (empty($this->id));
948 }
949
957 {
958 if (!empty($object->error)) {
959 $this->error = $object->error;
960 }
961 if (!empty($object->errors)) {
962 $this->errors = array_merge($this->errors, $object->errors);
963 }
964 }
965
973 public function getTooltipContentArray($params)
974 {
975 return [];
976 }
977
985 public function getTooltipContent($params)
986 {
987 global $action, $extrafields, $langs, $hookmanager;
988
989 // If there is too much extrafields, we do not include them into tooltip
990 $MAX_EXTRAFIELDS_TO_SHOW_IN_TOOLTIP = getDolGlobalInt('MAX_EXTRAFIELDS_TO_SHOW_IN_TOOLTIP', 3);
991
992 $data = $this->getTooltipContentArray($params);
993 $count = 0;
994
995 // Add extrafields
996 if (!empty($extrafields->attributes[$this->table_element]['label'])) {
997 $data['opendivextra'] = '<div class="centpercent wordbreak divtooltipextra">';
998 foreach ($extrafields->attributes[$this->table_element]['label'] as $key => $val) {
999 if ($extrafields->attributes[$this->table_element]['type'][$key] == 'separate') {
1000 continue;
1001 }
1002 if ($count >= abs($MAX_EXTRAFIELDS_TO_SHOW_IN_TOOLTIP)) {
1003 $data['more_extrafields'] = '<br>...';
1004 break;
1005 }
1006 $enabled = 1;
1007 if ($enabled && isset($extrafields->attributes[$this->table_element]['enabled'][$key])) {
1008 $enabled = (int) dol_eval((string) $extrafields->attributes[$this->table_element]['enabled'][$key], 1, 1, '2');
1009 }
1010 if ($enabled && isset($extrafields->attributes[$this->table_element]['list'][$key])) {
1011 $enabled = (int) dol_eval($extrafields->attributes[$this->table_element]['list'][$key], 1, 1, '2');
1012 }
1013 $perms = 1;
1014 if ($perms && isset($extrafields->attributes[$this->table_element]['perms'][$key])) {
1015 $perms = (int) dol_eval($extrafields->attributes[$this->table_element]['perms'][$key], 1, 1, '2');
1016 }
1017 if (empty($enabled)) {
1018 continue; // 0 = Never visible field
1019 }
1020 if (abs($enabled) != 1 && abs($enabled) != 3 && abs($enabled) != 5 && abs($enabled) != 4) {
1021 continue; // <> -1 and <> 1 and <> 3 = not visible on forms, only on list <> 4 = not visible at the creation
1022 }
1023 if (empty($perms)) {
1024 continue; // 0 = Not visible
1025 }
1026 if (!empty($extrafields->attributes[$this->table_element]['langfile'][$key])) {
1027 $langs->load($extrafields->attributes[$this->table_element]['langfile'][$key]);
1028 }
1029 $labelextra = $langs->trans((string) $extrafields->attributes[$this->table_element]['label'][$key]);
1030 if ($extrafields->attributes[$this->table_element]['type'][$key] == 'separate') {
1031 $data[$key] = '<br><b><u>'. $labelextra . '</u></b>';
1032 } else {
1033 $value = (empty($this->array_options['options_' . $key]) ? '' : $this->array_options['options_' . $key]);
1034 $data[$key] = '<br><b>'. $labelextra . ':</b> ' . $extrafields->showOutputField($key, $value, '', $this->table_element);
1035 $count++;
1036 }
1037 }
1038 $data['closedivextra'] = '</div>';
1039 }
1040
1041 $hookmanager->initHooks(array($this->element . 'dao'));
1042 $parameters = array(
1043 'tooltipcontentarray' => &$data,
1044 'params' => $params,
1045 );
1046 // Note that $action and $object may have been modified by some hooks
1047 $hookmanager->executeHooks('getTooltipContent', $parameters, $this, $action);
1048
1049 //var_dump($data);
1050 $label = implode($data);
1051
1052 return $label;
1053 }
1054
1055
1061 public function errorsToString()
1062 {
1063 return $this->error.(is_array($this->errors) ? (($this->error != '' ? ', ' : '').implode(', ', $this->errors)) : '');
1064 }
1065
1066
1073 public function getFormatedCustomerRef($objref)
1074 {
1075 global $hookmanager;
1076
1077 $parameters = array('objref' => $objref);
1078 $action = '';
1079 $reshook = $hookmanager->executeHooks('getFormatedCustomerRef', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
1080 if ($reshook > 0) {
1081 return $hookmanager->resArray['objref'];
1082 }
1083 return $objref.(isset($hookmanager->resArray['objref']) ? $hookmanager->resArray['objref'] : '');
1084 }
1085
1092 public function getFormatedSupplierRef($objref)
1093 {
1094 global $hookmanager;
1095
1096 $parameters = array('objref' => $objref);
1097 $action = '';
1098 $reshook = $hookmanager->executeHooks('getFormatedSupplierRef', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
1099 if ($reshook > 0) {
1100 return $hookmanager->resArray['objref'];
1101 }
1102 return $objref.(isset($hookmanager->resArray['objref']) ? $hookmanager->resArray['objref'] : '');
1103 }
1104
1114 public function getFullAddress($withcountry = 0, $sep = "\n", $withregion = 0, $extralangcode = '')
1115 {
1116 if ($withcountry && $this->country_id && (empty($this->country_code) || empty($this->country))) {
1117 require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
1118 $tmparray = getCountry($this->country_id, 'all');
1119 $this->country_code = $tmparray['code'];
1120 $this->country = $tmparray['label'];
1121 }
1122
1123 if ($withregion && $this->state_id && (empty($this->state_code) || empty($this->state) || empty($this->region) || empty($this->region_code))) {
1124 require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
1125 $tmparray = getState($this->state_id, 'all', null, 1);
1126 $this->state_code = $tmparray['code'];
1127 $this->state = $tmparray['label'];
1128 $this->region_code = $tmparray['region_code'];
1129 $this->region = $tmparray['region'];
1130 }
1131
1132 return dol_format_address($this, $withcountry, $sep, null, 0, $extralangcode);
1133 }
1134
1135
1144 public function getLastMainDocLink($modulepart, $initsharekey = 0, $relativelink = 0)
1145 {
1146 global $user, $dolibarr_main_url_root;
1147
1148 if (empty($this->last_main_doc)) {
1149 return ''; // No way to known which document name to use
1150 }
1151
1152 include_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmfiles.class.php';
1153 $ecmfile = new EcmFiles($this->db);
1154 $result = $ecmfile->fetch(0, '', $this->last_main_doc);
1155 if ($result < 0) {
1156 $this->error = $ecmfile->error;
1157 $this->errors = $ecmfile->errors;
1158 return -1;
1159 }
1160
1161 if (empty($ecmfile->id)) { // No entry into file index already exists, we should initialize the shared key manually.
1162 // Add entry into index
1163 if ($initsharekey) {
1164 require_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php';
1165
1166 // TODO We can't, we don't have full path of file, only last_main_doc and ->element, so we must first rebuild full path $destfull
1167 /*
1168 $ecmfile->filepath = $rel_dir;
1169 $ecmfile->filename = $filename;
1170 $ecmfile->label = md5_file(dol_osencode($destfull)); // hash of file content
1171 $ecmfile->fullpath_orig = '';
1172 $ecmfile->gen_or_uploaded = 'generated';
1173 $ecmfile->description = ''; // indexed content
1174 $ecmfile->keywords = ''; // keyword content
1175 $ecmfile->share = getRandomPassword(true);
1176 $result = $ecmfile->create($user);
1177 if ($result < 0)
1178 {
1179 $this->error = $ecmfile->error;
1180 $this->errors = $ecmfile->errors;
1181 }
1182 */
1183 } else {
1184 return '';
1185 }
1186 } elseif (empty($ecmfile->share)) { // Entry into file index already exists but no share key is defined.
1187 // Add entry into index
1188 if ($initsharekey) {
1189 require_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php';
1190 $ecmfile->share = getRandomPassword(true);
1191 $ecmfile->update($user);
1192 } else {
1193 return '';
1194 }
1195 }
1196 // Define $urlwithroot
1197 $urlwithouturlroot = preg_replace('/'.preg_quote(DOL_URL_ROOT, '/').'$/i', '', trim($dolibarr_main_url_root));
1198 // This is to use external domain name found into config file
1199 //if (DOL_URL_ROOT && ! preg_match('/\/$/', $urlwithouturlroot) && ! preg_match('/^\//', DOL_URL_ROOT)) $urlwithroot=$urlwithouturlroot.'/'.DOL_URL_ROOT;
1200 //else
1201 $urlwithroot = $urlwithouturlroot.DOL_URL_ROOT;
1202 //$urlwithroot=DOL_MAIN_URL_ROOT; // This is to use same domain name than current
1203
1204 $forcedownload = 0;
1205
1206 $paramlink = '';
1207 //if (!empty($modulepart)) $paramlink.=($paramlink?'&':'').'modulepart='.$modulepart; // For sharing with hash (so public files), modulepart is not required.
1208 //if (!empty($ecmfile->entity)) $paramlink.='&entity='.$ecmfile->entity; // For sharing with hash (so public files), entity is not required.
1209 //$paramlink.=($paramlink?'&':'').'file='.urlencode($filepath); // No need of name of file for public link, we will use the hash
1210 if (!empty($ecmfile->share)) {
1211 $paramlink .= ($paramlink ? '&' : '').'hashp='.$ecmfile->share; // Hash for public share
1212 }
1213 if ($forcedownload) {
1214 $paramlink .= ($paramlink ? '&' : '').'attachment=1';
1215 }
1216
1217 if ($relativelink) {
1218 $linktoreturn = 'document.php'.($paramlink ? '?'.$paramlink : '');
1219 } else {
1220 $linktoreturn = $urlwithroot.'/document.php'.($paramlink ? '?'.$paramlink : '');
1221 }
1222
1223 // Here $ecmfile->share is defined
1224 return $linktoreturn;
1225 }
1226
1227
1228 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1238 public function add_contact($fk_socpeople, $type_contact, $source = 'external', $notrigger = 0)
1239 {
1240 // phpcs:enable
1241 global $user, $langs;
1242
1243
1244 dol_syslog(get_class($this)."::add_contact $fk_socpeople, $type_contact, $source, $notrigger");
1245
1246 // Check parameters
1247 if ($fk_socpeople <= 0) {
1248 $langs->load("errors");
1249 $this->error = $langs->trans("ErrorWrongValueForParameterX", "1");
1250 dol_syslog(get_class($this)."::add_contact ".$this->error, LOG_ERR);
1251 return -1;
1252 }
1253 if (!$type_contact) {
1254 $langs->load("errors");
1255 $this->error = $langs->trans("ErrorWrongValueForParameterX", "2");
1256 dol_syslog(get_class($this)."::add_contact ".$this->error, LOG_ERR);
1257 return -2;
1258 }
1259
1260 $id_type_contact = 0;
1261 if (is_numeric($type_contact)) {
1262 $id_type_contact = $type_contact;
1263 } else {
1264 // We look for id type_contact
1265 $sql = "SELECT tc.rowid";
1266 $sql .= " FROM ".$this->db->prefix()."c_type_contact as tc";
1267 $sql .= " WHERE tc.element='".$this->db->escape($this->element)."'";
1268 $sql .= " AND tc.source='".$this->db->escape($source)."'";
1269 $sql .= " AND tc.code='".$this->db->escape($type_contact)."' AND tc.active=1";
1270 //print $sql;
1271 $resql = $this->db->query($sql);
1272 if ($resql) {
1273 $obj = $this->db->fetch_object($resql);
1274 if ($obj) {
1275 $id_type_contact = $obj->rowid;
1276 }
1277 }
1278 }
1279
1280 if ($id_type_contact == 0) {
1281 dol_syslog("CODE_NOT_VALID_FOR_THIS_ELEMENT: Code type of contact '".$type_contact."' does not exists or is not active for element ".$this->element.", we can ignore it");
1282 return 0;
1283 }
1284
1285 $datecreate = dol_now();
1286
1287 // Socpeople must have already been added by some trigger, then we have to check it to avoid DB_ERROR_RECORD_ALREADY_EXISTS error
1288 $TListeContacts = $this->liste_contact(-1, $source);
1289 $already_added = false;
1290 if (is_array($TListeContacts) && !empty($TListeContacts)) {
1291 foreach ($TListeContacts as $array_contact) {
1292 if ($array_contact['status'] == 4 && $array_contact['id'] == $fk_socpeople && $array_contact['fk_c_type_contact'] == $id_type_contact) {
1293 $already_added = true;
1294 break;
1295 }
1296 }
1297 }
1298
1299 if (!$already_added) {
1300 $this->db->begin();
1301
1302 // Insert into database
1303 $sql = "INSERT INTO ".$this->db->prefix()."element_contact";
1304 $sql .= " (element_id, fk_socpeople, datecreate, statut, fk_c_type_contact) ";
1305 $sql .= " VALUES (".$this->id.", ".((int) $fk_socpeople)." , ";
1306 $sql .= "'".$this->db->idate($datecreate)."'";
1307 $sql .= ", 4, ".((int) $id_type_contact);
1308 $sql .= ")";
1309
1310 $resql = $this->db->query($sql);
1311 if ($resql) {
1312 if (!$notrigger) {
1313 $result = $this->call_trigger(strtoupper($this->element).'_ADD_CONTACT', $user);
1314 if ($result < 0) {
1315 $this->db->rollback();
1316 return -1;
1317 }
1318 }
1319
1320 $this->db->commit();
1321 return 1;
1322 } else {
1323 if ($this->db->errno() == 'DB_ERROR_RECORD_ALREADY_EXISTS') {
1324 $this->error = $this->db->errno();
1325 $this->db->rollback();
1326 return -2;
1327 } else {
1328 $this->error = $this->db->lasterror();
1329 $this->db->rollback();
1330 return -1;
1331 }
1332 }
1333 } else {
1334 return 0;
1335 }
1336 }
1337
1338 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1346 public function copy_linked_contact($objFrom, $source = 'internal')
1347 {
1348 // phpcs:enable
1349 $contacts = $objFrom->liste_contact(-1, $source);
1350 foreach ($contacts as $contact) {
1351 if ($this->add_contact($contact['id'], $contact['fk_c_type_contact'], $contact['source']) < 0) {
1352 return -1;
1353 }
1354 }
1355 return 1;
1356 }
1357
1358 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1368 public function update_contact($rowid, $statut, $type_contact_id = 0, $fk_socpeople = 0)
1369 {
1370 // phpcs:enable
1371 // Insert into database
1372 $sql = "UPDATE ".$this->db->prefix()."element_contact set";
1373 $sql .= " statut = ".((int) $statut);
1374 if ($type_contact_id) {
1375 $sql .= ", fk_c_type_contact = ".((int) $type_contact_id);
1376 }
1377 if ($fk_socpeople) {
1378 $sql .= ", fk_socpeople = ".((int) $fk_socpeople);
1379 }
1380 $sql .= " where rowid = ".((int) $rowid);
1381
1382 $resql = $this->db->query($sql);
1383 if ($resql) {
1384 return 0;
1385 } else {
1386 $this->error = $this->db->lasterror();
1387 return -1;
1388 }
1389 }
1390
1391 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1399 public function delete_contact($rowid, $notrigger = 0)
1400 {
1401 // phpcs:enable
1402 global $user;
1403
1404 $error = 0;
1405
1406 $this->db->begin();
1407
1408 if (!$error && empty($notrigger)) {
1409 // Call trigger
1410 $this->context['contact_id'] = ((int) $rowid);
1411 $result = $this->call_trigger(strtoupper($this->element).'_DELETE_CONTACT', $user);
1412 if ($result < 0) {
1413 $error++;
1414 }
1415 // End call triggers
1416 }
1417
1418 if (!$error) {
1419 dol_syslog(get_class($this)."::delete_contact", LOG_DEBUG);
1420
1421 $sql = "DELETE FROM ".MAIN_DB_PREFIX."element_contact";
1422 $sql .= " WHERE rowid = ".((int) $rowid);
1423
1424 $result = $this->db->query($sql);
1425 if (!$result) {
1426 $error++;
1427 $this->errors[] = $this->db->lasterror();
1428 }
1429 }
1430
1431 if (!$error) {
1432 $this->db->commit();
1433 return 1;
1434 } else {
1435 $this->error = $this->db->lasterror();
1436 $this->db->rollback();
1437 return -1;
1438 }
1439 }
1440
1441 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1449 public function delete_linked_contact($source = '', $code = '')
1450 {
1451 // phpcs:enable
1452 $listId = '';
1453 $temp = array();
1454 $typeContact = $this->liste_type_contact($source, '', 0, 0, $code);
1455
1456 if (!empty($typeContact)) {
1457 foreach ($typeContact as $key => $value) {
1458 array_push($temp, $key);
1459 }
1460 $listId = implode(",", $temp);
1461 }
1462
1463 // If $listId is empty, we have not criteria on fk_c_type_contact so we will delete record on element_id for
1464 // any type or record instead of only the ones of the current object. So we do nothing in such a case.
1465 if (empty($listId)) {
1466 return 0;
1467 }
1468
1469 $sql = "DELETE FROM ".$this->db->prefix()."element_contact";
1470 $sql .= " WHERE element_id = ".((int) $this->id);
1471 $sql .= " AND fk_c_type_contact IN (".$this->db->sanitize($listId).")";
1472
1473 dol_syslog(get_class($this)."::delete_linked_contact", LOG_DEBUG);
1474 if ($this->db->query($sql)) {
1475 return 1;
1476 } else {
1477 $this->error = $this->db->lasterror();
1478 return -1;
1479 }
1480 }
1481
1482 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1494 public function liste_contact($statusoflink = -1, $source = 'external', $list = 0, $code = '', $status = -1, $arrayoftcids = array())
1495 {
1496 // phpcs:enable
1497 global $langs;
1498
1499 $tab = array();
1500
1501 $sql = "SELECT ec.rowid, ec.statut as statuslink, ec.fk_socpeople as id, ec.fk_c_type_contact"; // This field contains id of llx_socpeople or id of llx_user
1502 if ($source == 'internal') {
1503 $sql .= ", '-1' as socid, t.statut as statuscontact, t.login, t.photo, t.gender";
1504 }
1505 if ($source == 'external' || $source == 'thirdparty') {
1506 $sql .= ", t.fk_soc as socid, t.statut as statuscontact";
1507 }
1508 $sql .= ", t.civility as civility, t.lastname as lastname, t.firstname, t.email";
1509 if (empty($arrayoftcids)) {
1510 $sql .= ", tc.source, tc.element, tc.code, tc.libelle as type_label";
1511 }
1512 $sql .= " FROM";
1513 if (empty($arrayoftcids)) {
1514 $sql .= " ".$this->db->prefix()."c_type_contact as tc,";
1515 }
1516 $sql .= " ".$this->db->prefix()."element_contact as ec";
1517 if ($source == 'internal') { // internal contact (user)
1518 $sql .= " LEFT JOIN ".$this->db->prefix()."user as t on ec.fk_socpeople = t.rowid";
1519 }
1520 if ($source == 'external' || $source == 'thirdparty') { // external contact (socpeople)
1521 $sql .= " LEFT JOIN ".$this->db->prefix()."socpeople as t on ec.fk_socpeople = t.rowid";
1522 }
1523 $sql .= " WHERE ec.element_id = ".((int) $this->id);
1524 if (empty($arrayoftcids)) {
1525 $sql .= " AND ec.fk_c_type_contact = tc.rowid";
1526 $sql .= " AND tc.element = '".$this->db->escape($this->element)."'";
1527 if ($code) {
1528 $sql .= " AND tc.code = '".$this->db->escape($code)."'";
1529 }
1530 if ($source == 'internal') {
1531 $sql .= " AND tc.source = 'internal'";
1532 }
1533 if ($source == 'external' || $source == 'thirdparty') {
1534 $sql .= " AND tc.source = 'external'";
1535 }
1536 $sql .= " AND tc.active = 1";
1537 } else {
1538 $sql .= " AND ec.fk_c_type_contact IN (".$this->db->sanitize(implode(',', $arrayoftcids)).")";
1539 }
1540 if ($status >= 0) {
1541 $sql .= " AND t.statut = ".((int) $status); // t is llx_user or llx_socpeople
1542 }
1543 if ($statusoflink >= 0) {
1544 $sql .= " AND ec.statut = ".((int) $statusoflink);
1545 }
1546 $sql .= " ORDER BY t.lastname ASC";
1547
1548 dol_syslog(get_class($this)."::liste_contact", LOG_DEBUG);
1549 $resql = $this->db->query($sql);
1550 if ($resql) {
1551 $num = $this->db->num_rows($resql);
1552 $i = 0;
1553 while ($i < $num) {
1554 $obj = $this->db->fetch_object($resql);
1555
1556 if (!$list) {
1557 $transkey = "TypeContact_".$obj->element."_".$obj->source."_".$obj->code;
1558 $libelle_type = ($langs->trans($transkey) != $transkey ? $langs->trans($transkey) : $obj->type_label);
1559 $tab[$i] = array(
1560 'parentId' => $this->id,
1561 'source' => $obj->source,
1562 'socid' => $obj->socid,
1563 'id' => $obj->id,
1564 'nom' => $obj->lastname, // For backward compatibility
1565 'civility' => $obj->civility,
1566 'lastname' => $obj->lastname,
1567 'firstname' => $obj->firstname,
1568 'email' => $obj->email,
1569 'login' => (empty($obj->login) ? '' : $obj->login),
1570 'photo' => (empty($obj->photo) ? '' : $obj->photo),
1571 'gender' => (empty($obj->gender) ? '' : $obj->gender),
1572 'statuscontact' => $obj->statuscontact,
1573 'rowid' => $obj->rowid,
1574 'code' => $obj->code,
1575 'libelle' => $libelle_type,
1576 'status' => $obj->statuslink,
1577 'fk_c_type_contact' => $obj->fk_c_type_contact
1578 );
1579 } else {
1580 $tab[$i] = $obj->id;
1581 }
1582
1583 $i++;
1584 }
1585
1586 return $tab;
1587 } else {
1588 $this->error = $this->db->lasterror();
1589 dol_print_error($this->db);
1590 return -1;
1591 }
1592 }
1593
1594
1601 public function swapContactStatus($rowid)
1602 {
1603 $sql = "SELECT ec.datecreate, ec.statut, ec.fk_socpeople, ec.fk_c_type_contact,";
1604 $sql .= " tc.code, tc.libelle as type_label";
1605 $sql .= " FROM (".$this->db->prefix()."element_contact as ec, ".$this->db->prefix()."c_type_contact as tc)";
1606 $sql .= " WHERE ec.rowid =".((int) $rowid);
1607 $sql .= " AND ec.fk_c_type_contact = tc.rowid";
1608 $sql .= " AND tc.element = '".$this->db->escape($this->element)."'";
1609
1610 dol_syslog(get_class($this)."::swapContactStatus", LOG_DEBUG);
1611 $resql = $this->db->query($sql);
1612 if ($resql) {
1613 $obj = $this->db->fetch_object($resql);
1614 $newstatut = ($obj->statut == 4) ? 5 : 4;
1615 $result = $this->update_contact($rowid, $newstatut);
1616 $this->db->free($resql);
1617 return $result;
1618 } else {
1619 $this->error = $this->db->error();
1620 dol_print_error($this->db);
1621 return -1;
1622 }
1623 }
1624
1625 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1636 public function liste_type_contact($source = 'internal', $order = 'position', $option = 0, $activeonly = 0, $code = '')
1637 {
1638 // phpcs:enable
1639 global $langs;
1640
1641 if (empty($order)) {
1642 $order = 'position';
1643 }
1644 if ($order == 'position') {
1645 $order .= ',code';
1646 }
1647
1648 $tab = array();
1649
1650 $sql = "SELECT DISTINCT tc.rowid, tc.code, tc.libelle as type_label, tc.position";
1651 $sql .= " FROM ".$this->db->prefix()."c_type_contact as tc";
1652 $sql .= " WHERE tc.element = '".$this->db->escape($this->element)."'";
1653 if ($activeonly == 1) {
1654 $sql .= " AND tc.active = 1"; // only the active types
1655 }
1656 if (!empty($source) && $source != 'all') {
1657 $sql .= " AND tc.source = '".$this->db->escape($source)."'";
1658 }
1659 if (!empty($code)) {
1660 $sql .= " AND tc.code = '".$this->db->escape($code)."'";
1661 }
1662 $sql .= $this->db->order($order, 'ASC');
1663
1664 //print "sql=".$sql;
1665 $resql = $this->db->query($sql);
1666 if (!$resql) {
1667 $this->error = $this->db->lasterror();
1668 //dol_print_error($this->db);
1669 return null;
1670 }
1671
1672 $num = $this->db->num_rows($resql);
1673 $i = 0;
1674 while ($i < $num) {
1675 $obj = $this->db->fetch_object($resql);
1676
1677 $transkey = "TypeContact_".$this->element."_".$source."_".$obj->code;
1678 $libelle_type = ($langs->trans($transkey) != $transkey ? $langs->trans($transkey) : $obj->type_label);
1679 if (empty($option)) {
1680 $tab[$obj->rowid] = $libelle_type;
1681 } elseif ($option == 1) {
1682 $tab[$obj->code] = $libelle_type;
1683 } else {
1684 $tab[$obj->rowid] = array('id' => $obj->rowid, 'code' => $obj->code, 'label' => $libelle_type);
1685 }
1686 $i++;
1687 }
1688
1689 return $tab;
1690 }
1691
1703 public function listeTypeContacts($source = 'internal', $option = 0, $activeonly = 0, $code = '', $element = '', $excludeelement = '')
1704 {
1705 global $langs;
1706
1707 $langs->loadLangs(array('bills', 'contracts', 'interventions', 'orders', 'projects', 'propal', 'ticket', 'agenda'));
1708
1709 $tab = array();
1710
1711 $sql = "SELECT DISTINCT tc.rowid, tc.code, tc.libelle as type_label, tc.position, tc.element, tc.module";
1712 $sql .= " FROM ".$this->db->prefix()."c_type_contact as tc";
1713
1714 $sqlWhere = array();
1715 if (!empty($element)) {
1716 $sqlWhere[] = " tc.element='".$this->db->escape($element)."'";
1717 }
1718 if (!empty($excludeelement)) {
1719 $sqlWhere[] = " tc.element <> '".$this->db->escape($excludeelement)."'";
1720 }
1721
1722 if ($activeonly == 1) {
1723 $sqlWhere[] = " tc.active=1"; // only the active types
1724 }
1725
1726 if (!empty($source) && $source != 'all') {
1727 $sqlWhere[] = " tc.source='".$this->db->escape($source)."'";
1728 }
1729
1730 if (!empty($code)) {
1731 $sqlWhere[] = " tc.code='".$this->db->escape($code)."'";
1732 }
1733
1734 if (count($sqlWhere) > 0) {
1735 $sql .= " WHERE ".implode(' AND ', $sqlWhere);
1736 }
1737
1738 $sql .= $this->db->order('tc.element, tc.position', 'ASC');
1739
1740 dol_syslog(__METHOD__, LOG_DEBUG);
1741 $resql = $this->db->query($sql);
1742 if ($resql) {
1743 $num = $this->db->num_rows($resql);
1744 if ($num > 0) {
1745 $langs->loadLangs(array("propal", "orders", "bills", "suppliers", "contracts", "supplier_proposal"));
1746
1747 while ($obj = $this->db->fetch_object($resql)) {
1748 $modulename = $obj->module ?? $obj->element;
1749 if (strpos($obj->element, 'project') !== false) {
1750 $modulename = 'projet';
1751 } elseif ($obj->element == 'contrat') {
1752 $element = 'contract';
1753 } elseif ($obj->element == 'action') {
1754 $modulename = 'agenda';
1755 } elseif (strpos($obj->element, 'supplier') !== false && $obj->element != 'supplier_proposal') {
1756 $modulename = 'fournisseur';
1757 }
1758 if (isModEnabled($modulename)) {
1759 $libelle_element = $langs->trans('ContactDefault_'.$obj->element);
1760 $tmpelement = $obj->element;
1761 $transkey = "TypeContact_".$tmpelement."_".$source."_".$obj->code;
1762 $libelle_type = ($langs->trans($transkey) != $transkey ? $langs->trans($transkey) : $obj->type_label);
1763 $tab[$obj->rowid] = $libelle_element.' - '.$libelle_type;
1764 }
1765 }
1766 }
1767 return $tab;
1768 } else {
1769 $this->error = $this->db->lasterror();
1770 return null;
1771 }
1772 }
1773
1785 public function getIdContact($source, $code, $status = 0)
1786 {
1787 $result = array();
1788 $i = 0;
1789 // Particular case for shipping
1790 if ($this->element == 'shipping' && $this->origin_id != 0) {
1791 $id = $this->origin_id;
1792 $element = 'commande';
1793 } elseif ($this->element == 'reception' && $this->origin_id != 0) {
1794 $id = $this->origin_id;
1795 $element = 'order_supplier';
1796 } else {
1797 $id = $this->id;
1798 $element = $this->element;
1799 }
1800
1801 $sql = "SELECT ec.fk_socpeople";
1802 $sql .= " FROM ".$this->db->prefix()."element_contact as ec,";
1803 if ($source == 'internal') {
1804 $sql .= " ".$this->db->prefix()."user as c,";
1805 }
1806 if ($source == 'external') {
1807 $sql .= " ".$this->db->prefix()."socpeople as c,";
1808 }
1809 $sql .= " ".$this->db->prefix()."c_type_contact as tc";
1810 $sql .= " WHERE ec.element_id = ".((int) $id);
1811 $sql .= " AND ec.fk_socpeople = c.rowid";
1812 if ($source == 'internal') {
1813 $sql .= " AND c.entity IN (".getEntity('user').")";
1814 }
1815 if ($source == 'external') {
1816 $sql .= " AND c.entity IN (".getEntity('societe').")";
1817 }
1818 $sql .= " AND ec.fk_c_type_contact = tc.rowid";
1819 $sql .= " AND tc.element = '".$this->db->escape($element)."'";
1820 $sql .= " AND tc.source = '".$this->db->escape($source)."'";
1821 if ($code) {
1822 $sql .= " AND tc.code = '".$this->db->escape($code)."'";
1823 }
1824 $sql .= " AND tc.active = 1";
1825 if ($status) {
1826 $sql .= " AND ec.statut = ".((int) $status);
1827 }
1828
1829 dol_syslog(get_class($this)."::getIdContact", LOG_DEBUG);
1830 $resql = $this->db->query($sql);
1831 if ($resql) {
1832 while ($obj = $this->db->fetch_object($resql)) {
1833 $result[$i] = $obj->fk_socpeople;
1834 $i++;
1835 }
1836 } else {
1837 $this->error = $this->db->error();
1838 return null;
1839 }
1840
1841 return $result;
1842 }
1843
1844 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1851 public function fetch_contact($contactid = null)
1852 {
1853 // phpcs:enable
1854 if (empty($contactid)) {
1855 $contactid = $this->contact_id;
1856 }
1857
1858 if (empty($contactid)) {
1859 return 0;
1860 }
1861
1862 require_once DOL_DOCUMENT_ROOT.'/contact/class/contact.class.php';
1863 $contact = new Contact($this->db);
1864 $result = $contact->fetch($contactid);
1865 $this->contact = $contact;
1866 return $result;
1867 }
1868
1869 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1877 public function fetch_thirdparty($force_thirdparty_id = 0)
1878 {
1879 // phpcs:enable
1880 if (empty($this->socid) && empty($this->fk_soc) && empty($force_thirdparty_id)) {
1881 return 0;
1882 }
1883
1884 require_once DOL_DOCUMENT_ROOT.'/societe/class/societe.class.php';
1885
1886 $idtofetch = isset($this->socid) ? $this->socid : (isset($this->fk_soc) ? $this->fk_soc : 0);
1887 if ($force_thirdparty_id) {
1888 $idtofetch = $force_thirdparty_id;
1889 }
1890
1891 if ($idtofetch) {
1892 $thirdparty = new Societe($this->db);
1893 $result = $thirdparty->fetch($idtofetch);
1894 if ($result < 0) {
1895 $this->errors = array_merge($this->errors, $thirdparty->errors);
1896 }
1897 $this->thirdparty = $thirdparty;
1898
1899 // Use first price level if level not defined for third party
1900 if ((getDolGlobalString('PRODUIT_MULTIPRICES') || getDolGlobalString('PRODUIT_CUSTOMER_PRICES_AND_MULTIPRICES')) && empty($this->thirdparty->price_level)) {
1901 $this->thirdparty->price_level = 1;
1902 }
1903
1904 return $result;
1905 } else {
1906 return -1;
1907 }
1908 }
1909
1910
1918 public function fetchOneLike($ref)
1919 {
1920 if (!$this->table_ref_field) {
1921 return 0;
1922 }
1923
1924 $sql = "SELECT rowid FROM ".$this->db->prefix().$this->table_element;
1925 $sql .= " WHERE ".$this->table_ref_field." LIKE '".$this->db->escape($ref)."'"; // no escapeforlike here
1926 $sql .= " LIMIT 1";
1927
1928 $query = $this->db->query($sql);
1929
1930 if (!$this->db->num_rows($query)) {
1931 return 0;
1932 }
1933
1934 $result = $this->db->fetch_object($query);
1935
1936 if (method_exists($this, 'fetch')) {
1937 return $this->fetch($result->rowid);
1938 } else {
1939 $this->error = 'Fetch method not implemented on '.get_class($this);
1940 dol_syslog(get_class($this).'::fetchOneLike Error='.$this->error, LOG_ERR);
1941 array_push($this->errors, $this->error);
1942 return -1;
1943 }
1944 }
1945
1946 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1955 public function fetch_barcode()
1956 {
1957 // phpcs:enable
1958 return $this->fetchBarCode();
1959 }
1960
1968 public function fetchBarCode()
1969 {
1970 dol_syslog(get_class($this).'::fetchBarCode this->element='.$this->element.' this->barcode_type='.$this->barcode_type);
1971
1972 $idtype = $this->barcode_type;
1973 if (empty($idtype) && $idtype != '0') { // If type of barcode no set, we try to guess. If set to '0' it means we forced to have type remain not defined
1974 if ($this->element == 'product' && getDolGlobalString('PRODUIT_DEFAULT_BARCODE_TYPE')) {
1975 $idtype = getDolGlobalString('PRODUIT_DEFAULT_BARCODE_TYPE');
1976 } elseif ($this->element == 'societe') {
1977 $idtype = getDolGlobalString('GENBARCODE_BARCODETYPE_THIRDPARTY');
1978 } else {
1979 dol_syslog('Call fetchBarCode with barcode_type not defined and cannot be guessed', LOG_WARNING);
1980 }
1981 }
1982
1983 if ($idtype > 0) {
1984 if (empty($this->barcode_type) || empty($this->barcode_type_code) || empty($this->barcode_type_label) || empty($this->barcode_type_coder)) { // If data not already loaded
1985 $sql = "SELECT rowid, code, libelle as label, coder";
1986 $sql .= " FROM ".$this->db->prefix()."c_barcode_type";
1987 $sql .= " WHERE rowid = ".((int) $idtype);
1988
1989 $resql = $this->db->query($sql);
1990 if ($resql) {
1991 $obj = $this->db->fetch_object($resql);
1992
1993 $this->barcode_type = $obj->rowid;
1994 $this->barcode_type_code = $obj->code;
1995 $this->barcode_type_label = $obj->label;
1996 $this->barcode_type_coder = $obj->coder;
1997 return 1;
1998 } else {
1999 dol_print_error($this->db);
2000 return -1;
2001 }
2002 }
2003 }
2004 return 0;
2005 }
2006
2012 public function fetchProject()
2013 {
2014 include_once DOL_DOCUMENT_ROOT.'/projet/class/project.class.php';
2015
2016 if (empty($this->fk_project) && !empty($this->fk_projet)) {
2017 $this->fk_project = $this->fk_projet; // For backward compatibility
2018 }
2019 if (empty($this->fk_project)) {
2020 return 0;
2021 }
2022
2023 $project = new Project($this->db);
2024 $result = $project->fetch($this->fk_project);
2025
2026 $this->projet = $project; // deprecated
2027 $this->project = $project;
2028
2029 return $result;
2030 }
2031
2032 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2040 public function fetch_project()
2041 {
2042 // phpcs:enable
2043 return $this->fetchProject();
2044 }
2045
2046 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2054 public function fetch_projet()
2055 {
2056 // phpcs:enable
2057 return $this->fetchProject();
2058 }
2059
2060 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2066 public function fetch_product()
2067 {
2068 // phpcs:enable
2069 include_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
2070
2071 // @phan-suppress-next-line PhanUndeclaredProperty
2072 if (empty($this->fk_product)) {
2073 return 0;
2074 }
2075
2076 $product = new Product($this->db);
2077 // @phan-suppress-next-line PhanUndeclaredProperty
2078 $result = $product->fetch($this->fk_product);
2079
2080 $this->product = $product;
2081 return $result;
2082 }
2083
2084 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2091 public function fetch_user($userid)
2092 {
2093 // phpcs:enable
2094 $user = new User($this->db);
2095 $result = $user->fetch($userid);
2096 $this->user = $user;
2097 return $result;
2098 }
2099
2100 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2107 public function fetch_origin()
2108 {
2109 // phpcs:enable
2110 $origin = $this->origin ? $this->origin : $this->origin_type;
2111
2112 // Manage classes with non standard name
2113 if ($origin == 'shipping') {
2114 $origin = 'expedition';
2115 }
2116 if ($origin == 'delivery') {
2117 $origin = 'livraison';
2118 }
2119 if ($origin == 'order_supplier' || $origin == 'supplier_order') {
2120 $origin = 'commandeFournisseur';
2121 }
2122
2123 $classname = ucfirst($origin);
2124 $this->origin_object = new $classname($this->db);
2125 // @phan-suppress-next-line PhanPluginUnknownObjectMethodCall
2126 $this->origin_object->fetch($this->origin_id);
2127 }
2128
2138 public function fetchObjectFrom($table, $field, $key, $element = null)
2139 {
2140 global $conf;
2141
2142 $result = false;
2143
2144 $sql = "SELECT rowid FROM ".$this->db->prefix().$table;
2145 $sql .= " WHERE ".$field." = '".$this->db->escape($key)."'";
2146 if (!empty($element)) {
2147 $sql .= " AND entity IN (".getEntity($element).")";
2148 } else {
2149 $sql .= " AND entity = ".((int) $conf->entity);
2150 }
2151
2152 dol_syslog(get_class($this).'::fetchObjectFrom', LOG_DEBUG);
2153 $resql = $this->db->query($sql);
2154 if ($resql) {
2155 $obj = $this->db->fetch_object($resql);
2156 // Test for avoid error -1
2157 if ($obj) {
2158 if (method_exists($this, 'fetch')) {
2159 $result = $this->fetch($obj->rowid);
2160 } else {
2161 $this->error = 'fetch() method not implemented on '.get_class($this);
2162 dol_syslog(get_class($this).'::fetchOneLike Error='.$this->error, LOG_ERR);
2163 array_push($this->errors, $this->error);
2164 $result = -1;
2165 }
2166 }
2167 }
2168
2169 return $result;
2170 }
2171
2180 public function getValueFrom($table, $id, $field)
2181 {
2182 $result = false;
2183 if (!empty($id) && !empty($field) && !empty($table)) {
2184 $sql = "SELECT ".$field." FROM ".$this->db->prefix().$table;
2185 $sql .= " WHERE rowid = ".((int) $id);
2186
2187 dol_syslog(get_class($this).'::getValueFrom', LOG_DEBUG);
2188 $resql = $this->db->query($sql);
2189 if ($resql) {
2190 $row = $this->db->fetch_row($resql);
2191 $result = $row[0];
2192 }
2193 }
2194 return $result;
2195 }
2196
2213 public function setValueFrom($field, $value, $table = '', $id = null, $format = '', $id_field = '', $fuser = null, $trigkey = '', $fk_user_field = 'fk_user_modif')
2214 {
2215 global $user;
2216
2217 if (empty($table)) {
2218 $table = $this->table_element;
2219 }
2220 if (empty($id)) {
2221 $id = $this->id;
2222 }
2223 if (empty($format)) {
2224 $format = 'text';
2225 }
2226 if (empty($id_field)) {
2227 $id_field = 'rowid';
2228 }
2229
2230 // Special case
2231 if ($table == 'product' && $field == 'note_private') {
2232 $field = 'note';
2233 }
2234
2235 if (in_array($table, array('actioncomm', 'adherent', 'advtargetemailing', 'cronjob', 'establishment'))) {
2236 $fk_user_field = 'fk_user_mod';
2237 }
2238 if (in_array($table, array('prelevement_bons'))) { // TODO Add a field fk_user_modif into llx_prelevement_bons
2239 $fk_user_field = '';
2240 }
2241
2242 $oldvalue = null;
2243 if ($trigkey) {
2244 $sql = "SELECT " . $field;
2245 $sql .= " FROM " . MAIN_DB_PREFIX . $table;
2246 $sql .= " WHERE " . $id_field . " = " . ((int) $id);
2247
2248 $resql = $this->db->query($sql);
2249 if ($resql) {
2250 if ($obj = $this->db->fetch_object($resql)) {
2251 if ($format == 'date') {
2252 $oldvalue = $this->db->jdate($obj->$field);
2253 } else {
2254 $oldvalue = $obj->$field;
2255 }
2256 }
2257 } else {
2258 $this->error = $this->db->lasterror();
2259 return -1;
2260 }
2261 }
2262
2263 $error = 0;
2264
2265 dol_syslog(__METHOD__, LOG_DEBUG);
2266
2267 $this->db->begin();
2268
2269 $sql = "UPDATE ".$this->db->prefix().$table." SET ";
2270
2271 if ($format == 'text') {
2272 $sql .= $field." = '".$this->db->escape($value)."'";
2273 } elseif ($format == 'int') {
2274 $sql .= $field." = ".((int) $value);
2275 } elseif ($format == 'date') {
2276 $sql .= $field." = ".($value ? "'".$this->db->idate($value)."'" : "null");
2277 } elseif ($format == 'dategmt') {
2278 $sql .= $field." = ".($value ? "'".$this->db->idate($value, 'gmt')."'" : "null");
2279 }
2280
2281 if ($fk_user_field) {
2282 if (!empty($fuser) && is_object($fuser)) {
2283 $sql .= ", ".$fk_user_field." = ".((int) $fuser->id);
2284 } elseif (empty($fuser) || $fuser != 'none') {
2285 $sql .= ", ".$fk_user_field." = ".((int) $user->id);
2286 }
2287 }
2288
2289 $sql .= " WHERE ".$id_field." = ".((int) $id);
2290
2291 $resql = $this->db->query($sql);
2292 if ($resql) {
2293 if ($trigkey) {
2294 // call trigger with updated object values
2295 if (method_exists($this, 'fetch')) {
2296 $result = $this->fetch($id);
2297 } else {
2298 $result = $this->fetchCommon($id);
2299 }
2300 $this->oldcopy = clone $this;
2301 if (property_exists($this->oldcopy, $field)) {
2302 $this->oldcopy->$field = $oldvalue;
2303 }
2304
2305 if ($result >= 0) {
2306 $result = $this->call_trigger($trigkey, (!empty($fuser) && is_object($fuser)) ? $fuser : $user); // This may set this->errors
2307 }
2308 if ($result < 0) {
2309 $error++;
2310 }
2311 }
2312
2313 if (!$error) {
2314 if (property_exists($this, $field)) {
2315 $this->$field = $value;
2316 }
2317 $this->db->commit();
2318 return 1;
2319 } else {
2320 $this->db->rollback();
2321 return -2;
2322 }
2323 } else {
2324 if ($this->db->lasterrno() == 'DB_ERROR_RECORD_ALREADY_EXISTS') {
2325 $this->error = 'DB_ERROR_RECORD_ALREADY_EXISTS';
2326 } else {
2327 $this->error = $this->db->lasterror();
2328 }
2329 $this->db->rollback();
2330 return -1;
2331 }
2332 }
2333
2334 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2345 public function load_previous_next_ref($filter, $fieldid, $nodbprefix = 0)
2346 {
2347 // phpcs:enable
2348 global $conf, $user;
2349
2350 if (!$this->table_element) {
2351 dol_print_error(null, get_class($this)."::load_previous_next_ref was called on object with property table_element not defined");
2352 return -1;
2353 }
2354 if ($fieldid == 'none') {
2355 return 1;
2356 }
2357
2358 // For backward compatibility
2359 if (in_array($this->table_element, array('facture_rec', 'facture_fourn_rec')) && $fieldid == 'title') {
2360 $fieldid = 'titre';
2361 }
2362
2363 // Security on socid
2364 $socid = 0;
2365 if ($user->socid > 0) {
2366 $socid = $user->socid;
2367 }
2368
2369 // this->ismultientitymanaged contains
2370 // 0=No test on entity, 1=Test with field entity, 'field@table'=Test with link by field@table
2371 $aliastablesociete = 's';
2372 if ($this->element == 'societe') {
2373 $aliastablesociete = 'te'; // te as table_element
2374 }
2375 $restrictiononfksoc = empty($this->restrictiononfksoc) ? 0 : $this->restrictiononfksoc;
2376 $sql = "SELECT MAX(te.".$fieldid.")";
2377 $sql .= " FROM ".(empty($nodbprefix) ? $this->db->prefix() : '').$this->table_element." as te";
2378 if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged)) {
2379 $tmparray = explode('@', $this->ismultientitymanaged);
2380 $sql .= ", ".$this->db->prefix().$tmparray[1]." as ".($tmparray[1] == 'societe' ? 's' : 'parenttable'); // If we need to link to this table to limit select to entity
2381 } elseif ($restrictiononfksoc == 1 && $this->element != 'societe' && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2382 $sql .= ", ".$this->db->prefix()."societe as s"; // If we need to link to societe to limit select to socid
2383 } elseif ($restrictiononfksoc == 2 && $this->element != 'societe' && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2384 $sql .= " LEFT JOIN ".$this->db->prefix()."societe as s ON te.fk_soc = s.rowid"; // If we need to link to societe to limit select to socid
2385 }
2386 if ($restrictiononfksoc && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2387 $sql .= " LEFT JOIN ".$this->db->prefix()."societe_commerciaux as sc ON ".$aliastablesociete.".rowid = sc.fk_soc";
2388 }
2389 if ($fieldid == 'rowid') {
2390 $sql .= " WHERE te.".$fieldid." < ".((int) $this->id);
2391 } else {
2392 $sql .= " WHERE te.".$fieldid." < '".$this->db->escape($this->ref)."'"; // ->ref must always be defined (set to id if field does not exists)
2393 }
2394 if ($restrictiononfksoc == 1 && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2395 $sql .= " AND sc.fk_user = ".((int) $user->id);
2396 }
2397 if ($restrictiononfksoc == 2 && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2398 $sql .= " AND (sc.fk_user = ".((int) $user->id).' OR te.fk_soc IS NULL)';
2399 }
2400
2401 $filtermax = $filter;
2402
2403 // Manage filter
2404 $errormessage = '';
2405 $tmpsql = forgeSQLFromUniversalSearchCriteria($filtermax, $errormessage);
2406 if ($errormessage) {
2407 if (!preg_match('/^\s*AND/i', $filtermax)) {
2408 $sql .= " AND ";
2409 }
2410 $sql .= $filtermax;
2411 } else {
2412 $sql .= $tmpsql;
2413 }
2414
2415 if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged)) {
2416 $tmparray = explode('@', $this->ismultientitymanaged);
2417 $sql .= " AND te.".$tmparray[0]." = ".($tmparray[1] == "societe" ? "s" : "parenttable").".rowid"; // If we need to link to this table to limit select to entity
2418 } elseif ($restrictiononfksoc == 1 && $this->element != 'societe' && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2419 $sql .= ' AND te.fk_soc = s.rowid'; // If we need to link to societe to limit select to socid
2420 }
2421 if (isset($this->ismultientitymanaged) && $this->ismultientitymanaged == 1) {
2422 if ($this->element == 'user' && getDolGlobalInt('MULTICOMPANY_TRANSVERSE_MODE')) {
2423 if (!empty($user->admin) && empty($user->entity) && $conf->entity == 1) {
2424 $sql .= " AND te.entity IS NOT NULL"; // Show all users
2425 } else {
2426 $sql .= " AND te.rowid IN (SELECT ug.fk_user FROM ".$this->db->prefix()."usergroup_user as ug WHERE ug.entity IN (".getEntity('usergroup')."))";
2427 }
2428 } else {
2429 $sql .= ' AND te.entity IN ('.getEntity($this->element).')';
2430 }
2431 }
2432 if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged) && $this->element != 'societe') {
2433 $tmparray = explode('@', $this->ismultientitymanaged);
2434 $sql .= ' AND parenttable.entity IN ('.getEntity($tmparray[1]).')';
2435 }
2436 if ($restrictiononfksoc == 1 && $socid && $this->element != 'societe') {
2437 $sql .= ' AND te.fk_soc = '.((int) $socid);
2438 }
2439 if ($restrictiononfksoc == 2 && $socid && $this->element != 'societe') {
2440 $sql .= ' AND (te.fk_soc = '.((int) $socid).' OR te.fk_soc IS NULL)';
2441 }
2442 if ($restrictiononfksoc && $socid && $this->element == 'societe') {
2443 $sql .= ' AND te.rowid = '.((int) $socid);
2444 }
2445 //print 'socid='.$socid.' restrictiononfksoc='.$restrictiononfksoc.' ismultientitymanaged = '.$this->ismultientitymanaged.' filter = '.$filter.' -> '.$sql."<br>";
2446
2447 $result = $this->db->query($sql);
2448 if (!$result) {
2449 $this->error = $this->db->lasterror();
2450 return -1;
2451 }
2452 $row = $this->db->fetch_row($result);
2453 $this->ref_previous = $row[0];
2454
2455 $sql = "SELECT MIN(te.".$fieldid.")";
2456 $sql .= " FROM ".(empty($nodbprefix) ? $this->db->prefix() : '').$this->table_element." as te";
2457 if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged)) {
2458 $tmparray = explode('@', $this->ismultientitymanaged);
2459 $sql .= ", ".$this->db->prefix().$tmparray[1]." as ".($tmparray[1] == 'societe' ? 's' : 'parenttable'); // If we need to link to this table to limit select to entity
2460 } elseif ($restrictiononfksoc == 1 && $this->element != 'societe' && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2461 $sql .= ", ".$this->db->prefix()."societe as s"; // If we need to link to societe to limit select to socid
2462 } elseif ($restrictiononfksoc == 2 && $this->element != 'societe' && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2463 $sql .= " LEFT JOIN ".$this->db->prefix()."societe as s ON te.fk_soc = s.rowid"; // If we need to link to societe to limit select to socid
2464 }
2465 if ($restrictiononfksoc && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2466 $sql .= " LEFT JOIN ".$this->db->prefix()."societe_commerciaux as sc ON ".$aliastablesociete.".rowid = sc.fk_soc";
2467 }
2468 if ($fieldid == 'rowid') {
2469 $sql .= " WHERE te.".$fieldid." > ".((int) $this->id);
2470 } else {
2471 $sql .= " WHERE te.".$fieldid." > '".$this->db->escape($this->ref)."'"; // ->ref must always be defined (set to id if field does not exists)
2472 }
2473 if ($restrictiononfksoc == 1 && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2474 $sql .= " AND (sc.fk_user = ".((int) $user->id);
2475 if (getDolGlobalInt('MAIN_SEE_SUBORDINATES')) {
2476 $userschilds = $user->getAllChildIds();
2477 $sql .= " OR sc.fk_user IN (".$this->db->sanitize(implode(',', $userschilds)).")";
2478 }
2479 $sql .= ')';
2480 }
2481 if ($restrictiononfksoc == 2 && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2482 $sql .= " AND (sc.fk_user = ".((int) $user->id).' OR te.fk_soc IS NULL)';
2483 }
2484
2485 $filtermin = $filter;
2486
2487 // Manage filter
2488 $errormessage = '';
2489 $tmpsql = forgeSQLFromUniversalSearchCriteria($filtermin, $errormessage);
2490 if ($errormessage) {
2491 if (!preg_match('/^\s*AND/i', $filtermin)) {
2492 $sql .= " AND ";
2493 }
2494 $sql .= $filtermin;
2495
2496 $filtermin = '';
2497 } else {
2498 $sql .= $tmpsql;
2499 }
2500
2501 if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged)) {
2502 $tmparray = explode('@', $this->ismultientitymanaged);
2503 $sql .= " AND te.".$tmparray[0]." = ".($tmparray[1] == "societe" ? "s" : "parenttable").".rowid"; // If we need to link to this table to limit select to entity
2504 } elseif ($restrictiononfksoc == 1 && $this->element != 'societe' && !$user->hasRight('societe', 'client', 'voir') && !$socid) {
2505 $sql .= ' AND te.fk_soc = s.rowid'; // If we need to link to societe to limit select to socid
2506 }
2507 if (isset($this->ismultientitymanaged) && $this->ismultientitymanaged == 1) {
2508 if ($this->element == 'user' && getDolGlobalInt('MULTICOMPANY_TRANSVERSE_MODE')) {
2509 if (!empty($user->admin) && empty($user->entity) && $conf->entity == 1) {
2510 $sql .= " AND te.entity IS NOT NULL"; // Show all users
2511 } else {
2512 $sql .= " AND te.rowid IN (SELECT ug.fk_user FROM ".$this->db->prefix()."usergroup_user as ug WHERE ug.entity IN (".getEntity('usergroup')."))";
2513 }
2514 } else {
2515 $sql .= ' AND te.entity IN ('.getEntity($this->element).')';
2516 }
2517 }
2518 if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged) && $this->element != 'societe') {
2519 $tmparray = explode('@', $this->ismultientitymanaged);
2520 $sql .= ' AND parenttable.entity IN ('.getEntity($tmparray[1]).')';
2521 }
2522 if ($restrictiononfksoc == 1 && $socid && $this->element != 'societe') {
2523 $sql .= ' AND te.fk_soc = '.((int) $socid);
2524 }
2525 if ($restrictiononfksoc == 2 && $socid && $this->element != 'societe') {
2526 $sql .= ' AND (te.fk_soc = '.((int) $socid).' OR te.fk_soc IS NULL)';
2527 }
2528 if ($restrictiononfksoc && $socid && $this->element == 'societe') {
2529 $sql .= ' AND te.rowid = '.((int) $socid);
2530 }
2531 //print 'socid='.$socid.' restrictiononfksoc='.$restrictiononfksoc.' ismultientitymanaged = '.$this->ismultientitymanaged.' filter = '.$filter.' -> '.$sql."<br>";
2532 // Rem: Bug in some mysql version: SELECT MIN(rowid) FROM llx_socpeople WHERE rowid > 1 when one row in database with rowid=1, returns 1 instead of null
2533
2534 $result = $this->db->query($sql);
2535 if (!$result) {
2536 $this->error = $this->db->lasterror();
2537 return -2;
2538 }
2539 $row = $this->db->fetch_row($result);
2540 $this->ref_next = $row[0];
2541
2542 return 1;
2543 }
2544
2545
2553 public function getListContactId($source = 'external')
2554 {
2555 $contactAlreadySelected = array();
2556 $tab = $this->liste_contact(-1, $source);
2557 $num = count($tab);
2558 $i = 0;
2559 while ($i < $num) {
2560 if ($source == 'thirdparty') {
2561 $contactAlreadySelected[$i] = $tab[$i]['socid'];
2562 } else {
2563 $contactAlreadySelected[$i] = $tab[$i]['id'];
2564 }
2565 $i++;
2566 }
2567 return $contactAlreadySelected;
2568 }
2569
2570
2578 public function setProject($projectid, $notrigger = 0)
2579 {
2580 global $user;
2581 $error = 0;
2582
2583 if (!$this->table_element) {
2584 dol_syslog(get_class($this)."::setProject was called on object with property table_element not defined", LOG_ERR);
2585 return -1;
2586 }
2587
2588 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
2589 // @phan-suppress-next-line PhanTypeMismatchProperty
2590 if (!empty($this->fields['fk_project'])) { // Common case
2591 if ($projectid) {
2592 $sql .= " SET fk_project = ".((int) $projectid);
2593 } else {
2594 $sql .= " SET fk_project = NULL";
2595 }
2596 $sql .= ' WHERE rowid = '.((int) $this->id);
2597 } elseif ($this->table_element == 'actioncomm') { // Special case for actioncomm
2598 if ($projectid) {
2599 $sql .= " SET fk_project = ".((int) $projectid);
2600 } else {
2601 $sql .= " SET fk_project = NULL";
2602 }
2603 $sql .= ' WHERE id = '.((int) $this->id);
2604 } else { // Special case for old architecture objects
2605 if ($projectid) {
2606 $sql .= ' SET fk_projet = '.((int) $projectid);
2607 } else {
2608 $sql .= ' SET fk_projet = NULL';
2609 }
2610 $sql .= " WHERE rowid = ".((int) $this->id);
2611 }
2612
2613 $this->db->begin();
2614
2615 dol_syslog(get_class($this)."::setProject", LOG_DEBUG);
2616 if ($this->db->query($sql)) {
2617 $this->fk_project = ((int) $projectid);
2618 } else {
2619 dol_print_error($this->db);
2620 $error++;
2621 }
2622
2623 // Triggers
2624 if (!$error && !$notrigger) {
2625 // Call triggers
2626 $result = $this->call_trigger(strtoupper($this->element) . '_MODIFY', $user);
2627 if ($result < 0) {
2628 $error++;
2629 } //Do also here what you must do to rollback action if trigger fail
2630 // End call triggers
2631 }
2632
2633 // Commit or rollback
2634 if ($error) {
2635 $this->db->rollback();
2636 return -1;
2637 } else {
2638 $this->db->commit();
2639 return 1;
2640 }
2641 }
2642
2649 public function setPaymentMethods($id)
2650 {
2651 global $user;
2652
2653 $error = 0;
2654 $notrigger = 0;
2655
2656 dol_syslog(get_class($this).'::setPaymentMethods('.$id.')');
2657
2658 if ($this->status >= 0 || $this->element == 'societe') {
2659 // TODO uniformize field name
2660 $fieldname = 'fk_mode_reglement';
2661 if ($this->element == 'societe') {
2662 $fieldname = 'mode_reglement';
2663 }
2664 if (get_class($this) == 'Fournisseur') {
2665 $fieldname = 'mode_reglement_supplier';
2666 }
2667 if (get_class($this) == 'Tva') {
2668 $fieldname = 'fk_typepayment';
2669 }
2670 if (get_class($this) == 'Salary') {
2671 $fieldname = 'fk_typepayment';
2672 }
2673
2674 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
2675 $sql .= " SET ".$fieldname." = ".(($id > 0 || $id == '0') ? ((int) $id) : 'NULL');
2676 $sql .= ' WHERE rowid='.((int) $this->id);
2677
2678 if ($this->db->query($sql)) {
2679 $this->mode_reglement_id = $id;
2680 // for supplier
2681 if (get_class($this) == 'Fournisseur') {
2682 $this->mode_reglement_supplier_id = $id;
2683 }
2684 // Triggers
2685 if (!$error && !$notrigger) {
2686 // Call triggers
2687 if (get_class($this) == 'Commande') {
2688 $result = $this->call_trigger('ORDER_MODIFY', $user);
2689 } else {
2690 $result = $this->call_trigger(strtoupper(get_class($this)).'_MODIFY', $user);
2691 }
2692 if ($result < 0) {
2693 $error++;
2694 }
2695 // End call triggers
2696 }
2697 return 1;
2698 } else {
2699 dol_syslog(get_class($this).'::setPaymentMethods Error '.$this->db->error());
2700 $this->error = $this->db->error();
2701 return -1;
2702 }
2703 } else {
2704 dol_syslog(get_class($this).'::setPaymentMethods, status of the object is incompatible');
2705 $this->error = 'Status of the object is incompatible '.$this->status;
2706 return -2;
2707 }
2708 }
2709
2716 public function setMulticurrencyCode($code)
2717 {
2718 dol_syslog(get_class($this).'::setMulticurrencyCode('.$code.')');
2719 if ($this->status >= 0 || $this->element == 'societe') {
2720 $fieldname = 'multicurrency_code';
2721
2722 $sql = 'UPDATE '.$this->db->prefix().$this->table_element;
2723 $sql .= " SET ".$fieldname." = '".$this->db->escape($code)."'";
2724 $sql .= ' WHERE rowid='.((int) $this->id);
2725
2726 if ($this->db->query($sql)) {
2727 $this->multicurrency_code = $code;
2728
2729 list($fk_multicurrency, $rate) = MultiCurrency::getIdAndTxFromCode($this->db, $code);
2730 if ($rate) {
2731 $this->setMulticurrencyRate($rate, 2);
2732 }
2733
2734 return 1;
2735 } else {
2736 dol_syslog(get_class($this).'::setMulticurrencyCode Error '.$sql.' - '.$this->db->error());
2737 $this->error = $this->db->error();
2738 return -1;
2739 }
2740 } else {
2741 dol_syslog(get_class($this).'::setMulticurrencyCode, status of the object is incompatible');
2742 $this->error = 'Status of the object is incompatible '.$this->status;
2743 return -2;
2744 }
2745 }
2746
2754 public function setMulticurrencyRate($rate, $mode = 1)
2755 {
2756 dol_syslog(get_class($this).'::setMulticurrencyRate('.$rate.', '.$mode.')');
2757 if ($this->status >= 0 || $this->element == 'societe') {
2758 $fieldname = 'multicurrency_tx';
2759
2760 $sql = 'UPDATE '.$this->db->prefix().$this->table_element;
2761 $sql .= " SET ".$fieldname." = ".((float) $rate);
2762 $sql .= ' WHERE rowid='.((int) $this->id);
2763
2764 if ($this->db->query($sql)) {
2765 $this->multicurrency_tx = $rate;
2766
2767 // Update line price
2768 if (!empty($this->lines)) {
2769 foreach ($this->lines as &$line) {
2770 // Amounts in company currency will be recalculated
2771 if ($mode == 1) {
2772 $line->subprice = 0;
2773 }
2774
2775 // Amounts in foreign currency will be recalculated
2776 if ($mode == 2) {
2777 $line->multicurrency_subprice = 0;
2778 }
2779
2780 switch ($this->element) {
2781 case 'propal':
2784 '@phan-var-force Propal $this';
2785 '@phan-var-force PropaleLigne $line';
2786 $this->updateline(
2787 $line->id,
2788 $line->subprice,
2789 $line->qty,
2790 $line->remise_percent,
2791 $line->tva_tx,
2792 $line->localtax1_tx,
2793 $line->localtax2_tx,
2794 ($line->description ? $line->description : $line->desc),
2795 'HT',
2796 $line->info_bits,
2797 $line->special_code,
2798 $line->fk_parent_line,
2799 $line->skip_update_total,
2800 $line->fk_fournprice,
2801 $line->pa_ht,
2802 $line->label,
2803 $line->product_type,
2804 $line->date_start,
2805 $line->date_end,
2806 $line->array_options,
2807 $line->fk_unit,
2808 $line->multicurrency_subprice
2809 );
2810 break;
2811 case 'commande':
2814 '@phan-var-force Commande $this';
2815 '@phan-var-force OrderLine $line';
2816 $this->updateline(
2817 $line->id,
2818 ($line->description ? $line->description : $line->desc),
2819 $line->subprice,
2820 $line->qty,
2821 $line->remise_percent,
2822 $line->tva_tx,
2823 $line->localtax1_tx,
2824 $line->localtax2_tx,
2825 'HT',
2826 $line->info_bits,
2827 $line->date_start,
2828 $line->date_end,
2829 $line->product_type,
2830 $line->fk_parent_line,
2831 $line->skip_update_total,
2832 $line->fk_fournprice,
2833 $line->pa_ht,
2834 $line->label,
2835 $line->special_code,
2836 $line->array_options,
2837 $line->fk_unit,
2838 $line->multicurrency_subprice
2839 );
2840 break;
2841 case 'facture':
2844 '@phan-var-force Facture $this';
2845 '@phan-var-force FactureLigne $line';
2846 $this->updateline(
2847 $line->id,
2848 ($line->description ? $line->description : $line->desc),
2849 $line->subprice,
2850 $line->qty,
2851 $line->remise_percent,
2852 $line->date_start,
2853 $line->date_end,
2854 $line->tva_tx,
2855 $line->localtax1_tx,
2856 $line->localtax2_tx,
2857 'HT',
2858 $line->info_bits,
2859 $line->product_type,
2860 $line->fk_parent_line,
2861 $line->skip_update_total,
2862 $line->fk_fournprice,
2863 $line->pa_ht,
2864 $line->label,
2865 $line->special_code,
2866 $line->array_options,
2867 $line->situation_percent,
2868 $line->fk_unit,
2869 $line->multicurrency_subprice
2870 );
2871 break;
2872 case 'supplier_proposal':
2875 '@phan-var-force SupplierProposal $this';
2876 '@phan-var-force SupplierProposalLine $line';
2877 $this->updateline(
2878 $line->id,
2879 $line->subprice,
2880 $line->qty,
2881 $line->remise_percent,
2882 $line->tva_tx,
2883 $line->localtax1_tx,
2884 $line->localtax2_tx,
2885 ($line->description ? $line->description : $line->desc),
2886 'HT',
2887 $line->info_bits,
2888 $line->special_code,
2889 $line->fk_parent_line,
2890 $line->skip_update_total,
2891 $line->fk_fournprice,
2892 $line->pa_ht,
2893 $line->label,
2894 $line->product_type,
2895 $line->array_options,
2896 $line->ref_fourn,
2897 $line->multicurrency_subprice
2898 );
2899 break;
2900 case 'order_supplier':
2903 '@phan-var-force CommandeFournisseur $this';
2904 '@phan-var-force CommandeFournisseurLigne $line';
2905 $this->updateline(
2906 $line->id,
2907 ($line->description ? $line->description : $line->desc),
2908 $line->subprice,
2909 $line->qty,
2910 $line->remise_percent,
2911 $line->tva_tx,
2912 $line->localtax1_tx,
2913 $line->localtax2_tx,
2914 'HT',
2915 $line->info_bits,
2916 $line->product_type,
2917 0,
2918 $line->date_start,
2919 $line->date_end,
2920 $line->array_options,
2921 $line->fk_unit,
2922 $line->multicurrency_subprice,
2923 $line->ref_supplier
2924 );
2925 break;
2926 case 'invoice_supplier':
2929 '@phan-var-force FactureFournisseur $this';
2930 '@phan-var-force SupplierInvoiceLIne $line';
2931 $this->updateline(
2932 $line->id,
2933 ($line->description ? $line->description : $line->desc),
2934 $line->subprice,
2935 $line->tva_tx,
2936 $line->localtax1_tx,
2937 $line->localtax2_tx,
2938 $line->qty,
2939 0,
2940 'HT',
2941 $line->info_bits,
2942 $line->product_type,
2943 $line->remise_percent,
2944 0,
2945 $line->date_start,
2946 $line->date_end,
2947 $line->array_options,
2948 $line->fk_unit,
2949 $line->multicurrency_subprice,
2950 $line->ref_supplier
2951 );
2952 break;
2953 default:
2954 dol_syslog(get_class($this).'::setMulticurrencyRate no updateline defined', LOG_DEBUG);
2955 break;
2956 }
2957 }
2958 }
2959
2960 return 1;
2961 } else {
2962 dol_syslog(get_class($this).'::setMulticurrencyRate Error '.$sql.' - '.$this->db->error());
2963 $this->error = $this->db->error();
2964 return -1;
2965 }
2966 } else {
2967 dol_syslog(get_class($this).'::setMulticurrencyRate, status of the object is incompatible');
2968 $this->error = 'Status of the object is incompatible '.$this->status;
2969 return -2;
2970 }
2971 }
2972
2980 public function setPaymentTerms($id, $deposit_percent = null)
2981 {
2982 dol_syslog(get_class($this).'::setPaymentTerms('.$id.', '.var_export($deposit_percent, true).')');
2983 if ($this->status >= 0 || $this->element == 'societe') {
2984 // TODO uniformize field name
2985 $fieldname = 'fk_cond_reglement';
2986 if ($this->element == 'societe') {
2987 $fieldname = 'cond_reglement';
2988 }
2989 if (get_class($this) == 'Fournisseur') {
2990 $fieldname = 'cond_reglement_supplier';
2991 }
2992
2993 if (empty($deposit_percent) || $deposit_percent < 0) {
2994 $deposit_percent = (float) getDictionaryValue('c_payment_term', 'deposit_percent', $id);
2995 }
2996
2997 if ($deposit_percent > 100) {
2998 $deposit_percent = 100;
2999 }
3000
3001 $sql = 'UPDATE '.$this->db->prefix().$this->table_element;
3002 $sql .= " SET ".$fieldname." = ".(($id > 0 || $id == '0') ? ((int) $id) : 'NULL');
3003 if (in_array($this->table_element, array('propal', 'commande', 'societe'))) {
3004 $sql .= " , deposit_percent = " . (empty($deposit_percent) ? 'NULL' : "'".$this->db->escape($deposit_percent)."'");
3005 }
3006 $sql .= ' WHERE rowid='.((int) $this->id);
3007
3008 if ($this->db->query($sql)) {
3009 $this->cond_reglement_id = $id;
3010 // for supplier
3011 if (get_class($this) == 'Fournisseur') {
3012 $this->cond_reglement_supplier_id = $id;
3013 }
3014 $this->cond_reglement = $id; // for compatibility
3015 $this->deposit_percent = $deposit_percent;
3016 return 1;
3017 } else {
3018 dol_syslog(get_class($this).'::setPaymentTerms Error '.$sql.' - '.$this->db->error());
3019 $this->error = $this->db->error();
3020 return -1;
3021 }
3022 } else {
3023 dol_syslog(get_class($this).'::setPaymentTerms, status of the object is incompatible');
3024 $this->error = 'Status of the object is incompatible '.$this->status;
3025 return -2;
3026 }
3027 }
3028
3035 public function setTransportMode($id)
3036 {
3037 dol_syslog(get_class($this).'::setTransportMode('.$id.')');
3038 if ($this->status >= 0 || $this->element == 'societe') {
3039 $fieldname = 'fk_transport_mode';
3040 if ($this->element == 'societe') {
3041 $fieldname = 'transport_mode';
3042 }
3043 if (get_class($this) == 'Fournisseur') {
3044 $fieldname = 'transport_mode_supplier';
3045 }
3046
3047 $sql = 'UPDATE '.$this->db->prefix().$this->table_element;
3048 $sql .= " SET ".$fieldname." = ".(($id > 0 || $id == '0') ? ((int) $id) : 'NULL');
3049 $sql .= ' WHERE rowid='.((int) $this->id);
3050
3051 if ($this->db->query($sql)) {
3052 $this->transport_mode_id = $id;
3053 // for supplier
3054 if (get_class($this) == 'Fournisseur') {
3055 $this->transport_mode_supplier_id = $id;
3056 }
3057 return 1;
3058 } else {
3059 dol_syslog(get_class($this).'::setTransportMode Error '.$sql.' - '.$this->db->error());
3060 $this->error = $this->db->error();
3061 return -1;
3062 }
3063 } else {
3064 dol_syslog(get_class($this).'::setTransportMode, status of the object is incompatible');
3065 $this->error = 'Status of the object is incompatible '.$this->status;
3066 return -2;
3067 }
3068 }
3069
3077 {
3078 dol_syslog(get_class($this).'::setRetainedWarrantyPaymentTerms('.$id.')');
3079 if ($this->status >= 0 || $this->element == 'societe') {
3080 $fieldname = 'retained_warranty_fk_cond_reglement';
3081
3082 $sql = 'UPDATE '.$this->db->prefix().$this->table_element;
3083 $sql .= " SET ".$fieldname." = ".((int) $id);
3084 $sql .= ' WHERE rowid='.((int) $this->id);
3085
3086 if ($this->db->query($sql)) {
3087 $this->retained_warranty_fk_cond_reglement = $id;
3088 return 1;
3089 } else {
3090 dol_syslog(get_class($this).'::setRetainedWarrantyPaymentTerms Error '.$sql.' - '.$this->db->error());
3091 $this->error = $this->db->error();
3092 return -1;
3093 }
3094 } else {
3095 dol_syslog(get_class($this).'::setRetainedWarrantyPaymentTerms, status of the object is incompatible');
3096 $this->error = 'Status of the object is incompatible '.$this->status;
3097 return -2;
3098 }
3099 }
3100
3108 public function setDeliveryAddress($id)
3109 {
3110 $fieldname = 'fk_delivery_address';
3111 if ($this->element == 'delivery' || $this->element == 'shipping') {
3112 $fieldname = 'fk_address';
3113 }
3114
3115 $sql = "UPDATE ".$this->db->prefix().$this->table_element." SET ".$fieldname." = ".((int) $id);
3116 $sql .= " WHERE rowid = ".((int) $this->id)." AND fk_statut = 0";
3117
3118 if ($this->db->query($sql)) {
3119 $this->fk_delivery_address = $id;
3120 return 1;
3121 } else {
3122 $this->error = $this->db->error();
3123 dol_syslog(get_class($this).'::setDeliveryAddress Error '.$this->error);
3124 return -1;
3125 }
3126 }
3127
3128
3137 public function setShippingMethod($shipping_method_id, $notrigger = 0, $userused = null)
3138 {
3139 global $user;
3140
3141 if (empty($userused)) {
3142 $userused = $user;
3143 }
3144
3145 $error = 0;
3146
3147 if (!$this->table_element) {
3148 dol_syslog(get_class($this)."::setShippingMethod was called on object with property table_element not defined", LOG_ERR);
3149 return -1;
3150 }
3151
3152 $this->db->begin();
3153
3154 if ($shipping_method_id < 0) {
3155 $shipping_method_id = 'NULL';
3156 }
3157 dol_syslog(get_class($this).'::setShippingMethod('.$shipping_method_id.')');
3158
3159 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
3160 $sql .= " SET fk_shipping_method = ".((int) $shipping_method_id);
3161 $sql .= " WHERE rowid=".((int) $this->id);
3162 $resql = $this->db->query($sql);
3163 if (!$resql) {
3164 dol_syslog(get_class($this).'::setShippingMethod Error ', LOG_DEBUG);
3165 $this->error = $this->db->lasterror();
3166 $error++;
3167 } else {
3168 if (!$notrigger) {
3169 // Call trigger
3170 $this->context = array('shippingmethodupdate' => 1);
3171 $result = $this->call_trigger(strtoupper(get_class($this)).'_MODIFY', $userused);
3172 if ($result < 0) {
3173 $error++;
3174 }
3175 // End call trigger
3176 }
3177 }
3178 if ($error) {
3179 $this->db->rollback();
3180 return -1;
3181 } else {
3182 $this->shipping_method_id = ($shipping_method_id == 'NULL') ? null : $shipping_method_id;
3183 $this->db->commit();
3184 return 1;
3185 }
3186 }
3187
3188
3195 public function setWarehouse($warehouse_id)
3196 {
3197 if (!$this->table_element) {
3198 dol_syslog(get_class($this)."::setWarehouse was called on object with property table_element not defined", LOG_ERR);
3199 return -1;
3200 }
3201 if ($warehouse_id < 0) {
3202 $warehouse_id = 'NULL';
3203 }
3204 dol_syslog(get_class($this).'::setWarehouse('.$warehouse_id.')');
3205
3206 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
3207 $sql .= " SET fk_warehouse = ".((int) $warehouse_id);
3208 $sql .= " WHERE rowid=".((int) $this->id);
3209
3210 if ($this->db->query($sql)) {
3211 $this->warehouse_id = ($warehouse_id == 'NULL') ? null : $warehouse_id;
3212 return 1;
3213 } else {
3214 dol_syslog(get_class($this).'::setWarehouse Error ', LOG_DEBUG);
3215 $this->error = $this->db->error();
3216 return 0;
3217 }
3218 }
3219
3220
3228 public function setDocModel($user, $modelpdf)
3229 {
3230 if (!$this->table_element) {
3231 dol_syslog(get_class($this)."::setDocModel was called on object with property table_element not defined", LOG_ERR);
3232 return -1;
3233 }
3234
3235 $newmodelpdf = dol_trunc($modelpdf, 255);
3236
3237 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
3238 $sql .= " SET model_pdf = '".$this->db->escape($newmodelpdf)."'";
3239 $sql .= " WHERE rowid = ".((int) $this->id);
3240
3241 dol_syslog(get_class($this)."::setDocModel", LOG_DEBUG);
3242 $resql = $this->db->query($sql);
3243 if ($resql) {
3244 $this->model_pdf = $modelpdf;
3245 return 1;
3246 } else {
3247 dol_print_error($this->db);
3248 return 0;
3249 }
3250 }
3251
3252
3261 public function setBankAccount($fk_account, $notrigger = 0, $userused = null)
3262 {
3263 global $user;
3264
3265 if (empty($userused)) {
3266 $userused = $user;
3267 }
3268
3269 $error = 0;
3270
3271 if (!$this->table_element) {
3272 dol_syslog(get_class($this)."::setBankAccount was called on object with property table_element not defined", LOG_ERR);
3273 return -1;
3274 }
3275 $this->db->begin();
3276
3277 if ($fk_account < 0) {
3278 $fk_account = 'NULL';
3279 }
3280 dol_syslog(get_class($this).'::setBankAccount('.$fk_account.')');
3281
3282 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
3283 $sql .= " SET fk_account = ".((int) $fk_account);
3284 $sql .= " WHERE rowid=".((int) $this->id);
3285
3286 $resql = $this->db->query($sql);
3287 if (!$resql) {
3288 dol_syslog(get_class($this).'::setBankAccount Error '.$sql.' - '.$this->db->error());
3289 $this->error = $this->db->lasterror();
3290 $error++;
3291 } else {
3292 if (!$notrigger) {
3293 // Call trigger
3294 $this->context['bankaccountupdate'] = 1;
3295 $triggerName = strtoupper(get_class($this)).'_MODIFY';
3296 // Special cases
3297 if ($triggerName == 'FACTUREREC_MODIFY') {
3298 $triggerName = 'BILLREC_MODIFY';
3299 }
3300 $result = $this->call_trigger($triggerName, $userused);
3301 if ($result < 0) {
3302 $error++;
3303 }
3304 // End call trigger
3305 }
3306 }
3307 if ($error) {
3308 $this->db->rollback();
3309 return -1;
3310 } else {
3311 $this->fk_account = ($fk_account == 'NULL') ? null : $fk_account;
3312 $this->db->commit();
3313 return 1;
3314 }
3315 }
3316
3317
3318 // TODO: Move line related operations to CommonObjectLine?
3319
3320 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3330 public function line_order($renum = false, $rowidorder = 'ASC', $fk_parent_line = true)
3331 {
3332 // phpcs:enable
3333 if (!$this->table_element_line) {
3334 dol_syslog(get_class($this)."::line_order was called on object with property table_element_line not defined", LOG_ERR);
3335 return -1;
3336 }
3337 if (!$this->fk_element) {
3338 dol_syslog(get_class($this)."::line_order was called on object with property fk_element not defined", LOG_ERR);
3339 return -1;
3340 }
3341
3342 $fieldposition = 'rang'; // @todo Rename 'rang' into 'position'
3343 if (in_array($this->table_element_line, array('bom_bomline', 'ecm_files', 'emailcollector_emailcollectoraction', 'product_attribute_value'))) {
3344 $fieldposition = 'position';
3345 }
3346
3347 // Count number of lines to reorder (according to choice $renum)
3348 $nl = 0;
3349 $sql = "SELECT count(rowid) FROM ".$this->db->prefix().$this->table_element_line;
3350 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3351 if (!$renum) {
3352 $sql .= " AND " . $fieldposition . " = 0";
3353 }
3354 if ($renum) {
3355 $sql .= " AND " . $fieldposition . " <> 0";
3356 }
3357
3358 dol_syslog(get_class($this)."::line_order", LOG_DEBUG);
3359 $resql = $this->db->query($sql);
3360 if ($resql) {
3361 $row = $this->db->fetch_row($resql);
3362 $nl = $row[0];
3363 } else {
3364 dol_print_error($this->db);
3365 }
3366 if ($nl > 0) {
3367 // The goal of this part is to reorder all lines, with all children lines sharing the same counter that parents.
3368 $rows = array();
3369
3370 // We first search all lines that are parent lines (for multilevel details lines)
3371 $sql = "SELECT rowid FROM ".$this->db->prefix().$this->table_element_line;
3372 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3373 if ($fk_parent_line) {
3374 $sql .= ' AND fk_parent_line IS NULL';
3375 }
3376 $sql .= " ORDER BY " . $fieldposition . " ASC, rowid " . $rowidorder;
3377
3378 dol_syslog(get_class($this)."::line_order search all parent lines", LOG_DEBUG);
3379 $resql = $this->db->query($sql);
3380 if ($resql) {
3381 $i = 0;
3382 $num = $this->db->num_rows($resql);
3383 $grandchild = getDolGlobalInt('MAIN_CARE_GRANDCHILD');
3384 while ($i < $num) {
3385 $row = $this->db->fetch_row($resql);
3386 $rows[] = $row[0]; // Add parent line into array rows
3387 $children = $this->getChildrenOfLine($row[0], $grandchild);
3388 if (!empty($children)) {
3389 foreach ($children as $child) {
3390 array_push($rows, $child);
3391 }
3392 }
3393 $i++;
3394 }
3395
3396 // Now we set a new number for each lines (parent and children with children included into parent tree)
3397 if (!empty($rows)) {
3398 foreach ($rows as $key => $row) {
3399 $this->updateRangOfLine($row, ($key + 1));
3400 }
3401 }
3402 } else {
3403 dol_print_error($this->db);
3404 }
3405 }
3406 return 1;
3407 }
3408
3416 public function getChildrenOfLine($id, $includealltree = 0)
3417 {
3418 $fieldposition = 'rang'; // @todo Rename 'rang' into 'position'
3419 if (in_array($this->table_element_line, array('bom_bomline', 'ecm_files', 'emailcollector_emailcollectoraction', 'product_attribute_value'))) {
3420 $fieldposition = 'position';
3421 }
3422
3423 $rows = array();
3424
3425 $sql = "SELECT rowid FROM ".$this->db->prefix().$this->table_element_line;
3426 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3427 $sql .= ' AND fk_parent_line = '.((int) $id);
3428 $sql .= " ORDER BY " . $fieldposition . " ASC";
3429
3430 dol_syslog(get_class($this)."::getChildrenOfLine search children lines for line ".$id, LOG_DEBUG);
3431
3432 $resql = $this->db->query($sql);
3433 if ($resql) {
3434 if ($this->db->num_rows($resql) > 0) {
3435 while ($row = $this->db->fetch_row($resql)) {
3436 $rows[] = $row[0];
3437 if (!empty($includealltree) && $includealltree <= 1000) { // Test <= 1000 is a protection in depth of recursive call to avoid infinite loop
3438 $rows = array_merge($rows, $this->getChildrenOfLine($row[0], $includealltree + 1));
3439 }
3440 }
3441 }
3442 }
3443 return $rows;
3444 }
3445
3446 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3454 public function line_up($rowid, $fk_parent_line = true)
3455 {
3456 // phpcs:enable
3457 $this->line_order(false, 'ASC', $fk_parent_line);
3458
3459 // Get rang of line
3460 $rang = $this->getRangOfLine($rowid);
3461
3462 // Update position of line
3463 $this->updateLineUp($rowid, $rang);
3464 }
3465
3466 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3474 public function line_down($rowid, $fk_parent_line = true)
3475 {
3476 // phpcs:enable
3477 $this->line_order(false, 'ASC', $fk_parent_line);
3478
3479 // Get rang of line
3480 $rang = $this->getRangOfLine($rowid);
3481
3482 // Get max value for rang
3483 $max = $this->line_max();
3484
3485 // Update position of line
3486 $this->updateLineDown($rowid, $rang, $max);
3487 }
3488
3496 public function updateRangOfLine($rowid, $rang)
3497 {
3498 global $hookmanager;
3499 $fieldposition = 'rang'; // @todo Rename 'rang' into 'position'
3500 if (in_array($this->table_element_line, array('bom_bomline', 'ecm_files', 'emailcollector_emailcollectoraction', 'product_attribute_value'))) {
3501 $fieldposition = 'position';
3502 }
3503
3504 $sql = "UPDATE ".$this->db->prefix().$this->table_element_line." SET ".$fieldposition." = ".((int) $rang);
3505 $sql .= ' WHERE rowid = '.((int) $rowid);
3506
3507 dol_syslog(get_class($this)."::updateRangOfLine", LOG_DEBUG);
3508 if (!$this->db->query($sql)) {
3509 dol_print_error($this->db);
3510 return -1;
3511 } else {
3512 $parameters = array('rowid' => $rowid, 'rang' => $rang, 'fieldposition' => $fieldposition);
3513 $action = '';
3514 $reshook = $hookmanager->executeHooks('afterRankOfLineUpdate', $parameters, $this, $action);
3515 return 1;
3516 }
3517 }
3518
3519 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3526 public function line_ajaxorder($rows)
3527 {
3528 // phpcs:enable
3529 $num = count($rows);
3530 for ($i = 0; $i < $num; $i++) {
3531 $this->updateRangOfLine($rows[$i], ($i + 1));
3532 }
3533 }
3534
3542 public function updateLineUp($rowid, $rang)
3543 {
3544 if ($rang > 1) {
3545 $fieldposition = 'rang';
3546 if (in_array($this->table_element_line, array('ecm_files', 'emailcollector_emailcollectoraction', 'product_attribute_value'))) {
3547 $fieldposition = 'position';
3548 }
3549
3550 $sql = "UPDATE ".$this->db->prefix().$this->table_element_line." SET ".$fieldposition." = ".((int) $rang);
3551 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3552 $sql .= " AND " . $fieldposition . " = " . ((int) ($rang - 1));
3553 if ($this->db->query($sql)) {
3554 $sql = "UPDATE ".$this->db->prefix().$this->table_element_line." SET ".$fieldposition." = ".((int) ($rang - 1));
3555 $sql .= ' WHERE rowid = '.((int) $rowid);
3556 if (!$this->db->query($sql)) {
3557 dol_print_error($this->db);
3558 }
3559 } else {
3560 dol_print_error($this->db);
3561 }
3562 }
3563 }
3564
3573 public function updateLineDown($rowid, $rang, $max)
3574 {
3575 if ($rang < $max) {
3576 $fieldposition = 'rang';
3577 if (in_array($this->table_element_line, array('ecm_files', 'emailcollector_emailcollectoraction', 'product_attribute_value'))) {
3578 $fieldposition = 'position';
3579 }
3580
3581 $sql = "UPDATE ".$this->db->prefix().$this->table_element_line." SET ".$fieldposition." = ".((int) $rang);
3582 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3583 $sql .= " AND " . $fieldposition . " = " . ((int) ($rang + 1));
3584 if ($this->db->query($sql)) {
3585 $sql = "UPDATE ".$this->db->prefix().$this->table_element_line." SET ".$fieldposition." = ".((int) ($rang + 1));
3586 $sql .= ' WHERE rowid = '.((int) $rowid);
3587 if (!$this->db->query($sql)) {
3588 dol_print_error($this->db);
3589 }
3590 } else {
3591 dol_print_error($this->db);
3592 }
3593 }
3594 }
3595
3602 public function getRangOfLine($rowid)
3603 {
3604 $fieldposition = 'rang';
3605 if (in_array($this->table_element_line, array('ecm_files', 'emailcollector_emailcollectoraction', 'product_attribute_value'))) {
3606 $fieldposition = 'position';
3607 }
3608
3609 $sql = "SELECT " . $fieldposition . " FROM ".$this->db->prefix().$this->table_element_line;
3610 $sql .= " WHERE rowid = ".((int) $rowid);
3611
3612 dol_syslog(get_class($this)."::getRangOfLine", LOG_DEBUG);
3613 $resql = $this->db->query($sql);
3614 if ($resql) {
3615 $row = $this->db->fetch_row($resql);
3616 return $row[0];
3617 }
3618
3619 return 0;
3620 }
3621
3628 public function getIdOfLine($rang)
3629 {
3630 $fieldposition = 'rang';
3631 if (in_array($this->table_element_line, array('ecm_files', 'emailcollector_emailcollectoraction', 'product_attribute_value'))) {
3632 $fieldposition = 'position';
3633 }
3634
3635 $sql = "SELECT rowid FROM ".$this->db->prefix().$this->table_element_line;
3636 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3637 $sql .= " AND " . $fieldposition . " = ".((int) $rang);
3638 $resql = $this->db->query($sql);
3639 if ($resql) {
3640 $row = $this->db->fetch_row($resql);
3641 return $row[0];
3642 }
3643
3644 return 0;
3645 }
3646
3647 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3654 public function line_max($fk_parent_line = 0)
3655 {
3656 // phpcs:enable
3657 $positionfield = 'rang';
3658 if (in_array($this->table_element, array('bom_bom', 'product_attribute'))) {
3659 $positionfield = 'position';
3660 }
3661
3662 // Search the last rang with fk_parent_line
3663 if ($fk_parent_line) {
3664 $sql = "SELECT max(".$positionfield.") FROM ".$this->db->prefix().$this->table_element_line;
3665 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3666 $sql .= " AND fk_parent_line = ".((int) $fk_parent_line);
3667
3668 dol_syslog(get_class($this)."::line_max", LOG_DEBUG);
3669 $resql = $this->db->query($sql);
3670 if ($resql) {
3671 $row = $this->db->fetch_row($resql);
3672 if (!empty($row[0])) {
3673 return $row[0];
3674 } else {
3675 return $this->getRangOfLine($fk_parent_line);
3676 }
3677 }
3678 } else {
3679 // If not, search the last rang of element
3680 $sql = "SELECT max(".$positionfield.") FROM ".$this->db->prefix().$this->table_element_line;
3681 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3682
3683 dol_syslog(get_class($this)."::line_max", LOG_DEBUG);
3684 $resql = $this->db->query($sql);
3685 if ($resql) {
3686 $row = $this->db->fetch_row($resql);
3687 return $row[0];
3688 }
3689 }
3690
3691 return 0;
3692 }
3693
3694 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3701 public function update_ref_ext($ref_ext)
3702 {
3703 // phpcs:enable
3704 if (!$this->table_element) {
3705 dol_syslog(get_class($this)."::update_ref_ext was called on object with property table_element not defined", LOG_ERR);
3706 return -1;
3707 }
3708
3709 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
3710 $sql .= " SET ref_ext = '".$this->db->escape($ref_ext)."'";
3711 // @phan-suppress-next-line PhanUndeclaredProperty
3712 $sql .= " WHERE ".(isset($this->table_rowid) ? $this->table_rowid : 'rowid')." = ".((int) $this->id);
3713
3714 dol_syslog(get_class($this)."::update_ref_ext", LOG_DEBUG);
3715 if ($this->db->query($sql)) {
3716 $this->ref_ext = $ref_ext;
3717 return 1;
3718 } else {
3719 $this->error = $this->db->error();
3720 return -1;
3721 }
3722 }
3723
3724 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3733 public function update_note($note, $suffix = '', $notrigger = 0)
3734 {
3735 // phpcs:enable
3736 global $user;
3737
3738 if (!$this->table_element) {
3739 $this->error = 'update_note was called on object with property table_element not defined';
3740 dol_syslog(get_class($this)."::update_note was called on object with property table_element not defined", LOG_ERR);
3741 return -1;
3742 }
3743 if (!in_array($suffix, array('', '_public', '_private'))) {
3744 $this->error = 'update_note Parameter suffix must be empty, \'_private\' or \'_public\'';
3745 dol_syslog(get_class($this)."::update_note Parameter suffix must be empty, '_private' or '_public'", LOG_ERR);
3746 return -2;
3747 }
3748
3749 $newsuffix = $suffix;
3750
3751 // Special case
3752 if ($this->table_element == 'product' && $newsuffix == '_private') {
3753 $newsuffix = '';
3754 }
3755 if (in_array($this->table_element, array('actioncomm', 'adherent', 'advtargetemailing', 'cronjob', 'establishment'))) {
3756 $fieldusermod = "fk_user_mod";
3757 } elseif ($this->table_element == 'ecm_files') {
3758 $fieldusermod = "fk_user_m";
3759 } else {
3760 $fieldusermod = "fk_user_modif";
3761 }
3762 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
3763 $sql .= " SET note".$newsuffix." = ".(!empty($note) ? ("'".$this->db->escape($note)."'") : "NULL");
3764 $sql .= ", ".$fieldusermod." = ".((int) $user->id);
3765 $sql .= " WHERE rowid = ".((int) $this->id);
3766
3767 dol_syslog(get_class($this)."::update_note", LOG_DEBUG);
3768 if ($this->db->query($sql)) {
3769 if ($suffix == '_public') {
3770 $this->note_public = $note;
3771 } elseif ($suffix == '_private') {
3772 $this->note_private = $note;
3773 } else {
3774 $this->note = $note; // deprecated
3775 $this->note_private = $note;
3776 }
3777 if (empty($notrigger)) {
3778 switch ($this->element) {
3779 case 'societe':
3780 $trigger_name = 'COMPANY_MODIFY';
3781 break;
3782 case 'commande':
3783 $trigger_name = 'ORDER_MODIFY';
3784 break;
3785 case 'facture':
3786 $trigger_name = 'BILL_MODIFY';
3787 break;
3788 case 'invoice_supplier':
3789 $trigger_name = 'BILL_SUPPLIER_MODIFY';
3790 break;
3791 case 'facturerec':
3792 $trigger_name = 'BILLREC_MODIFIY';
3793 break;
3794 case 'expensereport':
3795 $trigger_name = 'EXPENSE_REPORT_MODIFY';
3796 break;
3797 default:
3798 $trigger_name = strtoupper($this->element) . '_MODIFY';
3799 }
3800 $ret = $this->call_trigger($trigger_name, $user);
3801 if ($ret < 0) {
3802 return -1;
3803 }
3804 }
3805 return 1;
3806 } else {
3807 $this->error = $this->db->lasterror();
3808 return -1;
3809 }
3810 }
3811
3812 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3821 public function update_note_public($note)
3822 {
3823 // phpcs:enable
3824 return $this->update_note($note, '_public');
3825 }
3826
3827 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
3838 public function update_price($exclspec = 0, $roundingadjust = 'auto', $nodatabaseupdate = 0, $seller = null)
3839 {
3840 // phpcs:enable
3841 global $conf, $hookmanager, $action;
3842
3843 $parameters = array('exclspec' => $exclspec, 'roundingadjust' => $roundingadjust, 'nodatabaseupdate' => $nodatabaseupdate, 'seller' => $seller);
3844 $reshook = $hookmanager->executeHooks('updateTotalPrice', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
3845 if ($reshook > 0) {
3846 return 1; // replacement code
3847 } elseif ($reshook < 0) {
3848 return -1; // failure
3849 } // reshook = 0 => execute normal code
3850
3851 // Some external module want no update price after a trigger because they have another method to calculate the total (ex: with an extrafield)
3852 $isElementForSupplier = false;
3853 $roundTotalConstName = 'MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND'; // const for customer by default
3854 $MODULE = "";
3855 if ($this->element == 'propal') {
3856 $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_PROPOSAL";
3857 } elseif ($this->element == 'commande' || $this->element == 'order') {
3858 $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_ORDER";
3859 } elseif ($this->element == 'facture' || $this->element == 'invoice') {
3860 $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_INVOICE";
3861 } elseif ($this->element == 'facture_fourn' || $this->element == 'supplier_invoice' || $this->element == 'invoice_supplier' || $this->element == 'invoice_supplier_rec') {
3862 $isElementForSupplier = true;
3863 $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_SUPPLIER_INVOICE";
3864 } elseif ($this->element == 'order_supplier' || $this->element == 'supplier_order') {
3865 $isElementForSupplier = true;
3866 $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_SUPPLIER_ORDER";
3867 } elseif ($this->element == 'supplier_proposal') {
3868 $isElementForSupplier = true;
3869 $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_SUPPLIER_PROPOSAL";
3870 }
3871 if ($isElementForSupplier) {
3872 $roundTotalConstName = 'MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND_SUPPLIER'; // const for supplier
3873 }
3874
3875 if (!empty($MODULE)) {
3876 if (getDolGlobalString($MODULE)) {
3877 $modsactivated = explode(',', getDolGlobalString($MODULE));
3878 foreach ($modsactivated as $mod) {
3879 if (isModEnabled($mod)) {
3880 return 1; // update was disabled by specific setup
3881 }
3882 }
3883 }
3884 }
3885
3886 include_once DOL_DOCUMENT_ROOT.'/core/lib/price.lib.php';
3887
3888 $forcedroundingmode = $roundingadjust;
3889 if ($forcedroundingmode == 'auto' && isset($conf->global->{$roundTotalConstName})) {
3890 $forcedroundingmode = getDolGlobalString($roundTotalConstName);
3891 } elseif ($forcedroundingmode == 'auto') {
3892 $forcedroundingmode = '0';
3893 }
3894
3895 $error = 0;
3896
3897 $multicurrency_tx = !empty($this->multicurrency_tx) ? $this->multicurrency_tx : 1;
3898
3899 // Define constants to find lines to sum (field name int the table_element_line not into table_element)
3900 $fieldtva = 'total_tva';
3901 $fieldlocaltax1 = 'total_localtax1';
3902 $fieldlocaltax2 = 'total_localtax2';
3903 $fieldup = 'subprice';
3904 $base_price_type = 'HT';
3905 if ($this->element == 'facture_fourn' || $this->element == 'invoice_supplier') {
3906 $fieldtva = 'tva';
3907 $fieldup = 'pu_ht';
3908 }
3909 if ($this->element == 'invoice_supplier_rec') {
3910 $fieldup = 'pu_ht';
3911 }
3912 if ($this->element == 'expensereport') {
3913 // Force rounding mode to '0', otherwise when you set MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND to 1, you may have lines with different totals.
3914 // For example, if you have 2 lines with same TTC amounts (6,2 Unit price TTC and VAT rate 20%), on the first line you got 5,17 on HT total
3915 // and 5,16 on HT total and 1,04 on VAT total to get 6,20 on TTT total on second line (see #30051).
3916 $forcedroundingmode = '0';
3917 $fieldup = 'value_unit';
3918 $base_price_type = 'TTC';
3919 }
3920
3921 $sql = "SELECT rowid, qty, ".$fieldup." as up, remise_percent, total_ht, ".$fieldtva." as total_tva, total_ttc, ".$fieldlocaltax1." as total_localtax1, ".$fieldlocaltax2." as total_localtax2,";
3922 $sql .= ' tva_tx as vatrate, localtax1_tx, localtax2_tx, localtax1_type, localtax2_type, info_bits, product_type';
3923 if ($this->table_element_line == 'facturedet') {
3924 $sql .= ', situation_percent';
3925 }
3926 $sql .= ', multicurrency_total_ht, multicurrency_total_tva, multicurrency_total_ttc';
3927 $sql .= " FROM ".$this->db->prefix().$this->table_element_line;
3928 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
3929 if ($exclspec) {
3930 $product_field = 'product_type';
3931 if ($this->table_element_line == 'contratdet') {
3932 $product_field = ''; // contratdet table has no product_type field
3933 }
3934 if ($product_field) {
3935 $sql .= " AND ".$product_field." <> 9";
3936 }
3937 }
3938 $sql .= ' ORDER by rowid'; // We want to be certain to always use same order of line to not change lines differently when option MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND is used
3939
3940 dol_syslog(get_class($this)."::update_price", LOG_DEBUG);
3941
3942 $resql = $this->db->query($sql);
3943 if ($resql) {
3944 $this->total_ht = 0;
3945 $this->total_tva = 0;
3946 $this->total_localtax1 = 0;
3947 $this->total_localtax2 = 0;
3948 $this->total_ttc = 0;
3949 $total_ht_by_vats = array();
3950 $total_tva_by_vats = array();
3951 $total_ttc_by_vats = array();
3952 $this->multicurrency_total_ht = 0;
3953 $this->multicurrency_total_tva = 0;
3954 $this->multicurrency_total_ttc = 0;
3955
3956 $this->db->begin();
3957
3958 $num = $this->db->num_rows($resql);
3959 $i = 0;
3960 while ($i < $num) {
3961 $obj = $this->db->fetch_object($resql);
3962
3963 // Note: There is no check on detail line and no check on total, if $forcedroundingmode = '0'
3964 $parameters = array('fk_element' => $obj->rowid);
3965 $reshook = $hookmanager->executeHooks('changeRoundingMode', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
3966
3967 if (empty($reshook) && $forcedroundingmode == '0') { // Check if data on line are consistent. This may solve lines that were not consistent because set with $forcedroundingmode='auto'
3968 // This part of code is to fix data. We should not call it too often.
3969 $localtax_array = array($obj->localtax1_type, $obj->localtax1_tx, $obj->localtax2_type, $obj->localtax2_tx);
3970 $tmpcal = calcul_price_total($obj->qty, $obj->up, $obj->remise_percent, $obj->vatrate, $obj->localtax1_tx, $obj->localtax2_tx, 0, $base_price_type, $obj->info_bits, $obj->product_type, $seller, $localtax_array, (isset($obj->situation_percent) ? $obj->situation_percent : 100), $multicurrency_tx);
3971
3972 $diff_when_using_price_ht = price2num((float) $tmpcal[1] - $obj->total_tva, 'MT', 1); // If price was set with tax price and unit price HT has a low number of digits, then we may have a diff on recalculation from unit price HT.
3973 $diff_on_current_total = price2num($obj->total_ttc - $obj->total_ht - $obj->total_tva - $obj->total_localtax1 - $obj->total_localtax2, 'MT', 1);
3974 //var_dump($obj->total_ht.' '.$obj->total_tva.' '.$obj->total_localtax1.' '.$obj->total_localtax2.' => '.$obj->total_ttc);
3975 //var_dump($diff_when_using_price_ht.' '.$diff_on_current_total);
3976
3977 if ($diff_on_current_total) {
3978 // This should not happen, we should always have in table: total_ttc = total_ht + total_vat + total_localtax1 + total_localtax2
3979 $sqlfix = "UPDATE ".$this->db->prefix().$this->table_element_line;
3980 $sqlfix .= " SET ".$fieldtva." = ".price2num((float) $tmpcal[1]).", total_ttc = ".price2num((float) $tmpcal[2]);
3981 $sqlfix .= ", multicurrency_total_tva = ".price2num((float) $tmpcal[17]).", multicurrency_total_ttc = ".price2num((float) $tmpcal[18]);
3982 $sqlfix .= " WHERE rowid = ".((int) $obj->rowid);
3983 dol_syslog('Warn1: We found inconsistent data into detailed line (diff_on_current_total = '.$diff_on_current_total.') for line rowid = '.$obj->rowid." (ht=".$obj->total_ht." vat=".$obj->total_tva." tax1=".$obj->total_localtax1." tax2=".$obj->total_localtax2." ttc=".$obj->total_ttc."). We fix the total_vat and total_ttc of line by running sqlfix = ".$sqlfix, LOG_WARNING);
3984 $resqlfix = $this->db->query($sqlfix);
3985 if (!$resqlfix) {
3986 dol_print_error($this->db, 'Failed to update line');
3987 }
3988 $obj->total_tva = $tmpcal[1];
3989 $obj->total_ttc = $tmpcal[2];
3990 $obj->multicurrency_total_tva = $tmpcal[17];
3991 $obj->multicurrency_total_ttc = $tmpcal[18];
3992 } elseif ($diff_when_using_price_ht) {
3993 // If total_ht calculated from unit price is different than the one in database, we do nothing, this may be a regular case to have also a different VAT, that can be explained
3994 // because price was entered included tax and we round the unit price without tax to store it in database (so recalculation will give different results).
3995 if ((float) $tmpcal[0] == (float) $obj->total_ht) {
3996 // After calculation from HT, total is consistent and total_ht is same, but we have found a difference between VAT part calculated from unit price and the VAT part into database,
3997 // and we ask to force the use of rounding on line (like done on calculation) so this should not happen, so we force the update of line to fix.
3998
3999 // This part of code must be called only to fix corrupted data due to the use of the feature to round total instead of rounding lines.
4000 $sqlfix = "UPDATE ".$this->db->prefix().$this->table_element_line;
4001 $sqlfix .= " SET ".$fieldtva." = ".price2num((float) $tmpcal[1]).", total_ttc = ".price2num((float) $tmpcal[2]);
4002 $sqlfix .= ", multicurrency_total_tva = ".price2num((float) $tmpcal[17]).", multicurrency_total_ttc = ".price2num((float) $tmpcal[18]);
4003 $sqlfix .= " WHERE rowid = ".((int) $obj->rowid);
4004 dol_syslog('Warn2: We found a line with different rounding data into detailed line (diff_when_using_price_ht = '.$diff_when_using_price_ht.' and diff_on_current_total = '.$diff_on_current_total.') for line rowid = '.$obj->rowid." (total vat of line calculated=".$tmpcal[1].", database=".$obj->total_tva."). We fix the total_vat and total_ttc of line by running sqlfix = ".$sqlfix);
4005 $resqlfix = $this->db->query($sqlfix);
4006 if (!$resqlfix) {
4007 dol_print_error($this->db, 'Failed to update line');
4008 }
4009 $obj->total_tva = $tmpcal[1];
4010 $obj->total_ttc = $tmpcal[2];
4011 $obj->multicurrency_total_tva = $tmpcal[17];
4012 $obj->multicurrency_total_ttc = $tmpcal[18];
4013 }
4014 }
4015 }
4016
4017 $this->total_ht += $obj->total_ht; // The field visible at end of line detail
4018 $this->total_tva += $obj->total_tva;
4019 $this->total_localtax1 += $obj->total_localtax1;
4020 $this->total_localtax2 += $obj->total_localtax2;
4021 $this->total_ttc += $obj->total_ttc;
4022 $this->multicurrency_total_ht += $obj->multicurrency_total_ht; // The field visible at end of line detail
4023 $this->multicurrency_total_tva += $obj->multicurrency_total_tva;
4024 $this->multicurrency_total_ttc += $obj->multicurrency_total_ttc;
4025
4026 if (!isset($total_ht_by_vats[$obj->vatrate])) {
4027 $total_ht_by_vats[$obj->vatrate] = 0;
4028 }
4029 if (!isset($total_tva_by_vats[$obj->vatrate])) {
4030 $total_tva_by_vats[$obj->vatrate] = 0;
4031 }
4032 if (!isset($total_ttc_by_vats[$obj->vatrate])) {
4033 $total_ttc_by_vats[$obj->vatrate] = 0;
4034 }
4035 $total_ht_by_vats[$obj->vatrate] += $obj->total_ht;
4036 $total_tva_by_vats[$obj->vatrate] += $obj->total_tva;
4037 $total_ttc_by_vats[$obj->vatrate] += $obj->total_ttc;
4038
4039 if ($forcedroundingmode == '1') { // Check if we need adjustment onto line for vat. TODO This works on the company currency but not on foreign currency
4040 if ($base_price_type == 'TTC') {
4041 $tmpvat = price2num($total_ttc_by_vats[$obj->vatrate] * $obj->vatrate / (100 + $obj->vatrate), 'MT', 1);
4042 } else {
4043 $tmpvat = price2num($total_ht_by_vats[$obj->vatrate] * $obj->vatrate / 100, 'MT', 1);
4044 }
4045 $diff = price2num($total_tva_by_vats[$obj->vatrate] - (float) $tmpvat, 'MT', 1);
4046 //print 'Line '.$i.' rowid='.$obj->rowid.' vat_rate='.$obj->vatrate.' total_ht='.$obj->total_ht.' total_tva='.$obj->total_tva.' total_ttc='.$obj->total_ttc.' total_ht_by_vats='.$total_ht_by_vats[$obj->vatrate].' total_tva_by_vats='.$total_tva_by_vats[$obj->vatrate].' (new calculation = '.$tmpvat.') total_ttc_by_vats='.$total_ttc_by_vats[$obj->vatrate].($diff?" => DIFF":"")."<br>\n";
4047 if ($diff) {
4048 $maxdiff = (10 * pow(10, -1 * getDolGlobalInt('MAIN_MAX_DECIMALS_TOT', 0)));
4049 if (abs((float) $diff) > $maxdiff) {
4050 // If error is more than 10 times the accuracy of rounding. This should not happen.
4051 $errmsg = 'We found a rounding difference after line '.($obj->rowid).' between HT*VAT='.$tmpvat.' and total in database='.$total_tva_by_vats[$obj->vatrate].' (calculated with UP*qty) but diff='.$diff.' is too high (> '.$maxdiff.') to be corrected. Some data in your lines may be corrupted. Try to edit each line manually to fix this before restarting.';
4052 dol_syslog($errmsg, LOG_WARNING);
4053 $this->error = $errmsg;
4054 $error++;
4055 break;
4056 }
4057
4058 if ($base_price_type == 'TTC') {
4059 $sqlfix = "UPDATE ".$this->db->prefix().$this->table_element_line." SET ".$fieldtva." = ".price2num($obj->total_tva - (float) $diff).", total_ht = ".price2num($obj->total_ht + (float) $diff)." WHERE rowid = ".((int) $obj->rowid);
4060 dol_syslog('We found a difference of '.$diff.' for line rowid = '.$obj->rowid.' between TotalHT('.$total_ht_by_vats[$obj->vatrate].')*VATrate('.$obj->vatrate.')='.$tmpvat.' and total in database='.$total_tva_by_vats[$obj->vatrate]." (calculated with UP*qty). We fix the total_vat and total_ht of line by running sqlfix = ".$sqlfix);
4061 } else {
4062 $sqlfix = "UPDATE ".$this->db->prefix().$this->table_element_line." SET ".$fieldtva." = ".price2num($obj->total_tva - (float) $diff).", total_ttc = ".price2num($obj->total_ttc - (float) $diff)." WHERE rowid = ".((int) $obj->rowid);
4063 dol_syslog('We found a difference of '.$diff.' for line rowid = '.$obj->rowid.' between TotalHT('.$total_ht_by_vats[$obj->vatrate].')*VATrate('.$obj->vatrate.')='.$tmpvat.' and total in database='.$total_tva_by_vats[$obj->vatrate]." (calculated with UP*qty). We fix the total_vat and total_ttc of line by running sqlfix = ".$sqlfix);
4064 }
4065
4066 $resqlfix = $this->db->query($sqlfix);
4067
4068 if (!$resqlfix) {
4069 dol_print_error($this->db, 'Failed to update line');
4070 }
4071
4072 $this->total_tva = (float) price2num($this->total_tva - (float) $diff, '', 1);
4073 $total_tva_by_vats[$obj->vatrate] = (float) price2num($total_tva_by_vats[$obj->vatrate] - (float) $diff, '', 1);
4074 if ($base_price_type == 'TTC') {
4075 $this->total_ht = (float) price2num($this->total_ht + (float) $diff, '', 1);
4076 $total_ht_by_vats[$obj->vatrate] = (float) price2num($total_ht_by_vats[$obj->vatrate] + (float) $diff, '', 1);
4077 } else {
4078 $this->total_ttc = (float) price2num($this->total_ttc - (float) $diff, '', 1);
4079 $total_ttc_by_vats[$obj->vatrate] = (float) price2num($total_ttc_by_vats[$obj->vatrate] - (float) $diff, '', 1);
4080 }
4081 }
4082 }
4083
4084 $i++;
4085 }
4086
4087 // Add revenue stamp to total
4088 // @phan-suppress-next-line PhanUndeclaredProperty
4089 $this->total_ttc += isset($this->revenuestamp) ? $this->revenuestamp : 0;
4090 // @phan-suppress-next-line PhanUndeclaredProperty
4091 $this->multicurrency_total_ttc += isset($this->revenuestamp) ? ($this->revenuestamp * $multicurrency_tx) : 0;
4092
4093 // Situations totals
4094 if (!empty($this->situation_cycle_ref) && !empty($this->situation_counter) && $this->situation_counter > 1 && method_exists($this, 'get_prev_sits')) { // @phan-suppress-current-line PhanUndeclaredProperty
4095 '@phan-var-force Facture $this';
4096 include_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php'; // Note: possibly useless as $this is normally already Facture, so the class file should be loaded
4097 if ($this->type != Facture::TYPE_CREDIT_NOTE) { // @phpstan-ignore-line
4098 if (getDolGlobalInt('INVOICE_USE_SITUATION') != 2) {
4099 $prev_sits = $this->get_prev_sits();
4100
4101 foreach ($prev_sits as $sit) { // $sit is an object Facture loaded with a fetch.
4102 $this->total_ht -= $sit->total_ht;
4103 $this->total_tva -= $sit->total_tva;
4104 $this->total_localtax1 -= $sit->total_localtax1;
4105 $this->total_localtax2 -= $sit->total_localtax2;
4106 $this->total_ttc -= $sit->total_ttc;
4107 $this->multicurrency_total_ht -= $sit->multicurrency_total_ht;
4108 $this->multicurrency_total_tva -= $sit->multicurrency_total_tva;
4109 $this->multicurrency_total_ttc -= $sit->multicurrency_total_ttc;
4110 }
4111 }
4112 }
4113 }
4114
4115 // Clean total
4116 $this->total_ht = (float) price2num($this->total_ht);
4117 $this->total_tva = (float) price2num($this->total_tva);
4118 $this->total_localtax1 = (float) price2num($this->total_localtax1);
4119 $this->total_localtax2 = (float) price2num($this->total_localtax2);
4120 $this->total_ttc = (float) price2num($this->total_ttc);
4121
4122 $this->db->free($resql);
4123
4124 // Now update global fields total_ht, total_ttc, total_tva, total_localtax1, total_localtax2, multicurrency_total_* of main object
4125 $fieldht = 'total_ht';
4126 $fieldtva = 'tva';
4127 $fieldlocaltax1 = 'localtax1';
4128 $fieldlocaltax2 = 'localtax2';
4129 $fieldttc = 'total_ttc';
4130 // Specific code for backward compatibility with old field names
4131 if (in_array($this->element, array('propal', 'commande', 'facture', 'facturerec', 'supplier_proposal', 'order_supplier', 'facture_fourn', 'invoice_supplier', 'invoice_supplier_rec', 'expensereport'))) {
4132 $fieldtva = 'total_tva';
4133 }
4134
4135 if (!$error && empty($nodatabaseupdate)) {
4136 $sql = "UPDATE ".$this->db->prefix().$this->table_element.' SET';
4137 $sql .= " ".$this->db->sanitize($fieldht)." = ".((float) price2num($this->total_ht, 'MT', 1)).",";
4138 $sql .= " ".$this->db->sanitize($fieldtva)." = ".((float) price2num($this->total_tva, 'MT', 1)).",";
4139 $sql .= " ".$this->db->sanitize($fieldlocaltax1)." = ".((float) price2num($this->total_localtax1, 'MT', 1)).",";
4140 $sql .= " ".$this->db->sanitize($fieldlocaltax2)." = ".((float) price2num($this->total_localtax2, 'MT', 1)).",";
4141 $sql .= " ".$this->db->sanitize($fieldttc)." = ".((float) price2num($this->total_ttc, 'MT', 1));
4142 $sql .= ", multicurrency_total_ht = ".((float) price2num($this->multicurrency_total_ht, 'MT', 1));
4143 $sql .= ", multicurrency_total_tva = ".((float) price2num($this->multicurrency_total_tva, 'MT', 1));
4144 $sql .= ", multicurrency_total_ttc = ".((float) price2num($this->multicurrency_total_ttc, 'MT', 1));
4145 $sql .= " WHERE rowid = ".((int) $this->id);
4146
4147 dol_syslog(get_class($this)."::update_price", LOG_DEBUG);
4148 $resql = $this->db->query($sql);
4149
4150 if (!$resql) {
4151 $error++;
4152 $this->error = $this->db->lasterror();
4153 $this->errors[] = $this->db->lasterror();
4154 }
4155 }
4156
4157 if (!$error) {
4158 $this->db->commit();
4159 return 1;
4160 } else {
4161 $this->db->rollback();
4162 return -1;
4163 }
4164 } else {
4165 dol_print_error($this->db, 'Bad request in update_price');
4166 return -1;
4167 }
4168 }
4169
4170 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
4181 public function add_object_linked($origin = null, $origin_id = null, $f_user = null, $notrigger = 0)
4182 {
4183 // phpcs:enable
4184 global $user, $hookmanager, $action;
4185 $origin = (!empty($origin) ? $origin : $this->origin);
4186 $origin_id = (!empty($origin_id) ? $origin_id : $this->origin_id);
4187 $f_user = isset($f_user) ? $f_user : $user;
4188
4189 // Special case
4190 if ($origin == 'order') {
4191 $origin = 'commande';
4192 }
4193 if ($origin == 'invoice') {
4194 $origin = 'facture';
4195 }
4196 if ($origin == 'invoice_template') {
4197 $origin = 'facturerec';
4198 }
4199 if ($origin == 'supplierorder') {
4200 $origin = 'order_supplier';
4201 }
4202
4203 // Add module part to target type
4204 $targettype = $this->getElementType();
4205
4206 $parameters = array('targettype' => $targettype);
4207 // Hook for explicitly set the targettype if it must be different than $this->element
4208 $reshook = $hookmanager->executeHooks('setLinkedObjectSourceTargetType', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
4209 if ($reshook > 0) {
4210 if (!empty($hookmanager->resArray['targettype'])) {
4211 $targettype = $hookmanager->resArray['targettype'];
4212 }
4213 }
4214
4215 $this->db->begin();
4216 $error = 0;
4217
4218 $sql = "INSERT INTO " . $this->db->prefix() . "element_element (";
4219 $sql .= "fk_source";
4220 $sql .= ", sourcetype";
4221 $sql .= ", fk_target";
4222 $sql .= ", targettype";
4223 $sql .= ") VALUES (";
4224 $sql .= ((int) $origin_id);
4225 $sql .= ", '" . $this->db->escape($origin) . "'";
4226 $sql .= ", " . ((int) $this->id);
4227 $sql .= ", '" . $this->db->escape($targettype) . "'";
4228 $sql .= ")";
4229
4230 dol_syslog(get_class($this) . "::add_object_linked", LOG_DEBUG);
4231 if ($this->db->query($sql)) {
4232 if (!$notrigger) {
4233 // Call trigger
4234 $this->context['link_origin'] = $origin;
4235 $this->context['link_origin_id'] = $origin_id;
4236 $result = $this->call_trigger('OBJECT_LINK_INSERT', $f_user);
4237 if ($result < 0) {
4238 $error++;
4239 }
4240 // End call triggers
4241 }
4242 } else {
4243 $this->error = $this->db->lasterror();
4244 $error++;
4245 }
4246
4247 if (!$error) {
4248 $this->db->commit();
4249 return 1;
4250 } else {
4251 $this->db->rollback();
4252 return 0;
4253 }
4254 }
4255
4261 public function getElementType()
4262 {
4263 // Elements of the core modules having a `$module` property but for which we may not want to prefix the element name with the module name for finding the linked object in llx_element_element.
4264 // It's because existing llx_element_element entries inserted prior to this modification (version <=14.2) may already use the element name alone in fk_source or fk_target (without the module name prefix).
4265 $coreModule = array('knowledgemanagement', 'partnership', 'workstation', 'ticket', 'recruitment', 'eventorganization', 'asset');
4266 // Add module part to target type if object has $module property and isn't in core modules.
4267 return ((!empty($this->module) && !in_array($this->module, $coreModule)) ? $this->module.'_' : '').$this->element;
4268 }
4269
4270
4293 public function fetchObjectLinked($sourceid = null, $sourcetype = '', $targetid = null, $targettype = '', $clause = 'OR', $alsosametype = 1, $orderby = 'sourcetype', $loadalsoobjects = 1)
4294 {
4295 global $hookmanager, $action;
4296
4297 // Important for pdf generation time reduction
4298 // This boolean is true if $this->linkedObjects has already been loaded with all objects linked without filter
4299 // If you need to force the reload, you can call clearObjectLinkedCache() before calling fetchObjectLinked()
4300 if ($this->id > 0 && !empty($this->linkedObjectsFullLoaded[$this->id])) {
4301 return 1;
4302 }
4303
4304 $this->linkedObjectsIds = array();
4305 $this->linkedObjects = array();
4306
4307 $justsource = false;
4308 $justtarget = false;
4309 $withtargettype = false;
4310 $withsourcetype = false;
4311
4312 $parameters = array('sourcetype' => $sourcetype, 'sourceid' => $sourceid, 'targettype' => $targettype, 'targetid' => $targetid);
4313 // Hook for explicitly set the targettype if it must be differtent than $this->element
4314 $reshook = $hookmanager->executeHooks('setLinkedObjectSourceTargetType', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
4315 if ($reshook > 0) {
4316 if (!empty($hookmanager->resArray['sourcetype'])) {
4317 $sourcetype = $hookmanager->resArray['sourcetype'];
4318 }
4319 if (!empty($hookmanager->resArray['sourceid'])) {
4320 $sourceid = $hookmanager->resArray['sourceid'];
4321 }
4322 if (!empty($hookmanager->resArray['targettype'])) {
4323 $targettype = $hookmanager->resArray['targettype'];
4324 }
4325 if (!empty($hookmanager->resArray['targetid'])) {
4326 $targetid = $hookmanager->resArray['targetid'];
4327 }
4328 }
4329
4330 if (!empty($sourceid) && !empty($sourcetype) && empty($targetid)) {
4331 $justsource = true; // the source (id and type) is a search criteria
4332 if (!empty($targettype)) {
4333 $withtargettype = true;
4334 }
4335 }
4336 if (!empty($targetid) && !empty($targettype) && empty($sourceid)) {
4337 $justtarget = true; // the target (id and type) is a search criteria
4338 if (!empty($sourcetype)) {
4339 $withsourcetype = true;
4340 }
4341 }
4342
4343 $sourceid = (!empty($sourceid) ? $sourceid : $this->id);
4344 $targetid = (!empty($targetid) ? $targetid : $this->id);
4345 $sourcetype = (!empty($sourcetype) ? $sourcetype : $this->getElementType());
4346 $targettype = (!empty($targettype) ? $targettype : $this->getElementType());
4347
4348 /*if (empty($sourceid) && empty($targetid))
4349 {
4350 dol_syslog('Bad usage of function. No source nor target id defined (nor as parameter nor as object id)', LOG_ERR);
4351 return -1;
4352 }*/
4353
4354 // Links between objects are stored in table element_element
4355 $sql = "SELECT rowid, fk_source, sourcetype, fk_target, targettype";
4356 $sql .= " FROM ".$this->db->prefix()."element_element";
4357 $sql .= " WHERE ";
4358 if ($justsource || $justtarget) {
4359 if ($justsource) {
4360 $sql .= "fk_source = ".((int) $sourceid)." AND sourcetype = '".$this->db->escape($sourcetype)."'";
4361 if ($withtargettype) {
4362 $sql .= " AND targettype = '".$this->db->escape($targettype)."'";
4363 }
4364 } elseif ($justtarget) {
4365 $sql .= "fk_target = ".((int) $targetid)." AND targettype = '".$this->db->escape($targettype)."'";
4366 if ($withsourcetype) {
4367 $sql .= " AND sourcetype = '".$this->db->escape($sourcetype)."'";
4368 }
4369 }
4370 } else {
4371 $sql .= "(fk_source = ".((int) $sourceid)." AND sourcetype = '".$this->db->escape($sourcetype)."')";
4372 $sql .= " ".$clause." (fk_target = ".((int) $targetid)." AND targettype = '".$this->db->escape($targettype)."')";
4373 if ($loadalsoobjects && $this->id > 0 && $sourceid == $this->id && $sourcetype == $this->element && $targetid == $this->id && $targettype == $this->element && $clause == 'OR') {
4374 $this->linkedObjectsFullLoaded[$this->id] = true;
4375 }
4376 }
4377 $sql .= " ORDER BY ".$orderby;
4378
4379 dol_syslog(get_class($this)."::fetchObjectLink", LOG_DEBUG);
4380 $resql = $this->db->query($sql);
4381 if ($resql) {
4382 $num = $this->db->num_rows($resql);
4383 $i = 0;
4384 while ($i < $num) {
4385 $obj = $this->db->fetch_object($resql);
4386 if ($justsource || $justtarget) {
4387 if ($justsource) {
4388 $this->linkedObjectsIds[$obj->targettype][$obj->rowid] = $obj->fk_target;
4389 } elseif ($justtarget) {
4390 $this->linkedObjectsIds[$obj->sourcetype][$obj->rowid] = $obj->fk_source;
4391 }
4392 } else {
4393 if ($obj->fk_source == $sourceid && $obj->sourcetype == $sourcetype) {
4394 $this->linkedObjectsIds[$obj->targettype][$obj->rowid] = $obj->fk_target;
4395 }
4396 if ($obj->fk_target == $targetid && $obj->targettype == $targettype) {
4397 $this->linkedObjectsIds[$obj->sourcetype][$obj->rowid] = $obj->fk_source;
4398 }
4399 }
4400 $i++;
4401 }
4402
4403 if (!empty($this->linkedObjectsIds)) {
4404 $tmparray = $this->linkedObjectsIds;
4405 foreach ($tmparray as $objecttype => $objectids) { // $objecttype is a module name ('facture', 'mymodule', ...) or a module name with a suffix ('project_task', 'mymodule_myobj', ...)
4406 $element_properties = getElementProperties($objecttype);
4407 $element = $element_properties['element'];
4408 $classPath = $element_properties['classpath'];
4409 $classFile = $element_properties['classfile'];
4410 $className = $element_properties['classname'];
4411 $module = $element_properties['module'];
4412
4413 // Here $module, $classFile and $className are set, we can use them.
4414 if (isModEnabled($module) && (($element != $this->element) || $alsosametype)) {
4415 if ($loadalsoobjects && (is_numeric($loadalsoobjects) || ($loadalsoobjects === $objecttype))) {
4416 dol_include_once('/'.$classPath.'/'.$classFile.'.class.php');
4417 if (class_exists($className)) {
4418 foreach ($objectids as $i => $objectid) { // $i is rowid into llx_element_element
4419 $object = new $className($this->db);
4420 '@phan-var-force CommonObject $object';
4421 $ret = $object->fetch($objectid);
4422 if ($ret >= 0) {
4423 $this->linkedObjects[$objecttype][$i] = $object;
4424 }
4425 }
4426 }
4427 }
4428 } else {
4429 unset($this->linkedObjectsIds[$objecttype]);
4430 }
4431 }
4432 }
4433 return 1;
4434 } else {
4435 dol_print_error($this->db);
4436 return -1;
4437 }
4438 }
4439
4446 public function clearObjectLinkedCache()
4447 {
4448 if ($this->id > 0 && !empty($this->linkedObjectsFullLoaded[$this->id])) {
4449 unset($this->linkedObjectsFullLoaded[$this->id]);
4450 }
4451
4452 return 1;
4453 }
4454
4467 public function updateObjectLinked($sourceid = null, $sourcetype = '', $targetid = null, $targettype = '', $f_user = null, $notrigger = 0)
4468 {
4469 global $user;
4470 $updatesource = false;
4471 $updatetarget = false;
4472 $f_user = isset($f_user) ? $f_user : $user;
4473
4474 if (!empty($sourceid) && !empty($sourcetype) && empty($targetid) && empty($targettype)) {
4475 $updatesource = true;
4476 } elseif (empty($sourceid) && empty($sourcetype) && !empty($targetid) && !empty($targettype)) {
4477 $updatetarget = true;
4478 }
4479
4480 $this->db->begin();
4481 $error = 0;
4482
4483 $sql = "UPDATE " . $this->db->prefix() . "element_element SET ";
4484 if ($updatesource) {
4485 $sql .= "fk_source = " . ((int) $sourceid);
4486 $sql .= ", sourcetype = '" . $this->db->escape($sourcetype) . "'";
4487 $sql .= " WHERE fk_target = " . ((int) $this->id);
4488 $sql .= " AND targettype = '" . $this->db->escape($this->element) . "'";
4489 } elseif ($updatetarget) {
4490 $sql .= "fk_target = " . ((int) $targetid);
4491 $sql .= ", targettype = '" . $this->db->escape($targettype) . "'";
4492 $sql .= " WHERE fk_source = " . ((int) $this->id);
4493 $sql .= " AND sourcetype = '" . $this->db->escape($this->element) . "'";
4494 }
4495
4496 dol_syslog(get_class($this) . "::updateObjectLinked", LOG_DEBUG);
4497 if ($this->db->query($sql)) {
4498 if (!$notrigger) {
4499 // Call trigger
4500 $this->context['link_source_id'] = $sourceid;
4501 $this->context['link_source_type'] = $sourcetype;
4502 $this->context['link_target_id'] = $targetid;
4503 $this->context['link_target_type'] = $targettype;
4504 $result = $this->call_trigger('OBJECT_LINK_MODIFY', $f_user);
4505 if ($result < 0) {
4506 $error++;
4507 }
4508 // End call triggers
4509 }
4510 } else {
4511 $this->error = $this->db->lasterror();
4512 $error++;
4513 }
4514
4515 if (!$error) {
4516 $this->db->commit();
4517 return 1;
4518 } else {
4519 $this->db->rollback();
4520 return -1;
4521 }
4522 }
4523
4537 public function deleteObjectLinked($sourceid = null, $sourcetype = '', $targetid = null, $targettype = '', $rowid = 0, $f_user = null, $notrigger = 0)
4538 {
4539 global $user;
4540 $deletesource = false;
4541 $deletetarget = false;
4542 $f_user = isset($f_user) ? $f_user : $user;
4543
4544 if (!empty($sourceid) && !empty($sourcetype) && empty($targetid) && empty($targettype)) {
4545 $deletesource = true;
4546 } elseif (empty($sourceid) && empty($sourcetype) && !empty($targetid) && !empty($targettype)) {
4547 $deletetarget = true;
4548 }
4549
4550 $sourceid = (!empty($sourceid) ? $sourceid : $this->id);
4551 $sourcetype = (!empty($sourcetype) ? $sourcetype : $this->element);
4552 $targetid = (!empty($targetid) ? $targetid : $this->id);
4553 $targettype = (!empty($targettype) ? $targettype : $this->element);
4554 $this->db->begin();
4555 $error = 0;
4556
4557 if (!$notrigger) {
4558 // Call trigger
4559 $this->context['link_id'] = $rowid;
4560 $this->context['link_source_id'] = $sourceid;
4561 $this->context['link_source_type'] = $sourcetype;
4562 $this->context['link_target_id'] = $targetid;
4563 $this->context['link_target_type'] = $targettype;
4564 $result = $this->call_trigger('OBJECT_LINK_DELETE', $f_user);
4565 if ($result < 0) {
4566 $error++;
4567 }
4568 // End call triggers
4569 }
4570
4571 if (!$error) {
4572 $sql = "DELETE FROM " . $this->db->prefix() . "element_element";
4573 $sql .= " WHERE";
4574 if ($rowid > 0) {
4575 $sql .= " rowid = " . ((int) $rowid);
4576 } else {
4577 if ($deletesource) {
4578 $sql .= " fk_source = " . ((int) $sourceid) . " AND sourcetype = '" . $this->db->escape($sourcetype) . "'";
4579 $sql .= " AND fk_target = " . ((int) $this->id) . " AND targettype = '" . $this->db->escape($this->element) . "'";
4580 } elseif ($deletetarget) {
4581 $sql .= " fk_target = " . ((int) $targetid) . " AND targettype = '" . $this->db->escape($targettype) . "'";
4582 $sql .= " AND fk_source = " . ((int) $this->id) . " AND sourcetype = '" . $this->db->escape($this->element) . "'";
4583 } else {
4584 $sql .= " (fk_source = " . ((int) $this->id) . " AND sourcetype = '" . $this->db->escape($this->element) . "')";
4585 $sql .= " OR";
4586 $sql .= " (fk_target = " . ((int) $this->id) . " AND targettype = '" . $this->db->escape($this->element) . "')";
4587 }
4588 }
4589
4590 dol_syslog(get_class($this) . "::deleteObjectLinked", LOG_DEBUG);
4591 if (!$this->db->query($sql)) {
4592 $this->error = $this->db->lasterror();
4593 $this->errors[] = $this->error;
4594 $error++;
4595 }
4596 }
4597
4598 if (!$error) {
4599 $this->db->commit();
4600 return 1;
4601 } else {
4602 $this->db->rollback();
4603 return 0;
4604 }
4605 }
4606
4616 public static function getAllItemsLinkedByObjectID($fk_object_where, $field_select, $field_where, $table_element)
4617 {
4618 if (empty($fk_object_where) || empty($field_where) || empty($table_element)) {
4619 return -1;
4620 }
4621 if (!preg_match('/^[_a-zA-Z0-9]+$/', $field_select)) {
4622 dol_syslog('Invalid value $field_select for parameter '.$field_select.' in call to getAllItemsLinkedByObjectID(). Must be a single field name.', LOG_ERR);
4623 }
4624
4625 global $db;
4626
4627 $sql = "SELECT ".$field_select." FROM ".$db->prefix().$table_element." WHERE ".$field_where." = ".((int) $fk_object_where);
4628 $resql = $db->query($sql);
4629
4630 $TRes = array();
4631 if (!empty($resql)) {
4632 while ($res = $db->fetch_object($resql)) {
4633 $TRes[] = $res->{$field_select};
4634 }
4635 }
4636
4637 return $TRes;
4638 }
4639
4648 public static function getCountOfItemsLinkedByObjectID($fk_object_where, $field_where, $table_element)
4649 {
4650 if (empty($fk_object_where) || empty($field_where) || empty($table_element)) {
4651 return -1;
4652 }
4653
4654 global $db;
4655
4656 $sql = "SELECT COUNT(*) as nb FROM ".$db->prefix().$table_element." WHERE ".$field_where." = ".((int) $fk_object_where);
4657 $resql = $db->query($sql);
4658 $n = 0;
4659 if ($resql) {
4660 $res = $db->fetch_object($resql);
4661 if ($res) {
4662 $n = $res->nb;
4663 }
4664 }
4665
4666 return $n;
4667 }
4668
4677 public static function deleteAllItemsLinkedByObjectID($fk_object_where, $field_where, $table_element)
4678 {
4679 if (empty($fk_object_where) || empty($field_where) || empty($table_element)) {
4680 return -1;
4681 }
4682
4683 global $db;
4684
4685 $sql = "DELETE FROM ".$db->prefix().$table_element." WHERE ".$field_where." = ".((int) $fk_object_where);
4686 $resql = $db->query($sql);
4687
4688 if (empty($resql)) {
4689 return 0;
4690 }
4691
4692 return 1;
4693 }
4694
4705 public function setStatut($status, $elementId = null, $elementType = '', $trigkey = '', $fieldstatus = 'fk_statut')
4706 {
4707 global $user;
4708
4709 $savElementId = $elementId; // To be used later to know if we were using the method using the id of this or not.
4710
4711 $elementId = (!empty($elementId) ? $elementId : $this->id);
4712 $elementTable = (!empty($elementType) ? $elementType : $this->table_element);
4713
4714 $this->db->begin();
4715
4716 if ($elementTable == 'facture_rec') {
4717 $fieldstatus = "suspended";
4718 }
4719 if ($elementTable == 'mailing') {
4720 $fieldstatus = "statut";
4721 }
4722 if ($elementTable == 'cronjob') {
4723 $fieldstatus = "status";
4724 }
4725 if ($elementTable == 'user') {
4726 $fieldstatus = "statut";
4727 }
4728 if ($elementTable == 'expensereport') {
4729 $fieldstatus = "fk_statut";
4730 }
4731 if ($elementTable == 'receptiondet_batch') {
4732 $fieldstatus = "status";
4733 }
4734 if ($elementTable == 'prelevement_bons') {
4735 $fieldstatus = "statut";
4736 }
4737 if (isset($this->fields) && is_array($this->fields) && array_key_exists('status', $this->fields)) {
4738 $fieldstatus = 'status';
4739 }
4740
4741 $sql = "UPDATE ".$this->db->prefix().$this->db->sanitize($elementTable);
4742 $sql .= " SET ".$this->db->sanitize($fieldstatus)." = ".((int) $status);
4743 // If status = 1 = validated, update also fk_user_valid
4744 // TODO Replace the test on $elementTable by doing a test on existence of the field in $this->fields
4745 if ($status == 1 && in_array($elementTable, array('expensereport', 'inventory'))) {
4746 $sql .= ", fk_user_valid = ".((int) $user->id);
4747 }
4748 if ($status == 1 && in_array($elementTable, array('expensereport'))) {
4749 $sql .= ", date_valid = '".$this->db->idate(dol_now())."'";
4750 }
4751 if ($status == 1 && in_array($elementTable, array('inventory'))) {
4752 $sql .= ", date_validation = '".$this->db->idate(dol_now())."'";
4753 }
4754 $sql .= " WHERE rowid = ".((int) $elementId);
4755 $sql .= " AND ".$fieldstatus." <> ".((int) $status); // We avoid update if status already correct
4756
4757 dol_syslog(get_class($this)."::setStatut", LOG_DEBUG);
4758 $resql = $this->db->query($sql);
4759 if ($resql) {
4760 $error = 0;
4761
4762 $nb_rows_affected = $this->db->affected_rows($resql); // should be 1 or 0 if status was already correct
4763
4764 if ($nb_rows_affected > 0) {
4765 if (empty($trigkey)) {
4766 // Try to guess trigkey (for backward compatibility, now we should have trigkey defined into the call of setStatus)
4767 if ($this->element == 'supplier_proposal' && $status == 2) {
4768 $trigkey = 'SUPPLIER_PROPOSAL_SIGN'; // 2 = SupplierProposal::STATUS_SIGNED. Can't use constant into this generic class
4769 }
4770 if ($this->element == 'supplier_proposal' && $status == 3) {
4771 $trigkey = 'SUPPLIER_PROPOSAL_REFUSE'; // 3 = SupplierProposal::STATUS_REFUSED. Can't use constant into this generic class
4772 }
4773 if ($this->element == 'supplier_proposal' && $status == 4) {
4774 $trigkey = 'SUPPLIER_PROPOSAL_CLOSE'; // 4 = SupplierProposal::STATUS_CLOSED. Can't use constant into this generic class
4775 }
4776 if ($this->element == 'fichinter' && $status == 3) {
4777 $trigkey = 'FICHINTER_CLASSIFY_DONE';
4778 }
4779 if ($this->element == 'fichinter' && $status == 2) {
4780 $trigkey = 'FICHINTER_CLASSIFY_BILLED';
4781 }
4782 if ($this->element == 'fichinter' && $status == 1) {
4783 $trigkey = 'FICHINTER_CLASSIFY_UNBILLED';
4784 }
4785 }
4786
4787 $this->context = array_merge($this->context, array('newstatus' => $status));
4788
4789 if ($trigkey) {
4790 // Call trigger
4791 $result = $this->call_trigger($trigkey, $user);
4792 if ($result < 0) {
4793 $error++;
4794 }
4795 // End call triggers
4796 }
4797 } else {
4798 // The status was probably already good. We do nothing more, no triggers.
4799 }
4800
4801 if (!$error) {
4802 $this->db->commit();
4803
4804 if (empty($savElementId)) {
4805 // If the element we update is $this (so $elementId was provided as null)
4806 if ($fieldstatus == 'tosell') {
4807 $this->status = $status;
4808 } elseif ($fieldstatus == 'tobuy') {
4809 $this->status_buy = $status; // @phpstan-ignore-line
4810 } else {
4811 $this->status = $status;
4812 }
4813 }
4814
4815 return 1;
4816 } else {
4817 $this->db->rollback();
4818 dol_syslog(get_class($this)."::setStatut ".$this->error, LOG_ERR);
4819 return -1;
4820 }
4821 } else {
4822 $this->error = $this->db->lasterror();
4823 $this->db->rollback();
4824 return -1;
4825 }
4826 }
4827
4828
4836 public function getCanvas($id = 0, $ref = '')
4837 {
4838 global $conf;
4839
4840 if (empty($id) && empty($ref)) {
4841 return 0;
4842 }
4843 if (getDolGlobalString('MAIN_DISABLE_CANVAS')) {
4844 return 0; // To increase speed. Not enabled by default.
4845 }
4846
4847 // Clean parameters
4848 $ref = trim($ref);
4849
4850 $sql = "SELECT rowid, canvas";
4851 $sql .= " FROM ".$this->db->prefix().$this->table_element;
4852 $sql .= " WHERE entity IN (".getEntity($this->element).")";
4853 if (!empty($id)) {
4854 $sql .= " AND rowid = ".((int) $id);
4855 }
4856 if (!empty($ref)) {
4857 $sql .= " AND ref = '".$this->db->escape($ref)."'";
4858 }
4859
4860 $resql = $this->db->query($sql);
4861 if ($resql) {
4862 $obj = $this->db->fetch_object($resql);
4863 if ($obj) {
4864 $this->canvas = $obj->canvas;
4865 return 1;
4866 } else {
4867 return 0;
4868 }
4869 } else {
4870 dol_print_error($this->db);
4871 return -1;
4872 }
4873 }
4874
4875
4882 public function getSpecialCode($lineid)
4883 {
4884 $sql = "SELECT special_code FROM ".$this->db->prefix().$this->table_element_line;
4885 $sql .= " WHERE rowid = ".((int) $lineid);
4886 $resql = $this->db->query($sql);
4887 if ($resql) {
4888 $row = $this->db->fetch_row($resql);
4889 return (!empty($row[0]) ? $row[0] : 0);
4890 }
4891
4892 return 0;
4893 }
4894
4903 public function isObjectUsed($id = 0, $entity = 0)
4904 {
4905 global $langs;
4906
4907 if (empty($id)) {
4908 $id = $this->id;
4909 }
4910
4911 // Check parameters
4912 if (!isset($this->childtables) || !is_array($this->childtables) || count($this->childtables) == 0) {
4913 dol_print_error(null, 'Called isObjectUsed on a class with property this->childtables not defined');
4914 return -1;
4915 }
4916
4917 $arraytoscan = $this->childtables; // array('tablename'=>array('fk_element'=>'parentfield'), ...) or array('tablename'=>array('parent'=>table_parent, 'parentkey'=>'nameoffieldforparentfkkey'), ...)
4918 // For backward compatibility, we check if array is old format array('tablename1', 'tablename2', ...)
4919 $tmparray = array_keys($this->childtables);
4920 if (is_numeric($tmparray[0])) {
4921 $arraytoscan = array_flip($this->childtables);
4922 }
4923
4924 // Test if child exists
4925 $haschild = 0;
4926 foreach ($arraytoscan as $table => $element) {
4927 //print $id.'-'.$table.'-'.$elementname.'<br>';
4928
4929 // Check if module is enabled (to avoid error if tables of module not created)
4930 if (isset($element['enabled']) && !empty($element['enabled'])) {
4931 $enabled = (int) dol_eval($element['enabled'], 1);
4932 if (empty($enabled)) {
4933 continue;
4934 }
4935 }
4936
4937 // Check if element can be deleted
4938 $sql = "SELECT COUNT(*) as nb";
4939 $sql .= " FROM ".$this->db->prefix().$table." as c";
4940 if (!empty($element['parent']) && !empty($element['parentkey'])) {
4941 $sql .= ", ".$this->db->prefix().$element['parent']." as p";
4942 }
4943 if (!empty($element['fk_element'])) {
4944 $sql .= " WHERE c.".$element['fk_element']." = ".((int) $id);
4945 } else {
4946 $sql .= " WHERE c.".$this->fk_element." = ".((int) $id);
4947 }
4948 if (!empty($element['parent']) && !empty($element['parentkey'])) {
4949 $sql .= " AND c.".$element['parentkey']." = p.rowid";
4950 }
4951 if (!empty($element['parent']) && !empty($element['parenttypefield']) && !empty($element['parenttypevalue'])) {
4952 $sql .= " AND c.".$element['parenttypefield']." = '".$this->db->escape($element['parenttypevalue'])."'";
4953 }
4954 if (!empty($entity)) {
4955 if (!empty($element['parent']) && !empty($element['parentkey'])) {
4956 $sql .= " AND p.entity = ".((int) $entity);
4957 } else {
4958 $sql .= " AND c.entity = ".((int) $entity);
4959 }
4960 }
4961
4962 $resql = $this->db->query($sql);
4963 if ($resql) {
4964 $obj = $this->db->fetch_object($resql);
4965 if ($obj->nb > 0) {
4966 $langs->load("errors");
4967 //print 'Found into table '.$table.', type '.$langs->transnoentitiesnoconv($elementname).', haschild='.$haschild;
4968 $haschild += $obj->nb;
4969 if (is_numeric($element)) { // very old usage array('table1', 'table2', ...)
4970 $this->errors[] = $langs->transnoentitiesnoconv("ErrorRecordHasAtLeastOneChildOfType", method_exists($this, 'getNomUrl') ? $this->getNomUrl() : $this->ref, $table);
4971 } elseif (is_string($element)) { // old usage array('table1' => 'TranslateKey1', 'table2' => 'TranslateKey2', ...)
4972 $this->errors[] = $langs->transnoentitiesnoconv("ErrorRecordHasAtLeastOneChildOfType", method_exists($this, 'getNomUrl') ? $this->getNomUrl() : $this->ref, $langs->transnoentitiesnoconv($element));
4973 } else { // new usage: $element['name']=Translation key
4974 $this->errors[] = $langs->transnoentitiesnoconv("ErrorRecordHasAtLeastOneChildOfType", method_exists($this, 'getNomUrl') ? $this->getNomUrl() : $this->ref, $langs->transnoentitiesnoconv($element['name']));
4975 }
4976 break; // We found at least one, we stop here
4977 }
4978 } else {
4979 $this->errors[] = $this->db->lasterror();
4980 return -1;
4981 }
4982 }
4983 if ($haschild > 0) {
4984 $this->errors[] = "ErrorRecordHasChildren";
4985 return $haschild;
4986 } else {
4987 return 0;
4988 }
4989 }
4990
4997 public function hasProductsOrServices($predefined = -1)
4998 {
4999 $nb = 0;
5000
5001 foreach ($this->lines as $key => $val) {
5002 $qualified = 0;
5003 if ($predefined == -1) {
5004 $qualified = 1;
5005 }
5006 if ($predefined == 1 && $val->fk_product > 0) {
5007 $qualified = 1;
5008 }
5009 if ($predefined == 0 && $val->fk_product <= 0) {
5010 $qualified = 1;
5011 }
5012 if ($predefined == 2 && $val->fk_product > 0 && $val->product_type == 0) {
5013 $qualified = 1;
5014 }
5015 if ($predefined == 3 && $val->fk_product > 0 && $val->product_type == 1) {
5016 $qualified = 1;
5017 }
5018 if ($qualified) {
5019 $nb++;
5020 }
5021 }
5022 dol_syslog(get_class($this).'::hasProductsOrServices we found '.$nb.' qualified lines of products/servcies');
5023 return $nb;
5024 }
5025
5031 public function getTotalDiscount()
5032 {
5033 if (!empty($this->table_element_line)) {
5034 $total_discount = 0.00;
5035
5036 $sql = "SELECT subprice as pu_ht, qty, remise_percent, total_ht";
5037 $sql .= " FROM ".$this->db->prefix().$this->table_element_line;
5038 $sql .= " WHERE ".$this->fk_element." = ".((int) $this->id);
5039
5040 dol_syslog(get_class($this).'::getTotalDiscount', LOG_DEBUG);
5041 $resql = $this->db->query($sql);
5042 if ($resql) {
5043 $num = $this->db->num_rows($resql);
5044 $i = 0;
5045 while ($i < $num) {
5046 $obj = $this->db->fetch_object($resql);
5047
5048 $pu_ht = $obj->pu_ht;
5049 $qty = $obj->qty;
5050 $total_ht = $obj->total_ht;
5051
5052 $total_discount_line = (float) price2num(($pu_ht * $qty) - $total_ht, 'MT');
5053 $total_discount += $total_discount_line;
5054
5055 $i++;
5056 }
5057 }
5058
5059 //print $total_discount; exit;
5060 return (float) price2num($total_discount);
5061 }
5062
5063 return null;
5064 }
5065
5066
5073 public function getTotalWeightVolume()
5074 {
5075 $totalWeight = 0;
5076 $totalVolume = 0;
5077 // defined for shipment only
5078 $totalOrdered = 0;
5079 // defined for shipment only
5080 $totalToShip = 0;
5081
5082 if (empty($this->lines)) {
5083 return array('weight' => $totalWeight, 'volume' => $totalVolume, 'ordered' => $totalOrdered, 'toship' => $totalToShip);
5084 }
5085
5086 foreach ($this->lines as $line) {
5087 if (isset($line->qty_asked)) {
5088 $totalOrdered += $line->qty_asked; // defined for shipment only
5089 }
5090 if (isset($line->qty_shipped)) {
5091 $totalToShip += $line->qty_shipped; // defined for shipment only
5092 } elseif ($line->element == 'commandefournisseurdispatch' && isset($line->qty)) {
5093 if (empty($totalToShip)) {
5094 $totalToShip = 0;
5095 }
5096 $totalToShip += $line->qty; // defined for reception only
5097 }
5098
5099 // Define qty, weight, volume, weight_units, volume_units
5100 if ($this->element == 'shipping') {
5101 // for shipments
5102 $qty = $line->qty_shipped ? $line->qty_shipped : 0;
5103 } else {
5104 $qty = $line->qty ? $line->qty : 0;
5105 }
5106
5107 $weight = !empty($line->weight) ? $line->weight : 0;
5108 ($weight == 0 && !empty($line->product->weight)) ? $weight = $line->product->weight : 0;
5109 $volume = !empty($line->volume) ? $line->volume : 0;
5110 ($volume == 0 && !empty($line->product->volume)) ? $volume = $line->product->volume : 0;
5111
5112 $weight_units = !empty($line->weight_units) ? $line->weight_units : 0;
5113 ($weight_units == 0 && !empty($line->product->weight_units)) ? $weight_units = $line->product->weight_units : 0;
5114 $volume_units = !empty($line->volume_units) ? $line->volume_units : 0;
5115 ($volume_units == 0 && !empty($line->product->volume_units)) ? $volume_units = $line->product->volume_units : 0;
5116
5117 $weightUnit = 0;
5118 $volumeUnit = 0;
5119 if (!empty($weight_units)) {
5120 $weightUnit = $weight_units;
5121 }
5122 if (!empty($volume_units)) {
5123 $volumeUnit = $volume_units;
5124 }
5125
5126 if (empty($totalWeight)) {
5127 $totalWeight = 0; // Avoid warning because $totalWeight is ''
5128 }
5129 if (empty($totalVolume)) {
5130 $totalVolume = 0; // Avoid warning because $totalVolume is ''
5131 }
5132
5133 //var_dump($line->volume_units);
5134 if ($weight_units < 50) { // < 50 means a standard unit (power of 10 of official unit), > 50 means an exotic unit (like inch)
5135 $trueWeightUnit = pow(10, $weightUnit);
5136 $totalWeight += $weight * $qty * $trueWeightUnit;
5137 } else {
5138 if ($weight_units == 99) {
5139 // conversion 1 Pound = 0.45359237 KG
5140 $trueWeightUnit = 0.45359237;
5141 $totalWeight += $weight * $qty * $trueWeightUnit;
5142 } elseif ($weight_units == 98) {
5143 // conversion 1 Ounce = 0.0283495 KG
5144 $trueWeightUnit = 0.0283495;
5145 $totalWeight += $weight * $qty * $trueWeightUnit;
5146 } else {
5147 $totalWeight += $weight * $qty; // This may be wrong if we mix different units
5148 }
5149 }
5150 if ($volume_units < 50) { // >50 means a standard unit (power of 10 of official unit), > 50 means an exotic unit (like inch)
5151 //print $line->volume."x".$line->volume_units."x".($line->volume_units < 50)."x".$volumeUnit;
5152 $trueVolumeUnit = pow(10, $volumeUnit);
5153 //print $line->volume;
5154 $totalVolume += $volume * $qty * $trueVolumeUnit;
5155 } else {
5156 $totalVolume += $volume * $qty; // This may be wrong if we mix different units
5157 }
5158 }
5159
5160 return array('weight' => $totalWeight, 'volume' => $totalVolume, 'ordered' => $totalOrdered, 'toship' => $totalToShip);
5161 }
5162
5163
5169 public function setExtraParameters()
5170 {
5171 $this->db->begin();
5172
5173 $extraparams = (!empty($this->extraparams) ? json_encode($this->extraparams) : null);
5174
5175 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
5176 $sql .= " SET extraparams = ".(!empty($extraparams) ? "'".$this->db->escape($extraparams)."'" : "null");
5177 $sql .= " WHERE rowid = ".((int) $this->id);
5178
5179 dol_syslog(get_class($this)."::setExtraParameters", LOG_DEBUG);
5180 $resql = $this->db->query($sql);
5181 if (!$resql) {
5182 $this->error = $this->db->lasterror();
5183 $this->db->rollback();
5184 return -1;
5185 } else {
5186 $this->db->commit();
5187 return 1;
5188 }
5189 }
5190
5191
5192 // --------------------
5193 // TODO: All functions here must be redesigned and moved as they are not business functions but output functions
5194 // --------------------
5195
5196 /* This is to show add lines */
5197
5207 public function formAddObjectLine($dateSelector, $seller, $buyer, $defaulttpldir = '/core/tpl')
5208 {
5209 global $conf, $user, $langs, $object, $hookmanager, $extrafields, $form;
5210
5211 // Line extrafield
5212 if (!is_object($extrafields)) {
5213 require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
5214 $extrafields = new ExtraFields($this->db);
5215 }
5216 $extrafields->fetch_name_optionals_label($this->table_element_line);
5217
5218 // Output template part (modules that overwrite templates must declare this into descriptor)
5219 // Use global variables + $dateSelector + $seller and $buyer
5220 // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook 'formAddObjectLine'.
5221 $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
5222 foreach ($dirtpls as $module => $reldir) {
5223 if (!empty($module)) {
5224 $tpl = dol_buildpath($reldir.'/objectline_create.tpl.php');
5225 } else {
5226 $tpl = DOL_DOCUMENT_ROOT.$reldir.'/objectline_create.tpl.php';
5227 }
5228
5229 if (empty($conf->file->strict_mode)) {
5230 $res = @include $tpl;
5231 } else {
5232 $res = include $tpl; // for debug
5233 }
5234 if ($res) {
5235 break;
5236 }
5237 }
5238 }
5239
5240
5241
5242 /* This is to show array of line of details */
5243
5244
5259 public function printObjectLines($action, $seller, $buyer, $selected = 0, $dateSelector = 0, $defaulttpldir = '/core/tpl')
5260 {
5261 global $conf, $hookmanager, $langs, $user, $form, $extrafields, $object;
5262 // TODO We should not use global var for this
5263 global $inputalsopricewithtax, $usemargins, $disableedit, $disablemove, $disableremove, $outputalsopricetotalwithtax;
5264
5265 // Define $usemargins (used by objectline_xxx.tpl.php files)
5266 $usemargins = 0;
5267 if (isModEnabled('margin') && !empty($this->element) && in_array($this->element, array('facture', 'facturerec', 'propal', 'commande'))) {
5268 $usemargins = 1;
5269 }
5270
5271 $num = count($this->lines);
5272
5273 // Line extrafield
5274 if (!is_object($extrafields)) {
5275 require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
5276 $extrafields = new ExtraFields($this->db);
5277 }
5278 $extrafields->fetch_name_optionals_label($this->table_element_line);
5279
5280 if (method_exists($this, 'loadExpeditions')) {
5281 $this->loadExpeditions();
5282 }
5283
5284 $parameters = array('num' => $num, 'dateSelector' => $dateSelector, 'seller' => $seller, 'buyer' => $buyer, 'selected' => $selected, 'table_element_line' => $this->table_element_line);
5285 $reshook = $hookmanager->executeHooks('printObjectLineTitle', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
5286 if (empty($reshook)) {
5287 // Output template part (modules that overwrite templates must declare this into descriptor)
5288 // Use global variables + $dateSelector + $seller and $buyer
5289 // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook.
5290 $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
5291 foreach ($dirtpls as $module => $reldir) {
5292 $res = 0;
5293 if (!empty($module)) {
5294 $tpl = dol_buildpath($reldir.'/objectline_title.tpl.php');
5295 } else {
5296 $tpl = DOL_DOCUMENT_ROOT.$reldir.'/objectline_title.tpl.php';
5297 }
5298 if (file_exists($tpl)) {
5299 if (empty($conf->file->strict_mode)) {
5300 $res = @include $tpl;
5301 } else {
5302 $res = include $tpl; // for debug
5303 }
5304 }
5305 if ($res) {
5306 break;
5307 }
5308 }
5309 }
5310
5311 $i = 0;
5312
5313 print "<!-- begin printObjectLines() -->\n";
5314 foreach ($this->lines as $line) {
5315 //Line extrafield
5316 $line->fetch_optionals();
5317
5318 //if (is_object($hookmanager) && (($line->product_type == 9 && !empty($line->special_code)) || !empty($line->fk_parent_line)))
5319 if (is_object($hookmanager)) { // Old code is commented on preceding line.
5320 if (empty($line->fk_parent_line)) {
5321 $parameters = array('line' => $line, 'num' => $num, 'i' => $i, 'dateSelector' => $dateSelector, 'seller' => $seller, 'buyer' => $buyer, 'selected' => $selected, 'table_element_line' => $line->table_element, 'defaulttpldir' => $defaulttpldir);
5322 $reshook = $hookmanager->executeHooks('printObjectLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
5323 } else {
5324 $parameters = array('line' => $line, 'num' => $num, 'i' => $i, 'dateSelector' => $dateSelector, 'seller' => $seller, 'buyer' => $buyer, 'selected' => $selected, 'table_element_line' => $line->table_element, 'fk_parent_line' => $line->fk_parent_line, 'defaulttpldir' => $defaulttpldir);
5325 $reshook = $hookmanager->executeHooks('printObjectSubLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
5326 }
5327 }
5328 if (empty($reshook)) {
5329 $this->printObjectLine($action, $line, '', $num, $i, $dateSelector, $seller, $buyer, $selected, $extrafields, $defaulttpldir);
5330 }
5331
5332 $i++;
5333 }
5334 print "<!-- end printObjectLines() -->\n";
5335 }
5336
5354 public function printObjectLine($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected = 0, $extrafields = null, $defaulttpldir = '/core/tpl')
5355 {
5356 global $conf, $langs, $user, $object, $hookmanager;
5357 global $form;
5358 global $disableedit, $disablemove, $disableremove; // TODO We should not use global var for this !
5359
5360 // var used into tpl
5361 $text = '';
5362 $description = '';
5363
5364 // Line in view mode
5365 if ($action != 'editline' || $selected != $line->id) {
5366 // Product
5367 if (!empty($line->fk_product) && $line->fk_product > 0) {
5368 $product_static = new Product($this->db);
5369 $product_static->fetch($line->fk_product);
5370
5371 $product_static->ref = $line->ref; //can change ref in hook
5372 $product_static->label = !empty($line->label) ? $line->label : ""; //can change label in hook
5373
5374 $text = $product_static->getNomUrl(1);
5375
5376 // Define output language and label
5377 if (getDolGlobalInt('MAIN_MULTILANGS')) {
5378 if (property_exists($this, 'socid') && !is_object($this->thirdparty)) {
5379 dol_print_error(null, 'Error: Method printObjectLine was called on an object and object->fetch_thirdparty was not done before');
5380 return;
5381 }
5382
5383 $prod = new Product($this->db);
5384 $prod->fetch($line->fk_product);
5385
5386 $outputlangs = $langs;
5387 $newlang = '';
5388 if (empty($newlang) && GETPOST('lang_id', 'aZ09')) {
5389 $newlang = GETPOST('lang_id', 'aZ09');
5390 }
5391 if (getDolGlobalString('PRODUIT_TEXTS_IN_THIRDPARTY_LANGUAGE') && empty($newlang) && is_object($this->thirdparty)) {
5392 $newlang = $this->thirdparty->default_lang; // To use language of customer
5393 }
5394 if (!empty($newlang)) {
5395 $outputlangs = new Translate("", $conf);
5396 $outputlangs->setDefaultLang($newlang);
5397 }
5398
5399 $label = (!empty($prod->multilangs[$outputlangs->defaultlang]["label"])) ? $prod->multilangs[$outputlangs->defaultlang]["label"] : $line->product_label;
5400 } else {
5401 $label = $line->product_label;
5402 }
5403
5404 $text .= ' - '.(!empty($line->label) ? $line->label : $label);
5405 $description .= (getDolGlobalInt('PRODUIT_DESC_IN_FORM_ACCORDING_TO_DEVICE') ? '' : (!empty($line->description) ? dol_htmlentitiesbr($line->description) : '')); // Description is what to show on popup. We shown nothing if already into desc.
5406 }
5407
5408 $line->pu_ttc = price2num((!empty($line->subprice) ? $line->subprice : 0) * (1 + ((!empty($line->tva_tx) ? $line->tva_tx : 0) / 100)), 'MU');
5409
5410 // Output template part (modules that overwrite templates must declare this into descriptor)
5411 // Use global variables + $dateSelector + $seller and $buyer
5412 // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook printObjectLine and printObjectSubLine.
5413
5414 $qty_shipped = 0;
5415 if (isset($this->expeditions[$line->id])) {
5416 $qty_shipped = $this->expeditions[$line->id];
5417 }
5418 $disableedit = ($qty_shipped > 0) && ($qty_shipped >= $line->qty);
5419
5420 $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
5421 foreach ($dirtpls as $module => $reldir) {
5422 $res = 0;
5423 if (!empty($module)) {
5424 $tpl = dol_buildpath($reldir.'/objectline_view.tpl.php');
5425 } else {
5426 $tpl = DOL_DOCUMENT_ROOT.$reldir.'/objectline_view.tpl.php';
5427 }
5428 //var_dump($tpl);
5429 if (file_exists($tpl)) {
5430 if (empty($conf->file->strict_mode)) {
5431 $res = @include $tpl;
5432 } else {
5433 $res = include $tpl; // for debug
5434 }
5435 }
5436 if ($res) {
5437 break;
5438 }
5439 }
5440 }
5441
5442 // Line in update mode
5443 if ($this->status == 0 && $action == 'editline' && $selected == $line->id) {
5444 $label = (!empty($line->label) ? $line->label : (($line->fk_product > 0) ? $line->product_label : ''));
5445
5446 $line->pu_ttc = price2num($line->subprice * (1 + ($line->tva_tx / 100)), 'MU');
5447
5448 // Output template part (modules that overwrite templates must declare this into descriptor)
5449 // Use global variables + $dateSelector + $seller and $buyer
5450 // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook printObjectLine and printObjectSubLine.
5451 $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
5452 foreach ($dirtpls as $module => $reldir) {
5453 if (!empty($module)) {
5454 $tpl = dol_buildpath($reldir.'/objectline_edit.tpl.php');
5455 } else {
5456 $tpl = DOL_DOCUMENT_ROOT.$reldir.'/objectline_edit.tpl.php';
5457 }
5458
5459 if (empty($conf->file->strict_mode)) {
5460 $res = @include $tpl;
5461 } else {
5462 $res = include $tpl; // for debug
5463 }
5464 if ($res) {
5465 break;
5466 }
5467 }
5468 }
5469 }
5470
5471
5472 /* This is to show array of line of details of source object */
5473
5474
5485 public function printOriginLinesList($restrictlist = '', $selectedLines = array())
5486 {
5487 global $langs, $hookmanager, $form, $action;
5488
5489 print '<tr class="liste_titre">';
5490 print '<td class="linecolref">'.$langs->trans('Ref').'</td>';
5491 print '<td class="linecoldescription">'.$langs->trans('Description').'</td>';
5492 print '<td class="linecolvat right">'.$langs->trans('VATRate').'</td>';
5493 print '<td class="linecoluht right">'.$langs->trans('PriceUHT').'</td>';
5494 if (isModEnabled("multicurrency")) {
5495 print '<td class="linecoluht_currency right">'.$langs->trans('PriceUHTCurrency').'</td>';
5496 }
5497 print '<td class="linecolqty right">'.$langs->trans('Qty').'</td>';
5498 if (getDolGlobalInt('PRODUCT_USE_UNITS')) {
5499 print '<td class="linecoluseunit left">'.$langs->trans('Unit').'</td>';
5500 }
5501 print '<td class="linecoldiscount right">'.$langs->trans('ReductionShort').'</td>';
5502 print '<td class="linecolht right">'.$langs->trans('TotalHT').'</td>';
5503 print '<td class="center">'.$form->showCheckAddButtons('checkforselect', 1).'</td>';
5504 print '</tr>';
5505 $i = 0;
5506
5507 if (!empty($this->lines)) {
5508 foreach ($this->lines as $line) {
5509 $reshook = 0;
5510 //if (is_object($hookmanager) && (($line->product_type == 9 && !empty($line->special_code)) || !empty($line->fk_parent_line))) {
5511 if (is_object($hookmanager)) { // Old code is commented on preceding line.
5512 $parameters = array('line' => $line, 'i' => $i, 'restrictlist' => $restrictlist, 'selectedLines' => $selectedLines);
5513 if (!empty($line->fk_parent_line)) {
5514 $parameters['fk_parent_line'] = $line->fk_parent_line;
5515 }
5516 $reshook = $hookmanager->executeHooks('printOriginObjectLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
5517 }
5518 if (empty($reshook)) {
5519 $this->printOriginLine($line, '', $restrictlist, '/core/tpl', $selectedLines);
5520 }
5521
5522 $i++;
5523 }
5524 }
5525 }
5526
5540 public function printOriginLine($line, $var, $restrictlist = '', $defaulttpldir = '/core/tpl', $selectedLines = array())
5541 {
5542 global $langs, $conf;
5543
5544 //var_dump($line);
5545 if (!empty($line->date_start)) {
5546 // @phan-suppress-next-line PhanUndeclaredProperty
5547 $date_start = $line->date_start;
5548 } else {
5549 $date_start = $line->date_debut_prevue;
5550 if ($line->date_debut_reel) {
5551 $date_start = $line->date_debut_reel;
5552 }
5553 }
5554 if (!empty($line->date_end)) {
5555 // @phan-suppress-next-line PhanUndeclaredProperty
5556 $date_end = $line->date_end;
5557 } else {
5558 $date_end = $line->date_fin_prevue;
5559 if ($line->date_fin_reel) {
5560 $date_end = $line->date_fin_reel;
5561 }
5562 }
5563
5564 $this->tpl['id'] = $line->id;
5565
5566 $this->tpl['label'] = '';
5567 if (!empty($line->fk_parent_line)) {
5568 $this->tpl['label'] .= img_picto('', 'rightarrow');
5569 }
5570
5571 if (($line->info_bits & 2) == 2) { // TODO Not sure this is used for source object
5572 $discount = new DiscountAbsolute($this->db);
5573 if (property_exists($this, 'socid')) {
5574 $discount->fk_soc = $this->socid;
5575 $discount->socid = $this->socid;
5576 }
5577 $this->tpl['label'] .= $discount->getNomUrl(0, 'discount');
5578 } elseif (!empty($line->fk_product)) {
5579 $productstatic = new Product($this->db);
5580 $productstatic->id = $line->fk_product;
5581 $productstatic->ref = $line->ref;
5582 $productstatic->type = $line->fk_product_type;
5583 if (empty($productstatic->ref)) {
5584 $line->fetch_product();
5585 $productstatic = $line->product;
5586 }
5587
5588 $this->tpl['label'] .= $productstatic->getNomUrl(1);
5589 $this->tpl['label'] .= ' - '.(!empty($line->label) ? $line->label : $line->product_label);
5590 // Dates
5591 if ($line->product_type == 1 && ($date_start || $date_end)) {
5592 $this->tpl['label'] .= get_date_range($date_start, $date_end);
5593 }
5594 } else {
5595 $this->tpl['label'] .= ($line->product_type == -1 ? '&nbsp;' : ($line->product_type == 1 ? img_object($langs->trans(''), 'service') : img_object($langs->trans(''), 'product')));
5596 if (!empty($line->desc)) {
5597 $this->tpl['label'] .= $line->desc;
5598 } else {
5599 $this->tpl['label'] .= ($line->label ? '&nbsp;'.$line->label : '');
5600 }
5601
5602 // Dates
5603 if ($line->product_type == 1 && ($date_start || $date_end)) {
5604 $this->tpl['label'] .= get_date_range($date_start, $date_end);
5605 }
5606 }
5607
5608 if (!empty($line->desc)) {
5609 '@phan-var-force OrderLine|FactureLigne|ContratLigne|FactureFournisseurLigneRec|SupplierInvoiceLine|SupplierProposalLine $line';
5610 if ($line->desc == '(CREDIT_NOTE)') { // TODO Not sure this is used for source object
5611 $discount = new DiscountAbsolute($this->db);
5612 $discount->fetch($line->fk_remise_except);
5613 $this->tpl['description'] = $langs->transnoentities("DiscountFromCreditNote", $discount->getNomUrl(0));
5614 } elseif ($line->desc == '(DEPOSIT)') { // TODO Not sure this is used for source object
5615 $discount = new DiscountAbsolute($this->db);
5616 $discount->fetch($line->fk_remise_except);
5617 $this->tpl['description'] = $langs->transnoentities("DiscountFromDeposit", $discount->getNomUrl(0));
5618 } elseif ($line->desc == '(EXCESS RECEIVED)') {
5619 $discount = new DiscountAbsolute($this->db);
5620 $discount->fetch($line->fk_remise_except);
5621 $this->tpl['description'] = $langs->transnoentities("DiscountFromExcessReceived", $discount->getNomUrl(0));
5622 } elseif ($line->desc == '(EXCESS PAID)') {
5623 $discount = new DiscountAbsolute($this->db);
5624 $discount->fetch($line->fk_remise_except);
5625 $this->tpl['description'] = $langs->transnoentities("DiscountFromExcessPaid", $discount->getNomUrl(0));
5626 } else {
5627 $this->tpl['description'] = dol_trunc($line->desc, 60);
5628 }
5629 } else {
5630 $this->tpl['description'] = '&nbsp;';
5631 }
5632
5633 // VAT Rate
5634 $this->tpl['vat_rate'] = vatrate($line->tva_tx, true);
5635 $this->tpl['vat_rate'] .= (($line->info_bits & 1) == 1) ? '*' : '';
5636 if (!empty($line->vat_src_code) && !preg_match('/\‍(/', $this->tpl['vat_rate'])) {
5637 $this->tpl['vat_rate'] .= ' ('.$line->vat_src_code.')';
5638 }
5639
5640 $this->tpl['price'] = price($line->subprice);
5641 $this->tpl['total_ht'] = price($line->total_ht);
5642 $this->tpl['multicurrency_price'] = price($line->multicurrency_subprice);
5643 $this->tpl['qty'] = (($line->info_bits & 2) != 2) ? $line->qty : '&nbsp;';
5644 if (getDolGlobalInt('PRODUCT_USE_UNITS')) {
5645 $this->tpl['unit'] = $langs->transnoentities($line->getLabelOfUnit('long'));
5646 }
5647 $this->tpl['remise_percent'] = (($line->info_bits & 2) != 2) ? vatrate((string) $line->remise_percent, true) : '&nbsp;';
5648
5649 // Is the line strike or not
5650 $this->tpl['strike'] = 0;
5651 if ($restrictlist == 'services' && $line->product_type != Product::TYPE_SERVICE) {
5652 $this->tpl['strike'] = 1;
5653 }
5654
5655 // Output template part (modules that overwrite templates must declare this into descriptor)
5656 // Use global variables + $dateSelector + $seller and $buyer
5657 $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
5658 foreach ($dirtpls as $module => $reldir) {
5659 if (!empty($module)) {
5660 $tpl = dol_buildpath($reldir.'/originproductline.tpl.php');
5661 } else {
5662 $tpl = DOL_DOCUMENT_ROOT.$reldir.'/originproductline.tpl.php';
5663 }
5664
5665 if (empty($conf->file->strict_mode)) {
5666 $res = @include $tpl;
5667 } else {
5668 $res = include $tpl; // for debug
5669 }
5670 if ($res) {
5671 break;
5672 }
5673 }
5674 }
5675
5676
5677 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
5688 public function add_element_resource($resource_id, $resource_type, $busy = 0, $mandatory = 0)
5689 {
5690 // phpcs:enable
5691 $this->db->begin();
5692
5693 $sql = "INSERT INTO ".$this->db->prefix()."element_resources (";
5694 $sql .= "resource_id";
5695 $sql .= ", resource_type";
5696 $sql .= ", element_id";
5697 $sql .= ", element_type";
5698 $sql .= ", busy";
5699 $sql .= ", mandatory";
5700 $sql .= ") VALUES (";
5701 $sql .= ((int) $resource_id);
5702 $sql .= ", '".$this->db->escape($resource_type)."'";
5703 $sql .= ", '".$this->db->escape($this->id)."'";
5704 $sql .= ", '".$this->db->escape($this->element)."'";
5705 $sql .= ", '".$this->db->escape($busy)."'";
5706 $sql .= ", '".$this->db->escape($mandatory)."'";
5707 $sql .= ")";
5708
5709 dol_syslog(get_class($this)."::add_element_resource", LOG_DEBUG);
5710 if ($this->db->query($sql)) {
5711 $this->db->commit();
5712 return 1;
5713 } else {
5714 $this->error = $this->db->lasterror();
5715 $this->db->rollback();
5716 return 0;
5717 }
5718 }
5719
5720 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
5729 public function delete_resource($rowid, $element, $notrigger = 0)
5730 {
5731 // phpcs:enable
5732 global $user;
5733
5734 $this->db->begin();
5735
5736 $sql = "DELETE FROM ".$this->db->prefix()."element_resources";
5737 $sql .= " WHERE rowid = ".((int) $rowid);
5738
5739 dol_syslog(get_class($this)."::delete_resource", LOG_DEBUG);
5740
5741 $resql = $this->db->query($sql);
5742 if (!$resql) {
5743 $this->error = $this->db->lasterror();
5744 $this->db->rollback();
5745 return -1;
5746 } else {
5747 if (!$notrigger) {
5748 $result = $this->call_trigger(strtoupper($element).'_DELETE_RESOURCE', $user);
5749 if ($result < 0) {
5750 $this->db->rollback();
5751 return -1;
5752 }
5753 }
5754 $this->db->commit();
5755 return 1;
5756 }
5757 }
5758
5759
5765 public function __clone()
5766 {
5767 // Force a copy of this->lines, otherwise it will point to same object.
5768 if (isset($this->lines) && is_array($this->lines)) {
5769 $nboflines = count($this->lines);
5770 for ($i = 0; $i < $nboflines; $i++) {
5771 if (is_object($this->lines[$i])) {
5772 $this->lines[$i] = clone $this->lines[$i];
5773 }
5774 }
5775 }
5776 }
5777
5791 protected function commonGenerateDocument($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams = null)
5792 {
5793 global $conf, $langs, $user, $hookmanager, $action;
5794
5795 $srctemplatepath = '';
5796
5797 $parameters = array('modelspath' => $modelspath, 'modele' => $modele, 'outputlangs' => $outputlangs, 'hidedetails' => $hidedetails, 'hidedesc' => $hidedesc, 'hideref' => $hideref, 'moreparams' => $moreparams);
5798 $reshook = $hookmanager->executeHooks('commonGenerateDocument', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
5799
5800 if (!empty($reshook)) {
5801 return $reshook;
5802 }
5803
5804 dol_syslog("commonGenerateDocument modele=".$modele." outputlangs->defaultlang=".(is_object($outputlangs) ? $outputlangs->defaultlang : 'null'));
5805
5806 if (empty($modele)) {
5807 $this->error = 'BadValueForParameterModele';
5808 return -1;
5809 }
5810
5811 // Increase limit for PDF build
5812 $err = error_reporting();
5813 error_reporting(0);
5814 @set_time_limit(120);
5815 error_reporting($err);
5816
5817 // If selected model is a filename template (then $modele="modelname" or "modelname:filename")
5818 $tmp = explode(':', $modele, 2);
5819 $saved_model = $modele;
5820 if (!empty($tmp[1])) {
5821 $modele = $tmp[0];
5822 $srctemplatepath = $tmp[1];
5823 }
5824
5825 // Search template files
5826 $file = '';
5827 $classname = '';
5828 $filefound = '';
5829 $dirmodels = array('/');
5830 if (is_array($conf->modules_parts['models'])) {
5831 $dirmodels = array_merge($dirmodels, $conf->modules_parts['models']);
5832 }
5833 foreach ($dirmodels as $reldir) {
5834 foreach (array('doc', 'pdf') as $prefix) {
5835 if (in_array(get_class($this), array('Adherent'))) {
5836 // Member module use prefix_modele.class.php
5837 $file = $prefix."_".$modele.".class.php";
5838 } else {
5839 // Other module use prefix_modele.modules.php
5840 $file = $prefix."_".$modele.".modules.php";
5841 }
5842
5843 $file = dol_sanitizeFileName($file);
5844
5845 // We check if the file exists
5846 $file = dol_buildpath($reldir.$modelspath.$file, 0);
5847 if (file_exists($file)) {
5848 $filefound = $file;
5849 $classname = $prefix.'_'.$modele;
5850 break;
5851 }
5852 }
5853 if ($filefound) {
5854 break;
5855 }
5856 }
5857
5858 if ($filefound === '' || $classname === '') {
5859 $this->error = $langs->trans("Error").' Failed to load doc generator with modelpaths='.$modelspath.' - modele='.$modele;
5860 $this->errors[] = $this->error;
5861 dol_syslog($this->error, LOG_ERR);
5862 return -1;
5863 }
5864
5865 // Sanitize $filefound
5866 $filefound = dol_sanitizePathName($filefound);
5867
5868 // If generator was found
5869 global $db; // Required to solve a conception error making an include of some code that uses $db instead of $this->db just after.
5870
5871 require_once $filefound;
5872
5873 $obj = new $classname($this->db);
5874
5875 // TODO: Check the following classes that seem possible for $obj, but removed for compatibility:
5876 // ModeleBankAccountDoc|ModeleExpenseReport|ModelePDFBom|ModelePDFCommandes|ModelePDFContract|
5877 // ModelePDFDeliveryOrder|ModelePDFEvaluation|ModelePDFFactures|ModelePDFFicheinter|
5878 // ModelePDFMo|ModelePDFMovement|ModelePDFProduct|ModelePDFProjects|ModelePDFPropales|
5879 // ModelePDFRecruitmentJobPosition|ModelePDFSupplierProposal|ModelePDFSuppliersInvoices|
5880 // ModelePDFSuppliersOrders|ModelePDFSuppliersPayments|ModelePdfExpedition|ModelePdfReception|
5881 // ModelePDFStock|ModelePDFStockTransfer|
5882 // ModeleDon|ModelePDFTask|
5883 // ModelePDFAsset|ModelePDFTicket|ModelePDFUserGroup|ModeleThirdPartyDoc|ModelePDFUser
5884 // Has no write_file: ModeleBarCode|ModeleImports|ModeleExports|
5885 '@phan-var-force ModelePDFMember $obj';
5886 // '@phan-var-force ModelePDFMember|ModeleBarCode|ModeleDon|ModeleExports|ModeleImports|ModelePDFAsset|ModelePDFContract|ModelePDFDeliveryOrder|ModelePDFEvaluation|ModelePDFFactures|ModelePDFFicheinter|ModelePDFMo|ModelePDFMovement|ModelePDFProduct|ModelePDFProjects|ModelePDFPropales|ModelePDFRecruitmentJobPosition|ModelePDFStock|ModelePDFStockTransfer|ModelePDFSupplierProposal|ModelePDFSuppliersInvoices|ModelePDFSuppliersOrders|ModelePDFSuppliersPayments|ModelePDFTask|ModelePDFTicket|ModelePDFUser|ModelePDFUserGroup|ModelePdfExpedition|ModelePdfReception|ModeleThirdPartyDoc $obj';
5887
5888 // If generator is ODT, we must have srctemplatepath defined, if not we set it.
5889 if ($obj->type == 'odt' && empty($srctemplatepath)) {
5890 $varfortemplatedir = $obj->scandir;
5891 if ($varfortemplatedir && getDolGlobalString($varfortemplatedir)) {
5892 $dirtoscan = getDolGlobalString($varfortemplatedir);
5893
5894 $listoffiles = array();
5895
5896 // Now we add first model found in directories scanned
5897 $listofdir = explode(',', $dirtoscan);
5898 foreach ($listofdir as $key => $tmpdir) {
5899 $tmpdir = trim($tmpdir);
5900 $tmpdir = preg_replace('/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir);
5901 if (!$tmpdir) {
5902 unset($listofdir[$key]);
5903 continue;
5904 }
5905 if (is_dir($tmpdir)) {
5906 $tmpfiles = dol_dir_list($tmpdir, 'files', 0, '\.od(s|t)$', '', 'name', SORT_ASC, 0);
5907 if (count($tmpfiles)) {
5908 $listoffiles = array_merge($listoffiles, $tmpfiles);
5909 }
5910 }
5911 }
5912
5913 if (count($listoffiles)) {
5914 foreach ($listoffiles as $record) {
5915 $srctemplatepath = $record['fullname'];
5916 break;
5917 }
5918 }
5919 }
5920
5921 if (empty($srctemplatepath)) {
5922 $this->error = 'ErrorGenerationAskedForOdtTemplateWithSrcFileNotDefined';
5923 return -1;
5924 }
5925 }
5926
5927 if ($obj->type == 'odt' && !empty($srctemplatepath)) {
5928 if (!dol_is_file($srctemplatepath)) {
5929 dol_syslog("Failed to locate template file ".$srctemplatepath, LOG_WARNING);
5930 $this->error = 'ErrorGenerationAskedForOdtTemplateWithSrcFileNotFound';
5931 return -1;
5932 }
5933 }
5934
5935 // We save charset_output to restore it because write_file can change it if needed for
5936 // output format that does not support UTF8.
5937 $sav_charset_output = empty($outputlangs->charset_output) ? '' : $outputlangs->charset_output;
5938
5939 // update model_pdf in object
5940 $this->model_pdf = $saved_model;
5941
5942 if ($obj instanceof ModelePDFMember) {
5943 $resultwritefile = $obj->write_file($this, $outputlangs, $srctemplatepath, 'member', 1, 'tmp_cards');
5944 } else {
5945 // TODO: Try to set type above again
5946 '@phan-var-force ModeleBarCode|ModeleDon|ModeleExports|ModeleImports|ModelePDFAsset|ModelePDFContract|ModelePDFDeliveryOrder|ModelePDFEvaluation|ModelePDFFactures|ModelePDFFicheinter|ModelePDFMo|ModelePDFMovement|ModelePDFProduct|ModelePDFProjects|ModelePDFPropales|ModelePDFRecruitmentJobPosition|ModelePDFStock|ModelePDFStockTransfer|ModelePDFSupplierProposal|ModelePDFSuppliersInvoices|ModelePDFSuppliersOrders|ModelePDFSuppliersPayments|ModelePDFTask|ModelePDFTicket|ModelePDFUser|ModelePDFUserGroup|ModelePdfExpedition|ModelePdfReception|ModeleThirdPartyDoc $obj';
5947 $resultwritefile = $obj->write_file($this, $outputlangs, $srctemplatepath, $hidedetails, $hidedesc, $hideref, $moreparams);
5948 }
5949 // After call of write_file $obj->result['fullpath'] is set with generated file. It will be used to update the ECM database index.
5950
5951 if ($resultwritefile > 0) {
5952 $outputlangs->charset_output = $sav_charset_output;
5953
5954 // We delete old preview
5955 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
5956 dol_delete_preview($this);
5957
5958 // Index file in database
5959 if (!empty($obj->result['fullpath'])) {
5960 $destfull = $obj->result['fullpath'];
5961
5962 // Update the last_main_doc field into main object (if document generator has property ->update_main_doc_field set)
5963 $update_main_doc_field = 0;
5964 if (!empty($obj->update_main_doc_field)) {
5965 $update_main_doc_field = 1;
5966 }
5967
5968 // Check that the file exists, before indexing it.
5969 // Hint: It does not exist, if we create a PDF and auto delete the ODT File
5970 if (dol_is_file($destfull)) {
5971 $this->indexFile($destfull, $update_main_doc_field);
5972 }
5973 } else {
5974 dol_syslog('Method ->write_file was called on object '.get_class($obj).' and return a success but the return array ->result["fullpath"] was not set.', LOG_WARNING);
5975 }
5976
5977 // Success in building document. We build meta file.
5978 dol_meta_create($this);
5979
5980 return 1;
5981 } else {
5982 $outputlangs->charset_output = $sav_charset_output;
5983 $this->error = $obj->error;
5984 $this->errors = $obj->errors;
5985 dol_syslog("Error generating document for ".__CLASS__.". Error: ".$obj->error, LOG_ERR);
5986 return -1;
5987 }
5988 }
5989
5999 public function indexFile($destfull, $update_main_doc_field)
6000 {
6001 global $conf, $user;
6002
6003 $upload_dir = dirname($destfull);
6004 $destfile = basename($destfull);
6005 $rel_dir = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $upload_dir);
6006
6007 if (!preg_match('/[\\/]temp[\\/]|[\\/]thumbs|\.meta$/', $rel_dir)) { // If not a tmp dir
6008 $filename = basename($destfile);
6009 $rel_dir = preg_replace('/[\\/]$/', '', $rel_dir);
6010 $rel_dir = preg_replace('/^[\\/]/', '', $rel_dir);
6011
6012 include_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmfiles.class.php';
6013 $ecmfile = new EcmFiles($this->db);
6014 $result = $ecmfile->fetch(0, '', ($rel_dir ? $rel_dir.'/' : '').$filename);
6015
6016 // Set the public "share" key
6017 $setsharekey = false;
6018 if ($this->element == 'propal' || $this->element == 'proposal') {
6019 if (getDolGlobalInt("PROPOSAL_ALLOW_ONLINESIGN")) {
6020 $setsharekey = true; // feature to make online signature is not set or set to on (default)
6021 }
6022 if (getDolGlobalInt("PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD")) {
6023 $setsharekey = true;
6024 }
6025 }
6026 if ($this->element == 'commande' && getDolGlobalInt("ORDER_ALLOW_EXTERNAL_DOWNLOAD")) {
6027 $setsharekey = true;
6028 }
6029 if ($this->element == 'facture' && getDolGlobalInt("INVOICE_ALLOW_EXTERNAL_DOWNLOAD")) {
6030 $setsharekey = true;
6031 }
6032 if ($this->element == 'bank_account' && getDolGlobalInt("BANK_ACCOUNT_ALLOW_EXTERNAL_DOWNLOAD")) {
6033 $setsharekey = true;
6034 }
6035 if ($this->element == 'product' && getDolGlobalInt("PRODUCT_ALLOW_EXTERNAL_DOWNLOAD")) {
6036 $setsharekey = true;
6037 }
6038 if ($this->element == 'contrat' && getDolGlobalInt("CONTRACT_ALLOW_EXTERNAL_DOWNLOAD")) {
6039 $setsharekey = true;
6040 }
6041 if ($this->element == 'fichinter' && getDolGlobalInt("FICHINTER_ALLOW_EXTERNAL_DOWNLOAD")) {
6042 $setsharekey = true;
6043 }
6044 if ($this->element == 'supplier_proposal' && getDolGlobalInt("SUPPLIER_PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD")) {
6045 $setsharekey = true;
6046 }
6047 if ($this->element == 'societe_rib' && getDolGlobalInt("SOCIETE_RIB_ALLOW_ONLINESIGN")) {
6048 $setsharekey = true;
6049 }
6050
6051 if ($setsharekey) {
6052 if (empty($ecmfile->share)) { // Because object not found or share not set yet
6053 require_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php';
6054 $ecmfile->share = getRandomPassword(true);
6055 }
6056 }
6057
6058 if ($result > 0) {
6059 $ecmfile->label = md5_file(dol_osencode($destfull)); // hash of file content
6060 $ecmfile->fullpath_orig = '';
6061 $ecmfile->gen_or_uploaded = 'generated';
6062 $ecmfile->description = ''; // indexed content
6063 $ecmfile->keywords = ''; // keyword content
6064 $ecmfile->src_object_type = $this->table_element;
6065 $ecmfile->src_object_id = $this->id;
6066 $result = $ecmfile->update($user);
6067 if ($result < 0) {
6068 setEventMessages($ecmfile->error, $ecmfile->errors, 'warnings');
6069 return -1;
6070 }
6071 } else {
6072 $ecmfile->entity = $conf->entity;
6073 $ecmfile->filepath = $rel_dir;
6074 $ecmfile->filename = $filename;
6075 $ecmfile->label = md5_file(dol_osencode($destfull)); // hash of file content
6076 $ecmfile->fullpath_orig = '';
6077 $ecmfile->gen_or_uploaded = 'generated';
6078 $ecmfile->description = ''; // indexed content
6079 $ecmfile->keywords = ''; // keyword content
6080 $ecmfile->src_object_type = $this->table_element; // $this->table_name is 'myobject' or 'mymodule_myobject'.
6081 $ecmfile->src_object_id = $this->id;
6082
6083 $result = $ecmfile->create($user);
6084 if ($result < 0) {
6085 setEventMessages($ecmfile->error, $ecmfile->errors, 'warnings');
6086 return -1;
6087 }
6088 }
6089
6090 /*$this->result['fullname']=$destfull;
6091 $this->result['filepath']=$ecmfile->filepath;
6092 $this->result['filename']=$ecmfile->filename;*/
6093 //var_dump($obj->update_main_doc_field);exit;
6094
6095 if ($update_main_doc_field && !empty($this->table_element)) {
6096 $sql = "UPDATE ".$this->db->prefix().$this->table_element." SET last_main_doc = '".$this->db->escape($ecmfile->filepath."/".$ecmfile->filename)."'";
6097 $sql .= " WHERE rowid = ".((int) $this->id);
6098
6099 $resql = $this->db->query($sql);
6100 if (!$resql) {
6101 dol_print_error($this->db);
6102 return -1;
6103 } else {
6104 $this->last_main_doc = $ecmfile->filepath.'/'.$ecmfile->filename;
6105 }
6106 }
6107 }
6108
6109 return 1;
6110 }
6111
6119 public function addThumbs($file)
6120 {
6121 $file_osencoded = dol_osencode($file);
6122
6123 if (file_exists($file_osencoded)) {
6124 require_once DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php';
6125
6126 $tmparraysize = getDefaultImageSizes();
6127 $maxwidthsmall = $tmparraysize['maxwidthsmall'];
6128 $maxheightsmall = $tmparraysize['maxheightsmall'];
6129 $maxwidthmini = $tmparraysize['maxwidthmini'];
6130 $maxheightmini = $tmparraysize['maxheightmini'];
6131 //$quality = $tmparraysize['quality'];
6132 $quality = 50; // For thumbs, we force quality to 50
6133
6134 // Create small thumbs for company (Ratio is near 16/9)
6135 // Used on logon for example
6136 vignette($file_osencoded, $maxwidthsmall, $maxheightsmall, '_small', $quality);
6137
6138 // Create mini thumbs for company (Ratio is near 16/9)
6139 // Used on menu or for setup page for example
6140 vignette($file_osencoded, $maxwidthmini, $maxheightmini, '_mini', $quality);
6141 }
6142 }
6143
6151 public function delThumbs($file)
6152 {
6153 $imgThumbName = getImageFileNameForSize($file, '_small'); // Full path of thumb file
6154 dol_delete_file($imgThumbName);
6155 $imgThumbName = getImageFileNameForSize($file, '_mini'); // Full path of thumb file
6156 dol_delete_file($imgThumbName);
6157 }
6158
6159
6160 /* Functions common to commonobject and commonobjectline */
6161
6162 /* For default values */
6163
6177 public function getDefaultCreateValueFor($fieldname, $alternatevalue = null, $type = 'alphanohtml')
6178 {
6179 // If param here has been posted, we use this value first.
6180 if (GETPOSTISSET($fieldname)) {
6181 return GETPOST($fieldname, $type, 3);
6182 }
6183
6184 if (isset($alternatevalue)) {
6185 return $alternatevalue;
6186 }
6187
6188 $newelement = $this->element;
6189 if ($newelement == 'facture') {
6190 $newelement = 'invoice';
6191 }
6192 if ($newelement == 'commande') {
6193 $newelement = 'order';
6194 }
6195 if (empty($newelement)) {
6196 dol_syslog("Ask a default value using common method getDefaultCreateValueForField on an object with no property ->element defined. Return empty string.", LOG_WARNING);
6197 return '';
6198 }
6199
6200 $keyforfieldname = strtoupper($newelement.'_DEFAULT_'.$fieldname);
6201 //var_dump($keyforfieldname);
6202 if (getDolGlobalString($keyforfieldname)) {
6203 return getDolGlobalString($keyforfieldname);
6204 }
6205
6206 // TODO Ad here a scan into table llx_overwrite_default with a filter on $this->element and $fieldname
6207 // store content into $conf->cache['overwrite_default']
6208
6209 return '';
6210 }
6211
6212
6213 /* For triggers */
6214
6215
6216 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
6227 public function call_trigger($triggerName, $user)
6228 {
6229 // phpcs:enable
6230 global $langs, $conf;
6231
6232 if (!empty(self::TRIGGER_PREFIX) && strpos($triggerName, self::TRIGGER_PREFIX . '_') !== 0) {
6233 dol_print_error(null, 'The trigger "' . $triggerName . '" does not start with "' . self::TRIGGER_PREFIX . '_" as required.');
6234 exit;
6235 }
6236 if (!is_object($langs)) { // If lang was not defined, we set it. It is required by run_triggers().
6237 include_once DOL_DOCUMENT_ROOT.'/core/class/translate.class.php';
6238 $langs = new Translate('', $conf);
6239 }
6240
6241 include_once DOL_DOCUMENT_ROOT.'/core/class/interfaces.class.php';
6242 $interface = new Interfaces($this->db);
6243 $result = $interface->run_triggers($triggerName, $this, $user, $langs, $conf);
6244
6245 if ($result < 0) {
6246 if (!empty($this->errors)) {
6247 $this->errors = array_unique(array_merge($this->errors, $interface->errors)); // We use array_unique because when a trigger call another trigger on same object, this->errors is added twice.
6248 } else {
6249 $this->errors = $interface->errors;
6250 }
6251 }
6252 return $result;
6253 }
6254
6255
6256 /* Functions for data in other language */
6257
6258
6267 {
6268 // To avoid SQL errors. Probably not the better solution though
6269 if (!$this->element) {
6270 return 0;
6271 }
6272 if (!($this->id > 0)) {
6273 return 0;
6274 }
6275 if (is_array($this->array_languages)) {
6276 return 1;
6277 }
6278
6279 $this->array_languages = array();
6280
6281 $element = $this->element;
6282 if ($element == 'categorie') {
6283 $element = 'categories'; // For compatibility
6284 }
6285
6286 // Request to get translation values for object
6287 $sql = "SELECT rowid, property, lang , value";
6288 $sql .= " FROM ".$this->db->prefix()."object_lang";
6289 $sql .= " WHERE type_object = '".$this->db->escape($element)."'";
6290 $sql .= " AND fk_object = ".((int) $this->id);
6291
6292 //dol_syslog(get_class($this)."::fetch_optionals get extrafields data for ".$this->table_element, LOG_DEBUG); // Too verbose
6293 $resql = $this->db->query($sql);
6294 if ($resql) {
6295 $numrows = $this->db->num_rows($resql);
6296 if ($numrows) {
6297 $i = 0;
6298 while ($i < $numrows) {
6299 $obj = $this->db->fetch_object($resql);
6300 $key = $obj->property;
6301 $value = $obj->value;
6302 $codelang = $obj->lang;
6303 $type = $this->fields[$key]['type'];
6304
6305 // we can add this attribute to object
6306 if (preg_match('/date/', $type)) {
6307 $this->array_languages[$key][$codelang] = $this->db->jdate($value);
6308 } else {
6309 $this->array_languages[$key][$codelang] = $value;
6310 }
6311
6312 $i++;
6313 }
6314 }
6315
6316 $this->db->free($resql);
6317
6318 if ($numrows) {
6319 return $numrows;
6320 } else {
6321 return 0;
6322 }
6323 } else {
6324 dol_print_error($this->db);
6325 return -1;
6326 }
6327 }
6328
6335 public function setValuesForExtraLanguages($onlykey = '')
6336 {
6337 // Get extra fields
6338 foreach ($_POST as $postfieldkey => $postfieldvalue) {
6339 $tmparray = explode('-', $postfieldkey);
6340 if ($tmparray[0] != 'field') {
6341 continue;
6342 }
6343
6344 $element = $tmparray[1];
6345 $key = $tmparray[2];
6346 $codelang = $tmparray[3];
6347 //var_dump("postfieldkey=".$postfieldkey." element=".$element." key=".$key." codelang=".$codelang);
6348
6349 if (!empty($onlykey) && $key != $onlykey) {
6350 continue;
6351 }
6352 if ($element != $this->element) {
6353 continue;
6354 }
6355
6356 $key_type = $this->fields[$key]['type'];
6357
6358 $enabled = 1;
6359 if (isset($this->fields[$key]['enabled'])) {
6360 $enabled = (int) dol_eval($this->fields[$key]['enabled'], 1, 1, '1');
6361 }
6362 /*$perms = 1;
6363 if (isset($this->fields[$key]['perms']))
6364 {
6365 $perms = (int) dol_eval($this->fields[$key]['perms'], 1, 1, '1');
6366 }*/
6367 if (empty($enabled)) {
6368 continue;
6369 }
6370 //if (empty($perms)) continue;
6371
6372 if (in_array($key_type, array('date'))) {
6373 // Clean parameters
6374 // TODO GMT date in memory must be GMT so we should add gm=true in parameters
6375 $value_key = dol_mktime(0, 0, 0, GETPOSTINT($postfieldkey."month"), GETPOSTINT($postfieldkey."day"), GETPOSTINT($postfieldkey."year"));
6376 } elseif (in_array($key_type, array('datetime'))) {
6377 // Clean parameters
6378 // TODO GMT date in memory must be GMT so we should add gm=true in parameters
6379 $value_key = dol_mktime(GETPOSTINT($postfieldkey."hour"), GETPOSTINT($postfieldkey."min"), 0, GETPOSTINT($postfieldkey."month"), GETPOSTINT($postfieldkey."day"), GETPOSTINT($postfieldkey."year"));
6380 } elseif (in_array($key_type, array('checkbox', 'chkbxlst'))) {
6381 $value_arr = GETPOST($postfieldkey, 'array'); // check if an array
6382 if (!empty($value_arr)) {
6383 $value_key = implode(',', $value_arr);
6384 } else {
6385 $value_key = '';
6386 }
6387 } elseif (in_array($key_type, array('price', 'double'))) {
6388 $value_arr = GETPOST($postfieldkey, 'alpha');
6389 $value_key = price2num($value_arr);
6390 } else {
6391 $value_key = GETPOST($postfieldkey);
6392 if (in_array($key_type, array('link')) && $value_key == '-1') {
6393 $value_key = '';
6394 }
6395 }
6396
6397 $this->array_languages[$key][$codelang] = $value_key;
6398
6399 /*if ($nofillrequired) {
6400 $langs->load('errors');
6401 setEventMessages($langs->trans('ErrorFieldsRequired').' : '.implode(', ', $error_field_required), null, 'errors');
6402 return -1;
6403 }*/
6404 }
6405
6406 return 1;
6407 }
6408
6409
6410 /* Functions for extrafields */
6411
6418 public function fetchNoCompute($id)
6419 {
6420 global $conf;
6421
6422 $savDisableCompute = $conf->disable_compute;
6423 $conf->disable_compute = 1;
6424
6425 $ret = $this->fetch($id); /* @phpstan-ignore-line */
6426
6427 $conf->disable_compute = $savDisableCompute;
6428
6429 return $ret;
6430 }
6431
6432 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
6442 public function fetch_optionals($rowid = null, $optionsArray = null)
6443 {
6444 // phpcs:enable
6445 global $conf, $extrafields;
6446
6447 if (empty($rowid)) {
6448 $rowid = $this->id;
6449 }
6450 if (empty($rowid) && isset($this->rowid)) { // @phan-suppress-current-line PhanUndeclaredProperty
6451 $rowid = $this->rowid; // deprecated @phan-suppress-current-line PhanUndeclaredProperty
6452 }
6453
6454 // To avoid SQL errors. Probably not the better solution though
6455 if (!$this->table_element) {
6456 return 0;
6457 }
6458
6459 $this->array_options = array();
6460
6461 if (!is_array($optionsArray)) {
6462 // If $extrafields is not a known object, we initialize it. Best practice is to have $extrafields defined into card.php or list.php page.
6463 if (!isset($extrafields) || !is_object($extrafields)) {
6464 require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
6465 $extrafields = new ExtraFields($this->db);
6466 }
6467
6468 // Load array of extrafields for elementype = $this->table_element
6469 if (empty($extrafields->attributes[$this->table_element]['loaded'])) {
6470 $extrafields->fetch_name_optionals_label($this->table_element);
6471 }
6472 $optionsArray = (!empty($extrafields->attributes[$this->table_element]['label']) ? $extrafields->attributes[$this->table_element]['label'] : null);
6473 } else {
6474 global $extrafields;
6475 dol_syslog("Warning: fetch_optionals was called with param optionsArray defined when you should pass null now", LOG_WARNING);
6476 }
6477
6478 $table_element = $this->table_element;
6479 if ($table_element == 'categorie') {
6480 $table_element = 'categories'; // For compatibility
6481 }
6482
6483 // Request to get complementary values
6484 if (is_array($optionsArray) && count($optionsArray) > 0) {
6485 $sql = "SELECT rowid";
6486 foreach ($optionsArray as $name => $label) {
6487 if (empty($extrafields->attributes[$this->table_element]['type'][$name]) || (!in_array($extrafields->attributes[$this->table_element]['type'][$name], ['separate', 'point', 'multipts', 'linestrg','polygon']))) {
6488 $sql .= ", ".$name;
6489 }
6490 // use geo sql fonction to read as text
6491 if (empty($extrafields->attributes[$this->table_element]['type'][$name]) || $extrafields->attributes[$this->table_element]['type'][$name] == 'point') {
6492 $sql .= ", ST_AsWKT(".$name.") as ".$name;
6493 }
6494 if (empty($extrafields->attributes[$this->table_element]['type'][$name]) || $extrafields->attributes[$this->table_element]['type'][$name] == 'multipts') {
6495 $sql .= ", ST_AsWKT(".$name.") as ".$name;
6496 }
6497 if (empty($extrafields->attributes[$this->table_element]['type'][$name]) || $extrafields->attributes[$this->table_element]['type'][$name] == 'linestrg') {
6498 $sql .= ", ST_AsWKT(".$name.") as ".$name;
6499 }
6500 if (empty($extrafields->attributes[$this->table_element]['type'][$name]) || $extrafields->attributes[$this->table_element]['type'][$name] == 'polygon') {
6501 $sql .= ", ST_AsWKT(".$name.") as ".$name;
6502 }
6503 }
6504 $sql .= " FROM ".$this->db->prefix().$table_element."_extrafields";
6505 $sql .= " WHERE fk_object = ".((int) $rowid);
6506
6507 //dol_syslog(get_class($this)."::fetch_optionals get extrafields data for ".$this->table_element, LOG_DEBUG); // Too verbose
6508 $resql = $this->db->query($sql);
6509 if ($resql) {
6510 $numrows = $this->db->num_rows($resql);
6511 if ($numrows) {
6512 $tab = $this->db->fetch_array($resql);
6513
6514 foreach ($tab as $key => $value) {
6515 // Test fetch_array ! is_int($key) because fetch_array result is a mix table with Key as alpha and Key as int (depend db engine)
6516 if ($key != 'rowid' && $key != 'tms' && $key != 'fk_member' && !is_int($key)) {
6517 // we can add this attribute to object
6518 if (!empty($extrafields->attributes[$this->table_element]) && in_array($extrafields->attributes[$this->table_element]['type'][$key], array('date', 'datetime'))) {
6519 //var_dump($extrafields->attributes[$this->table_element]['type'][$key]);
6520 $this->array_options["options_".$key] = $this->db->jdate($value);
6521 } else {
6522 $this->array_options["options_".$key] = $value;
6523 }
6524
6525 //var_dump('key '.$key.' '.$value.' type='.$extrafields->attributes[$this->table_element]['type'][$key].' '.$this->array_options["options_".$key]);
6526 }
6527 if (!empty($extrafields->attributes[$this->table_element]['type'][$key]) && $extrafields->attributes[$this->table_element]['type'][$key] == 'password') {
6528 if (!empty($value) && preg_match('/^dolcrypt:/', $value)) {
6529 $this->array_options["options_".$key] = dolDecrypt($value);
6530 }
6531 }
6532 }
6533 } else {
6538 if (is_array($extrafields->attributes[$this->table_element]['label'])) {
6539 foreach ($extrafields->attributes[$this->table_element]['label'] as $key => $val) {
6540 $this->array_options['options_' . $key] = null;
6541 }
6542 }
6543 }
6544
6545 // If field is a computed field, value must become result of compute (regardless of whether a row exists
6546 // in the element's extrafields table)
6547 if (is_array($extrafields->attributes[$this->table_element]['label'])) {
6548 foreach ($extrafields->attributes[$this->table_element]['label'] as $key => $val) {
6549 if (!empty($extrafields->attributes[$this->table_element]) && !empty($extrafields->attributes[$this->table_element]['computed'][$key])) {
6550 //var_dump($conf->disable_compute);
6551 if (empty($conf->disable_compute)) {
6552 global $objectoffield; // We set a global variable to $objectoffield so
6553 $objectoffield = $this; // we can use it inside computed formula
6554 $this->array_options['options_' . $key] = dol_eval($extrafields->attributes[$this->table_element]['computed'][$key], 1, 0, '2');
6555 }
6556 }
6557 }
6558 }
6559
6560 $this->db->free($resql);
6561
6562 if ($numrows) {
6563 return $numrows;
6564 } else {
6565 return 0;
6566 }
6567 } else {
6568 $this->errors[] = $this->db->lasterror;
6569 return -1;
6570 }
6571 }
6572 return 0;
6573 }
6574
6581 public function deleteExtraFields()
6582 {
6583 global $conf;
6584
6585 if (getDolGlobalString('MAIN_EXTRAFIELDS_DISABLED')) {
6586 return 0;
6587 }
6588
6589 $this->db->begin();
6590
6591 $table_element = $this->table_element;
6592 if ($table_element == 'categorie') {
6593 $table_element = 'categories'; // For compatibility
6594 }
6595
6596 dol_syslog(get_class($this)."::deleteExtraFields delete", LOG_DEBUG);
6597
6598 $sql_del = "DELETE FROM ".$this->db->prefix().$table_element."_extrafields WHERE fk_object = ".((int) $this->id);
6599
6600 $resql = $this->db->query($sql_del);
6601 if (!$resql) {
6602 $this->error = $this->db->lasterror();
6603 $this->db->rollback();
6604 return -1;
6605 } else {
6606 $this->db->commit();
6607 return 1;
6608 }
6609 }
6610
6621 public function insertExtraFields($trigger = '', $userused = null)
6622 {
6623 global $langs, $user;
6624
6625 if (getDolGlobalString('MAIN_EXTRAFIELDS_DISABLED')) {
6626 return 0;
6627 }
6628
6629 if (empty($userused)) {
6630 $userused = $user;
6631 }
6632
6633 $error = 0;
6634
6635 if (!empty($this->array_options)) {
6636 // Check parameters
6637 $langs->load('admin');
6638 require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
6639 $extrafields = new ExtraFields($this->db);
6640 $target_extrafields = $extrafields->fetch_name_optionals_label($this->table_element);
6641
6642 // Eliminate copied source object extra fields that do not exist in target object
6643 $new_array_options = array();
6644 foreach ($this->array_options as $key => $value) {
6645 if (in_array(substr($key, 8), array_keys($target_extrafields))) { // We remove the 'options_' from $key for test
6646 $new_array_options[$key] = $value;
6647 } elseif (in_array($key, array_keys($target_extrafields))) { // We test on $key that does not contain the 'options_' prefix
6648 $new_array_options['options_'.$key] = $value;
6649 }
6650 }
6651
6652 foreach ($new_array_options as $key => $value) {
6653 $attributeKey = substr($key, 8); // Remove 'options_' prefix
6654 $attributeType = $extrafields->attributes[$this->table_element]['type'][$attributeKey];
6655 $attributeLabel = $langs->transnoentities($extrafields->attributes[$this->table_element]['label'][$attributeKey]);
6656 $attributeParam = $extrafields->attributes[$this->table_element]['param'][$attributeKey];
6657 $attributeRequired = $extrafields->attributes[$this->table_element]['required'][$attributeKey];
6658 $attributeUnique = $extrafields->attributes[$this->table_element]['unique'][$attributeKey];
6659 $attrfieldcomputed = $extrafields->attributes[$this->table_element]['computed'][$attributeKey];
6660
6661 // If we clone, we have to clean unique extrafields to prevent duplicates.
6662 // This behaviour can be prevented by external code by changing $this->context['createfromclone'] value in createFrom hook
6663 if (!empty($this->context['createfromclone']) && $this->context['createfromclone'] == 'createfromclone' && !empty($attributeUnique)) {
6664 $new_array_options[$key] = null;
6665 }
6666
6667 // Similar code than into insertExtraFields
6668 if ($attributeRequired) {
6669 $v = $this->array_options[$key];
6670 if (ExtraFields::isEmptyValue($v, $attributeType)) {
6671 $langs->load("errors");
6672 dol_syslog("Mandatory field '".$key."' is empty during create and set to required into definition of extrafields");
6673 $this->errors[] = $langs->trans('ErrorFieldRequired', $attributeLabel);
6674 return -1;
6675 }
6676 }
6677
6678 //dol_syslog("attributeLabel=".$attributeLabel, LOG_DEBUG);
6679 //dol_syslog("attributeType=".$attributeType, LOG_DEBUG);
6680
6681 if (!empty($attrfieldcomputed)) {
6682 if (getDolGlobalString('MAIN_STORE_COMPUTED_EXTRAFIELDS')) {
6683 $value = dol_eval($attrfieldcomputed, 1, 0, '2');
6684 dol_syslog($langs->trans("Extrafieldcomputed")." on ".$attributeLabel."(".$value.")", LOG_DEBUG);
6685 $new_array_options[$key] = $value;
6686 } else {
6687 $new_array_options[$key] = null;
6688 }
6689 }
6690
6691 switch ($attributeType) {
6692 case 'int':
6693 if (!is_numeric($value) && $value != '') {
6694 $this->errors[] = $langs->trans("ExtraFieldHasWrongValue", $attributeLabel);
6695 return -1;
6696 } elseif ($value == '') {
6697 $new_array_options[$key] = null;
6698 }
6699 break;
6700 case 'price':
6701 case 'double':
6702 $value = price2num($value);
6703 if (!is_numeric($value) && $value != '') {
6704 dol_syslog($langs->trans("ExtraFieldHasWrongValue")." for ".$attributeLabel."(".$value."is not '".$attributeType."')", LOG_DEBUG);
6705 $this->errors[] = $langs->trans("ExtraFieldHasWrongValue", $attributeLabel);
6706 return -1;
6707 } elseif ($value == '') {
6708 $value = null;
6709 }
6710 //dol_syslog("double value"." on ".$attributeLabel."(".$value." is '".$attributeType."')", LOG_DEBUG);
6711 $new_array_options[$key] = $value;
6712 break;
6713 /*case 'select': // Not required, we chose value='0' for undefined values
6714 if ($value=='-1')
6715 {
6716 $this->array_options[$key] = null;
6717 }
6718 break;*/
6719 case 'password':
6720 $algo = '';
6721 if ($this->array_options[$key] != '' && is_array($extrafields->attributes[$this->table_element]['param'][$attributeKey]['options'])) {
6722 // If there is an encryption choice, we use it to encrypt data before insert
6723 $tmparrays = array_keys($extrafields->attributes[$this->table_element]['param'][$attributeKey]['options']);
6724 $algo = reset($tmparrays);
6725 if ($algo != '') {
6726 //global $action; // $action may be 'create', 'update', 'update_extras'...
6727 //var_dump($action);
6728 //var_dump($this->oldcopy);exit;
6729 if (is_object($this->oldcopy)) { // If this->oldcopy is not defined, we can't know if we change attribute or not, so we must keep value
6730 //var_dump('algo='.$algo.' '.$this->oldcopy->array_options[$key].' -> '.$this->array_options[$key]);
6731 if (isset($this->oldcopy->array_options[$key]) && $this->array_options[$key] == $this->oldcopy->array_options[$key]) {
6732 // If old value encrypted in database is same than submitted new value, it means we don't change it, so we don't update.
6733 if ($algo == 'dolcrypt') { // dolibarr reversible encryption
6734 if (!preg_match('/^dolcrypt:/', $this->array_options[$key])) {
6735 $new_array_options[$key] = dolEncrypt($this->array_options[$key]); // warning, must be called when on the master
6736 } else {
6737 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6738 }
6739 } else {
6740 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6741 }
6742 } else {
6743 // If value has changed
6744 if ($algo == 'dolcrypt') { // dolibarr reversible encryption
6745 if (!preg_match('/^dolcrypt:/', $this->array_options[$key])) {
6746 $new_array_options[$key] = dolEncrypt($this->array_options[$key]); // warning, must be called when on the master
6747 } else {
6748 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6749 }
6750 } else {
6751 $new_array_options[$key] = dol_hash($this->array_options[$key], $algo);
6752 }
6753 }
6754 } else {
6755 //var_dump('jjj'.$algo.' '.$this->oldcopy->array_options[$key].' -> '.$this->array_options[$key]);
6756 // If this->oldcopy is not defined, we can't know if we change attribute or not, so we must keep value
6757 if ($algo == 'dolcrypt' && !preg_match('/^dolcrypt:/', $this->array_options[$key])) { // dolibarr reversible encryption
6758 $new_array_options[$key] = dolEncrypt($this->array_options[$key]); // warning, must be called when on the master
6759 } else {
6760 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6761 }
6762 }
6763 } else {
6764 // No encryption
6765 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6766 }
6767 } else { // Common usage
6768 $new_array_options[$key] = $this->array_options[$key]; // Value is kept
6769 }
6770 break;
6771 case 'date':
6772 case 'datetime':
6773 // If data is a string instead of a timestamp, we convert it
6774 if (!is_numeric($this->array_options[$key]) || $this->array_options[$key] != intval($this->array_options[$key])) {
6775 $this->array_options[$key] = strtotime($this->array_options[$key]);
6776 }
6777 $new_array_options[$key] = $this->db->idate($this->array_options[$key]);
6778 break;
6779 case 'datetimegmt':
6780 // If data is a string instead of a timestamp, we convert it
6781 if (!is_numeric($this->array_options[$key]) || $this->array_options[$key] != intval($this->array_options[$key])) {
6782 $this->array_options[$key] = strtotime($this->array_options[$key]);
6783 }
6784 $new_array_options[$key] = $this->db->idate($this->array_options[$key], 'gmt');
6785 break;
6786 case 'link':
6787 $param_list = array_keys($attributeParam['options']);
6788 // 0 : ObjectName
6789 // 1 : classPath
6790 $InfoFieldList = explode(":", $param_list[0]);
6791 dol_include_once($InfoFieldList[1]);
6792 if ($InfoFieldList[0] && class_exists($InfoFieldList[0])) {
6793 if ($value == '-1') { // -1 is key for no defined in combo list of objects
6794 $new_array_options[$key] = '';
6795 } elseif ($value) {
6796 $object = new $InfoFieldList[0]($this->db);
6797 '@phan-var-force CommonObject $object';
6798 if (is_numeric($value)) {
6799 $res = $object->fetch($value); // Common case
6800 } else {
6801 $res = $object->fetch(0, $value); // For compatibility
6802 }
6803
6804 if ($res > 0) {
6805 $new_array_options[$key] = $object->id;
6806 } else {
6807 $this->error = "Id/Ref '".$value."' for object '".$object->element."' not found";
6808 return -1;
6809 }
6810 }
6811 } else {
6812 dol_syslog('Error bad setup of extrafield', LOG_WARNING);
6813 }
6814 break;
6815 case 'checkbox':
6816 case 'chkbxlst':
6817 if (is_array($this->array_options[$key])) {
6818 $new_array_options[$key] = implode(',', $this->array_options[$key]);
6819 } else {
6820 $new_array_options[$key] = $this->array_options[$key];
6821 }
6822 break;
6823 }
6824 }
6825
6826 $this->db->begin();
6827
6828 $table_element = $this->table_element;
6829 if ($table_element == 'categorie') {
6830 $table_element = 'categories'; // For compatibility
6831 }
6832
6833 dol_syslog(get_class($this)."::insertExtraFields delete then insert", LOG_DEBUG);
6834
6835 $sql_del = "DELETE FROM ".$this->db->prefix().$table_element."_extrafields WHERE fk_object = ".((int) $this->id);
6836 $this->db->query($sql_del);
6837
6838 $sql = "INSERT INTO ".$this->db->prefix().$table_element."_extrafields (fk_object";
6839 foreach ($new_array_options as $key => $value) {
6840 $attributeKey = substr($key, 8); // Remove 'options_' prefix
6841 // Add field of attribute
6842 if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] != 'separate') { // Only for other type than separator
6843 $sql .= ",".$attributeKey;
6844 }
6845 }
6846 // We must insert a default value for fields for other entities that are mandatory to avoid not null error
6847 if (!empty($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities']) && is_array($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities'])) {
6848 foreach ($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities'] as $tmpkey => $tmpval) {
6849 if (!isset($extrafields->attributes[$this->table_element]['type'][$tmpkey])) { // If field not already added previously
6850 $sql .= ",".$tmpkey;
6851 }
6852 }
6853 }
6854 $sql .= ") VALUES (".$this->id;
6855
6856 foreach ($new_array_options as $key => $value) {
6857 $attributeKey = substr($key, 8); // Remove 'options_' prefix
6858 // Add field of attribute
6859 if (!in_array($extrafields->attributes[$this->table_element]['type'][$attributeKey], ['separate', 'point', 'multipts', 'linestrg', 'polygon'])) { // Only for other type than separator)
6860 if ($new_array_options[$key] != '' || $new_array_options[$key] == '0') {
6861 $sql .= ",'".$this->db->escape($new_array_options[$key])."'";
6862 } else {
6863 $sql .= ",null";
6864 }
6865 }
6866 if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] == 'point') { // for point type
6867 if (!empty($new_array_options[$key])) {
6868 if (!preg_match('/error/i', $new_array_options[$key])) {
6869 // Text must be a WKT string, so "POINT(15 20)"
6870 $sql .= ",ST_PointFromText('".$this->db->escape($new_array_options[$key])."')";
6871 } else {
6872 dol_syslog("Bad syntax string for point ".$new_array_options[$key]." to generate SQL request", LOG_WARNING);
6873 $sql .= ",null";
6874 }
6875 } else {
6876 $sql .= ",null";
6877 }
6878 }
6879 if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] == 'multipts') { // for point type
6880 if (!empty($new_array_options[$key])) {
6881 if (!preg_match('/error/i', $new_array_options[$key])) {
6882 // Text must be a WKT string, so "MULTIPOINT(0 0, 20 20, 60 60)"
6883 $sql .= ",ST_MultiPointFromText('".$this->db->escape($new_array_options[$key])."')";
6884 } else {
6885 dol_syslog("Bad syntax string for multipoint ".$new_array_options[$key]." to generate SQL request", LOG_WARNING);
6886 $sql .= ",null";
6887 }
6888 } else {
6889 $sql .= ",null";
6890 }
6891 }
6892 if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] == 'linestrg') { // for linestring type
6893 if (!empty($new_array_options[$key])) {
6894 if (!preg_match('/error/i', $new_array_options[$key])) {
6895 // Text must be a WKT string, so "LINESTRING(0 0, 10 10, 20 25, 50 60)"
6896 $sql .= ",ST_LineFromText('".$this->db->escape($new_array_options[$key])."')";
6897 } else {
6898 dol_syslog("Bad syntax string for line ".$new_array_options[$key]." to generate SQL request", LOG_WARNING);
6899 $sql .= ",null";
6900 }
6901 } else {
6902 $sql .= ",null";
6903 }
6904 }
6905 if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] == 'polygon') { // for polygon type
6906 if (!empty($new_array_options[$key])) {
6907 if (!preg_match('/error/i', $new_array_options[$key])) {
6908 // Text must be a WKT string, so "POLYGON((0 0,10 0,10 10,0 10,0 0),(5 5,7 5,7 7,5 7, 5 5))"
6909 $sql .= ",ST_PolyFromText('".$this->db->escape($new_array_options[$key])."')";
6910 } else {
6911 dol_syslog("Bad syntax string for polygon ".$new_array_options[$key]." to generate SQL request", LOG_WARNING);
6912 $sql .= ",null";
6913 }
6914 } else {
6915 $sql .= ",null";
6916 }
6917 }
6918 }
6919 // We must insert a default value for fields for other entities that are mandatory to avoid not null error
6920 if (!empty($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities']) && is_array($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities'])) {
6921 foreach ($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities'] as $tmpkey => $tmpval) {
6922 if (!isset($extrafields->attributes[$this->table_element]['type'][$tmpkey])) { // If field not already added previously
6923 if (in_array($tmpval, array('int', 'double', 'price'))) {
6924 $sql .= ", 0";
6925 } else {
6926 $sql .= ", ''";
6927 }
6928 }
6929 }
6930 }
6931
6932 $sql .= ")";
6933
6934 $resql = $this->db->query($sql);
6935 if (!$resql) {
6936 $this->error = $this->db->lasterror();
6937 $error++;
6938 }
6939
6940 if (!$error && $trigger) {
6941 // Call trigger
6942 $this->context = array('extrafieldaddupdate' => 1);
6943 $result = $this->call_trigger($trigger, $userused);
6944 if ($result < 0) {
6945 $error++;
6946 }
6947 // End call trigger
6948 }
6949
6950 if ($error) {
6951 $this->db->rollback();
6952 return -1;
6953 } else {
6954 $this->db->commit();
6955 return 1;
6956 }
6957 } else {
6958 return 0;
6959 }
6960 }
6961
6972 public function insertExtraLanguages($trigger = '', $userused = null)
6973 {
6974 global $conf, $langs, $user;
6975
6976 if (empty($userused)) {
6977 $userused = $user;
6978 }
6979
6980 $error = 0;
6981
6982 if (getDolGlobalString('MAIN_EXTRALANGUAGES_DISABLED')) {
6983 return 0; // For avoid conflicts if trigger used
6984 }
6985
6986 if (is_array($this->array_languages)) {
6987 $new_array_languages = $this->array_languages;
6988
6989 foreach ($new_array_languages as $key => $value) {
6990 $attributeKey = $key;
6991 $attributeType = $this->fields[$attributeKey]['type'];
6992 $attributeLabel = $this->fields[$attributeKey]['label'];
6993
6994 //dol_syslog("attributeLabel=".$attributeLabel, LOG_DEBUG);
6995 //dol_syslog("attributeType=".$attributeType, LOG_DEBUG);
6996
6997 switch ($attributeType) {
6998 case 'int':
6999 if (is_array($value) || (!is_numeric($value) && $value != '')) {
7000 $this->errors[] = $langs->trans("ExtraLanguageHasWrongValue", $attributeLabel);
7001 return -1;
7002 } elseif ($value == '') { // @phan-suppress-current-line PhanTypeComparisonFromArray
7003 $new_array_languages[$key] = null;
7004 }
7005 break;
7006 case 'double':
7007 $value = price2num((string) $value);
7008 if (!is_numeric($value) && $value != '') {
7009 dol_syslog($langs->trans("ExtraLanguageHasWrongValue")." on ".$attributeLabel."(".$value."is not '".$attributeType."')", LOG_DEBUG);
7010 $this->errors[] = $langs->trans("ExtraLanguageHasWrongValue", $attributeLabel);
7011 return -1;
7012 } elseif ($value == '') {
7013 $new_array_languages[$key] = null;
7014 } else {
7015 $new_array_languages[$key] = $value;
7016 }
7017 break;
7018 /*case 'select': // Not required, we chose value='0' for undefined values
7019 if ($value=='-1')
7020 {
7021 $this->array_options[$key] = null;
7022 }
7023 break;*/
7024 }
7025 }
7026
7027 $this->db->begin();
7028
7029 $table_element = $this->table_element;
7030 if ($table_element == 'categorie') { // TODO Rename table llx_categories_extrafields into llx_categorie_extrafields so we can remove this.
7031 $table_element = 'categories'; // For compatibility
7032 }
7033
7034 dol_syslog(get_class($this)."::insertExtraLanguages delete then insert", LOG_DEBUG);
7035
7036 foreach ($new_array_languages as $key => $langcodearray) { // $key = 'name', 'town', ...
7037 foreach ($langcodearray as $langcode => $value) {
7038 $sql_del = "DELETE FROM ".$this->db->prefix()."object_lang";
7039 $sql_del .= " WHERE fk_object = ".((int) $this->id)." AND property = '".$this->db->escape($key)."' AND type_object = '".$this->db->escape($table_element)."'";
7040 $sql_del .= " AND lang = '".$this->db->escape($langcode)."'";
7041 $this->db->query($sql_del);
7042
7043 if ($value !== '') {
7044 $sql = "INSERT INTO ".$this->db->prefix()."object_lang (fk_object, property, type_object, lang, value";
7045 $sql .= ") VALUES (".$this->id.", '".$this->db->escape($key)."', '".$this->db->escape($table_element)."', '".$this->db->escape($langcode)."', '".$this->db->escape($value)."'";
7046 $sql .= ")";
7047
7048 $resql = $this->db->query($sql);
7049 if (!$resql) {
7050 $this->error = $this->db->lasterror();
7051 $error++;
7052 break;
7053 }
7054 }
7055 }
7056 }
7057
7058 if (!$error && $trigger) {
7059 // Call trigger
7060 $this->context = array('extralanguagesaddupdate' => 1);
7061 $result = $this->call_trigger($trigger, $userused);
7062 if ($result < 0) {
7063 $error++;
7064 }
7065 // End call trigger
7066 }
7067
7068 if ($error) {
7069 $this->db->rollback();
7070 return -1;
7071 } else {
7072 $this->db->commit();
7073 return 1;
7074 }
7075 } else {
7076 return 0;
7077 }
7078 }
7079
7090 public function updateExtraField($key, $trigger = null, $userused = null)
7091 {
7092 global $conf, $langs, $user, $hookmanager;
7093
7094 if (getDolGlobalString('MAIN_EXTRAFIELDS_DISABLED')) {
7095 return 0;
7096 }
7097
7098 if (empty($userused)) {
7099 $userused = $user;
7100 }
7101
7102 $error = 0;
7103
7104 if (!empty($this->array_options) && isset($this->array_options["options_".$key])) {
7105 // Check parameters
7106 $langs->load('admin');
7107 require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
7108 $extrafields = new ExtraFields($this->db);
7109 $extrafields->fetch_name_optionals_label($this->table_element);
7110
7111 $value = $this->array_options["options_".$key];
7112
7113 $attributeKey = $key;
7114 $attributeType = $extrafields->attributes[$this->table_element]['type'][$key];
7115 $attributeLabel = $extrafields->attributes[$this->table_element]['label'][$key];
7116 $attributeParam = $extrafields->attributes[$this->table_element]['param'][$key];
7117 $attributeRequired = $extrafields->attributes[$this->table_element]['required'][$key];
7118 $attributeUnique = $extrafields->attributes[$this->table_element]['unique'][$attributeKey];
7119 $attrfieldcomputed = $extrafields->attributes[$this->table_element]['computed'][$key];
7120
7121 // Similar code than into insertExtraFields
7122 if ($attributeRequired) {
7123 $mandatorypb = false;
7124 if ($attributeType == 'link' && $this->array_options["options_".$key] == '-1') {
7125 $mandatorypb = true;
7126 }
7127 if ($this->array_options["options_".$key] === '') {
7128 $mandatorypb = true;
7129 }
7130 if ($mandatorypb) {
7131 $langs->load("errors");
7132 dol_syslog("Mandatory field 'options_".$key."' is empty during update and set to required into definition of extrafields");
7133 $this->errors[] = $langs->trans('ErrorFieldRequired', $attributeLabel);
7134 return -1;
7135 }
7136 }
7137
7138 // $new_array_options will be used for direct update, so must contains formatted data for the UPDATE.
7139 $new_array_options = $this->array_options;
7140
7141 //dol_syslog("attributeLabel=".$attributeLabel, LOG_DEBUG);
7142 //dol_syslog("attributeType=".$attributeType, LOG_DEBUG);
7143 if (!empty($attrfieldcomputed)) {
7144 if (getDolGlobalString('MAIN_STORE_COMPUTED_EXTRAFIELDS')) {
7145 $value = dol_eval($attrfieldcomputed, 1, 0, '2');
7146 dol_syslog($langs->trans("Extrafieldcomputed")." on ".$attributeLabel."(".$value.")", LOG_DEBUG);
7147
7148 $new_array_options["options_".$key] = $value;
7149
7150 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7151 } else {
7152 $new_array_options["options_".$key] = null;
7153
7154 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7155 }
7156 }
7157
7158 switch ($attributeType) {
7159 case 'int':
7160 if (!is_numeric($value) && $value != '') {
7161 $this->errors[] = $langs->trans("ExtraFieldHasWrongValue", $attributeLabel);
7162 return -1;
7163 } elseif ($value === '') {
7164 $new_array_options["options_".$key] = null;
7165
7166 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7167 }
7168 break;
7169 case 'price':
7170 case 'double':
7171 $value = price2num($value);
7172 if (!is_numeric($value) && $value != '') {
7173 dol_syslog($langs->trans("ExtraFieldHasWrongValue")." on ".$attributeLabel."(".$value."is not '".$attributeType."')", LOG_DEBUG);
7174 $this->errors[] = $langs->trans("ExtraFieldHasWrongValue", $attributeLabel);
7175 return -1;
7176 } elseif ($value === '') {
7177 $value = null;
7178 }
7179 //dol_syslog("double value"." on ".$attributeLabel."(".$value." is '".$attributeType."')", LOG_DEBUG);
7180 $new_array_options["options_".$key] = $value;
7181
7182 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7183 break;
7184 /*case 'select': // Not required, we chose value='0' for undefined values
7185 if ($value=='-1')
7186 {
7187 $new_array_options["options_".$key] = $value;
7188
7189 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7190 }
7191 break;*/
7192 case 'password':
7193 $algo = '';
7194 if ($this->array_options["options_".$key] != '' && is_array($extrafields->attributes[$this->table_element]['param'][$attributeKey]['options'])) {
7195 // If there is an encryption choice, we use it to encrypt data before insert
7196 $tmparrays = array_keys($extrafields->attributes[$this->table_element]['param'][$attributeKey]['options']);
7197 $algo = reset($tmparrays);
7198 if ($algo != '') {
7199 //global $action; // $action may be 'create', 'update', 'update_extras'...
7200 //var_dump($action);
7201 //var_dump($this->oldcopy);exit;
7202 //var_dump($key.' '.$this->array_options["options_".$key].' '.$algo);
7203 if (is_object($this->oldcopy)) { // If this->oldcopy is not defined, we can't know if we change attribute or not, so we must keep value
7204 //var_dump($this->oldcopy->array_options["options_".$key]); var_dump($this->array_options["options_".$key]);
7205 if (isset($this->oldcopy->array_options["options_".$key]) && $this->array_options["options_".$key] == $this->oldcopy->array_options["options_".$key]) { // If old value encrypted in database is same than submitted new value, it means we don't change it, so we don't update.
7206 if ($algo == 'dolcrypt') { // dolibarr reversible encryption
7207 if (!preg_match('/^dolcrypt:/', $this->array_options["options_".$key])) {
7208 $new_array_options["options_".$key] = dolEncrypt($this->array_options["options_".$key]); // warning, must be called when on the master
7209 } else {
7210 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7211 }
7212 } else {
7213 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7214 }
7215 } else {
7216 if ($algo == 'dolcrypt') { // dolibarr reversible encryption
7217 if (!preg_match('/^dolcrypt:/', $this->array_options["options_".$key])) {
7218 $new_array_options["options_".$key] = dolEncrypt($this->array_options["options_".$key]);
7219 } else {
7220 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7221 }
7222 } else {
7223 $new_array_options["options_".$key] = dol_hash($this->array_options["options_".$key], $algo);
7224 }
7225 }
7226 } else {
7227 if ($algo == 'dolcrypt' && !preg_match('/^dolcrypt:/', $this->array_options["options_".$key])) { // dolibarr reversible encryption
7228 $new_array_options["options_".$key] = dolEncrypt($this->array_options["options_".$key]); // warning, must be called when on the master
7229 } else {
7230 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7231 }
7232 }
7233 } else {
7234 // No encryption
7235 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7236 }
7237 } else { // Common usage
7238 $new_array_options["options_".$key] = $this->array_options["options_".$key]; // Value is kept
7239 }
7240
7241 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7242 break;
7243 case 'date':
7244 case 'datetime':
7245 if (empty($this->array_options["options_".$key])) {
7246 $new_array_options["options_".$key] = null;
7247
7248 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7249 } else {
7250 $new_array_options["options_".$key] = $this->db->idate($this->array_options["options_".$key]);
7251 }
7252 break;
7253 case 'datetimegmt':
7254 if (empty($this->array_options["options_".$key])) {
7255 $new_array_options["options_".$key] = null;
7256
7257 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7258 } else {
7259 $new_array_options["options_".$key] = $this->db->idate($this->array_options["options_".$key], 'gmt');
7260 }
7261 break;
7262 case 'boolean':
7263 if (empty($this->array_options["options_".$key])) {
7264 $new_array_options["options_".$key] = null;
7265
7266 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7267 }
7268 break;
7269 case 'link':
7270 if ($this->array_options["options_".$key] === '') {
7271 $new_array_options["options_".$key] = null;
7272
7273 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7274 }
7275 break;
7276 /*
7277 case 'link':
7278 $param_list = array_keys($attributeParam['options']);
7279 // 0 : ObjectName
7280 // 1 : classPath
7281 $InfoFieldList = explode(":", $param_list[0]);
7282 dol_include_once($InfoFieldList[1]);
7283 if ($InfoFieldList[0] && class_exists($InfoFieldList[0]))
7284 {
7285 if ($value == '-1') // -1 is key for no defined in combo list of objects
7286 {
7287 $new_array_options[$key] = '';
7288 } elseif ($value) {
7289 $object = new $InfoFieldList[0]($this->db);
7290 if (is_numeric($value)) $res = $object->fetch($value); // Common case
7291 else $res = $object->fetch(0, $value); // For compatibility
7292
7293 if ($res > 0) $new_array_options[$key] = $object->id;
7294 else {
7295 $this->error = "Id/Ref '".$value."' for object '".$object->element."' not found";
7296 $this->db->rollback();
7297 return -1;
7298 }
7299 }
7300 } else {
7301 dol_syslog('Error bad setup of extrafield', LOG_WARNING);
7302 }
7303 break;
7304 */
7305 case 'checkbox':
7306 case 'chkbxlst':
7307 $new_array_options = array();
7308 if (is_array($this->array_options["options_".$key])) {
7309 $new_array_options["options_".$key] = implode(',', $this->array_options["options_".$key]);
7310 } else {
7311 $new_array_options["options_".$key] = $this->array_options["options_".$key];
7312 }
7313
7314 $this->array_options["options_".$key] = $new_array_options["options_".$key];
7315 break;
7316 }
7317
7318 $this->db->begin();
7319
7320 $linealreadyfound = 0;
7321
7322 // Check if there is already a line for this object (in most cases, it is, but sometimes it is not, for example when extra field has been created after), so we must keep this overload)
7323 $table_element = $this->table_element;
7324 if ($table_element == 'categorie') { // TODO Rename table llx_categories_extrafields into llx_categorie_extrafields so we can remove this.
7325 $table_element = 'categories'; // For compatibility
7326 }
7327
7328 $sql = "SELECT COUNT(rowid) as nb FROM ".$this->db->prefix().$table_element."_extrafields WHERE fk_object = ".((int) $this->id);
7329 $resql = $this->db->query($sql);
7330 if ($resql) {
7331 $tmpobj = $this->db->fetch_object($resql);
7332 if ($tmpobj) {
7333 $linealreadyfound = $tmpobj->nb;
7334 }
7335 }
7336
7337 //var_dump('linealreadyfound='.$linealreadyfound.' sql='.$sql); exit;
7338 if ($linealreadyfound) {
7339 if ($this->array_options["options_".$key] === null) {
7340 $sql = "UPDATE ".$this->db->prefix().$table_element."_extrafields SET ".$key." = null";
7341 } else {
7342 $sql = "UPDATE ".$this->db->prefix().$table_element."_extrafields SET ".$key." = '".$this->db->escape($new_array_options["options_".$key])."'";
7343 }
7344 $sql .= " WHERE fk_object = ".((int) $this->id);
7345
7346 $resql = $this->db->query($sql);
7347 if (!$resql) {
7348 $error++;
7349 $this->error = $this->db->lasterror();
7350 }
7351 } else {
7352 $result = $this->insertExtraFields('', $user);
7353 if ($result < 0) {
7354 $error++;
7355 }
7356 }
7357
7358 if (!$error) {
7359 $parameters = array('key' => $key);
7360 global $action;
7361 $reshook = $hookmanager->executeHooks('updateExtraFieldBeforeCommit', $parameters, $this, $action);
7362 if ($reshook < 0) {
7363 setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
7364 }
7365 }
7366
7367 if (!$error && $trigger) {
7368 // Call trigger
7369 $this->context = array('extrafieldupdate' => 1);
7370 $result = $this->call_trigger($trigger, $userused);
7371 if ($result < 0) {
7372 $error++;
7373 }
7374 // End call trigger
7375 }
7376
7377 if ($error) {
7378 dol_syslog(__METHOD__.$this->error, LOG_ERR);
7379 $this->db->rollback();
7380 return -1;
7381 } else {
7382 $this->db->commit();
7383 return 1;
7384 }
7385 } else {
7386 return 0;
7387 }
7388 }
7389
7396 public function getExtraField($key)
7397 {
7398 return $this->array_options['options_'.$key] ?? null;
7399 }
7400
7408 public function setExtraField($key, $value)
7409 {
7410 $this->array_options['options_'.$key] = $value;
7411 }
7412
7423 public function updateExtraLanguages($key, $trigger = null, $userused = null)
7424 {
7425 global $conf, $langs, $user;
7426
7427 if (empty($userused)) {
7428 $userused = $user;
7429 }
7430
7431 $error = 0;
7432
7433 if (getDolGlobalString('MAIN_EXTRALANGUAGES_DISABLED')) {
7434 return 0; // For avoid conflicts if trigger used
7435 }
7436
7437 return 0;
7438 }
7439
7440
7456 public function showInputField($val, $key, $value, $moreparam = '', $keysuffix = '', $keyprefix = '', $morecss = 0, $nonewbutton = 0)
7457 {
7458 global $conf, $langs, $form;
7459
7460 // TODO pass the current object as a parameter to give more flexibility (like disable showing input for extra fields when canAlwaysBeEdited is false and $object->status is not draft...)
7461
7462 if (!is_object($form)) {
7463 require_once DOL_DOCUMENT_ROOT.'/core/class/html.form.class.php';
7464 $form = new Form($this->db);
7465 }
7466
7467 if (!empty($this->fields)) {
7468 $val = $this->fields[$key];
7469 }
7470
7471 // Validation tests and output
7472 $fieldValidationErrorMsg = '';
7473 $validationClass = '';
7474 $fieldValidationErrorMsg = $this->getFieldError($key);
7475 if (!empty($fieldValidationErrorMsg)) {
7476 $validationClass = ' --error'; // the -- is use as class state in css : .--error can't be be defined alone it must be define with another class like .my-class.--error or input.--error
7477 } else {
7478 $validationClass = ' --success'; // the -- is use as class state in css : .--success can't be be defined alone it must be define with another class like .my-class.--success or input.--success
7479 }
7480
7481 //$valuemultiselectinput = array();
7482 $out = '';
7483 $type = '';
7484 $isDependList = 0;
7485 $param = array();
7486 $param['options'] = array();
7487 $reg = array();
7488 // @phan-suppress-next-line PhanTypeMismatchProperty
7489 $size = !empty($this->fields[$key]['size']) ? $this->fields[$key]['size'] : 0;
7490 // Because we work on extrafields
7491 if (preg_match('/^(integer|link):(.*):(.*):(.*):(.*)/i', $val['type'], $reg)) {
7492 $param['options'] = array($reg[2].':'.$reg[3].':'.$reg[4].':'.$reg[5] => 'N');
7493 $type = 'link';
7494 } elseif (preg_match('/^(integer|link):(.*):(.*):(.*)/i', $val['type'], $reg)) {
7495 $param['options'] = array($reg[2].':'.$reg[3].':'.$reg[4] => 'N');
7496 $type = 'link';
7497 } elseif (preg_match('/^(integer|link):(.*):(.*)/i', $val['type'], $reg)) {
7498 $param['options'] = array($reg[2].':'.$reg[3] => 'N');
7499 $type = 'link';
7500 } elseif (preg_match('/^(sellist):(.*):(.*):(.*):(.*)/i', $val['type'], $reg)) {
7501 $param['options'] = array($reg[2].':'.$reg[3].':'.$reg[4].':'.$reg[5] => 'N');
7502 $type = 'sellist';
7503 } elseif (preg_match('/^(sellist):(.*):(.*):(.*)/i', $val['type'], $reg)) {
7504 $param['options'] = array($reg[2].':'.$reg[3].':'.$reg[4] => 'N');
7505 $type = 'sellist';
7506 } elseif (preg_match('/^(sellist):(.*):(.*)/i', $val['type'], $reg)) {
7507 $param['options'] = array($reg[2].':'.$reg[3] => 'N');
7508 $type = 'sellist';
7509 } elseif (preg_match('/^chkbxlst:(.*)/i', $val['type'], $reg)) {
7510 $param['options'] = array($reg[1] => 'N');
7511 $type = 'chkbxlst';
7512 } elseif (preg_match('/varchar\‍((\d+)\‍)/', $val['type'], $reg)) {
7513 $param['options'] = array();
7514 $type = 'varchar';
7515 $size = $reg[1];
7516 } elseif (preg_match('/varchar/', $val['type'])) {
7517 $param['options'] = array();
7518 $type = 'varchar';
7519 } elseif (preg_match('/stars\‍((\d+)\‍)/', $val['type'], $reg)) {
7520 $param['options'] = array();
7521 $type = 'stars';
7522 $size = $reg[1];
7523 } else {
7524 $param['options'] = array();
7525 $type = $this->fields[$key]['type'];
7526 }
7527 //var_dump($type); var_dump($param['options']);
7528
7529 // Special case that force options and type ($type can be integer, varchar, ...)
7530 if (!empty($this->fields[$key]['arrayofkeyval']) && is_array($this->fields[$key]['arrayofkeyval'])) {
7531 $param['options'] = $this->fields[$key]['arrayofkeyval'];
7532 // Special case that prevent to force $type to have multiple input @phan-suppress-next-line PhanTypeMismatchProperty
7533 if (empty($this->fields[$key]['multiinput'])) {
7534 $type = (($this->fields[$key]['type'] == 'checkbox') ? $this->fields[$key]['type'] : 'select');
7535 }
7536 }
7537
7538 $label = $this->fields[$key]['label'];
7539 //$elementtype=$this->fields[$key]['elementtype']; // Seems not used
7540 // @phan-suppress-next-line PhanTypeArraySuspiciousNullable
7541 $default = (!empty($this->fields[$key]['default']) ? $this->fields[$key]['default'] : '');
7542 // @phan-suppress-next-line PhanTypeMismatchProperty
7543 $computed = (!empty($this->fields[$key]['computed']) ? $this->fields[$key]['computed'] : '');
7544 // @phan-suppress-next-line PhanTypeMismatchProperty
7545 $unique = (!empty($this->fields[$key]['unique']) ? $this->fields[$key]['unique'] : 0);
7546 // @phan-suppress-next-line PhanTypeMismatchProperty
7547 $required = (!empty($this->fields[$key]['required']) ? $this->fields[$key]['required'] : 0);
7548 // @phan-suppress-next-line PhanTypeMismatchProperty
7549 $autofocusoncreate = (!empty($this->fields[$key]['autofocusoncreate']) ? $this->fields[$key]['autofocusoncreate'] : 0);
7550 // @phan-suppress-next-line PhanTypeMismatchProperty
7551 $placeholder = (!empty($this->fields[$key]['placeholder']) ? $this->fields[$key]['placeholder'] : 0);
7552
7553 // @phan-suppress-next-line PhanTypeMismatchProperty
7554 $langfile = (!empty($this->fields[$key]['langfile']) ? $this->fields[$key]['langfile'] : '');
7555 // @phan-suppress-next-line PhanTypeMismatchProperty
7556 $list = (!empty($this->fields[$key]['list']) ? $this->fields[$key]['list'] : 0);
7557 $hidden = (in_array(abs($this->fields[$key]['visible']), array(0, 2)) ? 1 : 0);
7558
7559 $objectid = $this->id;
7560
7561 if ($computed) {
7562 if (!preg_match('/^search_/', $keyprefix)) {
7563 return '<span class="opacitymedium">'.$langs->trans("AutomaticallyCalculated").'</span>';
7564 } else {
7565 return '';
7566 }
7567 }
7568
7569 // Set value of $morecss. For this, we use in priority showsize from parameters, then $val['css'] then autodefine
7570 if (empty($morecss) && !empty($val['css'])) {
7571 $morecss = $val['css'];
7572 } elseif (empty($morecss)) {
7573 if ($type == 'date') {
7574 $morecss = 'minwidth100imp';
7575 } elseif ($type == 'datetime' || $type == 'link') { // link means an foreign key to another primary id
7576 $morecss = 'minwidth200imp';
7577 } elseif (in_array($type, array('int', 'integer', 'price')) || preg_match('/^double(\‍([0-9],[0-9]\‍)){0,1}/', (string) $type)) {
7578 $morecss = 'maxwidth75';
7579 } elseif ($type == 'url') {
7580 $morecss = 'minwidth400';
7581 } elseif ($type == 'boolean') {
7582 $morecss = '';
7583 } else {
7584 if (is_numeric($size) && round((float) $size) < 12) {
7585 $morecss = 'minwidth100';
7586 } elseif (is_numeric($size) && round((float) $size) <= 48) {
7587 $morecss = 'minwidth200';
7588 } else {
7589 $morecss = 'minwidth400';
7590 }
7591 }
7592 }
7593
7594 // Add validation state class
7595 if (!empty($validationClass)) {
7596 $morecss .= $validationClass;
7597 }
7598
7599 if (in_array($type, array('date'))) {
7600 $tmp = explode(',', $size);
7601 $newsize = $tmp[0];
7602 $showtime = 0;
7603
7604 // Do not show current date when field not required (see selectDate() method)
7605 if (!$required && $value == '') {
7606 $value = '-1';
7607 }
7608
7609 // TODO Must also support $moreparam
7610 $out = $form->selectDate($value, $keyprefix.$key.$keysuffix, $showtime, $showtime, $required, '', 1, (($keyprefix != 'search_' && $keyprefix != 'search_options_') ? 1 : 0), 0, 1);
7611 } elseif (in_array($type, array('datetime'))) {
7612 $tmp = explode(',', $size);
7613 $newsize = $tmp[0];
7614 $showtime = 1;
7615
7616 // Do not show current date when field not required (see selectDate() method)
7617 if (!$required && $value == '') {
7618 $value = '-1';
7619 }
7620
7621 // TODO Must also support $moreparam
7622 $out = $form->selectDate($value, $keyprefix.$key.$keysuffix, $showtime, $showtime, $required, '', 1, (($keyprefix != 'search_' && $keyprefix != 'search_options_') ? 1 : 0), 0, 1, '', '', '', 1, '', '', 'tzuserrel');
7623 } elseif (in_array($type, array('duration'))) {
7624 $out = $form->select_duration($keyprefix.$key.$keysuffix, $value, 0, 'text', 0, 1);
7625 } elseif (in_array($type, array('int', 'integer'))) {
7626 $tmp = explode(',', $size);
7627 $newsize = $tmp[0];
7628 $out = '<input type="text" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'"'.($newsize > 0 ? ' maxlength="'.$newsize.'"' : '').' value="'.dol_escape_htmltag($value).'"'.($moreparam ? $moreparam : '').($autofocusoncreate ? ' autofocus' : '').'>';
7629 } elseif (in_array($type, array('real'))) {
7630 $out = '<input type="text" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.dol_escape_htmltag($value).'"'.($moreparam ? $moreparam : '').($autofocusoncreate ? ' autofocus' : '').'>';
7631 } elseif (preg_match('/varchar/', (string) $type)) {
7632 $out = '<input type="text" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'"'.($size > 0 ? ' maxlength="'.$size.'"' : '').' value="'.dol_escape_htmltag($value).'"'.($moreparam ? $moreparam : '').($placeholder ? ' placeholder="'.dolPrintHTMLForAttribute($placeholder).'"' : '').($autofocusoncreate ? ' autofocus' : '').'>';
7633 } elseif (in_array($type, array('email', 'mail', 'phone', 'url', 'ip'))) {
7634 $out = '<input type="text" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.dol_escape_htmltag($value).'" '.($moreparam ? $moreparam : '').($autofocusoncreate ? ' autofocus' : '').'>';
7635 } elseif (preg_match('/^text/', (string) $type)) {
7636 if (!preg_match('/search_/', $keyprefix)) { // If keyprefix is search_ or search_options_, we must just use a simple text field
7637 if (!empty($param['options'])) {
7638 // If the textarea field has a list of arrayofkeyval into its definition, we suggest a combo with possible values to fill the textarea.
7639 //var_dump($param['options']);
7640 $out .= $form->selectarray($keyprefix.$key.$keysuffix."_multiinput", $param['options'], '', 1, 0, 0, "flat maxwidthonphone".$morecss);
7641 $out .= '<input id="'.$keyprefix.$key.$keysuffix.'_multiinputadd" type="button" class="button" value="'.$langs->trans("Add").'">';
7642 $out .= "<script>";
7643 $out .= '
7644 function handlemultiinputdisabling(htmlname){
7645 console.log("We handle the disabling of used options for "+htmlname+"_multiinput");
7646 multiinput = $("#"+htmlname+"_multiinput");
7647 multiinput.find("option").each(function(){
7648 tmpval = $("#"+htmlname).val();
7649 tmpvalarray = tmpval.split("\n");
7650 valtotest = $(this).val();
7651 if(tmpvalarray.includes(valtotest)){
7652 $(this).prop("disabled",true);
7653 } else {
7654 if($(this).prop("disabled") == true){
7655 console.log(valtotest)
7656 $(this).prop("disabled", false);
7657 }
7658 }
7659 });
7660 }
7661
7662 $(document).ready(function () {
7663 $("#'.$keyprefix.$key.$keysuffix.'_multiinputadd").on("click",function() {
7664 tmpval = $("#'.$keyprefix.$key.$keysuffix.'").val();
7665 tmpvalarray = tmpval.split(",");
7666 valtotest = $("#'.$keyprefix.$key.$keysuffix.'_multiinput").val();
7667 if(valtotest != -1 && !tmpvalarray.includes(valtotest)){
7668 console.log("We add the selected value to the text area '.$keyprefix.$key.$keysuffix.'");
7669 if(tmpval == ""){
7670 tmpval = valtotest;
7671 } else {
7672 tmpval = tmpval + "\n" + valtotest;
7673 }
7674 $("#'.$keyprefix.$key.$keysuffix.'").val(tmpval);
7675 handlemultiinputdisabling("'.$keyprefix.$key.$keysuffix.'");
7676 $("#'.$keyprefix.$key.$keysuffix.'_multiinput").val(-1);
7677 } else {
7678 console.log("We add nothing the text area '.$keyprefix.$key.$keysuffix.'");
7679 }
7680 });
7681 $("#'.$keyprefix.$key.$keysuffix.'").on("change",function(){
7682 handlemultiinputdisabling("'.$keyprefix.$key.$keysuffix.'");
7683 });
7684 handlemultiinputdisabling("'.$keyprefix.$key.$keysuffix.'");
7685 })';
7686 $out .= "</script>";
7687 $value = str_replace(',', "\n", $value);
7688 }
7689 require_once DOL_DOCUMENT_ROOT.'/core/class/doleditor.class.php';
7690 $doleditor = new DolEditor($keyprefix.$key.$keysuffix, $value, '', 200, 'dolibarr_notes', 'In', false, false, false, ROWS_5, '90%');
7691 $out .= (string) $doleditor->Create(1, '', true, '', '', '', $morecss);
7692 } else {
7693 $out = '<input type="text" class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.dol_escape_htmltag($value).'" '.($moreparam ? $moreparam : '').'>';
7694 }
7695 } elseif (preg_match('/^html/', (string) $type)) {
7696 if (!preg_match('/search_/', $keyprefix)) { // If keyprefix is search_ or search_options_, we must just use a simple text field
7697 require_once DOL_DOCUMENT_ROOT.'/core/class/doleditor.class.php';
7698 $doleditor = new DolEditor($keyprefix.$key.$keysuffix, $value, '', 200, 'dolibarr_notes', 'In', false, false, isModEnabled('fckeditor') && getDolGlobalInt('FCKEDITOR_ENABLE_SOCIETE'), ROWS_5, '90%');
7699 $out = (string) $doleditor->Create(1, '', true, '', '', $moreparam, $morecss);
7700 } else {
7701 $out = '<input type="text" class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.dol_escape_htmltag($value).'" '.($moreparam ? $moreparam : '').'>';
7702 }
7703 } elseif ($type == 'boolean') {
7704 $checked = '';
7705 if (!empty($value)) {
7706 $checked = ' checked value="1" ';
7707 } else {
7708 $checked = ' value="1" ';
7709 }
7710 $out = '<input type="checkbox" class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" '.$checked.' '.($moreparam ? $moreparam : '').'>';
7711 } elseif ($type == 'price') {
7712 if (!empty($value)) { // $value in memory is a php numeric, we format it into user number format.
7713 $value = price($value);
7714 }
7715 $out = '<input type="text" class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.$value.'" '.($moreparam ? $moreparam : '').'> '.$langs->getCurrencySymbol($conf->currency);
7716 } elseif ($type == 'stars') {
7717 $out = '<input type="hidden" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.dol_escape_htmltag($value).'"'.($moreparam ? $moreparam : '').($autofocusoncreate ? ' autofocus' : '').'>';
7718 $out .= '<div class="star-selection" id="'.$keyprefix.$key.$keysuffix.'_selection">';
7719 $i = 1;
7720 while ($i <= $size) {
7721 $out .= '<span class="star" data-value="'.$i.'">'.img_picto('', 'fontawesome_star_fas').'</span>';
7722 $i++;
7723 }
7724 $out .= '</div>';
7725 $out .= '<script>
7726 jQuery(function($) {
7727 let container = $("#'.$keyprefix.$key.$keysuffix.'_selection");
7728 let selectedStars = parseInt($("#'.$keyprefix.$key.$keysuffix.'").val()) || 0;
7729 container.find(".star").each(function() {
7730 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
7731 });
7732 container.find(".star").on("mouseover", function() {
7733 let selectedStar = $(this).data("value");
7734 container.find(".star").each(function() {
7735 $(this).toggleClass("active", $(this).data("value") <= selectedStar);
7736 });
7737 });
7738 container.on("mouseout", function() {
7739 container.find(".star").each(function() {
7740 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
7741 });
7742 });
7743 container.find(".star").off("click").on("click", function() {
7744 selectedStars = $(this).data("value");
7745 if (selectedStars === 1 && $("#'.$keyprefix.$key.$keysuffix.'").val() == 1) {
7746 selectedStars = 0;
7747 }
7748 $("#'.$keyprefix.$key.$keysuffix.'").val(selectedStars);
7749 container.find(".star").each(function() {
7750 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
7751 });
7752 });
7753 });
7754 </script>';
7755 } elseif (preg_match('/^double(\‍([0-9],[0-9]\‍)){0,1}/', (string) $type)) {
7756 if (!empty($value)) { // $value in memory is a php numeric, we format it into user number format.
7757 $value = price($value);
7758 }
7759 $out = '<input type="text" class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.$value.'" '.($moreparam ? $moreparam : '').'> ';
7760 } elseif ($type == 'select') { // combo list
7761 $out = '';
7762 if (!empty($conf->use_javascript_ajax) && !getDolGlobalString('MAIN_EXTRAFIELDS_DISABLE_SELECT2')) {
7763 include_once DOL_DOCUMENT_ROOT.'/core/lib/ajax.lib.php';
7764 $out .= ajax_combobox($keyprefix.$key.$keysuffix, array(), 0);
7765 }
7766
7767 $tmpselect = '';
7768 $nbchoice = 0;
7769 foreach ($param['options'] as $keyb => $valb) {
7770 if ((string) $keyb == '') {
7771 continue;
7772 }
7773 if (strpos($valb, "|") !== false) {
7774 list($valb, $parent) = explode('|', $valb);
7775 }
7776 $nbchoice++;
7777 $tmpselect .= '<option value="'.$keyb.'"';
7778 $tmpselect .= (((string) $value == (string) $keyb) ? ' selected' : '');
7779 if (!empty($parent)) {
7780 $isDependList = 1;
7781 }
7782 $tmpselect .= (!empty($parent) ? ' parent="'.$parent.'"' : '');
7783 $tmpselect .= '>'.$langs->trans($valb).'</option>';
7784 }
7785
7786 $out .= '<select class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" '.($moreparam ? $moreparam : '').'>';
7787 if ((!isset($this->fields[$key]['default'])) || ($this->fields[$key]['notnull'] != 1) || $nbchoice >= 2) {
7788 $out .= '<option value="0">&nbsp;</option>';
7789 }
7790 $out .= $tmpselect;
7791 $out .= '</select>';
7792 } elseif ($type == 'sellist') {
7793 $out = '';
7794 if (!empty($conf->use_javascript_ajax) && !getDolGlobalString('MAIN_EXTRAFIELDS_DISABLE_SELECT2')) {
7795 include_once DOL_DOCUMENT_ROOT.'/core/lib/ajax.lib.php';
7796 $out .= ajax_combobox($keyprefix.$key.$keysuffix, array(), 0);
7797 }
7798
7799 $out .= '<select class="flat '.$morecss.' maxwidthonsmartphone" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" '.($moreparam ? $moreparam : '').'>';
7800 if (is_array($param['options'])) {
7801 $tmpparamoptions = array_keys($param['options']);
7802 $paramoptions = preg_split('/[\r\n]+/', $tmpparamoptions[0]);
7803
7804 $InfoFieldList = explode(":", $paramoptions[0], 5);
7805 // 0 : tableName
7806 // 1 : label field name
7807 // 2 : key fields name (if different of rowid)
7808 // optional parameters...
7809 // 3 : key field parent (for dependent lists). How this is used ?
7810 // 4 : where clause filter on column or table extrafield, syntax field='value' or extra.field=value. Or use USF on a second line separated by "\n".
7811 // 5 : string category type. This replace the filter.
7812 // 6 : ids categories list separated by comma for category root. This replace the filter.
7813 // 7 : sort field
7814
7815 // If there is filter
7816 if (! empty($InfoFieldList[4])) {
7817 $pos = 0;
7818 $parenthesisopen = 0;
7819 while (substr($InfoFieldList[4], $pos, 1) !== '' && ($parenthesisopen || $pos == 0 || substr($InfoFieldList[4], $pos, 1) != ':')) {
7820 if (substr($InfoFieldList[4], $pos, 1) == '(') {
7821 $parenthesisopen++;
7822 }
7823 if (substr($InfoFieldList[4], $pos, 1) == ')') {
7824 $parenthesisopen--;
7825 }
7826 $pos++;
7827 }
7828 $tmpbefore = substr($InfoFieldList[4], 0, $pos);
7829 $tmpafter = substr($InfoFieldList[4], $pos + 1);
7830 //var_dump($InfoFieldList[4].' -> '.$pos); var_dump($tmpafter);
7831 $InfoFieldList[4] = $tmpbefore;
7832 if ($tmpafter !== '') {
7833 $InfoFieldList = array_merge($InfoFieldList, explode(':', $tmpafter));
7834 }
7835 //var_dump($InfoFieldList);
7836
7837 // Fix better compatibility with some old extrafield syntax filter "(field=123)"
7838 $reg = array();
7839 if (preg_match('/^\‍(?([a-z0-9]+)([=<>]+)(\d+)\‍)?$/i', $InfoFieldList[4], $reg)) {
7840 $InfoFieldList[4] = '('.$reg[1].':'.$reg[2].':'.$reg[3].')';
7841 }
7842
7843 //var_dump($InfoFieldList);
7844 }
7845
7846 //$Usf = empty($paramoptions[1]) ? '' :$paramoptions[1];
7847
7848 $parentName = '';
7849 $parentField = '';
7850
7851 $keyList = (empty($InfoFieldList[2]) ? 'rowid' : $InfoFieldList[2].' as rowid');
7852
7853 if (count($InfoFieldList) > 4 && !empty($InfoFieldList[4])) {
7854 if (strpos($InfoFieldList[4], 'extra.') !== false) {
7855 $keyList = 'main.'.$InfoFieldList[2].' as rowid';
7856 } else {
7857 $keyList = $InfoFieldList[2].' as rowid';
7858 }
7859 }
7860 if (count($InfoFieldList) > 3 && !empty($InfoFieldList[3])) {
7861 list($parentName, $parentField) = explode('|', $InfoFieldList[3]);
7862 $keyList .= ', '.$parentField;
7863 }
7864
7865 $filter_categorie = false;
7866 if (count($InfoFieldList) > 5) {
7867 if ($InfoFieldList[0] == 'categorie') {
7868 $filter_categorie = true;
7869 }
7870 }
7871
7872 if (!$filter_categorie) {
7873 $fields_label = explode('|', $InfoFieldList[1]);
7874 if (is_array($fields_label)) {
7875 $keyList .= ', ';
7876 $keyList .= implode(', ', $fields_label);
7877 }
7878
7879 $sqlwhere = '';
7880 $sql = "SELECT " . $keyList;
7881 $sql .= " FROM " . $this->db->prefix() . $InfoFieldList[0];
7882
7883 if (!empty($InfoFieldList[4])) {
7884 // can use SELECT request
7885 if (strpos($InfoFieldList[4], '$SEL$') !== false) {
7886 $InfoFieldList[4] = str_replace('$SEL$', 'SELECT', $InfoFieldList[4]);
7887 }
7888
7889 // current object id can be use into filter
7890 if (strpos($InfoFieldList[4], '$ID$') !== false && !empty($objectid)) {
7891 $InfoFieldList[4] = str_replace('$ID$', (string) $objectid, $InfoFieldList[4]);
7892 } else {
7893 $InfoFieldList[4] = str_replace('$ID$', '0', $InfoFieldList[4]);
7894 }
7895
7896 // We have to join on extrafield table
7897 $errstr = '';
7898 if (strpos($InfoFieldList[4], 'extra') !== false) {
7899 $sql .= " as main, " . $this->db->sanitize($this->db->prefix() . $InfoFieldList[0]) . "_extrafields as extra";
7900 $sqlwhere .= " WHERE extra.fk_object = main." . $this->db->sanitize($InfoFieldList[2]);
7901 $sqlwhere .= " AND " . forgeSQLFromUniversalSearchCriteria($InfoFieldList[4], $errstr, 1);
7902 } else {
7903 $sqlwhere .= " WHERE " . forgeSQLFromUniversalSearchCriteria($InfoFieldList[4], $errstr, 1);
7904 }
7905 } else {
7906 $sqlwhere .= ' WHERE 1=1';
7907 }
7908
7909 // Add Usf filter on second line
7910 /*
7911 if ($Usf) {
7912 $errorstr = '';
7913 $sqlusf .= forgeSQLFromUniversalSearchCriteria($Usf, $errorstr);
7914 if (!$errorstr) {
7915 $sqlwhere .= $sqlusf;
7916 } else {
7917 $sqlwhere .= " AND invalid_usf_filter_of_extrafield";
7918 }
7919 }
7920 */
7921
7922 // Some tables may have field, some other not. For the moment we disable it.
7923 if (in_array($InfoFieldList[0], array('tablewithentity'))) {
7924 $sqlwhere .= " AND entity = " . ((int) $conf->entity);
7925 }
7926 $sql .= $sqlwhere;
7927
7928 // Note: $InfoFieldList can be 'sellist:TableName:LabelFieldName[:KeyFieldName[:KeyFieldParent[:Filter[:CategoryIdType[:CategoryIdList[:Sortfield]]]]]]'
7929 if (isset($InfoFieldList[7]) && preg_match('/^[a-z0-9_\-,]+$/i', $InfoFieldList[7])) {
7930 $sql .= " ORDER BY ".$this->db->escape($InfoFieldList[7]);
7931 } else {
7932 $sql .= " ORDER BY ".$this->db->sanitize(implode(', ', $fields_label));
7933 }
7934
7935 dol_syslog(get_class($this) . '::showInputField type=sellist', LOG_DEBUG);
7936 $resql = $this->db->query($sql);
7937 if ($resql) {
7938 $out .= '<option value="0">&nbsp;</option>';
7939 $num = $this->db->num_rows($resql);
7940 $i = 0;
7941 while ($i < $num) {
7942 $labeltoshow = '';
7943 $obj = $this->db->fetch_object($resql);
7944
7945 // Several field into label (eq table:code|libelle:rowid)
7946 $notrans = false;
7947 $fields_label = explode('|', $InfoFieldList[1]);
7948 if (count($fields_label) > 1) {
7949 $notrans = true;
7950 foreach ($fields_label as $field_toshow) {
7951 $labeltoshow .= $obj->$field_toshow . ' ';
7952 }
7953 } else {
7954 $labeltoshow = $obj->{$InfoFieldList[1]};
7955 }
7956 $labeltoshow = dol_trunc($labeltoshow, 45);
7957
7958 if ($value == $obj->rowid) {
7959 foreach ($fields_label as $field_toshow) {
7960 $translabel = $langs->trans($obj->$field_toshow);
7961 if ($translabel != $obj->$field_toshow) {
7962 $labeltoshow = dol_trunc($translabel) . ' ';
7963 } else {
7964 $labeltoshow = dol_trunc($obj->$field_toshow) . ' ';
7965 }
7966 }
7967 $out .= '<option value="' . $obj->rowid . '" selected>' . $labeltoshow . '</option>';
7968 } else {
7969 if (!$notrans) {
7970 $translabel = $langs->trans($obj->{$InfoFieldList[1]});
7971 if ($translabel != $obj->{$InfoFieldList[1]}) {
7972 $labeltoshow = dol_trunc($translabel, 18);
7973 } else {
7974 $labeltoshow = dol_trunc($obj->{$InfoFieldList[1]});
7975 }
7976 }
7977 if (empty($labeltoshow)) {
7978 $labeltoshow = '(not defined)';
7979 }
7980 if ($value == $obj->rowid) {
7981 $out .= '<option value="' . $obj->rowid . '" selected>' . $labeltoshow . '</option>';
7982 }
7983
7984 if (!empty($InfoFieldList[3]) && $parentField) {
7985 $parent = $parentName . ':' . $obj->{$parentField};
7986 $isDependList = 1;
7987 }
7988
7989 $out .= '<option value="' . $obj->rowid . '"';
7990 $out .= ($value == $obj->rowid ? ' selected' : '');
7991 $out .= (!empty($parent) ? ' parent="' . $parent . '"' : '');
7992 $out .= '>' . $labeltoshow . '</option>';
7993 }
7994
7995 $i++;
7996 }
7997 $this->db->free($resql);
7998 } else {
7999 print 'Error in request ' . $sql . ' ' . $this->db->lasterror() . '. Check setup of extra parameters.<br>';
8000 }
8001 } else {
8002 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
8003 $data = $form->select_all_categories(Categorie::$MAP_ID_TO_CODE[$InfoFieldList[5]], '', 'parent', 64, $InfoFieldList[6], 1, 1);
8004 $out .= '<option value="0">&nbsp;</option>';
8005 foreach ($data as $data_key => $data_value) {
8006 $out .= '<option value="' . $data_key . '"';
8007 $out .= ($value == $data_key ? ' selected' : '');
8008 $out .= '>' . $data_value . '</option>';
8009 }
8010 }
8011 }
8012 $out .= '</select>';
8013 } elseif ($type == 'checkbox') {
8014 $value_arr = explode(',', $value);
8015 $out = $form->multiselectarray($keyprefix.$key.$keysuffix, (empty($param['options']) ? null : $param['options']), $value_arr, 0, 0, $morecss, 0, '100%');
8016 } elseif ($type == 'radio') {
8017 $out = '';
8018 foreach ($param['options'] as $keyopt => $valopt) {
8019 $out .= '<input class="flat '.$morecss.'" type="radio" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" '.($moreparam ? $moreparam : '');
8020 $out .= ' value="'.$keyopt.'"';
8021 $out .= ' id="'.$keyprefix.$key.$keysuffix.'_'.$keyopt.'"';
8022 $out .= ($value == $keyopt ? 'checked' : '');
8023 $out .= '/><label for="'.$keyprefix.$key.$keysuffix.'_'.$keyopt.'">'.$valopt.'</label><br>';
8024 }
8025 } elseif ($type == 'chkbxlst') {
8026 if (is_array($value)) {
8027 $value_arr = $value;
8028 } else {
8029 $value_arr = explode(',', $value);
8030 }
8031
8032 if (is_array($param['options'])) {
8033 $tmpparamoptions = array_keys($param['options']);
8034 $paramoptions = preg_split('/[\r\n]+/', $tmpparamoptions[0]);
8035
8036 $InfoFieldList = explode(":", $paramoptions[0], 5);
8037 // 0 : tableName
8038 // 1 : label field name
8039 // 2 : key fields name (if different of rowid)
8040 // optional parameters...
8041 // 3 : key field parent (for dependent lists). How this is used ?
8042 // 4 : where clause filter on column or table extrafield, syntax field='value' or extra.field=value. Or use USF on a second line separated by "\n".
8043 // 5 : string category type. This replace the filter.
8044 // 6 : ids categories list separated by comma for category root. This replace the filter.
8045 // 7 : sort field
8046
8047 // If there is a filter
8048 if (! empty($InfoFieldList[4])) {
8049 $pos = 0;
8050 $parenthesisopen = 0;
8051 while (substr($InfoFieldList[4], $pos, 1) !== '' && ($parenthesisopen || $pos == 0 || substr($InfoFieldList[4], $pos, 1) != ':')) {
8052 if (substr($InfoFieldList[4], $pos, 1) == '(') {
8053 $parenthesisopen++;
8054 }
8055 if (substr($InfoFieldList[4], $pos, 1) == ')') {
8056 $parenthesisopen--;
8057 }
8058 $pos++;
8059 }
8060 $tmpbefore = substr($InfoFieldList[4], 0, $pos);
8061 $tmpafter = substr($InfoFieldList[4], $pos + 1);
8062 //var_dump($InfoFieldList[4].' -> '.$pos); var_dump($tmpafter);
8063 $InfoFieldList[4] = $tmpbefore;
8064 if ($tmpafter !== '') {
8065 $InfoFieldList = array_merge($InfoFieldList, explode(':', $tmpafter));
8066 }
8067
8068 // Fix better compatibility with some old extrafield syntax filter "(field=123)"
8069 $reg = array();
8070 if (preg_match('/^\‍(?([a-z0-9]+)([=<>]+)(\d+)\‍)?$/i', $InfoFieldList[4], $reg)) {
8071 $InfoFieldList[4] = '('.$reg[1].':'.$reg[2].':'.$reg[3].')';
8072 }
8073
8074 //var_dump($InfoFieldList);
8075 }
8076
8077 //$Usf = empty($paramoptions[1]) ? '' :$paramoptions[1];
8078
8079 '@phan-var-force array{0:string,1:string,2:string,3:string,3:string,5:string,6:string} $InfoFieldList';
8080
8081 $parentName = '';
8082 $parentField = '';
8083
8084 $keyList = (empty($InfoFieldList[2]) ? 'rowid' : $InfoFieldList[2].' as rowid');
8085
8086 if (count($InfoFieldList) > 3 && !empty($InfoFieldList[3])) {
8087 list($parentName, $parentField) = explode('|', $InfoFieldList[3]);
8088 $keyList .= ', '.$parentField;
8089 }
8090 if (count($InfoFieldList) > 4 && !empty($InfoFieldList[4])) {
8091 if (strpos($InfoFieldList[4], 'extra.') !== false) {
8092 $keyList = 'main.'.$InfoFieldList[2].' as rowid';
8093 } else {
8094 $keyList = $InfoFieldList[2].' as rowid';
8095 }
8096 }
8097
8098 $filter_categorie = false;
8099 if (count($InfoFieldList) > 5) {
8100 if ($InfoFieldList[0] == 'categorie') {
8101 $filter_categorie = true;
8102 }
8103 }
8104
8105 // Common filter
8106 if (!$filter_categorie) {
8107 $fields_label = explode('|', $InfoFieldList[1]);
8108 if (is_array($fields_label)) {
8109 $keyList .= ', ';
8110 $keyList .= implode(', ', $fields_label);
8111 }
8112
8113 $sqlwhere = '';
8114 $sql = "SELECT " . $keyList;
8115 $sql .= ' FROM ' . $this->db->prefix() . $InfoFieldList[0];
8116
8117 if (!empty($InfoFieldList[4])) {
8118 // can use SELECT request
8119 if (strpos($InfoFieldList[4], '$SEL$') !== false) {
8120 $InfoFieldList[4] = str_replace('$SEL$', 'SELECT', $InfoFieldList[4]);
8121 }
8122
8123 // current object id can be use into filter
8124 if (strpos($InfoFieldList[4], '$ID$') !== false && !empty($objectid)) {
8125 $InfoFieldList[4] = str_replace('$ID$', (string) $objectid, $InfoFieldList[4]);
8126 } else {
8127 $InfoFieldList[4] = str_replace('$ID$', '0', $InfoFieldList[4]);
8128 }
8129
8130 // We have to join on extrafield table
8131 $errstr = '';
8132 if (strpos($InfoFieldList[4], 'extra') !== false) {
8133 $sql .= ' as main, ' . $this->db->sanitize($this->db->prefix() . $InfoFieldList[0]) . '_extrafields as extra';
8134 $sqlwhere .= " WHERE extra.fk_object = main." . $this->db->sanitize($InfoFieldList[2]);
8135 $sqlwhere .= " AND " . $InfoFieldList[4];
8136 } else {
8137 $sqlwhere .= " WHERE " . $InfoFieldList[4];
8138 }
8139 } else {
8140 $sqlwhere .= ' WHERE 1=1';
8141 }
8142
8143 // Add Usf filter on second line
8144 /*
8145 if ($Usf) {
8146 $errorstr = '';
8147 $sqlusf .= forgeSQLFromUniversalSearchCriteria($Usf, $errorstr);
8148 if (!$errorstr) {
8149 $sqlwhere .= $sqlusf;
8150 } else {
8151 $sqlwhere .= " AND invalid_usf_filter_of_extrafield";
8152 }
8153 }
8154 */
8155
8156 // Some tables may have field, some other not. For the moment we disable it.
8157 if (in_array($InfoFieldList[0], array('tablewithentity'))) {
8158 $sqlwhere .= " AND entity = " . ((int) $conf->entity);
8159 }
8160 // $sql.=preg_replace('/^ AND /','',$sqlwhere);
8161 // print $sql;
8162
8163 $sql .= $sqlwhere;
8164
8165 dol_syslog(get_class($this) . '::showInputField type=chkbxlst', LOG_DEBUG);
8166
8167 $resql = $this->db->query($sql);
8168 if ($resql) {
8169 $num = $this->db->num_rows($resql);
8170 $i = 0;
8171
8172 $data = array();
8173
8174 while ($i < $num) {
8175 $labeltoshow = '';
8176 $obj = $this->db->fetch_object($resql);
8177
8178 $notrans = false;
8179 // Several field into label (eq table:code|libelle:rowid)
8180 $fields_label = explode('|', $InfoFieldList[1]);
8181 if (count($fields_label) > 1) {
8182 $notrans = true;
8183 foreach ($fields_label as $field_toshow) {
8184 $labeltoshow .= $obj->$field_toshow . ' ';
8185 }
8186 } else {
8187 $labeltoshow = $obj->{$InfoFieldList[1]};
8188 }
8189 $labeltoshow = dol_trunc($labeltoshow, 45);
8190
8191 if (is_array($value_arr) && in_array($obj->rowid, $value_arr)) {
8192 foreach ($fields_label as $field_toshow) {
8193 $translabel = $langs->trans($obj->$field_toshow);
8194 if ($translabel != $obj->$field_toshow) {
8195 $labeltoshow = dol_trunc($translabel, 18) . ' ';
8196 } else {
8197 $labeltoshow = dol_trunc($obj->$field_toshow, 18) . ' ';
8198 }
8199 }
8200
8201 $data[$obj->rowid] = $labeltoshow;
8202 } else {
8203 if (!$notrans) {
8204 $translabel = $langs->trans($obj->{$InfoFieldList[1]});
8205 if ($translabel != $obj->{$InfoFieldList[1]}) {
8206 $labeltoshow = dol_trunc($translabel, 18);
8207 } else {
8208 $labeltoshow = dol_trunc($obj->{$InfoFieldList[1]}, 18);
8209 }
8210 }
8211 if (empty($labeltoshow)) {
8212 $labeltoshow = '(not defined)';
8213 }
8214
8215 if (is_array($value_arr) && in_array($obj->rowid, $value_arr)) {
8216 $data[$obj->rowid] = $labeltoshow;
8217 }
8218
8219 if (!empty($InfoFieldList[3]) && $parentField) {
8220 $parent = $parentName . ':' . $obj->{$parentField};
8221 $isDependList = 1;
8222 }
8223
8224 $data[(int) $obj->rowid] = $labeltoshow;
8225 }
8226
8227 $i++;
8228 }
8229 $this->db->free($resql);
8230
8231 $out = $form->multiselectarray($keyprefix . $key . $keysuffix, $data, $value_arr, 0, 0, $morecss, 0, '100%');
8232 } else {
8233 print 'Error in request ' . $sql . ' ' . $this->db->lasterror() . '. Check setup of extra parameters.<br>';
8234 }
8235 } else {
8236 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
8237 $data = $form->select_all_categories(Categorie::$MAP_ID_TO_CODE[(int) $InfoFieldList[5]], '', 'parent', 64, $InfoFieldList[6], 1, 1);
8238 $out = $form->multiselectarray($keyprefix . $key . $keysuffix, $data, $value_arr, 0, 0, $morecss, 0, '100%');
8239 }
8240 }
8241 } elseif ($type == 'link') {
8242 // $param_list='ObjectName:classPath[:AddCreateButtonOrNot[:Filter[:Sortfield]]]'
8243 // Filter can contains some ':' inside.
8244 $param_list = array_keys($param['options']);
8245 $param_list_array = explode(':', $param_list[0], 4);
8246
8247 $showempty = (($required && $default != '') ? 0 : 1);
8248
8249 if (!preg_match('/search_/', $keyprefix)) {
8250 if (!empty($param_list_array[2])) { // If the entry into $fields is set to add a create button
8251 // @phan-suppress-next-line PhanTypeMismatchProperty
8252 if (!empty($this->fields[$key]['picto'])) {
8253 $morecss .= ' widthcentpercentminusxx';
8254 } else {
8255 $morecss .= ' widthcentpercentminusx';
8256 }
8257 } else {
8258 // @phan-suppress-next-line PhanTypeMismatchProperty
8259 if (!empty($this->fields[$key]['picto'])) {
8260 $morecss .= ' widthcentpercentminusx';
8261 }
8262 }
8263 }
8264 $objectfield = $this->element.($this->module ? '@'.$this->module : '').':'.$key.$keysuffix;
8265 $out = $form->selectForForms($param_list_array[0], $keyprefix.$key.$keysuffix, $value, $showempty, '', '', $morecss, $moreparam, 0, (empty($val['disabled']) ? 0 : 1), '', $objectfield);
8266
8267 if (!empty($param_list_array[2])) { // If the entry into $fields is set, we must add a create button
8268 if ((!GETPOSTISSET('backtopage') || strpos(GETPOST('backtopage'), $_SERVER['PHP_SELF']) === 0) // // To avoid to open several times the 'Plus' button (we accept only one level)
8269 && empty($val['disabled']) && empty($nonewbutton)) { // and to avoid to show the button if the field is protected by a "disabled".
8270 list($class, $classfile) = explode(':', $param_list[0]);
8271 if (file_exists(dol_buildpath(dirname(dirname($classfile)).'/card.php'))) {
8272 $url_path = dol_buildpath(dirname(dirname($classfile)).'/card.php', 1);
8273 } else {
8274 $url_path = dol_buildpath(dirname(dirname($classfile)).'/'.strtolower($class).'_card.php', 1);
8275 }
8276 $paramforthenewlink = '';
8277 $paramforthenewlink .= (GETPOSTISSET('action') ? '&action='.GETPOST('action', 'aZ09') : '');
8278 $paramforthenewlink .= (GETPOSTISSET('id') ? '&id='.GETPOSTINT('id') : '');
8279 $paramforthenewlink .= (GETPOSTISSET('origin') ? '&origin='.GETPOST('origin', 'aZ09') : '');
8280 $paramforthenewlink .= (GETPOSTISSET('originid') ? '&originid='.GETPOSTINT('originid') : '');
8281 $paramforthenewlink .= '&fk_'.strtolower($class).'=--IDFORBACKTOPAGE--';
8282 // TODO Add JavaScript code to add input fields already filled into $paramforthenewlink so we won't loose them when going back to main page
8283 $out .= '<a class="butActionNew" title="'.$langs->trans("New").'" href="'.$url_path.'?action=create&backtopage='.urlencode($_SERVER['PHP_SELF'].($paramforthenewlink ? '?'.$paramforthenewlink : '')).'"><span class="fa fa-plus-circle valignmiddle"></span></a>';
8284 }
8285 }
8286 } elseif ($type == 'password') {
8287 // If prefix is 'search_', field is used as a filter, we use a common text field.
8288 if ($keyprefix.$key.$keysuffix == 'pass_crypted') {
8289 $out = '<input type="'.($keyprefix == 'search_' ? 'text' : 'password').'" class="flat '.$morecss.'" name="pass" id="pass" value="" '.($moreparam ? $moreparam : '').'>';
8290 $out .= '<input type="hidden" name="pass_crypted" id="pass_crypted" value="'.$value.'" '.($moreparam ? $moreparam : '').'>';
8291 } else {
8292 $out = '<input type="'.($keyprefix == 'search_' ? 'text' : 'password').'" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'" value="'.$value.'" '.($moreparam ? $moreparam : '').'>';
8293 }
8294 } elseif ($type == 'array') {
8295 $newval = $val;
8296 $newval['type'] = 'varchar(256)';
8297
8298 $out = '';
8299 if (!empty($value)) {
8300 foreach ($value as $option) {
8301 $out .= '<span><a class="'.dol_escape_htmltag($keyprefix.$key.$keysuffix).'_del" href="javascript:;"><span class="fa fa-minus-circle valignmiddle"></span></a> ';
8302 $out .= $this->showInputField($newval, $keyprefix.$key.$keysuffix.'[]', $option, $moreparam, '', '', $morecss).'<br></span>';
8303 }
8304 }
8305 $out .= '<a id="'.dol_escape_htmltag($keyprefix.$key.$keysuffix).'_add" href="javascript:;"><span class="fa fa-plus-circle valignmiddle"></span></a>';
8306
8307 $newInput = '<span><a class="'.dol_escape_htmltag($keyprefix.$key.$keysuffix).'_del" href="javascript:;"><span class="fa fa-minus-circle valignmiddle"></span></a> ';
8308 $newInput .= $this->showInputField($newval, $keyprefix.$key.$keysuffix.'[]', '', $moreparam, '', '', $morecss).'<br></span>';
8309
8310 if (!empty($conf->use_javascript_ajax)) {
8311 $out .= '
8312 <script nonce="'.getNonce().'">
8313 $(document).ready(function() {
8314 $("a#'.dol_escape_js($keyprefix.$key.$keysuffix).'_add").click(function() {
8315 $("'.dol_escape_js($newInput).'").insertBefore(this);
8316 });
8317
8318 $(document).on("click", "a.'.dol_escape_js($keyprefix.$key.$keysuffix).'_del", function() {
8319 $(this).parent().remove();
8320 });
8321 });
8322 </script>';
8323 }
8324 }
8325 if (!empty($hidden)) {
8326 $out = '<input type="hidden" value="'.$value.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.'"/>';
8327 }
8328
8329 if ($isDependList == 1) {
8330 $out .= $this->getJSListDependancies('_common');
8331 }
8332 /* Add comments
8333 if ($type == 'date') $out.=' (YYYY-MM-DD)';
8334 elseif ($type == 'datetime') $out.=' (YYYY-MM-DD HH:MM:SS)';
8335 */
8336
8337 // Display error message for field
8338 if (!empty($fieldValidationErrorMsg) && function_exists('getFieldErrorIcon')) {
8339 $out .= ' '.getFieldErrorIcon($fieldValidationErrorMsg);
8340 }
8341
8342 return $out;
8343 }
8344
8358 public function showOutputField($val, $key, $value, $moreparam = '', $keysuffix = '', $keyprefix = '', $morecss = '')
8359 {
8360 global $conf, $langs, $form;
8361
8362 // TODO pass the current object as a parameter to give more flexibility (like disable ajax update when canAlwaysBeEdited is false and $object->status is not draft...)
8363
8364 if (!is_object($form)) {
8365 require_once DOL_DOCUMENT_ROOT.'/core/class/html.form.class.php';
8366 $form = new Form($this->db);
8367 }
8368
8369 //$label = empty($val['label']) ? '' : $val['label'];
8370 $type = empty($val['type']) ? '' : $val['type'];
8371 $size = empty($val['css']) ? '' : $val['css'];
8372 $reg = array();
8373
8374 // Convert var to be able to share same code than showOutputField of extrafields
8375 if (preg_match('/varchar\‍((\d+)\‍)/', $type, $reg)) {
8376 $type = 'varchar'; // convert varchar(xx) int varchar
8377 $size = $reg[1];
8378 } elseif (preg_match('/varchar/', $type)) {
8379 $type = 'varchar'; // convert varchar(xx) int varchar
8380 }
8381 if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
8382 // @phan-suppress-next-line PhanTypeMismatchProperty
8383 if (empty($this->fields[$key]['multiinput'])) {
8384 $type = (($this->fields[$key]['type'] == 'checkbox') ? $this->fields[$key]['type'] : 'select');
8385 }
8386 }
8387 if (preg_match('/^integer:(.*):(.*)/i', $val['type'], $reg)) {
8388 $type = 'link';
8389 }
8390
8391 $default = empty($val['default']) ? '' : $val['default'];
8392 $computed = empty($val['computed']) ? '' : $val['computed'];
8393 $unique = empty($val['unique']) ? '' : $val['unique'];
8394 $required = empty($val['required']) ? '' : $val['required'];
8395 $param = array();
8396 $param['options'] = array();
8397
8398 if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
8399 $param['options'] = $val['arrayofkeyval'];
8400 }
8401 if (preg_match('/^integer:([^:]*):([^:]*)/i', $val['type'], $reg)) { // ex: integer:User:user/class/user.class.php
8402 $type = 'link';
8403 $stringforoptions = $reg[1].':'.$reg[2];
8404 // Special case: Force addition of getnomurlparam1 to -1 for users
8405 if ($reg[1] == 'User') {
8406 $stringforoptions .= ':#getnomurlparam1=-1';
8407 }
8408 $param['options'] = array($stringforoptions => $stringforoptions);
8409 } elseif (preg_match('/^sellist:(.*):(.*):(.*):(.*)/i', $val['type'], $reg)) {
8410 $param['options'] = array($reg[1].':'.$reg[2].':'.$reg[3].':'.$reg[4] => 'N');
8411 $type = 'sellist';
8412 } elseif (preg_match('/^sellist:(.*):(.*):(.*)/i', $val['type'], $reg)) {
8413 $param['options'] = array($reg[1].':'.$reg[2].':'.$reg[3] => 'N');
8414 $type = 'sellist';
8415 } elseif (preg_match('/^sellist:(.*):(.*)/i', $val['type'], $reg)) {
8416 $param['options'] = array($reg[1].':'.$reg[2] => 'N');
8417 $type = 'sellist';
8418 } elseif (preg_match('/^chkbxlst:(.*)/i', $val['type'], $reg)) {
8419 $param['options'] = array($reg[1] => 'N');
8420 $type = 'chkbxlst';
8421 } elseif (preg_match('/stars\‍((\d+)\‍)/', $val['type'], $reg)) {
8422 $param['options'] = array();
8423 $type = 'stars';
8424 $size = $reg[1];
8425 }
8426
8427 $langfile = empty($val['langfile']) ? '' : $val['langfile'];
8428 $list = (empty($val['list']) ? '' : $val['list']);
8429 $help = (empty($val['help']) ? '' : $val['help']);
8430 $hidden = (($val['visible'] == 0) ? 1 : 0); // If zero, we are sure it is hidden, otherwise we show. If it depends on mode (view/create/edit form or list, this must be filtered by caller)
8431
8432 if ($hidden) {
8433 return '';
8434 }
8435
8436 // If field is a computed field, value must become result of compute
8437 if ($computed) {
8438 // Make the eval of compute string
8439 //var_dump($computed);
8440 $value = dol_eval($computed, 1, 0, '2');
8441 }
8442
8443 if (empty($morecss)) {
8444 if ($type == 'date') {
8445 $morecss = 'minwidth100imp';
8446 } elseif ($type == 'datetime' || $type == 'timestamp') {
8447 $morecss = 'minwidth200imp';
8448 } elseif (in_array($type, array('int', 'double', 'price'))) {
8449 $morecss = 'maxwidth75';
8450 } elseif ($type == 'url') {
8451 $morecss = 'minwidth400';
8452 } elseif ($type == 'boolean') {
8453 $morecss = '';
8454 } else {
8455 if (is_numeric($size) && round((float) $size) < 12) {
8456 $morecss = 'minwidth100';
8457 } elseif (is_numeric($size) && round((float) $size) <= 48) {
8458 $morecss = 'minwidth200';
8459 } else {
8460 $morecss = 'minwidth400';
8461 }
8462 }
8463 }
8464
8465 // Format output value differently according to properties of field
8466 if (in_array($key, array('rowid', 'ref')) && method_exists($this, 'getNomUrl')) {
8467 // @phan-suppress-next-line PhanTypeMismatchProperty
8468 if ($key != 'rowid' || empty($this->fields['ref'])) { // If we want ref field or if we want ID and there is no ref field, we show the link.
8469 $value = $this->getNomUrl(1, '', 0, '', 1);
8470 }
8471 } elseif ($key == 'status' && method_exists($this, 'getLibStatut')) {
8472 $value = $this->getLibStatut(3);
8473 } elseif ($type == 'date') {
8474 if (!empty($value)) {
8475 $value = dol_print_date($value, 'day'); // We suppose dates without time are always gmt (storage of course + output)
8476 } else {
8477 $value = '';
8478 }
8479 } elseif ($type == 'datetime' || $type == 'timestamp') {
8480 if (!empty($value)) {
8481 $value = dol_print_date($value, 'dayhour', 'tzuserrel');
8482 } else {
8483 $value = '';
8484 }
8485 } elseif ($type == 'duration') {
8486 include_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
8487 if (!is_null($value) && $value !== '') {
8488 $value = convertSecondToTime((int) $value, 'allhourmin');
8489 }
8490 } elseif ($type == 'double' || $type == 'real') {
8491 if (!is_null($value) && $value !== '') {
8492 $value = price($value);
8493 }
8494 } elseif ($type == 'boolean') {
8495 $checked = '';
8496 if (!empty($value)) {
8497 $checked = ' checked ';
8498 }
8499 if (getDolGlobalInt('MAIN_OPTIMIZEFORTEXTBROWSER') < 2) {
8500 $value = '<input type="checkbox" '.$checked.' '.($moreparam ? $moreparam : '').' readonly disabled>';
8501 } else {
8502 $value = yn($value ? 1 : 0);
8503 }
8504 } elseif ($type == 'mail' || $type == 'email') {
8505 $value = dol_print_email($value, 0, 0, 0, 64, 1, 1);
8506 } elseif ($type == 'url') {
8507 $value = dol_print_url($value, '_blank', 32, 1);
8508 } elseif ($type == 'phone') {
8509 $value = dol_print_phone($value, '', 0, 0, '', '&nbsp;', 'phone');
8510 } elseif ($type == 'ip') {
8511 $value = dol_print_ip($value, 0);
8512 } elseif ($type == 'stars') {
8513 $value = '<input type="hidden" class="flat '.$morecss.'" name="'.$keyprefix.$key.$keysuffix.'" id="'.$keyprefix.$key.$keysuffix.$this->id.'" value="'.dol_escape_htmltag($value).'"'.($moreparam ? $moreparam : '').'>';
8514 $value .= '<div class="star-selection" id="'.$keyprefix.$key.$keysuffix.$this->id.'_selection">';
8515 $i = 1;
8516 while ($i <= $size) {
8517 $value .= '<span class="star" data-value="'.$i.'">'.img_picto('', 'fontawesome_star_fas').'</span>';
8518 $i++;
8519 }
8520 $value .= '</div>';
8521 $value .= '<script>
8522 $(document).ready(function() {
8523 let container = $("#'.$keyprefix.$key.$keysuffix.$this->id.'_selection");
8524 let selectedStars = parseInt($("#'.$keyprefix.$key.$keysuffix.$this->id.'").val()) || 0;
8525 container.find(".star").each(function() {
8526 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
8527 });
8528 container.find(".star").on("mouseover", function() {
8529 let selectedStar = $(this).data("value");
8530 container.find(".star").each(function() {
8531 $(this).toggleClass("active", $(this).data("value") <= selectedStar);
8532 });
8533 });
8534 container.on("mouseout", function() {
8535 container.find(".star").each(function() {
8536 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
8537 });
8538 });
8539 container.find(".star").off("click").on("click", function() {
8540 selectedStars = $(this).data("value");
8541 if (selectedStars == 1 && $("#'.$keyprefix.$key.$keysuffix.$this->id.'").val() == 1) {
8542 selectedStars = 0;
8543 }
8544 container.find("#'.$keyprefix.$key.$keysuffix.$this->id.'").val(selectedStars);
8545 container.find(".star").each(function() {
8546 $(this).toggleClass("active", $(this).data("value") <= selectedStars);
8547 });
8548 $.ajax({
8549 url: "ajax/'.$this->element.'.php",
8550 method: "POST",
8551 data: {
8552 objectId: "'.$this->id.'",
8553 field: "'.$keyprefix.$key.$keysuffix.'",
8554 value: selectedStars,
8555 token: "'.newToken().'"
8556 },
8557 success: function(response) {
8558 var res = JSON.parse(response);
8559 console[res.status === "success" ? "log" : "error"](res.message);
8560 },
8561 error: function(xhr, status, error) {
8562 console.log("Ajax request failed while updating '.$keyprefix.$key.$keysuffix.':", error);
8563 }
8564 });
8565 });
8566 });
8567 </script>';
8568 } elseif ($type == 'price') {
8569 if (!is_null($value) && $value !== '') {
8570 $value = price($value, 0, $langs, 0, 0, -1, $conf->currency);
8571 }
8572 } elseif ($type == 'select') {
8573 $value = isset($param['options'][(string) $value]) ? $param['options'][(string) $value] : '';
8574 if (strpos($value, "|") !== false) {
8575 $value = $langs->trans(explode('|', $value)[0]);
8576 } elseif (! is_numeric($value)) {
8577 $value = $langs->trans($value);
8578 }
8579 } elseif ($type == 'sellist') {
8580 $param_list = array_keys($param['options']);
8581 $InfoFieldList = explode(":", $param_list[0]);
8582
8583 $selectkey = "rowid";
8584 $keyList = 'rowid';
8585
8586 if (count($InfoFieldList) > 2 && !empty($InfoFieldList[2])) {
8587 $selectkey = $InfoFieldList[2];
8588 $keyList = $InfoFieldList[2].' as rowid';
8589 }
8590
8591 $fields_label = explode('|', $InfoFieldList[1]);
8592 if (is_array($fields_label)) {
8593 $keyList .= ', ';
8594 $keyList .= implode(', ', $fields_label);
8595 }
8596
8597 $filter_categorie = false;
8598 if (count($InfoFieldList) > 5) {
8599 if ($InfoFieldList[0] == 'categorie') {
8600 $filter_categorie = true;
8601 }
8602 }
8603
8604 $sql = "SELECT ".$keyList;
8605 $sql .= ' FROM '.$this->db->prefix().$InfoFieldList[0];
8606 if (isset($InfoFieldList[4]) && strpos($InfoFieldList[4], 'extra') !== false) {
8607 $sql .= ' as main';
8608 }
8609 if ($selectkey == 'rowid' && empty($value)) {
8610 $sql .= " WHERE ".$selectkey." = 0";
8611 } elseif ($selectkey == 'rowid') {
8612 $sql .= " WHERE ".$selectkey." = ".((int) $value);
8613 } else {
8614 $sql .= " WHERE ".$selectkey." = '".$this->db->escape($value)."'";
8615 }
8616
8617 //$sql.= ' AND entity = '.$conf->entity;
8618
8619 dol_syslog(get_class($this).':showOutputField:$type=sellist', LOG_DEBUG);
8620 $resql = $this->db->query($sql);
8621 if ($resql) {
8622 if (!$filter_categorie) {
8623 $value = ''; // value was used, so now we reset it to use it to build final output
8624 $numrows = $this->db->num_rows($resql);
8625 if ($numrows) {
8626 $obj = $this->db->fetch_object($resql);
8627
8628 // Several field into label (eq table:code|libelle:rowid)
8629 $fields_label = explode('|', $InfoFieldList[1]);
8630
8631 if (is_array($fields_label) && count($fields_label) > 1) {
8632 foreach ($fields_label as $field_toshow) {
8633 $translabel = '';
8634 if (!empty($obj->$field_toshow)) {
8635 $translabel = $langs->trans($obj->$field_toshow);
8636 }
8637 if ($translabel != $field_toshow) {
8638 $value .= dol_trunc($translabel, 18) . ' ';
8639 } else {
8640 $value .= $obj->$field_toshow . ' ';
8641 }
8642 }
8643 } else {
8644 $translabel = '';
8645 if (!empty($obj->{$InfoFieldList[1]})) {
8646 $translabel = $langs->trans($obj->{$InfoFieldList[1]});
8647 }
8648 if ($translabel != $obj->{$InfoFieldList[1]}) {
8649 $value = dol_trunc($translabel, 18);
8650 } else {
8651 $value = $obj->{$InfoFieldList[1]};
8652 }
8653 }
8654 }
8655 } else {
8656 require_once DOL_DOCUMENT_ROOT . '/categories/class/categorie.class.php';
8657
8658 $toprint = array();
8659 $obj = $this->db->fetch_object($resql);
8660 $c = new Categorie($this->db);
8661 $c->fetch($obj->rowid);
8662 $ways = $c->print_all_ways(); // $ways[0] = "ccc2 >> ccc2a >> ccc2a1" with html formatted text
8663 foreach ($ways as $way) {
8664 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories"' . ($c->color ? ' style="background: #' . $c->color . ';"' : ' style="background: #aaa"') . '>' . img_object('', 'category') . ' ' . $way . '</li>';
8665 }
8666 $value = '<div class="select2-container-multi-dolibarr" style="width: 90%;"><ul class="select2-choices-dolibarr">'.implode(' ', $toprint).'</ul></div>';
8667 }
8668 } else {
8669 dol_syslog(get_class($this).'::showOutputField error '.$this->db->lasterror(), LOG_WARNING);
8670 }
8671 } elseif ($type == 'radio') {
8672 $value = $param['options'][(string) $value];
8673 } elseif ($type == 'checkbox') {
8674 $value_arr = explode(',', (string) $value);
8675 $value = '';
8676 if (is_array($value_arr) && count($value_arr) > 0) {
8677 $toprint = array();
8678 foreach ($value_arr as $keyval => $valueval) {
8679 if (!empty($valueval)) {
8680 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories" style="background: #bbb">' . $param['options'][$valueval] . '</li>';
8681 }
8682 }
8683 if (!empty($toprint)) {
8684 $value = '<div class="select2-container-multi-dolibarr" style="width: 90%;"><ul class="select2-choices-dolibarr">' . implode(' ', $toprint) . '</ul></div>';
8685 }
8686 }
8687 } elseif ($type == 'chkbxlst') {
8688 $value_arr = (isset($value) ? explode(',', $value) : array());
8689
8690 $param_list = array_keys($param['options']);
8691 $InfoFieldList = explode(":", $param_list[0]);
8692
8693 $selectkey = "rowid";
8694 $keyList = 'rowid';
8695
8696 if (count($InfoFieldList) >= 3) {
8697 $selectkey = $InfoFieldList[2];
8698 $keyList = $InfoFieldList[2].' as rowid';
8699 }
8700
8701 $fields_label = explode('|', $InfoFieldList[1]);
8702 if (is_array($fields_label)) {
8703 $keyList .= ', ';
8704 $keyList .= implode(', ', $fields_label);
8705 }
8706
8707 $filter_categorie = false;
8708 if (count($InfoFieldList) > 5) {
8709 if ($InfoFieldList[0] == 'categorie') {
8710 $filter_categorie = true;
8711 }
8712 }
8713
8714 $sql = "SELECT ".$keyList;
8715 $sql .= ' FROM '.$this->db->prefix().$InfoFieldList[0];
8716 if (isset($InfoFieldList[4]) && strpos($InfoFieldList[4], 'extra') !== false) {
8717 $sql .= ' as main';
8718 }
8719 // $sql.= " WHERE ".$selectkey."='".$this->db->escape($value)."'";
8720 // $sql.= ' AND entity = '.$conf->entity;
8721
8722 dol_syslog(get_class($this).':showOutputField:$type=chkbxlst', LOG_DEBUG);
8723 $resql = $this->db->query($sql);
8724 if ($resql) {
8725 if (!$filter_categorie) {
8726 $value = ''; // value was used, so now we reset it to use it to build final output
8727 $toprint = array();
8728 while ($obj = $this->db->fetch_object($resql)) {
8729 // Several field into label (eq table:code|libelle:rowid)
8730 $fields_label = explode('|', $InfoFieldList[1]);
8731 if (is_array($value_arr) && in_array($obj->rowid, $value_arr)) {
8732 if (is_array($fields_label) && count($fields_label) > 1) {
8733 foreach ($fields_label as $field_toshow) {
8734 $translabel = '';
8735 if (!empty($obj->$field_toshow)) {
8736 $translabel = $langs->trans($obj->$field_toshow);
8737 }
8738 if ($translabel != $field_toshow) {
8739 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories" style="background: #bbb">' . dol_trunc($translabel, 18) . '</li>';
8740 } else {
8741 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories" style="background: #bbb">' . $obj->$field_toshow . '</li>';
8742 }
8743 }
8744 } else {
8745 $translabel = '';
8746 if (!empty($obj->{$InfoFieldList[1]})) {
8747 $translabel = $langs->trans($obj->{$InfoFieldList[1]});
8748 }
8749 if ($translabel != $obj->{$InfoFieldList[1]}) {
8750 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories" style="background: #bbb">' . dol_trunc($translabel, 18) . '</li>';
8751 } else {
8752 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories" style="background: #bbb">' . $obj->{$InfoFieldList[1]} . '</li>';
8753 }
8754 }
8755 }
8756 }
8757 } else {
8758 require_once DOL_DOCUMENT_ROOT . '/categories/class/categorie.class.php';
8759
8760 $toprint = array();
8761 while ($obj = $this->db->fetch_object($resql)) {
8762 if (is_array($value_arr) && in_array($obj->rowid, $value_arr)) {
8763 $c = new Categorie($this->db);
8764 $c->fetch($obj->rowid);
8765 $ways = $c->print_all_ways(); // $ways[0] = "ccc2 >> ccc2a >> ccc2a1" with html formatted text
8766 foreach ($ways as $way) {
8767 $toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories"' . ($c->color ? ' style="background: #' . $c->color . ';"' : ' style="background: #aaa"') . '>' . img_object('', 'category') . ' ' . $way . '</li>';
8768 }
8769 }
8770 }
8771 }
8772 $value = '<div class="select2-container-multi-dolibarr" style="width: 90%;"><ul class="select2-choices-dolibarr">'.implode(' ', $toprint).'</ul></div>';
8773 } else {
8774 dol_syslog(get_class($this).'::showOutputField error '.$this->db->lasterror(), LOG_WARNING);
8775 }
8776 } elseif ($type == 'link') {
8777 $out = '';
8778
8779 // only if something to display (perf)
8780 if ($value) {
8781 $param_list = array_keys($param['options']);
8782 // Example: $param_list='ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]'
8783 // Example: $param_list='ObjectClass:PathToClass:#getnomurlparam1=-1#getnomurlparam2=customer'
8784
8785 $InfoFieldList = explode(":", $param_list[0]);
8786
8787 $classname = $InfoFieldList[0];
8788 $classpath = $InfoFieldList[1];
8789
8790 // Set $getnomurlparam1 et getnomurlparam2
8791 $getnomurlparam = 3;
8792 $getnomurlparam2 = '';
8793 $regtmp = array();
8794 if (preg_match('/#getnomurlparam1=([^#]*)/', $param_list[0], $regtmp)) {
8795 $getnomurlparam = $regtmp[1];
8796 }
8797 if (preg_match('/#getnomurlparam2=([^#]*)/', $param_list[0], $regtmp)) {
8798 $getnomurlparam2 = $regtmp[1];
8799 }
8800
8801 if (!empty($classpath)) {
8802 dol_include_once($InfoFieldList[1]);
8803
8804 if ($classname && !class_exists($classname)) {
8805 // from V19 of Dolibarr, In some cases link use element instead of class, example project_task
8806 // TODO use newObjectByElement() introduce in V20 by PR #30036 for better errors management
8807 $element_prop = getElementProperties($classname);
8808 if ($element_prop) {
8809 $classname = $element_prop['classname'];
8810 }
8811 }
8812
8813
8814 if ($classname && class_exists($classname)) {
8815 $object = new $classname($this->db);
8816 '@phan-var-force CommonObject $object';
8817 if ($object->element === 'product') { // Special case for product because default valut of fetch are wrong
8818 '@phan-var-force Product $object';
8819 $result = $object->fetch($value, '', '', '', 0, 1, 1);
8820 } else {
8821 $result = $object->fetch($value);
8822 }
8823 if ($result > 0) {
8824 if ($object->element === 'product') {
8825 '@phan-var-force Product $object';
8826 $get_name_url_param_arr = array($getnomurlparam, $getnomurlparam2, 0, -1, 0, '', 0);
8827 if (isset($val['get_name_url_params'])) {
8828 $get_name_url_params = explode(':', $val['get_name_url_params']);
8829 if (!empty($get_name_url_params)) {
8830 $param_num_max = count($get_name_url_param_arr) - 1;
8831 foreach ($get_name_url_params as $param_num => $param_value) {
8832 if ($param_num > $param_num_max) {
8833 break;
8834 }
8835 $get_name_url_param_arr[$param_num] = $param_value;
8836 }
8837 }
8838 }
8839
8843 $value = $object->getNomUrl($get_name_url_param_arr[0], $get_name_url_param_arr[1], $get_name_url_param_arr[2], $get_name_url_param_arr[3], $get_name_url_param_arr[4], $get_name_url_param_arr[5], $get_name_url_param_arr[6]);
8844 } else {
8845 $value = $object->getNomUrl($getnomurlparam, $getnomurlparam2);
8846 }
8847 } else {
8848 $value = '';
8849 }
8850 }
8851 } else {
8852 dol_syslog('Error bad setup of extrafield', LOG_WARNING);
8853 return 'Error bad setup of extrafield';
8854 }
8855 } else {
8856 $value = '';
8857 }
8858 } elseif ($type == 'password') {
8859 $value = '<span class="opacitymedium">'.$langs->trans("Encrypted").'</span>';
8860 //$value = preg_replace('/./i', '*', $value);
8861 } elseif ($type == 'array') {
8862 if (is_array($value)) {
8863 $value = implode('<br>', $value);
8864 } else {
8865 dol_syslog(__METHOD__.' Expected array from dol_eval, but got '.gettype($value), LOG_ERR);
8866 return 'Error unexpected result from code evaluation';
8867 }
8868 } else { // text|html|varchar
8869 if (!empty($value) && preg_match('/^text/', (string) $type) && !preg_match('/search_/', $keyprefix) && !empty($param['options'])) {
8870 $value = str_replace(',', "\n", $value);
8871 }
8872 $value = dol_htmlentitiesbr($value);
8873 }
8874
8875 //print $type.'-'.$size.'-'.$value;
8876 $out = $value;
8877
8878 return is_null($out) ? '' : $out;
8879 }
8880
8887 public function clearFieldError($fieldKey)
8888 {
8889 $this->error = '';
8890 unset($this->validateFieldsErrors[$fieldKey]);
8891 }
8892
8900 public function setFieldError($fieldKey, $msg = '')
8901 {
8902 global $langs;
8903 if (empty($msg)) {
8904 $msg = $langs->trans("UnknownError");
8905 }
8906
8907 $this->error = $this->validateFieldsErrors[$fieldKey] = $msg;
8908 }
8909
8916 public function getFieldError($fieldKey)
8917 {
8918 if (!empty($this->validateFieldsErrors[$fieldKey])) {
8919 return $this->validateFieldsErrors[$fieldKey];
8920 }
8921 return '';
8922 }
8923
8932 public function validateField($fields, $fieldKey, $fieldValue)
8933 {
8934 global $langs;
8935
8936 if (!class_exists('Validate')) {
8937 require_once DOL_DOCUMENT_ROOT . '/core/class/validate.class.php';
8938 }
8939
8940 $this->clearFieldError($fieldKey);
8941
8942 if (!array_key_exists($fieldKey, $fields) || !is_array($fields[$fieldKey])) {
8943 $this->setFieldError($fieldKey, $langs->trans('FieldNotFoundInObject'));
8944 return false;
8945 }
8946
8947 $val = $fields[$fieldKey];
8948
8949 $param = array();
8950 $param['options'] = array();
8951 $type = $val['type'];
8952
8953 $required = false;
8954 if (isset($val['notnull']) && $val['notnull'] === 1) {
8955 // 'notnull' is set to 1 if not null in database. Set to -1 if we must set data to null if empty ('' or 0).
8956 $required = true;
8957 }
8958
8959 $maxSize = 0;
8960 $minSize = 0;
8961
8962 //
8963 // PREPARE Elements
8964 //
8965 $reg = array();
8966
8967 // Convert var to be able to share same code than showOutputField of extrafields
8968 if (preg_match('/varchar\‍((\d+)\‍)/', $type, $reg)) {
8969 $type = 'varchar'; // convert varchar(xx) int varchar
8970 $maxSize = $reg[1];
8971 } elseif (preg_match('/varchar/', $type)) {
8972 $type = 'varchar'; // convert varchar(xx) int varchar
8973 }
8974
8975 if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
8976 $type = 'select';
8977 }
8978
8979 if (!empty($val['type']) && preg_match('/^integer:(.*):(.*)/i', $val['type'], $reg)) {
8980 $type = 'link';
8981 }
8982
8983 if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
8984 $param['options'] = $val['arrayofkeyval'];
8985 }
8986
8987 if (preg_match('/^integer:(.*):(.*)/i', $val['type'], $reg)) {
8988 $type = 'link';
8989 $param['options'] = array($reg[1].':'.$reg[2] => $reg[1].':'.$reg[2]);
8990 } elseif (preg_match('/^sellist:(.*):(.*):(.*):(.*)/i', $val['type'], $reg)) {
8991 $param['options'] = array($reg[1].':'.$reg[2].':'.$reg[3].':'.$reg[4] => 'N');
8992 $type = 'sellist';
8993 } elseif (preg_match('/^sellist:(.*):(.*):(.*)/i', $val['type'], $reg)) {
8994 $param['options'] = array($reg[1].':'.$reg[2].':'.$reg[3] => 'N');
8995 $type = 'sellist';
8996 } elseif (preg_match('/^sellist:(.*):(.*)/i', $val['type'], $reg)) {
8997 $param['options'] = array($reg[1].':'.$reg[2] => 'N');
8998 $type = 'sellist';
8999 }
9000
9001 //
9002 // TEST Value
9003 //
9004
9005 // Use Validate class to allow external Modules to use data validation part instead of concentrate all test here (factoring) or just for reuse
9006 $validate = new Validate($this->db, $langs);
9007
9008
9009 // little trick : to perform tests with good performances sort tests by quick to low
9010
9011 //
9012 // COMMON TESTS
9013 //
9014
9015 // Required test and empty value
9016 if ($required && !$validate->isNotEmptyString($fieldValue)) {
9017 $this->setFieldError($fieldKey, $validate->error);
9018 return false;
9019 } elseif (!$required && !$validate->isNotEmptyString($fieldValue)) {
9020 // if no value sent and the field is not mandatory, no need to perform tests
9021 return true;
9022 }
9023
9024 // MAX Size test
9025 if (!empty($maxSize) && !$validate->isMaxLength($fieldValue, $maxSize)) {
9026 $this->setFieldError($fieldKey, $validate->error);
9027 return false;
9028 }
9029
9030 // MIN Size test
9031 if (!empty($minSize) && !$validate->isMinLength($fieldValue, $minSize)) {
9032 $this->setFieldError($fieldKey, $validate->error);
9033 return false;
9034 }
9035
9036 //
9037 // TESTS for TYPE
9038 //
9039
9040 if (in_array($type, array('date', 'datetime', 'timestamp'))) {
9041 if (!$validate->isTimestamp($fieldValue)) {
9042 $this->setFieldError($fieldKey, $validate->error);
9043 return false;
9044 } else {
9045 return true;
9046 }
9047 } elseif ($type == 'duration') {
9048 if (!$validate->isDuration($fieldValue)) {
9049 $this->setFieldError($fieldKey, $validate->error);
9050 return false;
9051 } else {
9052 return true;
9053 }
9054 } elseif (in_array($type, array('double', 'real', 'price'))) {
9055 // is numeric
9056 if (!$validate->isNumeric($fieldValue)) {
9057 $this->setFieldError($fieldKey, $validate->error);
9058 return false;
9059 } else {
9060 return true;
9061 }
9062 } elseif ($type == 'boolean') {
9063 if (!$validate->isBool($fieldValue)) {
9064 $this->setFieldError($fieldKey, $validate->error);
9065 return false;
9066 } else {
9067 return true;
9068 }
9069 } elseif ($type == 'mail') {
9070 if (!$validate->isEmail($fieldValue)) {
9071 $this->setFieldError($fieldKey, $validate->error);
9072 return false;
9073 }
9074 } elseif ($type == 'url') {
9075 if (!$validate->isUrl($fieldValue)) {
9076 $this->setFieldError($fieldKey, $validate->error);
9077 return false;
9078 } else {
9079 return true;
9080 }
9081 } elseif ($type == 'phone') {
9082 if (!$validate->isPhone($fieldValue)) {
9083 $this->setFieldError($fieldKey, $validate->error);
9084 return false;
9085 } else {
9086 return true;
9087 }
9088 } elseif ($type == 'select' || $type == 'radio') {
9089 if (!isset($param['options'][$fieldValue])) {
9090 $this->error = $langs->trans('RequireValidValue');
9091 return false;
9092 } else {
9093 return true;
9094 }
9095 } elseif ($type == 'sellist' || $type == 'chkbxlst') {
9096 $param_list = array_keys($param['options']);
9097 $InfoFieldList = explode(":", $param_list[0]);
9098 $value_arr = explode(',', $fieldValue);
9099 $value_arr = array_map(array($this->db, 'escape'), $value_arr);
9100
9101 $selectkey = "rowid";
9102 if (count($InfoFieldList) > 4 && !empty($InfoFieldList[4])) {
9103 $selectkey = $InfoFieldList[2];
9104 }
9105
9106 if (!$validate->isInDb($value_arr, $InfoFieldList[0], $selectkey)) {
9107 $this->setFieldError($fieldKey, $validate->error);
9108 return false;
9109 } else {
9110 return true;
9111 }
9112 } elseif ($type == 'link') {
9113 $param_list = array_keys($param['options']); // $param_list='ObjectName:classPath'
9114 $InfoFieldList = explode(":", $param_list[0]);
9115 $classname = $InfoFieldList[0];
9116 $classpath = $InfoFieldList[1];
9117 if (!$validate->isFetchable($fieldValue, $classname, $classpath)) {
9118 $lastIsFetchableError = $validate->error;
9119
9120 // from V19 of Dolibarr, In some cases link use element instead of class, example project_task
9121 if ($validate->isFetchableElement($fieldValue, $classname)) {
9122 return true;
9123 }
9124
9125 $this->setFieldError($fieldKey, $lastIsFetchableError);
9126 return false;
9127 } else {
9128 return true;
9129 }
9130 }
9131
9132 // if no test failed all is ok
9133 return true;
9134 }
9135
9149 public function showOptionals($extrafields, $mode = 'view', $params = null, $keysuffix = '', $keyprefix = '', $onetrtd = '', $display_type = 'card')
9150 {
9151 global $db, $conf, $langs, $action, $form, $hookmanager;
9152
9153 if (!is_object($form)) {
9154 $form = new Form($db);
9155 }
9156 if (!is_object($extrafields)) {
9157 dol_syslog('Bad parameter extrafields for showOptionals', LOG_ERR);
9158 return 'Bad parameter extrafields for showOptionals';
9159 }
9160 if (!is_array($extrafields->attributes[$this->table_element])) {
9161 dol_syslog("extrafields->attributes was not loaded with extrafields->fetch_name_optionals_label(table_element);", LOG_WARNING);
9162 }
9163
9164 $out = '';
9165
9166 $parameters = array('mode' => $mode, 'params' => $params, 'keysuffix' => $keysuffix, 'keyprefix' => $keyprefix, 'display_type' => $display_type);
9167 $reshook = $hookmanager->executeHooks('showOptionals', $parameters, $this, $action); // Note that $action and $object may have been modified by hook
9168
9169 if (empty($reshook)) {
9170 if (is_array($extrafields->attributes[$this->table_element]) && array_key_exists('label', $extrafields->attributes[$this->table_element]) && is_array($extrafields->attributes[$this->table_element]['label']) && count($extrafields->attributes[$this->table_element]['label']) > 0) {
9171 $out .= "\n";
9172 $out .= '<!-- commonobject:showOptionals --> ';
9173 $out .= "\n";
9174
9175 $nbofextrafieldsshown = 0;
9176 $e = 0; // var to manage the modulo (odd/even)
9177
9178 $lastseparatorkeyfound = '';
9179 $extrafields_collapse_num = '';
9180 $extrafields_collapse_num_old = '';
9181 $i = 0;
9182
9183 foreach ($extrafields->attributes[$this->table_element]['label'] as $key => $label) {
9184 $i++;
9185
9186 // Show only the key field in params @phan-suppress-next-line PhanTypeArraySuspiciousNullable
9187 if (is_array($params) && array_key_exists('onlykey', $params) && $key != $params['onlykey']) {
9188 continue;
9189 }
9190
9191 // Test on 'enabled' ('enabled' is different than 'list' = 'visibility')
9192 $enabled = 1;
9193 if ($enabled && isset($extrafields->attributes[$this->table_element]['enabled'][$key])) {
9194 $enabled = (int) dol_eval((string) $extrafields->attributes[$this->table_element]['enabled'][$key], 1, 1, '2');
9195 }
9196 if (empty($enabled)) {
9197 continue;
9198 }
9199
9200 $visibility = 1;
9201 if (isset($extrafields->attributes[$this->table_element]['list'][$key])) {
9202 $visibility = (int) dol_eval($extrafields->attributes[$this->table_element]['list'][$key], 1, 1, '2');
9203 }
9204
9205 $perms = 1;
9206 if ($perms && isset($extrafields->attributes[$this->table_element]['perms'][$key])) {
9207 $perms = (int) dol_eval($extrafields->attributes[$this->table_element]['perms'][$key], 1, 1, '2');
9208 }
9209
9210 if (($mode == 'create') && !in_array(abs($visibility), array(1, 3))) {
9211 continue; // <> -1 and <> 1 and <> 3 = not visible on forms, only on list
9212 } elseif (($mode == 'edit') && !in_array(abs($visibility), array(1, 3, 4))) {
9213 // We need to make sure, that the values of hidden extrafields are also part of $_POST. Otherwise, they would be empty after an update of the object. See also getOptionalsFromPost
9214 $ef_name = 'options_' . $key;
9215 $ef_value = $this->array_options[$ef_name];
9216 $out .= '<input type="hidden" name="' . $ef_name . '" id="' . $ef_name . '" value="' . $ef_value . '" />' . "\n";
9217 continue; // <> -1 and <> 1 and <> 3 = not visible on forms, only on list and <> 4 = not visible at the creation
9218 } elseif ($mode == 'view' && empty($visibility)) {
9219 continue;
9220 }
9221 if (empty($perms)) {
9222 continue;
9223 }
9224
9225 // Load language if required
9226 if (!empty($extrafields->attributes[$this->table_element]['langfile'][$key])) {
9227 $langs->load($extrafields->attributes[$this->table_element]['langfile'][$key]);
9228 }
9229
9230 $colspan = 0;
9231 $value = null;
9232 if (is_array($params) && count($params) > 0 && $display_type == 'card') {
9233 if (array_key_exists('cols', $params)) {
9234 $colspan = $params['cols'];
9235 } elseif (array_key_exists('colspan', $params)) { // For backward compatibility. Use cols instead now.
9236 $reg = array();
9237 if (preg_match('/colspan="(\d+)"/', $params['colspan'], $reg)) {
9238 $colspan = $reg[1];
9239 } else {
9240 $colspan = $params['colspan'];
9241 }
9242 }
9243 }
9244 $colspan = intval($colspan);
9245
9246 switch ($mode) {
9247 case "view":
9248 $value = ((!empty($this->array_options) && array_key_exists("options_".$key.$keysuffix, $this->array_options)) ? $this->array_options["options_".$key.$keysuffix] : null); // Value may be cleaned or formatted later
9249 break;
9250 case "create":
9251 case "edit":
9252 // We get the value of property found with GETPOST so it takes into account:
9253 // default values overwrite, restore back to list link, ... (but not 'default value in database' of field)
9254 $check = 'alphanohtml';
9255 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('html', 'text'))) {
9256 $check = 'restricthtml';
9257 }
9258 $getposttemp = GETPOST($keyprefix.'options_'.$key.$keysuffix, $check, 3); // GETPOST can get value from GET, POST or setup of default values overwrite.
9259 // GETPOST("options_" . $key) can be 'abc' or array(0=>'abc')
9260 if (is_array($getposttemp) || $getposttemp != '' || GETPOSTISSET($keyprefix.'options_'.$key.$keysuffix)) {
9261 if (is_array($getposttemp)) {
9262 // $getposttemp is an array but following code expects a comma separated string
9263 $value = implode(",", $getposttemp);
9264 } else {
9265 $value = $getposttemp;
9266 }
9267 } elseif (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('int'))) {
9268 $value = (!empty($this->array_options["options_".$key]) || (isset($this->array_options["options_".$key]) && $this->array_options["options_".$key] === '0')) ? $this->array_options["options_".$key] : '';
9269 } else {
9270 $value = (!empty($this->array_options["options_".$key]) ? $this->array_options["options_".$key] : ''); // No GET, no POST, no default value, so we take value of object.
9271 }
9272 //var_dump($keyprefix.' - '.$key.' - '.$keysuffix.' - '.$keyprefix.'options_'.$key.$keysuffix.' - '.$this->array_options["options_".$key.$keysuffix].' - '.$getposttemp.' - '.$value);
9273 break;
9274 }
9275
9276 $nbofextrafieldsshown++;
9277
9278 // Output value of the current field
9279 if ($extrafields->attributes[$this->table_element]['type'][$key] == 'separate') {
9280 $extrafields_collapse_num = $key;
9281 /*
9282 $extrafield_param = $extrafields->attributes[$this->table_element]['param'][$key];
9283 if (!empty($extrafield_param) && is_array($extrafield_param)) {
9284 $extrafield_param_list = array_keys($extrafield_param['options']);
9285
9286 if (count($extrafield_param_list) > 0) {
9287 $extrafield_collapse_display_value = intval($extrafield_param_list[0]);
9288
9289 if ($extrafield_collapse_display_value == 1 || $extrafield_collapse_display_value == 2) {
9290 //$extrafields_collapse_num = $extrafields->attributes[$this->table_element]['pos'][$key];
9291 $extrafields_collapse_num = $key;
9292 }
9293 }
9294 }
9295 */
9296
9297 // if colspan=0 or 1, the second column is not extended, so the separator must be on 2 columns
9298 $out .= $extrafields->showSeparator($key, $this, ($colspan ? $colspan + 1 : 2), $display_type, $mode);
9299
9300 $lastseparatorkeyfound = $key;
9301 } else {
9302 $collapse_group = $extrafields_collapse_num.(!empty($this->id) ? '_'.$this->id : '');
9303
9304 $class = (!empty($extrafields->attributes[$this->table_element]['hidden'][$key]) ? 'hideobject ' : '');
9305 $csstyle = '';
9306 if (is_array($params) && count($params) > 0) {
9307 if (array_key_exists('class', $params)) {
9308 $class .= $params['class'].' ';
9309 }
9310 if (array_key_exists('style', $params)) {
9311 $csstyle = $params['style'];
9312 }
9313 }
9314
9315 // add html5 elements
9316 $domData = ' data-element="extrafield"';
9317 $domData .= ' data-targetelement="'.$this->element.'"';
9318 $domData .= ' data-targetid="'.$this->id.'"';
9319
9320 $html_id = (empty($this->id) ? '' : 'extrarow-'.$this->element.'_'.$key.'_'.$this->id);
9321 if ($display_type == 'card') {
9322 if (getDolGlobalString('MAIN_EXTRAFIELDS_USE_TWO_COLUMS') && ($e % 2) == 0) {
9323 $colspan = 0;
9324 }
9325
9326 if ($action == 'selectlines') {
9327 $colspan++;
9328 }
9329 }
9330
9331 // Convert date into timestamp format (value in memory must be a timestamp)
9332 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('date'))) {
9333 $datenotinstring = null;
9334 if (array_key_exists('options_'.$key, $this->array_options)) {
9335 $datenotinstring = $this->array_options['options_'.$key];
9336 if (!is_numeric($this->array_options['options_'.$key])) { // For backward compatibility
9337 $datenotinstring = $this->db->jdate($datenotinstring);
9338 }
9339 }
9340 $datekey = $keyprefix.'options_'.$key.$keysuffix;
9341 $value = (GETPOSTISSET($datekey) && $this->id == GETPOST('elrowid', 'int')) ? dol_mktime(12, 0, 0, GETPOSTINT($datekey.'month', 3), GETPOSTINT($datekey.'day', 3), GETPOSTINT($datekey.'year', 3)) : $datenotinstring;
9342 }
9343 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('datetime'))) {
9344 $datenotinstring = null;
9345 if (array_key_exists('options_'.$key, $this->array_options)) {
9346 $datenotinstring = $this->array_options['options_'.$key];
9347 if (!is_numeric($this->array_options['options_'.$key])) { // For backward compatibility
9348 $datenotinstring = $this->db->jdate($datenotinstring);
9349 }
9350 }
9351 $timekey = $keyprefix.'options_'.$key.$keysuffix;
9352 $value = (GETPOSTISSET($timekey)) ? dol_mktime(GETPOSTINT($timekey.'hour', 3), GETPOSTINT($timekey.'min', 3), GETPOSTINT($timekey.'sec', 3), GETPOSTINT($timekey.'month', 3), GETPOSTINT($timekey.'day', 3), GETPOSTINT($timekey.'year', 3), 'tzuserrel') : $datenotinstring;
9353 }
9354 // Convert float submitted string into real php numeric (value in memory must be a php numeric)
9355 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('price', 'double'))) {
9356 if (GETPOSTISSET($keyprefix.'options_'.$key.$keysuffix) || $value) {
9357 $value = price2num($value);
9358 } elseif (isset($this->array_options['options_'.$key])) {
9359 $value = $this->array_options['options_'.$key];
9360 }
9361 }
9362
9363 // HTML, text, select, integer and varchar: take into account default value in database if in create mode
9364 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('html', 'text', 'varchar', 'select', 'radio', 'int', 'boolean'))) {
9365 if ($action == 'create' || $mode == 'create') {
9366 $value = (GETPOSTISSET($keyprefix.'options_'.$key.$keysuffix) || $value) ? $value : $extrafields->attributes[$this->table_element]['default'][$key];
9367 }
9368 }
9369
9370 $labeltoshow = $langs->trans($label);
9371 $helptoshow = $langs->trans($extrafields->attributes[$this->table_element]['help'][$key]);
9372 if ($display_type == 'card') {
9373 $out .= '<tr '.($html_id ? 'id="'.$html_id.'" ' : '').$csstyle.' class="field_options_'.$key.' '.$class.$this->element.'_extras_'.$key.' trextrafields_collapse'.$collapse_group.'" '.$domData.' >';
9374 if (getDolGlobalString('MAIN_VIEW_LINE_NUMBER') && ($action == 'view' || $action == 'valid' || $action == 'editline' || $action == 'confirm_valid' || $action == 'confirm_cancel')) {
9375 $out .= '<td></td>';
9376 }
9377 $out .= '<td class="'.(empty($params['tdclass']) ? 'titlefieldmax45' : $params['tdclass']).' wordbreak';
9378 if ($extrafields->attributes[$this->table_element]['type'][$key] == 'text') {
9379 $out .= ' tdtop';
9380 }
9381 } elseif ($display_type == 'line') {
9382 $out .= '<div '.($html_id ? 'id="'.$html_id.'" ' : '').$csstyle.' class="fieldline_options_'.$key.' '.$class.$this->element.'_extras_'.$key.' trextrafields_collapse'.$collapse_group.'" '.$domData.' >';
9383 $out .= '<div style="display: inline-block; padding-right:4px" class="wordbreak';
9384 }
9385 //$out .= "titlefield";
9386 //if (GETPOST('action', 'restricthtml') == 'create') $out.='create';
9387 // BUG #11554 : For public page, use red dot for required fields, instead of bold label
9388 $tpl_context = isset($params["tpl_context"]) ? $params["tpl_context"] : "none";
9389 if ($tpl_context != "public") { // Public page : red dot instead of fieldrequired characters
9390 if ($mode != 'view' && !empty($extrafields->attributes[$this->table_element]['required'][$key])) {
9391 $out .= ' fieldrequired';
9392 }
9393 }
9394 $out .= '">';
9395 if ($tpl_context == "public") { // Public page : red dot instead of fieldrequired characters
9396 if (!empty($extrafields->attributes[$this->table_element]['help'][$key])) {
9397 $out .= $form->textwithpicto($labeltoshow, $helptoshow);
9398 } else {
9399 $out .= $labeltoshow;
9400 }
9401 if ($mode != 'view' && !empty($extrafields->attributes[$this->table_element]['required'][$key])) {
9402 $out .= '&nbsp;<span style="color: red">*</span>';
9403 }
9404 } else {
9405 if (!empty($extrafields->attributes[$this->table_element]['help'][$key])) {
9406 $out .= $form->textwithpicto($labeltoshow, $helptoshow);
9407 } else {
9408 $out .= $labeltoshow;
9409 }
9410 }
9411
9412 $out .= ($display_type == 'card' ? '</td>' : '</div>');
9413
9414 // Second column
9415 $html_id = !empty($this->id) ? $this->element.'_extras_'.$key.'_'.$this->id : '';
9416 if ($display_type == 'card') {
9417 // a first td column was already output (and may be another on before if MAIN_VIEW_LINE_NUMBER set), so this td is the next one
9418 $out .= '<td '.($html_id ? 'id="'.$html_id.'" ' : '').' class="valuefieldcreate '.$this->element.'_extras_'.$key;
9419 $out .= '" '.($colspan ? ' colspan="'.$colspan.'"' : '');
9420 $out .= '>';
9421 } elseif ($display_type == 'line') {
9422 $out .= '<div '.($html_id ? 'id="'.$html_id.'" ' : '').' style="display: inline-block" class="valuefieldcreate '.$this->element.'_extras_'.$key.' extra_inline_'.$extrafields->attributes[$this->table_element]['type'][$key].'">';
9423 }
9424
9425 switch ($mode) {
9426 case "view":
9427 $out .= $extrafields->showOutputField($key, $value, '', $this->table_element);
9428 break;
9429 case "create":
9430 $listoftypestoshowpicto = explode(',', getDolGlobalString('MAIN_TYPES_TO_SHOW_PICTO', 'email,phone,ip,password'));
9431 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], $listoftypestoshowpicto)) {
9432 $out .= getPictoForType($extrafields->attributes[$this->table_element]['type'][$key], ($extrafields->attributes[$this->table_element]['type'][$key] == 'text' ? 'tdtop' : ''));
9433 }
9434 //$out .= '<!-- type = '.$extrafields->attributes[$this->table_element]['type'][$key].' -->';
9435 $out .= $extrafields->showInputField($key, $value, '', $keysuffix, '', 0, $this, $this->table_element);
9436 break;
9437 case "edit":
9438 $listoftypestoshowpicto = explode(',', getDolGlobalString('MAIN_TYPES_TO_SHOW_PICTO', 'email,phone,ip,password'));
9439 if (in_array($extrafields->attributes[$this->table_element]['type'][$key], $listoftypestoshowpicto)) {
9440 $out .= getPictoForType($extrafields->attributes[$this->table_element]['type'][$key], ($extrafields->attributes[$this->table_element]['type'][$key] == 'text' ? 'tdtop' : ''));
9441 }
9442 $out .= $extrafields->showInputField($key, $value, '', $keysuffix, '', '', $this, $this->table_element);
9443 break;
9444 }
9445
9446 $out .= ($display_type == 'card' ? '</td>' : '</div>');
9447 $out .= ($display_type == 'card' ? '</tr>'."\n" : '</div>');
9448 $e++;
9449 }
9450 }
9451 $out .= "\n";
9452 // Add code to manage list depending on others
9453 if (!empty($conf->use_javascript_ajax)) {
9454 $out .= $this->getJSListDependancies();
9455 }
9456
9457 $out .= '<!-- commonobject:showOptionals end --> '."\n";
9458
9459 if (empty($nbofextrafieldsshown)) {
9460 $out = '';
9461 }
9462 }
9463 }
9464
9465 $out .= $hookmanager->resPrint;
9466
9467 return $out;
9468 }
9469
9474 public function getJSListDependancies($type = '_extra')
9475 {
9476 $out = '
9477 <script nonce="'.getNonce().'">
9478 jQuery(document).ready(function() {
9479 function showOptions'.$type.'(child_list, parent_list, orig_select)
9480 {
9481 var val = $("select[name=\""+parent_list+"\"]").val();
9482 var parentVal = parent_list + ":" + val;
9483 if(typeof val == "string"){
9484 if(val != "") {
9485 var options = orig_select.find("option[parent=\""+parentVal+"\"]").clone();
9486 $("select[name=\""+child_list+"\"] option[parent]").remove();
9487 $("select[name=\""+child_list+"\"]").append(options);
9488 } else {
9489 var options = orig_select.find("option[parent]").clone();
9490 $("select[name=\""+child_list+"\"] option[parent]").remove();
9491 $("select[name=\""+child_list+"\"]").append(options);
9492 }
9493 } else if(val > 0) {
9494 var options = orig_select.find("option[parent=\""+parentVal+"\"]").clone();
9495 $("select[name=\""+child_list+"\"] option[parent]").remove();
9496 $("select[name=\""+child_list+"\"]").append(options);
9497 } else {
9498 var options = orig_select.find("option[parent]").clone();
9499 $("select[name=\""+child_list+"\"] option[parent]").remove();
9500 $("select[name=\""+child_list+"\"]").append(options);
9501 }
9502 }
9503 function setListDependencies'.$type.'() {
9504 jQuery("select option[parent]").parent().each(function() {
9505 var orig_select = {};
9506 var child_list = $(this).attr("name");
9507 orig_select[child_list] = $(this).clone();
9508 var parent = $(this).find("option[parent]:first").attr("parent");
9509 var infos = parent.split(":");
9510 var parent_list = infos[0];
9511
9512 //Hide daughters lists
9513 if ($("#"+child_list).val() == 0 && $("#"+parent_list).val() == 0){
9514 $("#"+child_list).hide();
9515 //Show mother lists
9516 } else if ($("#"+parent_list).val() != 0){
9517 $("#"+parent_list).show();
9518 }
9519 //Show the child list if the parent list value is selected
9520 $("select[name=\""+parent_list+"\"]").click(function() {
9521 if ($(this).val() != 0){
9522 $("#"+child_list).show()
9523 }
9524 });
9525
9526 //When we change parent list
9527 $("select[name=\""+parent_list+"\"]").change(function() {
9528 showOptions'.$type.'(child_list, parent_list, orig_select[child_list]);
9529 //Select the value 0 on child list after a change on the parent list
9530 $("#"+child_list).val(0).trigger("change");
9531 //Hide child lists if the parent value is set to 0
9532 if ($(this).val() == 0){
9533 $("#"+child_list).hide();
9534 }
9535 });
9536 });
9537 }
9538
9539 setListDependencies'.$type.'();
9540 });
9541 </script>'."\n";
9542 return $out;
9543 }
9544
9550 public function getRights()
9551 {
9552 global $user;
9553
9554 $module = empty($this->module) ? '' : $this->module;
9555 $element = $this->element;
9556
9557 if ($element == 'facturerec') {
9558 $element = 'facture';
9559 } elseif ($element == 'invoice_supplier_rec') {
9560 return !$user->hasRight('fournisseur', 'facture') ? null : $user->hasRight('fournisseur', 'facture');
9561 } elseif ($module && $user->hasRight($module, $element)) {
9562 // for modules built with ModuleBuilder
9563 return $user->hasRight($module, $element);
9564 }
9565
9566 return $user->rights->$element;
9567 }
9568
9581 public static function commonReplaceThirdparty(DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors = 0)
9582 {
9583 global $hookmanager;
9584
9585 $parameters = array(
9586 'origin_id' => $origin_id,
9587 'dest_id' => $dest_id,
9588 'tables' => $tables,
9589 );
9590 $reshook = $hookmanager->executeHooks('commonReplaceThirdparty', $parameters);
9591 if ($reshook) {
9592 return true; // replacement code
9593 } elseif ($reshook < 0) {
9594 return $ignoreerrors === 1; // failure
9595 } // reshook = 0 => execute normal code
9596
9597 foreach ($tables as $table) {
9598 $sql = 'UPDATE '.$dbs->prefix().$table.' SET fk_soc = '.((int) $dest_id).' WHERE fk_soc = '.((int) $origin_id);
9599
9600 if (!$dbs->query($sql)) {
9601 if ($ignoreerrors) {
9602 return true; // FIXME Not enough. If there is A-B on the kept thirdparty and B-C on the old one, we must get A-B-C after merge. Not A-B.
9603 }
9604 //$this->errors = $db->lasterror();
9605 return false;
9606 }
9607 }
9608
9609 return true;
9610 }
9611
9624 public static function commonReplaceProduct(DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors = 0)
9625 {
9626 foreach ($tables as $table) {
9627 $sql = 'UPDATE '.MAIN_DB_PREFIX.$table.' SET fk_product = '.((int) $dest_id).' WHERE fk_product = '.((int) $origin_id);
9628
9629 if (!$dbs->query($sql)) {
9630 if ($ignoreerrors) {
9631 return true; // TODO Not enough. If there is A-B on kept product and B-C on old one, we must get A-B-C after merge. Not A-B.
9632 }
9633 //$this->errors = $db->lasterror();
9634 return false;
9635 }
9636 }
9637
9638 return true;
9639 }
9640
9653 public function defineBuyPrice($unitPrice = 0.0, $discountPercent = 0.0, $fk_product = 0)
9654 {
9655 global $conf;
9656
9657 $buyPrice = 0;
9658
9659 if (($unitPrice > 0) && (isset($conf->global->ForceBuyingPriceIfNull) && getDolGlobalInt('ForceBuyingPriceIfNull') > 0)) {
9660 // When ForceBuyingPriceIfNull is set
9661 $buyPrice = $unitPrice * (1 - $discountPercent / 100);
9662 } else {
9663 // Get cost price for margin calculation
9664 if (!empty($fk_product) && $fk_product > 0) {
9665 $result = 0;
9666 if (getDolGlobalString('MARGIN_TYPE') == 'costprice') {
9667 require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
9668 $product = new Product($this->db);
9669 $result = $product->fetch($fk_product);
9670 if ($result <= 0) {
9671 $this->errors[] = 'ErrorProductIdDoesNotExists';
9672 return -1;
9673 }
9674 if ($product->cost_price > 0) {
9675 $buyPrice = $product->cost_price;
9676 } elseif ($product->pmp > 0) {
9677 $buyPrice = $product->pmp;
9678 }
9679 } elseif (getDolGlobalString('MARGIN_TYPE') == 'pmp') {
9680 require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
9681 $product = new Product($this->db);
9682 $result = $product->fetch($fk_product);
9683 if ($result <= 0) {
9684 $this->errors[] = 'ErrorProductIdDoesNotExists';
9685 return -1;
9686 }
9687 if ($product->pmp > 0) {
9688 $buyPrice = $product->pmp;
9689 }
9690 }
9691
9692 if (empty($buyPrice) && isset($conf->global->MARGIN_TYPE) && in_array($conf->global->MARGIN_TYPE, array('1', 'pmp', 'costprice'))) {
9693 require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.product.class.php';
9694 $productFournisseur = new ProductFournisseur($this->db);
9695 if (($result = $productFournisseur->find_min_price_product_fournisseur($fk_product)) > 0) {
9696 $buyPrice = $productFournisseur->fourn_unitprice;
9697 } elseif ($result < 0) {
9698 $this->errors[] = $productFournisseur->error;
9699 return -2;
9700 }
9701 }
9702 }
9703 }
9704 return $buyPrice;
9705 }
9706
9714 public function getDataToShowPhoto($modulepart, $imagesize)
9715 {
9716 // See getDataToShowPhoto() implemented by Product for example.
9717 return array('dir' => '', 'file' => '', 'originalfile' => '', 'altfile' => '', 'email' => '', 'capture' => '');
9718 }
9719
9720
9721 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
9741 public function show_photos($modulepart, $sdir, $size = 0, $nbmax = 0, $nbbyrow = 5, $showfilename = 0, $showaction = 0, $maxHeight = 120, $maxWidth = 160, $nolink = 0, $overwritetitle = 0, $usesharelink = 0, $cache = '', $addphotorefcss = 'photoref')
9742 {
9743 // phpcs:enable
9744 global $user, $langs;
9745
9746 include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
9747 include_once DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php';
9748
9749 $sortfield = 'position_name';
9750 $sortorder = 'asc';
9751
9752 $dir = $sdir.'/';
9753 $pdir = '/';
9754
9755 $dir .= get_exdir(0, 0, 0, 0, $this, $modulepart);
9756 $pdir .= get_exdir(0, 0, 0, 0, $this, $modulepart);
9757
9758 // For backward compatibility
9759 if ($modulepart == 'product') {
9760 if (getDolGlobalInt('PRODUCT_USE_OLD_PATH_FOR_PHOTO')) {
9761 $dir = $sdir.'/'.get_exdir($this->id, 2, 0, 0, $this, $modulepart).$this->id."/photos/";
9762 $pdir = '/'.get_exdir($this->id, 2, 0, 0, $this, $modulepart).$this->id."/photos/";
9763 }
9764 }
9765 if ($modulepart == 'category') {
9766 $dir = $sdir.'/'.get_exdir($this->id, 2, 0, 0, $this, $modulepart).$this->id."/photos/";
9767 $pdir = '/'.get_exdir($this->id, 2, 0, 0, $this, $modulepart).$this->id."/photos/";
9768 }
9769
9770 // Defined relative dir to DOL_DATA_ROOT
9771 $relativedir = '';
9772 if ($dir) {
9773 $relativedir = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $dir);
9774 $relativedir = preg_replace('/^[\\/]/', '', $relativedir);
9775 $relativedir = preg_replace('/[\\/]$/', '', $relativedir);
9776 }
9777
9778 $dirthumb = $dir.'thumbs/';
9779 $pdirthumb = $pdir.'thumbs/';
9780
9781 $return = '<!-- Photo -->'."\n";
9782 $nbphoto = 0;
9783
9784 $filearray = dol_dir_list($dir, "files", 0, '', '(\.meta|_preview.*\.png)$', $sortfield, (strtolower($sortorder) == 'desc' ? SORT_DESC : SORT_ASC), 1);
9785
9786 /*if (getDolGlobalInt('PRODUCT_USE_OLD_PATH_FOR_PHOTO')) // For backward compatibility, we scan also old dirs
9787 {
9788 $filearrayold=dol_dir_list($dirold,"files",0,'','(\.meta|_preview.*\.png)$',$sortfield,(strtolower($sortorder)=='desc'?SORT_DESC:SORT_ASC),1);
9789 $filearray=array_merge($filearray, $filearrayold);
9790 }*/
9791
9792 completeFileArrayWithDatabaseInfo($filearray, $relativedir);
9793 '@phan-var-force array<array{name:string,path:string,level1name:string,relativename:string,fullname:string,date:string,size:int,perm:int,type:string,position_name:string,cover:string,keywords:string,acl:string,rowid:int,label:string,share:string}> $filearray';
9794
9795 if (count($filearray)) {
9796 if ($sortfield && $sortorder) {
9797 $filearray = dol_sort_array($filearray, $sortfield, $sortorder);
9798 }
9799
9800 foreach ($filearray as $key => $val) {
9801 $photo = '';
9802 $file = $val['name'];
9803
9804 //if (dol_is_file($dir.$file) && image_format_supported($file) >= 0)
9805 if (image_format_supported($file) >= 0) {
9806 $nbphoto++;
9807 $photo = $file;
9808 $viewfilename = $file;
9809
9810 if ($size == 1 || $size == 'small') { // Format vignette
9811 // Find name of thumb file
9812 $photo_vignette = basename(getImageFileNameForSize($dir.$file, '_small'));
9813 if (!dol_is_file($dirthumb.$photo_vignette)) {
9814 // The thumb does not exists, so we will use the original file
9815 $dirthumb = $dir;
9816 $pdirthumb = $pdir;
9817 $photo_vignette = basename($file);
9818 }
9819
9820 // Get filesize of original file
9821 $imgarray = dol_getImageSize($dir.$photo);
9822
9823 if ($nbbyrow > 0) {
9824 if ($nbphoto == 1) {
9825 $return .= '<table class="valigntop center centpercent" style="border: 0; padding: 2px; border-spacing: 2px; border-collapse: separate;">';
9826 }
9827
9828 if ($nbphoto % $nbbyrow == 1) {
9829 $return .= '<tr class="center valignmiddle" style="border: 1px">';
9830 }
9831 $return .= '<td style="width: '.ceil(100 / $nbbyrow).'%" class="photo">'."\n";
9832 } elseif ($nbbyrow < 0) {
9833 $return .= '<div class="inline-block">'."\n";
9834 }
9835
9836 $relativefile = preg_replace('/^\//', '', $pdir.$photo);
9837 if (empty($nolink)) {
9838 $urladvanced = getAdvancedPreviewUrl($modulepart, $relativefile, 0, 'entity='.$this->entity);
9839 if ($urladvanced) {
9840 $return .= '<a href="'.$urladvanced.'">';
9841 } else {
9842 $return .= '<a href="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$modulepart.'&entity='.$this->entity.'&file='.urlencode($pdir.$photo).'" class="aphoto" target="_blank" rel="noopener noreferrer">';
9843 }
9844 }
9845
9846 // Show image (width height=$maxHeight)
9847 // Si fichier vignette disponible et image source trop grande, on utilise la vignette, sinon on utilise photo origine
9848 $alt = $langs->transnoentitiesnoconv('File').': '.$relativefile;
9849 $alt .= ' - '.$langs->transnoentitiesnoconv('Size').': '.$imgarray['width'].'x'.$imgarray['height'];
9850 if ($overwritetitle) {
9851 if (is_numeric($overwritetitle)) {
9852 $alt = '';
9853 } else {
9854 $alt = $overwritetitle;
9855 }
9856 }
9857 if (empty($cache) && !empty($val['label'])) {
9858 // label is md5 of file
9859 // use it in url to say we want to cache this version of the file
9860 $cache = $val['label'];
9861 }
9862 if ($usesharelink) {
9863 if (array_key_exists('share', $val) && $val['share']) {
9864 if (empty($maxHeight) || ($photo_vignette && $imgarray['height'] > $maxHeight)) {
9865 $return .= '<!-- Show original file (thumb not yet available with shared links) -->';
9866 $return .= '<img class="photo photowithmargin'.($addphotorefcss ? ' '.$addphotorefcss : '').'"'.($maxHeight ? ' height="'.$maxHeight.'"' : '').' src="'.DOL_URL_ROOT.'/viewimage.php?hashp='.urlencode($val['share']).($cache ? '&cache='.urlencode($cache) : '').'" title="'.dol_escape_htmltag($alt).'">';
9867 } else {
9868 $return .= '<!-- Show original file -->';
9869 $return .= '<img class="photo photowithmargin'.($addphotorefcss ? ' '.$addphotorefcss : '').'" height="'.$maxHeight.'" src="'.DOL_URL_ROOT.'/viewimage.php?hashp='.urlencode($val['share']).($cache ? '&cache='.urlencode($cache) : '').'" title="'.dol_escape_htmltag($alt).'">';
9870 }
9871 } else {
9872 $return .= '<!-- Show nophoto file (because file is not shared) -->';
9873 $return .= '<img class="photo photowithmargin'.($addphotorefcss ? ' '.$addphotorefcss : '').'" height="'.$maxHeight.'" src="'.DOL_URL_ROOT.'/public/theme/common/nophoto.png" title="'.dol_escape_htmltag($alt).'">';
9874 }
9875 } else {
9876 if (empty($maxHeight) || ($photo_vignette && $imgarray['height'] > $maxHeight)) {
9877 $return .= '<!-- Show thumb -->';
9878 $return .= '<img class="photo photowithmargin'.($addphotorefcss ? ' '.$addphotorefcss : '').' maxwidth150onsmartphone maxwidth200"'.($maxHeight ? ' height="'.$maxHeight.'"' : '').' src="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$modulepart.'&entity='.$this->entity.($cache ? '&cache='.urlencode($cache) : '').'&file='.urlencode($pdirthumb.$photo_vignette).'" title="'.dol_escape_htmltag($alt).'">';
9879 } else {
9880 $return .= '<!-- Show original file -->';
9881 $return .= '<img class="photo photowithmargin'.($addphotorefcss ? ' '.$addphotorefcss : '').'" height="'.$maxHeight.'" src="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$modulepart.'&entity='.$this->entity.($cache ? '&cache='.urlencode($cache) : '').'&file='.urlencode($pdir.$photo).'" title="'.dol_escape_htmltag($alt).'">';
9882 }
9883 }
9884
9885 if (empty($nolink)) {
9886 $return .= '</a>';
9887 }
9888
9889 if ($showfilename) {
9890 $return .= '<br>'.$viewfilename;
9891 }
9892 if ($showaction) {
9893 $return .= '<br>';
9894 // If $photo_vignette set, we add a link to generate thumbs if file is an image and width or height higher than limits
9895 if ($photo_vignette && (image_format_supported($photo) > 0) && ((isset($imgarray['width']) && $imgarray['width'] > $maxWidth) || (isset($imgarray['width']) && $imgarray['width'] > $maxHeight))) {
9896 $return .= '<a href="'.$_SERVER["PHP_SELF"].'?id='.$this->id.'&action=addthumb&token='.newToken().'&file='.urlencode($pdir.$viewfilename).'">'.img_picto($langs->trans('GenerateThumb'), 'refresh').'&nbsp;&nbsp;</a>';
9897 }
9898 // Special case for product
9899 if ($modulepart == 'product' && ($user->hasRight('produit', 'creer') || $user->hasRight('service', 'creer'))) {
9900 // Link to resize
9901 $return .= '<a href="'.DOL_URL_ROOT.'/core/photos_resize.php?modulepart='.urlencode('produit|service').'&id='.$this->id.'&file='.urlencode($pdir.$viewfilename).'" title="'.dol_escape_htmltag($langs->trans("Resize")).'">'.img_picto($langs->trans("Resize"), 'resize', '').'</a> &nbsp; ';
9902
9903 // Link to delete
9904 $return .= '<a href="'.$_SERVER["PHP_SELF"].'?id='.$this->id.'&action=delete&token='.newToken().'&file='.urlencode($pdir.$viewfilename).'">';
9905 $return .= img_delete().'</a>';
9906 }
9907 }
9908 $return .= "\n";
9909
9910 if ($nbbyrow > 0) {
9911 $return .= '</td>';
9912 if (($nbphoto % $nbbyrow) == 0) {
9913 $return .= '</tr>';
9914 }
9915 } elseif ($nbbyrow < 0) {
9916 $return .= '</div>'."\n";
9917 }
9918 }
9919
9920 if (empty($size)) { // Format origine
9921 $return .= '<img class="photo photowithmargin" src="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$modulepart.'&entity='.$this->entity.'&file='.urlencode($pdir.$photo).'">';
9922
9923 if ($showfilename) {
9924 $return .= '<br>'.$viewfilename;
9925 }
9926 if ($showaction) {
9927 // Special case for product
9928 if ($modulepart == 'product' && ($user->hasRight('produit', 'creer') || $user->hasRight('service', 'creer'))) {
9929 // Link to resize
9930 $return .= '<a href="'.DOL_URL_ROOT.'/core/photos_resize.php?modulepart='.urlencode('produit|service').'&id='.$this->id.'&file='.urlencode($pdir.$viewfilename).'" title="'.dol_escape_htmltag($langs->trans("Resize")).'">'.img_picto($langs->trans("Resize"), 'resize', '').'</a> &nbsp; ';
9931
9932 // Link to delete
9933 $return .= '<a href="'.$_SERVER["PHP_SELF"].'?id='.$this->id.'&action=delete&token='.newToken().'&file='.urlencode($pdir.$viewfilename).'">';
9934 $return .= img_delete().'</a>';
9935 }
9936 }
9937 }
9938
9939 // On continue ou on arrete de boucler ?
9940 if ($nbmax && $nbphoto >= $nbmax) {
9941 break;
9942 }
9943 }
9944 }
9945
9946 if ($size == 1 || $size == 'small') {
9947 if ($nbbyrow > 0) {
9948 // Ferme tableau
9949 while ($nbphoto % $nbbyrow) {
9950 $return .= '<td style="width: '.ceil(100 / $nbbyrow).'%">&nbsp;</td>';
9951 $nbphoto++;
9952 }
9953
9954 if ($nbphoto) {
9955 $return .= '</table>';
9956 }
9957 }
9958 }
9959 }
9960
9961 $this->nbphoto = $nbphoto;
9962
9963 return $return;
9964 }
9965
9966
9973 protected function isArray($info)
9974 {
9975 if (is_array($info)) {
9976 if (isset($info['type']) && $info['type'] == 'array') {
9977 return true;
9978 } else {
9979 return false;
9980 }
9981 }
9982 return false;
9983 }
9984
9991 public function isDate($info)
9992 {
9993 if (isset($info['type']) && ($info['type'] == 'date' || $info['type'] == 'datetime' || $info['type'] == 'timestamp')) {
9994 return true;
9995 }
9996 return false;
9997 }
9998
10005 public function isDuration($info)
10006 {
10007 if (is_array($info)) {
10008 if (isset($info['type']) && ($info['type'] == 'duration')) {
10009 return true;
10010 } else {
10011 return false;
10012 }
10013 } else {
10014 return false;
10015 }
10016 }
10017
10024 public function isInt($info)
10025 {
10026 if (is_array($info)) {
10027 if (isset($info['type']) && (preg_match('/(^int|int$)/i', $info['type']))) {
10028 return true;
10029 } else {
10030 return false;
10031 }
10032 } else {
10033 return false;
10034 }
10035 }
10036
10043 public function isFloat($info)
10044 {
10045 if (is_array($info)) {
10046 if (isset($info['type']) && (preg_match('/^(double|real|price)/i', $info['type']))) {
10047 return true;
10048 } else {
10049 return false;
10050 }
10051 }
10052 return false;
10053 }
10054
10061 public function isText($info)
10062 {
10063 if (is_array($info)) {
10064 if (isset($info['type']) && $info['type'] == 'text') {
10065 return true;
10066 } else {
10067 return false;
10068 }
10069 }
10070 return false;
10071 }
10072
10079 protected function canBeNull($info)
10080 {
10081 if (is_array($info)) {
10082 if (array_key_exists('notnull', $info) && $info['notnull'] != '1') {
10083 return true;
10084 } else {
10085 return false;
10086 }
10087 }
10088 return true;
10089 }
10090
10097 protected function isForcedToNullIfZero($info)
10098 {
10099 if (is_array($info)) {
10100 if (array_key_exists('notnull', $info) && $info['notnull'] == '-1') {
10101 return true;
10102 } else {
10103 return false;
10104 }
10105 }
10106 return false;
10107 }
10108
10115 protected function isIndex($info)
10116 {
10117 if (is_array($info)) {
10118 if (array_key_exists('index', $info) && $info['index'] == true) {
10119 return true;
10120 } else {
10121 return false;
10122 }
10123 }
10124 return false;
10125 }
10126
10127
10136 protected function setSaveQuery()
10137 {
10138 global $conf;
10139
10140 $queryarray = array();
10141 foreach ($this->fields as $field => $info) { // Loop on definition of fields
10142 // Depending on field type ('datetime', ...)
10143 if ($this->isDate($info)) {
10144 if (empty($this->{$field})) {
10145 $queryarray[$field] = null;
10146 } else {
10147 $queryarray[$field] = $this->db->idate($this->{$field});
10148 }
10149 } elseif ($this->isDuration($info)) {
10150 // $this->{$field} may be null, '', 0, '0', 123, '123'
10151 if ((isset($this->{$field}) && $this->{$field} != '') || !empty($info['notnull'])) {
10152 if (!isset($this->{$field})) {
10153 if (!empty($info['default'])) {
10154 $queryarray[$field] = $info['default'];
10155 } else {
10156 $queryarray[$field] = 0;
10157 }
10158 } else {
10159 $queryarray[$field] = (int) $this->{$field}; // If '0', it may be set to null later if $info['notnull'] == -1
10160 }
10161 } else {
10162 $queryarray[$field] = null;
10163 }
10164 } elseif ($this->isInt($info) || $this->isFloat($info)) {
10165 if ($field == 'entity' && is_null($this->{$field})) {
10166 $queryarray[$field] = ((int) $conf->entity);
10167 } else {
10168 // $this->{$field} may be null, '', 0, '0', 123, '123'
10169 if ((isset($this->{$field}) && ((string) $this->{$field}) != '') || !empty($info['notnull'])) {
10170 if (!isset($this->{$field})) {
10171 $queryarray[$field] = 0;
10172 } elseif ($this->isInt($info)) {
10173 $queryarray[$field] = (int) $this->{$field}; // If '0', it may be set to null later if $info['notnull'] == -1
10174 } elseif ($this->isFloat($info)) {
10175 $queryarray[$field] = (float) $this->{$field}; // If '0', it may be set to null later if $info['notnull'] == -1
10176 }
10177 } else {
10178 $queryarray[$field] = null;
10179 }
10180 }
10181 } else {
10182 // Note: If $this->{$field} is not defined, it means there is a bug into definition of ->fields or a missing declaration of property
10183 // We should keep the warning generated by this because it is a bug somewhere else in code, not here.
10184 $queryarray[$field] = $this->{$field};
10185 }
10186
10187 if (array_key_exists('type', $info) && $info['type'] == 'timestamp' && empty($queryarray[$field])) {
10188 unset($queryarray[$field]);
10189 }
10190 if (!empty($info['notnull']) && $info['notnull'] == -1 && empty($queryarray[$field])) {
10191 $queryarray[$field] = null; // May force 0 to null
10192 }
10193 }
10194
10195 return $queryarray;
10196 }
10197
10204 public function setVarsFromFetchObj(&$obj)
10205 {
10206 global $db;
10207
10208 foreach ($this->fields as $field => $info) {
10209 if ($this->isDate($info)) {
10210 if (!isset($obj->$field) || is_null($obj->$field) || $obj->$field === '' || $obj->$field === '0000-00-00 00:00:00' || $obj->$field === '1000-01-01 00:00:00') {
10211 $this->$field = '';
10212 } else {
10213 $this->$field = $db->jdate($obj->$field);
10214 }
10215 } elseif ($this->isInt($info)) {
10216 if ($field == 'rowid') {
10217 $this->id = (int) $obj->$field;
10218 } else {
10219 if ($this->isForcedToNullIfZero($info)) {
10220 if (empty($obj->$field)) {
10221 $this->$field = null;
10222 } else {
10223 $this->$field = (int) $obj->$field;
10224 }
10225 } else {
10226 if (isset($obj->$field) && (!is_null($obj->$field) || (array_key_exists('notnull', $info) && $info['notnull'] == 1))) {
10227 $this->$field = (int) $obj->$field;
10228 } else {
10229 $this->$field = null;
10230 }
10231 }
10232 }
10233 } elseif ($this->isFloat($info)) {
10234 if ($this->isForcedToNullIfZero($info)) {
10235 if (empty($obj->$field)) {
10236 $this->$field = null;
10237 } else {
10238 $this->$field = (float) $obj->$field;
10239 }
10240 } else {
10241 if (isset($obj->$field) && (!is_null($obj->$field) || (array_key_exists('notnull', $info) && $info['notnull'] == 1))) {
10242 $this->$field = (float) $obj->$field;
10243 } else {
10244 $this->$field = null;
10245 }
10246 }
10247 } else {
10248 $this->$field = isset($obj->$field) ? $obj->$field : null;
10249 }
10250 }
10251
10252 // If there is no 'ref' field, we force property ->ref to ->id for a better compatibility with common functions.
10253 if (!isset($this->fields['ref']) && isset($this->id)) {
10254 $this->ref = (string) $this->id;
10255 }
10256 }
10257
10262 public function emtpyObjectVars()
10263 {
10264 foreach ($this->fields as $field => $arr) {
10265 $this->$field = null;
10266 }
10267 }
10268
10276 public function getFieldList($alias = '', $excludefields = array())
10277 {
10278 $keys = array_keys($this->fields);
10279 if (!empty($alias)) {
10280 $keys_with_alias = array();
10281 foreach ($keys as $fieldname) {
10282 if (!empty($excludefields)) {
10283 if (in_array($fieldname, $excludefields)) { // The field is excluded and must not be in output
10284 continue;
10285 }
10286 }
10287 $keys_with_alias[] = $alias . '.' . $fieldname;
10288 }
10289 return implode(',', $keys_with_alias);
10290 } else {
10291 return implode(',', $keys);
10292 }
10293 }
10294
10302 protected function quote($value, $fieldsentry)
10303 {
10304 if (is_null($value)) {
10305 return 'NULL';
10306 } elseif (preg_match('/^(int|double|real|price)/i', $fieldsentry['type'])) {
10307 return price2num((string) $value);
10308 } elseif (preg_match('/int$/i', $fieldsentry['type'])) {
10309 return (int) $value;
10310 } elseif ($fieldsentry['type'] == 'boolean') {
10311 if ($value) {
10312 return 'true';
10313 } else {
10314 return 'false';
10315 }
10316 } else {
10317 return "'".$this->db->escape($value)."'";
10318 }
10319 }
10320
10321
10329 public function createCommon(User $user, $notrigger = 0)
10330 {
10331 global $langs;
10332
10333 dol_syslog(get_class($this)."::createCommon create", LOG_DEBUG);
10334
10335 $error = 0;
10336
10337 $now = dol_now();
10338
10339 $fieldvalues = $this->setSaveQuery();
10340
10341 // Note: Here, $fieldvalues contains same keys (or less) that are inside ->fields
10342
10343 if (array_key_exists('date_creation', $fieldvalues) && empty($fieldvalues['date_creation'])) {
10344 $fieldvalues['date_creation'] = $this->db->idate($now);
10345 $this->date_creation = $this->db->idate($now);
10346 }
10347 if (array_key_exists('fk_user_creat', $fieldvalues) && !($fieldvalues['fk_user_creat'] > 0)) {
10348 $fieldvalues['fk_user_creat'] = $user->id;
10349 $this->fk_user_creat = $user->id;
10350 }
10351 if (array_key_exists('user_creation_id', $fieldvalues) && !($fieldvalues['user_creation_id'] > 0)) {
10352 $fieldvalues['user_creation_id'] = $user->id;
10353 $this->user_creation_id = $user->id;
10354 }
10355 if (array_key_exists('pass_crypted', $fieldvalues) && property_exists($this, 'pass')) {
10356 // @phan-suppress-next-line PhanUndeclaredProperty
10357 $fieldvalues['pass_crypted'] = dol_hash($this->pass);
10358 }
10359 if (array_key_exists('ref', $fieldvalues)) {
10360 $fieldvalues['ref'] = dol_string_nospecial($fieldvalues['ref']); // If field is a ref, we sanitize data
10361 }
10362
10363 unset($fieldvalues['rowid']); // The field 'rowid' is reserved field name for autoincrement field so we don't need it into insert.
10364
10365 $keys = array();
10366 $values = array(); // Array to store string forged for SQL syntax
10367 foreach ($fieldvalues as $k => $v) {
10368 $keys[$k] = $k;
10369 $value = $this->fields[$k];
10370 // @phan-suppress-next-line PhanPluginSuspiciousParamPosition
10371 $values[$k] = $this->quote($v, $value); // May return string 'NULL' if $value is null
10372 }
10373
10374 // Clean and check mandatory
10375 foreach ($keys as $key) {
10376 if (!isset($this->fields[$key])) {
10377 continue;
10378 }
10379 $key_fields = $this->fields[$key];
10380
10381 // If field is an implicit foreign key field (so type = 'integer:...')
10382 if (preg_match('/^integer:/i', $key_fields['type']) && $values[$key] == '-1') {
10383 $values[$key] = '';
10384 }
10385 if (!empty($key_fields['foreignkey']) && $values[$key] == '-1') {
10386 $values[$key] = '';
10387 }
10388
10389 if (isset($key_fields['notnull']) && $key_fields['notnull'] == 1 && (!isset($values[$key]) || $values[$key] === 'NULL') && (!isset($key_fields['default']) || is_null($key_fields['default']))) {
10390 $error++;
10391 $langs->load("errors");
10392 dol_syslog("Mandatory field '".$key."' is empty and required into ->fields definition of class");
10393 $this->errors[] = $langs->trans("ErrorFieldRequired", isset($key_fields['label']) ? $key_fields['label'] : $key);
10394 }
10395
10396 // If value is null and there is a default value for field @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset
10397 if (isset($key_fields['notnull']) && $key_fields['notnull'] == 1 && (!isset($values[$key]) || $values[$key] === 'NULL') && !is_null($key_fields['default'])) {
10398 $values[$key] = $this->quote($key_fields['default'], $key_fields);
10399 }
10400
10401 // If field is an implicit foreign key field (so type = 'integer:...')
10402 if (isset($key_fields['type']) && preg_match('/^integer:/i', $key_fields['type']) && empty($values[$key])) {
10403 if (isset($key_fields['default'])) {
10404 $values[$key] = ((int) $key_fields['default']);
10405 } else {
10406 $values[$key] = 'null';
10407 }
10408 }
10409 if (!empty($key_fields['foreignkey']) && empty($values[$key])) {
10410 $values[$key] = 'null';
10411 }
10412 }
10413
10414 if ($error) {
10415 return -1;
10416 }
10417
10418 $this->db->begin();
10419
10420 if (!$error) {
10421 $sql = "INSERT INTO ".$this->db->prefix().$this->table_element;
10422 $sql .= " (".implode(", ", $keys).')';
10423 $sql .= " VALUES (".implode(", ", $values).")"; // $values can contains 'abc' or 123
10424
10425 $res = $this->db->query($sql);
10426 if (!$res) {
10427 $error++;
10428 if ($this->db->lasterrno() == 'DB_ERROR_RECORD_ALREADY_EXISTS') {
10429 $this->errors[] = "ErrorRefAlreadyExists";
10430 } else {
10431 $this->errors[] = $this->db->lasterror();
10432 }
10433 }
10434 }
10435
10436 if (!$error) {
10437 $this->id = $this->db->last_insert_id($this->db->prefix().$this->table_element);
10438 }
10439
10440 // If we have a field ref with a default value of (PROV)
10441 if (!$error) {
10442 // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset
10443 if (array_key_exists('ref', $this->fields) && array_key_exists('notnull', $this->fields['ref']) && $this->fields['ref']['notnull'] > 0 && array_key_exists('default', $this->fields['ref']) && $this->fields['ref']['default'] == '(PROV)') {
10444 $sql = "UPDATE ".$this->db->prefix().$this->table_element." SET ref = '(PROV".((int) $this->id).")' WHERE (ref = '(PROV)' OR ref = '') AND rowid = ".((int) $this->id);
10445 $resqlupdate = $this->db->query($sql);
10446
10447 if ($resqlupdate === false) {
10448 $error++;
10449 $this->errors[] = $this->db->lasterror();
10450 } else {
10451 $this->ref = '(PROV'.$this->id.')';
10452 }
10453 }
10454 }
10455
10456 // Create extrafields
10457 if (!$error) {
10458 $result = $this->insertExtraFields();
10459 if ($result < 0) {
10460 $error++;
10461 }
10462 }
10463
10464 // Create lines
10465 if (!empty($this->table_element_line) && !empty($this->fk_element)) {
10466 foreach ($this->lines as $line) {
10467 $keyforparent = $this->fk_element;
10468 $line->$keyforparent = $this->id;
10469
10470 // Test and convert into object this->lines[$i]. When coming from REST API, we may still have an array
10471 //if (! is_object($line)) $line=json_decode(json_encode($line), false); // convert recursively array into object.
10472 if (!is_object($line)) {
10473 $line = (object) $line;
10474 }
10475
10476 $result = 0;
10477 if (method_exists($line, 'insert')) {
10478 $result = $line->insert($user, 1);
10479 } elseif (method_exists($line, 'create')) {
10480 $result = $line->create($user, 1);
10481 }
10482 if ($result < 0) {
10483 $this->error = $line->error;
10484 $this->db->rollback();
10485 return -1;
10486 }
10487 }
10488 }
10489
10490 // Triggers
10491 if (!$error && !$notrigger) {
10492 // Call triggers
10493 $result = $this->call_trigger(strtoupper(get_class($this)).'_CREATE', $user);
10494 if ($result < 0) {
10495 $error++;
10496 }
10497 // End call triggers
10498 }
10499
10500 // Commit or rollback
10501 if ($error) {
10502 $this->db->rollback();
10503 return -1;
10504 } else {
10505 $this->db->commit();
10506 return $this->id;
10507 }
10508 }
10509
10510
10520 public function fetchCommon($id, $ref = null, $morewhere = '', $noextrafields = 0)
10521 {
10522 if (empty($id) && empty($ref) && empty($morewhere)) {
10523 return -1;
10524 }
10525
10526 $fieldlist = $this->getFieldList('t');
10527 if (empty($fieldlist)) {
10528 return 0;
10529 }
10530
10531 $sql = "SELECT ".$fieldlist;
10532 $sql .= " FROM ".$this->db->prefix().$this->table_element.' as t';
10533
10534 if (!empty($id)) {
10535 $sql .= ' WHERE t.rowid = '.((int) $id);
10536 } elseif (!empty($ref)) {
10537 $sql .= " WHERE t.ref = '".$this->db->escape($ref)."'";
10538 } else {
10539 $sql .= ' WHERE 1 = 1'; // usage with empty id and empty ref is very rare
10540 }
10541 if (empty($id) && isset($this->ismultientitymanaged) && $this->ismultientitymanaged == 1) {
10542 $sql .= ' AND t.entity IN ('.getEntity($this->element).')';
10543 }
10544 if ($morewhere) {
10545 $sql .= $morewhere;
10546 }
10547 $sql .= ' LIMIT 1'; // This is a fetch, to be certain to get only one record
10548
10549 $res = $this->db->query($sql);
10550 if ($res) {
10551 $obj = $this->db->fetch_object($res);
10552 if ($obj) {
10553 $this->setVarsFromFetchObj($obj);
10554
10555 // Retrieve all extrafield
10556 // fetch optionals attributes and labels
10557 if (empty($noextrafields)) {
10558 $result = $this->fetch_optionals();
10559 if ($result < 0) {
10560 $this->error = $this->db->lasterror();
10561 $this->errors[] = $this->error;
10562 return -4;
10563 }
10564 }
10565
10566 return $this->id;
10567 } else {
10568 return 0;
10569 }
10570 } else {
10571 $this->error = $this->db->lasterror();
10572 $this->errors[] = $this->error;
10573 return -1;
10574 }
10575 }
10576
10584 public function fetchLinesCommon($morewhere = '', $noextrafields = 0)
10585 {
10586 $objectlineclassname = get_class($this).'Line';
10587 if (!class_exists($objectlineclassname)) {
10588 $this->error = 'Error, class '.$objectlineclassname.' not found during call of fetchLinesCommon';
10589 return -1;
10590 }
10591
10592 $objectline = new $objectlineclassname($this->db);
10593 '@phan-var-force CommonObjectLine $objectline';
10594
10595 $sql = "SELECT ".$objectline->getFieldList('l');
10596 $sql .= " FROM ".$this->db->prefix().$objectline->table_element." as l";
10597 $sql .= " WHERE l.fk_".$this->db->escape($this->element)." = ".((int) $this->id);
10598 if ($morewhere) {
10599 $sql .= $morewhere;
10600 }
10601 if (isset($objectline->fields['position'])) {
10602 $sql .= $this->db->order('position', 'ASC');
10603 }
10604
10605 $resql = $this->db->query($sql);
10606 if ($resql) {
10607 $num_rows = $this->db->num_rows($resql);
10608 $i = 0;
10609 $this->lines = array();
10610 while ($i < $num_rows) {
10611 $obj = $this->db->fetch_object($resql);
10612 if ($obj) {
10613 $newline = new $objectlineclassname($this->db);
10614 '@phan-var-force CommonObjectLine $newline';
10615 $newline->setVarsFromFetchObj($obj);
10616
10617 // Note: extrafields load of line not yet supported
10618 /*
10619 if (empty($noextrafields)) {
10620 // Load extrafields of line
10621 }*/
10622
10623 $this->lines[] = $newline;
10624 }
10625 $i++;
10626 }
10627
10628 return 1;
10629 } else {
10630 $this->error = $this->db->lasterror();
10631 $this->errors[] = $this->error;
10632 return -1;
10633 }
10634 }
10635
10643 public function updateCommon(User $user, $notrigger = 0)
10644 {
10645 dol_syslog(get_class($this)."::updateCommon update", LOG_DEBUG);
10646
10647 $error = 0;
10648
10649 $now = dol_now();
10650
10651 // $this->oldcopy should have been set by the caller of update
10652 //if (empty($this->oldcopy)) {
10653 // dol_syslog("this->oldcopy should have been set by the caller of update (here properties were already modified)", LOG_WARNING);
10654 // $this->oldcopy = dol_clone($this, 2);
10655 //}
10656
10657 $fieldvalues = $this->setSaveQuery();
10658
10659 // Note: Here, $fieldvalues contains same keys (or less) that are inside ->fields
10660
10661 if (array_key_exists('date_modification', $fieldvalues) && empty($fieldvalues['date_modification'])) {
10662 $fieldvalues['date_modification'] = $this->db->idate($now);
10663 }
10664 if (array_key_exists('fk_user_modif', $fieldvalues) && !($fieldvalues['fk_user_modif'] > 0)) {
10665 $fieldvalues['fk_user_modif'] = $user->id;
10666 }
10667 if (array_key_exists('user_modification_id', $fieldvalues) && !($fieldvalues['user_modification_id'] > 0)) {
10668 $fieldvalues['user_modification_id'] = $user->id;
10669 }
10670 if (array_key_exists('ref', $fieldvalues)) {
10671 $fieldvalues['ref'] = dol_string_nospecial($fieldvalues['ref']); // If field is a ref, we sanitize data
10672 }
10673
10674 unset($fieldvalues['rowid']); // The field 'rowid' is reserved field name for autoincrement field so we don't need it into update.
10675
10676 // Add quotes and escape on fields with type string
10677 $keys = array();
10678 $values = array();
10679 $tmp = array();
10680 foreach ($fieldvalues as $k => $v) {
10681 $keys[$k] = $k;
10682 $value = $this->fields[$k];
10683 // @phan-suppress-next-line PhanPluginSuspiciousParamPosition
10684 $values[$k] = $this->quote($v, $value);
10685 if (($value["type"] == "text") && !empty($value['arrayofkeyval']) && is_array($value['arrayofkeyval'])) {
10686 // Clean values for text with selectbox
10687 $v = preg_replace('/\s/', ',', $v);
10688 $v = preg_replace('/,+/', ',', $v);
10689 }
10690 // @phan-suppress-next-line PhanPluginSuspiciousParamPosition
10691 $tmp[] = $k.'='.$this->quote($v, $this->fields[$k]);
10692 }
10693
10694 // Clean and check mandatory fields
10695 foreach ($keys as $key) {
10696 if (preg_match('/^integer:/i', $this->fields[$key]['type']) && $values[$key] == '-1') {
10697 $values[$key] = ''; // This is an implicit foreign key field
10698 }
10699 if (!empty($this->fields[$key]['foreignkey']) && $values[$key] == '-1') {
10700 $values[$key] = ''; // This is an explicit foreign key field
10701 }
10702
10703 //var_dump($key.'-'.$values[$key].'-'.($this->fields[$key]['notnull'] == 1));
10704 /*
10705 if ($this->fields[$key]['notnull'] == 1 && empty($values[$key]))
10706 {
10707 $error++;
10708 $this->errors[]=$langs->trans("ErrorFieldRequired", $this->fields[$key]['label']);
10709 }*/
10710 }
10711
10712 $sql = 'UPDATE '.$this->db->prefix().$this->table_element.' SET '.implode(', ', $tmp).' WHERE rowid='.((int) $this->id);
10713
10714 $this->db->begin();
10715
10716 if (!$error) {
10717 $res = $this->db->query($sql);
10718 if (!$res) {
10719 $error++;
10720 $this->errors[] = $this->db->lasterror();
10721 }
10722 }
10723
10724 // Update extrafield
10725 if (!$error) {
10726 $result = $this->insertExtraFields(); // This delete and reinsert extrafields
10727 if ($result < 0) {
10728 $error++;
10729 }
10730 }
10731
10732 // Triggers
10733 if (!$error && !$notrigger) {
10734 // Call triggers
10735 $result = $this->call_trigger(strtoupper(get_class($this)).'_MODIFY', $user);
10736 if ($result < 0) {
10737 $error++;
10738 } //Do also here what you must do to rollback action if trigger fail
10739 // End call triggers
10740 }
10741
10742 // Commit or rollback
10743 if ($error) {
10744 $this->db->rollback();
10745 return -1;
10746 } else {
10747 $this->db->commit();
10748 return $this->id;
10749 }
10750 }
10751
10760 public function deleteCommon(User $user, $notrigger = 0, $forcechilddeletion = 0)
10761 {
10762 dol_syslog(get_class($this)."::deleteCommon delete", LOG_DEBUG);
10763
10764 $error = 0;
10765
10766 $this->db->begin();
10767
10768 if ($forcechilddeletion) { // Force also delete of childtables that should lock deletion in standard case when option force is off
10769 foreach ($this->childtables as $table) {
10770 $sql = "DELETE FROM ".$this->db->prefix().$table." WHERE ".$this->fk_element." = ".((int) $this->id);
10771 $resql = $this->db->query($sql);
10772 if (!$resql) {
10773 $this->error = $this->db->lasterror();
10774 $this->errors[] = $this->error;
10775 $this->db->rollback();
10776 return -1;
10777 }
10778 }
10779 } elseif (!empty($this->childtables)) { // If object has children linked with a foreign key field, we check all child tables.
10780 $objectisused = $this->isObjectUsed($this->id);
10781 if (!empty($objectisused)) {
10782 dol_syslog(get_class($this)."::deleteCommon Can't delete record as it has some child", LOG_WARNING);
10783 $this->error = 'ErrorRecordHasChildren';
10784 $this->errors[] = $this->error;
10785 $this->db->rollback();
10786 return 0;
10787 }
10788 }
10789
10790 // Delete cascade first
10791 if (is_array($this->childtablesoncascade) && !empty($this->childtablesoncascade)) {
10792 foreach ($this->childtablesoncascade as $tabletodelete) {
10793 $deleteFromObject = explode(':', $tabletodelete, 4);
10794 if (count($deleteFromObject) >= 2) {
10795 $className = str_replace('@', '', $deleteFromObject[0]);
10796 $filePath = $deleteFromObject[1];
10797 $columnName = $deleteFromObject[2];
10798 $filter = '';
10799 if (!empty($deleteFromObject[3])) {
10800 $filter = $deleteFromObject[3];
10801 }
10802 if (dol_include_once($filePath)) {
10803 $childObject = new $className($this->db);
10804 if (method_exists($childObject, 'deleteByParentField')) {
10805 '@phan-var-force CommonObject $childObject';
10806 $result = $childObject->deleteByParentField($this->id, $columnName, $filter);
10807 if ($result < 0) {
10808 $error++;
10809 $this->errors[] = $childObject->error;
10810 break;
10811 }
10812 } else {
10813 $error++;
10814 $this->errors[] = "You defined a cascade delete on an object $className/$this->id but there is no method deleteByParentField for it";
10815 break;
10816 }
10817 } else {
10818 $error++;
10819 $this->errors[] = 'Cannot include child class file '.$filePath;
10820 break;
10821 }
10822 } else {
10823 // Delete record in child table
10824 $sql = "DELETE FROM ".$this->db->prefix().$tabletodelete." WHERE ".$this->fk_element." = ".((int) $this->id);
10825
10826 $resql = $this->db->query($sql);
10827 if (!$resql) {
10828 $error++;
10829 $this->error = $this->db->lasterror();
10830 $this->errors[] = $this->error;
10831 break;
10832 }
10833 }
10834 }
10835 }
10836
10837 if (!$error) {
10838 if (!$notrigger) {
10839 // Call triggers
10840 $result = $this->call_trigger(strtoupper(get_class($this)).'_DELETE', $user);
10841 if ($result < 0) {
10842 $error++;
10843 } // Do also here what you must do to rollback action if trigger fail
10844 // End call triggers
10845 }
10846 }
10847
10848 // Delete llx_ecm_files
10849 if (!$error) {
10850 $res = $this->deleteEcmFiles(1); // Deleting files physically is done later with the dol_delete_dir_recursive
10851 if (!$res) {
10852 $error++;
10853 }
10854 }
10855
10856 // Delete linked object
10857 $res = $this->deleteObjectLinked();
10858 if ($res < 0) {
10859 $error++;
10860 }
10861
10862 if (!$error && !empty($this->isextrafieldmanaged)) {
10863 $result = $this->deleteExtraFields();
10864 if ($result < 0) {
10865 $error++;
10866 }
10867 }
10868
10869 if (!$error) {
10870 $sql = 'DELETE FROM '.$this->db->prefix().$this->table_element.' WHERE rowid='.((int) $this->id);
10871
10872 $resql = $this->db->query($sql);
10873 if (!$resql) {
10874 $error++;
10875 $this->errors[] = $this->db->lasterror();
10876 }
10877 }
10878
10879 // Commit or rollback
10880 if ($error) {
10881 $this->db->rollback();
10882 return -1;
10883 } else {
10884 $this->db->commit();
10885 return 1;
10886 }
10887 }
10888
10900 public function deleteByParentField($parentId = 0, $parentField = '', $filter = '', $filtermode = "AND")
10901 {
10902 global $user;
10903
10904 $error = 0;
10905 $deleted = 0;
10906
10907 if (!empty($parentId) && !empty($parentField)) {
10908 $this->db->begin();
10909
10910 $sql = "SELECT rowid FROM ".$this->db->prefix().$this->table_element;
10911 $sql .= " WHERE ".$this->db->sanitize($parentField)." = ".(int) $parentId;
10912
10913 // Manage filter
10914 $errormessage = '';
10915 $sql .= forgeSQLFromUniversalSearchCriteria($filter, $errormessage);
10916 if ($errormessage) {
10917 $this->errors[] = $errormessage;
10918 dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
10919 return -1;
10920 }
10921
10922 $resql = $this->db->query($sql);
10923 if (!$resql) {
10924 $this->errors[] = $this->db->lasterror();
10925 $error++;
10926 } else {
10927 while ($obj = $this->db->fetch_object($resql)) {
10928 $result = $this->fetch($obj->rowid); // @phpstan-ignore-line
10929 if ($result < 0) {
10930 $error++;
10931 $this->errors[] = $this->error;
10932 } else {
10933 $result = $this->delete($user); // @phpstan-ignore-line
10934 if ($result < 0) {
10935 $error++;
10936 $this->errors[] = $this->error;
10937 } else {
10938 $deleted++;
10939 }
10940 }
10941 }
10942 }
10943
10944 if (empty($error)) {
10945 $this->db->commit();
10946 return $deleted;
10947 } else {
10948 $this->error = implode(', ', $this->errors);
10949 $this->db->rollback();
10950 return $error * -1;
10951 }
10952 }
10953
10954 return $deleted;
10955 }
10956
10965 public function deleteLineCommon(User $user, $idline, $notrigger = 0)
10966 {
10967 $error = 0;
10968
10969 $tmpforobjectclass = get_class($this);
10970 $tmpforobjectlineclass = ucfirst($tmpforobjectclass).'Line';
10971
10972 $this->db->begin();
10973
10974 // Call trigger
10975 $result = $this->call_trigger('LINE'.strtoupper($tmpforobjectclass).'_DELETE', $user);
10976 if ($result < 0) {
10977 $error++;
10978 }
10979 // End call triggers
10980
10981 if (empty($error)) {
10982 $sql = "DELETE FROM ".$this->db->prefix().$this->table_element_line;
10983 $sql .= " WHERE rowid = ".((int) $idline);
10984
10985 $resql = $this->db->query($sql);
10986 if (!$resql) {
10987 $this->error = "Error ".$this->db->lasterror();
10988 $error++;
10989 }
10990 }
10991
10992 if (empty($error)) {
10993 // Remove extrafields
10994 $tmpobjectline = new $tmpforobjectlineclass($this->db);
10995 '@phan-var-force CommonObjectLine $tmpobjectline';
10996 if (!isset($tmpobjectline->isextrafieldmanaged) || !empty($tmpobjectline->isextrafieldmanaged)) {
10997 $tmpobjectline->id = $idline;
10998 $result = $tmpobjectline->deleteExtraFields();
10999 if ($result < 0) {
11000 $error++;
11001 $this->error = "Error ".get_class($this)."::deleteLineCommon deleteExtraFields error -4 ".$tmpobjectline->error;
11002 }
11003 }
11004 }
11005
11006 if (empty($error)) {
11007 $this->db->commit();
11008 return 1;
11009 } else {
11010 dol_syslog(get_class($this)."::deleteLineCommon ERROR:".$this->error, LOG_ERR);
11011 $this->db->rollback();
11012 return -1;
11013 }
11014 }
11015
11016
11026 public function setStatusCommon($user, $status, $notrigger = 0, $triggercode = '')
11027 {
11028 $error = 0;
11029
11030 $this->db->begin();
11031
11032 $statusfield = 'status';
11033 if (in_array($this->element, array('don', 'donation', 'shipping'))) {
11034 $statusfield = 'fk_statut';
11035 }
11036
11037 $sql = "UPDATE ".$this->db->prefix().$this->table_element;
11038 $sql .= " SET ".$statusfield." = ".((int) $status);
11039 $sql .= " WHERE rowid = ".((int) $this->id);
11040
11041 if ($this->db->query($sql)) {
11042 if (!$error) {
11043 $this->oldcopy = clone $this;
11044 }
11045
11046 if (!$error && !$notrigger) {
11047 // Call trigger
11048 $result = $this->call_trigger($triggercode, $user);
11049 if ($result < 0) {
11050 $error++;
11051 }
11052 }
11053
11054 if (!$error) {
11055 $this->status = $status;
11056 if (property_exists($this, 'statut')) { // For backward compatibility
11057 $this->statut = $status;
11058 }
11059 $this->db->commit();
11060 return 1;
11061 } else {
11062 $this->db->rollback();
11063 return -1;
11064 }
11065 } else {
11066 $this->error = $this->db->error();
11067 $this->db->rollback();
11068 return -1;
11069 }
11070 }
11071
11078 public function initAsSpecimenCommon()
11079 {
11080 global $user;
11081
11082 $this->id = 0;
11083 $this->specimen = 1;
11084 $fields = array(
11085 'label' => 'This is label',
11086 'ref' => 'ABCD1234',
11087 'description' => 'This is a description',
11088 'qty' => 123.12,
11089 'note_public' => 'Public note',
11090 'note_private' => 'Private note',
11091 'date_creation' => (dol_now() - 3600 * 48),
11092 'date_modification' => (dol_now() - 3600 * 24),
11093 'fk_user_creat' => $user->id,
11094 'fk_user_modif' => $user->id,
11095 'date' => dol_now(),
11096 );
11097 foreach ($fields as $key => $value) {
11098 if (array_key_exists($key, $this->fields)) {
11099 $this->{$key} = $value; // @phpstan-ignore-line
11100 }
11101 }
11102
11103 // Force values to default values when known
11104 if (property_exists($this, 'fields')) {
11105 foreach ($this->fields as $key => $value) {
11106 // If fields are already set, do nothing
11107 if (array_key_exists($key, $fields)) {
11108 continue;
11109 }
11110
11111 if (!empty($value['default'])) {
11112 $this->$key = $value['default'];
11113 }
11114 }
11115 }
11116
11117 return 1;
11118 }
11119
11120
11121 /* Part for comments */
11122
11128 public function fetchComments()
11129 {
11130 require_once DOL_DOCUMENT_ROOT.'/core/class/comment.class.php';
11131
11132 $comment = new Comment($this->db);
11133 $result = $comment->fetchAllFor($this->element, $this->id);
11134 if ($result < 0) {
11135 $this->errors = array_merge($this->errors, $comment->errors);
11136 return -1;
11137 } else {
11138 $this->comments = $comment->comments;
11139 }
11140 return count($this->comments);
11141 }
11142
11148 public function getNbComments()
11149 {
11150 return count($this->comments);
11151 }
11152
11159 public function trimParameters($parameters)
11160 {
11161 if (!is_array($parameters)) {
11162 return;
11163 }
11164 foreach ($parameters as $parameter) {
11165 if (isset($this->$parameter)) {
11166 $this->$parameter = trim($this->$parameter);
11167 }
11168 }
11169 }
11170
11171 /* Part for categories/tags */
11172
11183 public function getCategoriesCommon($type_categ)
11184 {
11185 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
11186
11187 // Get current categories
11188 $c = new Categorie($this->db);
11189 $existing = $c->containing($this->id, $type_categ, 'id');
11190
11191 return $existing;
11192 }
11193
11206 public function setCategoriesCommon($categories, $type_categ = '', $remove_existing = true)
11207 {
11208 // Handle single category
11209 if (!is_array($categories)) {
11210 $categories = array($categories);
11211 }
11212
11213 dol_syslog(get_class($this)."::setCategoriesCommon Object Id:".$this->id.' type_categ:'.$type_categ.' nb tag add:'.count($categories), LOG_DEBUG);
11214
11215 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
11216
11217 if (empty($type_categ)) {
11218 dol_syslog(__METHOD__.': Type '.$type_categ.'is an unknown category type. Done nothing.', LOG_ERR);
11219 return -1;
11220 }
11221
11222 // Get current categories
11223 $c = new Categorie($this->db);
11224 $existing = $c->containing($this->id, $type_categ, 'id');
11225 if ($remove_existing) {
11226 // Diff
11227 if (is_array($existing)) {
11228 $to_del = array_diff($existing, $categories);
11229 $to_add = array_diff($categories, $existing);
11230 } else {
11231 $to_del = array(); // Nothing to delete
11232 $to_add = $categories;
11233 }
11234 } else {
11235 $to_del = array(); // Nothing to delete
11236 $to_add = array_diff($categories, $existing);
11237 }
11238
11239 $error = 0;
11240 $ok = 0;
11241
11242 // Process
11243 foreach ($to_del as $del) {
11244 if ($c->fetch($del) > 0) {
11245 $result = $c->del_type($this, $type_categ);
11246 if ($result < 0) {
11247 $error++;
11248 $this->error = $c->error;
11249 $this->errors = $c->errors;
11250 break;
11251 } else {
11252 $ok += $result;
11253 }
11254 }
11255 }
11256 foreach ($to_add as $add) {
11257 if ($c->fetch($add) > 0) {
11258 $result = $c->add_type($this, $type_categ);
11259 if ($result < 0) {
11260 $error++;
11261 $this->error = $c->error;
11262 $this->errors = $c->errors;
11263 break;
11264 } else {
11265 $ok += $result;
11266 }
11267 }
11268 }
11269
11270 return $error ? (-1 * $error) : $ok;
11271 }
11272
11281 public function cloneCategories($fromId, $toId, $type = '')
11282 {
11283 $this->db->begin();
11284
11285 if (empty($type)) {
11286 $type = $this->table_element;
11287 }
11288
11289 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
11290 $categorystatic = new Categorie($this->db);
11291
11292 $sql = "INSERT INTO ".$this->db->prefix()."categorie_".(empty($categorystatic->MAP_CAT_TABLE[$type]) ? $type : $categorystatic->MAP_CAT_TABLE[$type])." (fk_categorie, fk_product)";
11293 $sql .= " SELECT fk_categorie, $toId FROM ".$this->db->prefix()."categorie_".(empty($categorystatic->MAP_CAT_TABLE[$type]) ? $type : $categorystatic->MAP_CAT_TABLE[$type]);
11294 $sql .= " WHERE fk_product = ".((int) $fromId);
11295
11296 if (!$this->db->query($sql)) {
11297 $this->error = $this->db->lasterror();
11298 $this->db->rollback();
11299 return -1;
11300 }
11301
11302 $this->db->commit();
11303 return 1;
11304 }
11305
11312 public function deleteEcmFiles($mode = 0)
11313 {
11314 global $conf;
11315
11316 $this->db->begin();
11317
11318 // Delete in database with mode 0
11319 if ($mode == 0) {
11320 switch ($this->element) {
11321 case 'propal':
11322 $element = 'propale';
11323 break;
11324 case 'product':
11325 $element = 'produit';
11326 break;
11327 case 'order_supplier':
11328 $element = 'fournisseur/commande';
11329 break;
11330 case 'invoice_supplier':
11331 // Special cases that need to use get_exdir to get real dir of object
11332 // In future, all object should use this to define path of documents.
11333 $element = 'fournisseur/facture/'.get_exdir($this->id, 2, 0, 1, $this, 'invoice_supplier');
11334 break;
11335 case 'shipping':
11336 $element = 'expedition/sending';
11337 break;
11338 case 'task':
11339 case 'project_task':
11340 require_once DOL_DOCUMENT_ROOT.'/projet/class/task.class.php';
11341
11342 $project_result = $this->fetchProject();
11343 if ($project_result >= 0) {
11344 $element = 'projet/'.dol_sanitizeFileName($this->project->ref).'/';
11345 }
11346 // no break
11347 default:
11348 $element = $this->element;
11349 }
11350 '@phan-var-force string $element';
11351
11352 // Delete ecm_files_extrafields with mode 0 (using name)
11353 $sql = "DELETE FROM ".$this->db->prefix()."ecm_files_extrafields WHERE fk_object IN (";
11354 $sql .= " SELECT rowid FROM ".$this->db->prefix()."ecm_files WHERE filename LIKE '".$this->db->escape($this->ref)."%'";
11355 $sql .= " AND filepath = '".$this->db->escape($element)."/".$this->db->escape($this->ref)."' AND entity = ".((int) $conf->entity); // No need of getEntity here
11356 $sql .= ")";
11357
11358 if (!$this->db->query($sql)) {
11359 $this->error = $this->db->lasterror();
11360 $this->db->rollback();
11361 return false;
11362 }
11363
11364 // Delete ecm_files with mode 0 (using name)
11365 $sql = "DELETE FROM ".$this->db->prefix()."ecm_files";
11366 $sql .= " WHERE filename LIKE '".$this->db->escape($this->ref)."%'";
11367 $sql .= " AND filepath = '".$this->db->escape($element)."/".$this->db->escape($this->ref)."' AND entity = ".((int) $conf->entity); // No need of getEntity here
11368
11369 if (!$this->db->query($sql)) {
11370 $this->error = $this->db->lasterror();
11371 $this->db->rollback();
11372 return false;
11373 }
11374 }
11375
11376 // Delete in database with mode 1
11377 if ($mode == 1) {
11378 $sql = 'DELETE FROM '.$this->db->prefix()."ecm_files_extrafields";
11379 $sql .= " WHERE fk_object IN (SELECT rowid FROM ".$this->db->prefix()."ecm_files WHERE src_object_type = '".$this->db->escape($this->table_element.(empty($this->module) ? "" : "@".$this->module))."' AND src_object_id = ".((int) $this->id).")";
11380 $resql = $this->db->query($sql);
11381 if (!$resql) {
11382 $this->error = $this->db->lasterror();
11383 $this->db->rollback();
11384 return false;
11385 }
11386
11387 $sql = 'DELETE FROM '.$this->db->prefix()."ecm_files";
11388 $sql .= " WHERE src_object_type = '".$this->db->escape($this->table_element.(empty($this->module) ? "" : "@".$this->module))."' AND src_object_id = ".((int) $this->id);
11389 $resql = $this->db->query($sql);
11390 if (!$resql) {
11391 $this->error = $this->db->lasterror();
11392 $this->db->rollback();
11393 return false;
11394 }
11395 }
11396
11397 $this->db->commit();
11398 return true;
11399 }
11400}
$id
Definition account.php:48
if( $user->socid > 0) if(! $user->hasRight('accounting', 'chartofaccount')) $object
Definition card.php:66
ajax_combobox($htmlname, $events=array(), $minLengthToAutocomplete=0, $forcefocus=0, $widthTypeOfAutocomplete='resolve', $idforemptyvalue='-1', $morecss='')
Convert a html select field into an ajax combobox.
Definition ajax.lib.php:459
$object ref
Definition info.php:89
Class to manage categories.
Class to manage comment.
Parent class of all other business classes (invoices, contracts, proposals, orders,...
fetch_optionals($rowid=null, $optionsArray=null)
Function to get extra fields of an object into $this->array_options This method is in most cases call...
getCategoriesCommon($type_categ)
Sets object to given categories.
indexFile($destfull, $update_main_doc_field)
Index a file into the ECM database.
getFormatedSupplierRef($objref)
Return supplier ref for screen output.
line_order($renum=false, $rowidorder='ASC', $fk_parent_line=true)
Save a new position (field rang) for details lines.
deleteLineCommon(User $user, $idline, $notrigger=0)
Delete a line of object in database.
isEmpty()
isEmpty We consider CommonObject isEmpty if this->id is empty
clearFieldError($fieldKey)
clear validation message result for a field
static getCountOfItemsLinkedByObjectID($fk_object_where, $field_where, $table_element)
Count items linked to an object id in association table.
deleteEcmFiles($mode=0)
Delete related files of object in database.
getLastMainDocLink($modulepart, $initsharekey=0, $relativelink=0)
Return the link of last main doc file for direct public download.
liste_type_contact($source='internal', $order='position', $option=0, $activeonly=0, $code='')
Return array with list of possible values for type of contacts.
getTooltipContent($params)
getTooltipContent
update_price($exclspec=0, $roundingadjust='auto', $nodatabaseupdate=0, $seller=null)
Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines).
swapContactStatus($rowid)
Update status of a contact linked to object.
getFieldError($fieldKey)
get field error message
add_object_linked($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
Add an object link into llx_element_element.
updateObjectLinked($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
Update object linked of a current object.
defineBuyPrice($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
Get buy price to use for margin calculation.
commonGenerateDocument($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
Common function for all objects extending CommonObject for generating documents.
liste_contact($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
Get array of all contacts for an object.
fetchObjectFrom($table, $field, $key, $element=null)
Load object from specific field.
fetchProject()
Load the project with id $this->fk_project into this->project.
fetch_thirdparty($force_thirdparty_id=0)
Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty.
static deleteAllItemsLinkedByObjectID($fk_object_where, $field_where, $table_element)
Function used to remove all items linked to an object id in association table.
setFieldError($fieldKey, $msg='')
set validation error message a field
validateField($fields, $fieldKey, $fieldValue)
Return validation test result for a field.
getDataToShowPhoto($modulepart, $imagesize)
Function used to get the logos or photos of an object.
setMulticurrencyCode($code)
Change the multicurrency code.
add_element_resource($resource_id, $resource_type, $busy=0, $mandatory=0)
Add resources to the current object : add entry into llx_element_resources Need $this->element & $thi...
emtpyObjectVars()
Sets all object fields to null.
fetch_projet()
Load the project with id $this->fk_project into this->project.
getIdContact($source, $code, $status=0)
Return id of contacts for a source and a contact code.
setExtraField($key, $value)
Convenience method for setting the value of an extrafield without actually updating it in the databas...
setDocModel($user, $modelpdf)
Set last model used by doc generator.
deleteObjectLinked($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
Delete all links between an object $this.
getExtraField($key)
Convenience method for retrieving the value of an extrafield without actually fetching it from the da...
updateExtraField($key, $trigger=null, $userused=null)
Update 1 extra field value for the current object.
setPaymentTerms($id, $deposit_percent=null)
Change the payments terms.
isFloat($info)
Function test if type is float.
setBankAccount($fk_account, $notrigger=0, $userused=null)
Change the bank account.
setExtraParameters()
Set extra parameters.
setErrorsFromObject($object)
setErrorsFromObject
setShippingMethod($shipping_method_id, $notrigger=0, $userused=null)
Change the shipping method.
update_note_public($note)
Update public note (kept for backward compatibility)
getSpecialCode($lineid)
Get special code of a line.
clearObjectLinkedCache()
Clear the cache saying that all linked object were already loaded.
update_ref_ext($ref_ext)
Update external ref of element.
fetchOneLike($ref)
Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_f...
hasProductsOrServices($predefined=-1)
Function to say how many lines object contains.
static isExistingObject($element, $id, $ref='', $ref_ext='')
Check if an object id or ref exists If you don't need or want to instantiate the object and just need...
isObjectUsed($id=0, $entity=0)
Function to check if an object is used by others (by children).
updateRangOfLine($rowid, $rang)
Update position of line (rang)
getDefaultCreateValueFor($fieldname, $alternatevalue=null, $type='alphanohtml')
Return the default value to use for a field when showing the create form of object.
createCommon(User $user, $notrigger=0)
Create object in the database.
getTotalWeightVolume()
Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding ...
update_note($note, $suffix='', $notrigger=0)
Update note of element.
getFullAddress($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
Return full address of contact.
fetch_project()
Load the project with id $this->fk_project into this->project.
setStatut($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
Set status of an object.
getFieldList($alias='', $excludefields=array())
Function to concat keys of fields.
getNbComments()
Return nb comments already posted.
setVarsFromFetchObj(&$obj)
Function to load data from a SQL pointer into properties of current object $this.
printObjectLines($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir='/core/tpl')
Return HTML table for object lines TODO Move this into an output class file (htmlline....
getChildrenOfLine($id, $includealltree=0)
Get children of line.
updateCommon(User $user, $notrigger=0)
Update object into database.
updateExtraLanguages($key, $trigger=null, $userused=null)
Update an extra language value for the current object.
deleteExtraFields()
Delete all extra fields values for the current object.
setStatusCommon($user, $status, $notrigger=0, $triggercode='')
Set to a status.
deprecatedProperties()
Provide list of deprecated properties and replacements.
addThumbs($file)
Build thumb.
setSaveQuery()
Function to return the array of data key-value from the ->fields and all the ->properties of an objec...
setValuesForExtraLanguages($onlykey='')
Fill array_options property of object by extrafields value (using for data sent by forms)
insertExtraLanguages($trigger='', $userused=null)
Add/Update all extra fields values for the current object.
setTransportMode($id)
Change the transport mode methods.
isArray($info)
Function test if type is array.
isInt($info)
Function test if type is integer.
fetchObjectLinked($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1)
Fetch array of objects linked to current object (object of enabled modules only).
delete_contact($rowid, $notrigger=0)
Delete a link to contact line.
updateLineUp($rowid, $rang)
Update position of line up (rang)
fetch_user($userid)
Load the user with id $userid into this->user.
errorsToString()
Method to output saved errors.
getListContactId($source='external')
Return list of id of contacts of object.
setWarehouse($warehouse_id)
Change the warehouse.
setDeliveryAddress($id)
Define delivery address.
fetchBarCode()
Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode...
getTotalDiscount()
Function that returns the total amount HT of discounts applied for all lines.
initAsSpecimenCommon()
Initialise object with example values Id must be 0 if object instance is a specimen.
printObjectLine($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir='/core/tpl')
Return HTML content of a detail line TODO Move this into an output class file (htmlline....
copy_linked_contact($objFrom, $source='internal')
Copy contact from one element to current.
static commonReplaceThirdparty(DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
Function used to replace a thirdparty id with another one.
getValueFrom($table, $id, $field)
Getter generic.
trimParameters($parameters)
Trim object parameters.
fetch_product()
Load the product with id $this->fk_product into this->product.
isIndex($info)
Function test if is indexed.
quote($value, $fieldsentry)
Add quote to field value if necessary.
formAddObjectLine($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
Show add free and predefined products/services form.
fetchComments()
Load comments linked with current task.
line_down($rowid, $fk_parent_line=true)
Update a line to have a higher rank.
setValueFrom($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
Setter generic.
fetch_contact($contactid=null)
Load object contact with id=$this->contact_id into $this->contact.
setRetainedWarrantyPaymentTerms($id)
Change the retained warranty payments terms.
delThumbs($file)
Delete thumbs.
show_photos($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0, $cache='', $addphotorefcss='photoref')
Show photos of an object (nbmax maximum), into several columns.
fetchLinesCommon($morewhere='', $noextrafields=0)
Load object in memory from the database.
static commonReplaceProduct(DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
Function used to replace a product id with another one.
getRangOfLine($rowid)
Get position of line (rang)
showInputField($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0, $nonewbutton=0)
Return HTML string to put an input field into a page Code very similar with showInputField of extra f...
delete_resource($rowid, $element, $notrigger=0)
Delete a link to resource line.
update_contact($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
Update a link to contact line.
getElementType()
Return an element type string formatted like element_element target_type and source_type.
load_previous_next_ref($filter, $fieldid, $nodbprefix=0)
Load properties id_previous and id_next by comparing $fieldid with $this->ref.
setCategoriesCommon($categories, $type_categ='', $remove_existing=true)
Sets object to given categories.
fetchValuesForExtraLanguages()
Function to get alternative languages of a data into $this->array_languages This method is NOT called...
fetchNoCompute($id)
Function to make a fetch but set environment to avoid to load computed values before.
line_max($fk_parent_line=0)
Get max value used for position of line (rang)
getJSListDependancies($type='_extra')
setProject($projectid, $notrigger=0)
Link element with a project.
isForcedToNullIfZero($info)
Function test if field is forced to null if zero or empty.
line_ajaxorder($rows)
Update position of line with ajax (rang)
printOriginLinesList($restrictlist='', $selectedLines=array())
Return HTML table table of source object lines TODO Move this and previous function into output html ...
fetch_origin()
Read linked origin object.
getIdOfLine($rang)
Get rowid of the line relative to its position.
insertExtraFields($trigger='', $userused=null)
Add/Update all extra fields values for the current object.
deleteByParentField($parentId=0, $parentField='', $filter='', $filtermode="AND")
Delete all child object from a parent ID.
static getAllItemsLinkedByObjectID($fk_object_where, $field_select, $field_where, $table_element)
Function used to get an array with all items linked to an object id in association table.
__clone()
Overwrite magic function to solve problem of cloning object that are kept as references.
setPaymentMethods($id)
Change the payments methods.
updateLineDown($rowid, $rang, $max)
Update position of line down (rang)
delete_linked_contact($source='', $code='')
Delete all links between an object $this and all its contacts in llx_element_contact.
fetchCommon($id, $ref=null, $morewhere='', $noextrafields=0)
Load object in memory from the database.
deleteCommon(User $user, $notrigger=0, $forcechilddeletion=0)
Delete object in database.
getFormatedCustomerRef($objref)
Return customer ref for screen output.
getTooltipContentArray($params)
Return array of data to show into a tooltip.
isText($info)
Function test if type is text.
isDate($info)
Function test if type is date.
printOriginLine($line, $var, $restrictlist='', $defaulttpldir='/core/tpl', $selectedLines=array())
Return HTML with a line of table array of source object lines TODO Move this and previous function in...
showOptionals($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
Function to show lines of extrafields with output data.
getCanvas($id=0, $ref='')
Load type of canvas of an object if it exists.
line_up($rowid, $fk_parent_line=true)
Update a line to have a lower rank.
isDuration($info)
Function test if type is duration.
canBeNull($info)
Function test if field can be null.
listeTypeContacts($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
Return array with list of possible values for type of contacts.
call_trigger($triggerName, $user)
Call trigger based on this instance.
getRights()
Returns the rights used for this class.
add_contact($fk_socpeople, $type_contact, $source='external', $notrigger=0)
Add a link between element $this->element and a contact.
cloneCategories($fromId, $toId, $type='')
Copy related categories to another object.
fetch_barcode()
Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode...
Class to manage contact/addresses.
Class to manage absolute discounts.
Class to manage a WYSIWYG editor.
Class to manage Dolibarr database access.
Class to manage ECM files.
Class to manage standard extra fields.
static isEmptyValue($v, string $type)
Return if a value is "empty" for a mandatory vision.
const TYPE_CREDIT_NOTE
Credit note invoice.
Class to manage generation of HTML components Only common components must be here.
Class to manage triggers.
Parent class to manage intervention document templates.
static getIdAndTxFromCode($dbs, $code, $date_document='')
Get id and rate of currency from code.
Class to manage predefined suppliers products.
Class to manage products or services.
const TYPE_SERVICE
Service.
Class to manage projects.
Class to manage third parties objects (customers, suppliers, prospects...)
Class to manage translations.
Class to manage Dolibarr users.
Class toolbox to validate values.
print $langs trans("Ref").' m titre as m m statut as status
Or an array listing all the potential status of the object: array: int of the status => translated la...
Definition index.php:171
getCountry($searchkey, $withcode='', $dbtouse=null, $outputlangs=null, $entconv=1, $searchlabel='')
Return country label, code or id from an id, code or label.
getState($id, $withcode='0', $dbtouse=null, $withregion=0, $outputlangs=null, $entconv=1)
Return state translated from an id.
convertSecondToTime($iSecond, $format='all', $lengthOfDay=86400, $lengthOfWeek=7)
Return, in clear text, value of a number of seconds in days, hours and minutes.
Definition date.lib.php:244
dol_meta_create($object)
Create a meta file with document file into same directory.
dol_delete_file($file, $disableglob=0, $nophperrors=0, $nohook=0, $object=null, $allowdotdot=false, $indexdatabase=1, $nolog=0)
Remove a file or several files with a mask.
dol_is_file($pathoffile)
Return if path is a file.
dol_dir_list($utf8_path, $types="all", $recursive=0, $filter="", $excludefilter=null, $sortcriteria="name", $sortorder=SORT_ASC, $mode=0, $nohook=0, $relativename="", $donotfollowsymlinks=0, $nbsecondsold=0)
Scan a directory and return a list of files/directories.
Definition files.lib.php:63
completeFileArrayWithDatabaseInfo(&$filearray, $relativedir)
Complete $filearray with data from database.
dol_delete_preview($object)
Delete all preview files linked to object instance.
dol_mktime($hour, $minute, $second, $month, $day, $year, $gm='auto', $check=1)
Return a timestamp date built from detailed information (by default a local PHP server timestamp) Rep...
img_object($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0)
Show a picto called object_picto (generic function)
setEventMessages($mesg, $mesgs, $style='mesgs', $messagekey='', $noduplicate=0, $attop=0)
Set event messages in dol_events session object.
vatrate($rate, $addpercent=false, $info_bits=0, $usestarfornpr=0, $html=0)
Return a string with VAT rate label formatted for view output Used into pdf and HTML pages.
dol_print_ip($ip, $mode=0)
Return an IP formatted to be shown on screen.
img_delete($titlealt='default', $other='class="pictodelete"', $morecss='')
Show delete logo.
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
GETPOSTINT($paramname, $method=0)
Return the value of a $_GET or $_POST supervariable, converted into integer.
dol_format_address($object, $withcountry=0, $sep="\n", $outputlangs=null, $mode=0, $extralangcode='')
Return a formatted address (part address/zip/town/state) according to country rules.
dol_print_phone($phone, $countrycode='', $cid=0, $socid=0, $addlink='', $separ="&nbsp;", $withpicto='', $titlealt='', $adddivfloat=0, $morecss='paddingright')
Format phone numbers according to country.
dol_osencode($str)
Return a string encoded into OS filesystem encoding.
price2num($amount, $rounding='', $option=0)
Function that return a number with universal decimal format (decimal separator is '.
dol_string_nospecial($str, $newstr='_', $badcharstoreplace='', $badcharstoremove='', $keepspaces=0)
Clean a string from all punctuation characters to use it as a ref or login.
dol_eval($s, $returnvalue=1, $hideerrors=1, $onlysimplestring='1')
Replace eval function to add more security.
dol_print_url($url, $target='_blank', $max=32, $withpicto=0, $morecss='')
Show Url link.
price($amount, $form=0, $outlangs='', $trunc=1, $rounding=-1, $forcerounding=-1, $currency_code='')
Function to format a value into an amount for visual output Function used into PDF and HTML pages.
getPictoForType($key, $morecss='')
Return the picto for a data type.
forgeSQLFromUniversalSearchCriteria($filter, &$errorstr='', $noand=0, $nopar=0, $noerror=0)
forgeSQLFromUniversalSearchCriteria
dol_now($mode='auto')
Return date for now.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
getElementProperties($elementType)
Get an array with properties of an element.
dol_escape_js($stringtoescape, $mode=0, $noescapebackslashn=0)
Returns text escaped for inclusion into javascript code.
dolPrintHTMLForAttribute($s)
Return a string ready to be output on an HTML attribute (alt, title, data-html, .....
dol_print_date($time, $format='', $tzoutput='auto', $outputlangs=null, $encodetooutput=false)
Output date in a string format according to outputlangs (or langs if not defined).
dol_sort_array(&$array, $index, $order='asc', $natsort=0, $case_sensitive=0, $keepindex=0)
Advanced sort array by the value of a given key, which produces ascending (default) or descending out...
if(!function_exists( 'dol_getprefix')) dol_include_once($relpath, $classname='')
Make an include_once using default root and alternate root if it fails.
newToken()
Return the value of token currently saved into session with name 'newtoken'.
dol_print_email($email, $cid=0, $socid=0, $addlink=0, $max=64, $showinvalid=1, $withpicto=0, $morecss='paddingrightonly')
Show EMail link formatted for HTML output.
getImageFileNameForSize($file, $extName, $extImgTarget='')
Return the filename of file to get the thumbs.
yn($yesno, $format=1, $color=0)
Return yes or no in current language.
get_date_range($date_start, $date_end, $format='', $outputlangs=null, $withparenthesis=1)
Format output for start and end date.
getAdvancedPreviewUrl($modulepart, $relativepath, $alldata=0, $param='')
Return URL we can use for advanced preview links.
GETPOST($paramname, $check='alphanohtml', $method=0, $filter=null, $options=null, $noreplace=0)
Return value of a param into GET or POST supervariable.
dol_buildpath($path, $type=0, $returnemptyifnotfound=0)
Return path of url or filesystem.
dol_sanitizeFileName($str, $newstr='_', $unaccent=1)
Clean a string to use it as a file name.
dol_print_error($db=null, $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
dol_trunc($string, $size=40, $trunc='right', $stringencoding='UTF-8', $nodot=0, $display=0)
Truncate a string to a particular length adding '…' if string larger than length.
dol_htmlentitiesbr($stringtoencode, $nl2brmode=0, $pagecodefrom='UTF-8', $removelasteolbr=1)
This function is called to encode a string into a HTML string but differs from htmlentities because a...
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
getDictionaryValue($tablename, $field, $id, $checkentity=false, $rowidfield='rowid')
Return the value of a filed into a dictionary for the record $id.
get_exdir($num, $level, $alpha, $withoutslash, $object, $modulepart='')
Return a path to have a the directory according to object where files are stored.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
getEntity($element, $shared=1, $currentobject=null)
Get list of entity id to use.
dol_sanitizePathName($str, $newstr='_', $unaccent=1)
Clean a string to use it as a path name.
dol_escape_htmltag($stringtoescape, $keepb=0, $keepn=0, $noescapetags='', $escapeonlyhtmltags=0, $cleanalsojavascript=0)
Returns text escaped for inclusion in HTML alt or title or value tags, or into values of HTML input f...
vignette($file, $maxWidth=160, $maxHeight=120, $extName='_small', $quality=50, $outdir='thumbs', $targetformat=0)
Create a thumbnail from an image file (Supported extensions are gif, jpg, png and bmp).
if(!defined( 'IMAGETYPE_WEBP')) getDefaultImageSizes()
Return default values for image sizes.
dol_getImageSize($file, $url=false)
Return size of image file on disk (Supported extensions are gif, jpg, png, bmp and webp)
image_format_supported($file, $acceptsvg=0)
Return if a filename is file name of a supported image format.
query($query, $usesavepoint=0, $type='auto', $result_mode=0)
Execute a SQL request and return the resultset.
global $conf
The following vars must be defined: $type2label $form $conf, $lang, The following vars may also be de...
Definition member.php:79
calcul_price_total($qty, $pu, $remise_percent_ligne, $txtva, $uselocaltax1_rate, $uselocaltax2_rate, $remise_percent_global, $price_base_type, $info_bits, $type, $seller='', $localtaxes_array=[], $progress=100, $multicurrency_tx=1, $pu_devise=0, $multicurrency_code='')
Calculate totals (net, vat, ...) of a line.
Definition price.lib.php:90
$conf db user
Active Directory does not allow anonymous connections.
Definition repair.php:153
if(preg_match('/crypted:/i', $dolibarr_main_db_pass)||!empty($dolibarr_main_db_encrypted_pass)) $conf db type
Definition repair.php:149
getRandomPassword($generic=false, $replaceambiguouschars=null, $length=32)
Return a generated password using default module.
dolEncrypt($chain, $key='', $ciphering='', $forceseed='')
Encode a string with a symmetric encryption.
dolDecrypt($chain, $key='')
Decode a string with a symmetric encryption.
dol_hash($chain, $type='0', $nosalt=0)
Returns a hash (non reversible encryption) of a string.