* Copyright (C) 2005-2013 Regis Houssin * Copyright (C) 2010-2020 Juanjo Menent * Copyright (C) 2012-2013 Christophe Battarel * Copyright (C) 2011-2019 Philippe Grand * Copyright (C) 2012-2015 Marcos García * Copyright (C) 2012-2015 Raphaël Doursenaud * Copyright (C) 2012 Cedric Salvador * Copyright (C) 2015 Alexandre Spangaro * Copyright (C) 2016 Bahfir abbes * Copyright (C) 2017 ATM Consulting * Copyright (C) 2017-2019 Nicolas ZABOURI * Copyright (C) 2017 Rui Strecht * Copyright (C) 2018-2019 Frédéric France * Copyright (C) 2018 Josep Lluís Amador * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /** * \file htdocs/core/class/commonobject.class.php * \ingroup core * \brief File of parent class of all other business classes (invoices, contracts, proposals, orders, ...) */ /** * Parent class of all other business classes (invoices, contracts, proposals, orders, ...) */ abstract class CommonObject { /** * @var DoliDb Database handler (result of a new DoliDB) */ public $db; /** * @var int The object identifier */ public $id; /** * @var string Error string * @see $errors */ public $error; /** * @var string[] Array of error strings */ public $errors = array(); /** * @var string ID to identify managed object */ public $element; /** * @var string Name of table without prefix where object is stored */ public $table_element; /** * @var string Name of subtable line */ public $table_element_line = ''; /** * @var string Key value used to track if data is coming from import wizard */ public $import_key; /** * @var mixed Contains data to manage extrafields */ public $array_options = array(); /** * @var mixed Array to store alternative languages values of object */ public $array_languages = null; // Value is array() when load already tried /** * @var int[][] Array of linked objects ids. Loaded by ->fetchObjectLinked */ public $linkedObjectsIds; /** * @var mixed Array of linked objects. Loaded by ->fetchObjectLinked */ public $linkedObjects; /** * @var Object To store a cloned copy of object before to edit it and keep track of old properties */ public $oldcopy; /** * @var string Column name of the ref field. */ protected $table_ref_field = ''; // Following vars are used by some objects only. We keep this property here in CommonObject to be able to provide common method using them. /** * @var array Can be used to pass information when only object is provided to method */ public $context = array(); /** * @var string Contains canvas name if record is an alternative canvas record */ public $canvas; /** * @var Project The related project * @see fetch_projet() */ public $project; /** * @var int The related project ID * @see setProject(), project */ public $fk_project; /** * @deprecated * @see project */ public $projet; /** * @var Contact a related contact * @see fetch_contact() */ public $contact; /** * @var int The related contact ID * @see fetch_contact() */ public $contact_id; /** * @var Societe A related thirdparty * @see fetch_thirdparty() */ public $thirdparty; /** * @var User A related user * @see fetch_user() */ public $user; /** * @var string The type of originating object ('commande', 'facture', ...) * @see fetch_origin() */ public $origin; /** * @var int The id of originating object * @see fetch_origin() */ public $origin_id; /** * @var string The object's reference */ public $ref; /** * @var string The object's previous reference */ public $ref_previous; /** * @var string The object's next reference */ public $ref_next; /** * @var string An external reference for the object */ public $ref_ext; /** * @var int The object's status * @see setStatut() */ public $statut; /** * @var string * @see getFullAddress() */ public $country; /** * @var int * @see getFullAddress(), country */ public $country_id; /** * @var string * @see getFullAddress(), isInEEC(), country */ public $country_code; /** * @var string * @see getFullAddress() */ public $state; /** * @var int * @see getFullAddress(), state */ public $state_id; /** * @var string * @see getFullAddress(), $state */ public $state_code; /** * @var int * @see getFullAddress(), $region_code, $region */ public $region_id; /** * @var string * @see getFullAddress(), $region_id, $region */ public $region_code; /** * @var string * @see getFullAddress(), $region_id, $region_code */ public $region; /** * @var int * @see fetch_barcode() */ public $barcode_type; /** * @var string * @see fetch_barcode(), barcode_type */ public $barcode_type_code; /** * @var string * @see fetch_barcode(), barcode_type */ public $barcode_type_label; /** * @var string * @see fetch_barcode(), barcode_type */ public $barcode_type_coder; /** * @var int Payment method ID (cheque, cash, ...) * @see setPaymentMethods() */ public $mode_reglement_id; /** * @var int Payment terms ID * @see setPaymentTerms() */ public $cond_reglement_id; /** * @var int Payment terms ID * @deprecated Kept for compatibility * @see cond_reglement_id; */ public $cond_reglement; /** * @var int Delivery address ID * @see setDeliveryAddress() * @deprecated */ public $fk_delivery_address; /** * @var int Shipping method ID * @see setShippingMethod() */ public $shipping_method_id; /** * @var string * @see SetDocModel() */ public $model_pdf; /** * @var string * Contains relative path of last generated main file */ public $last_main_doc; /** * @var int Bank account ID * @see SetBankAccount() */ public $fk_account; /** * @var string Public note * @see update_note() */ public $note_public; /** * @var string Private note * @see update_note() */ public $note_private; /** * @deprecated * @see $note_private */ public $note; /** * @var float Total amount before taxes * @see update_price() */ public $total_ht; /** * @var float Total VAT amount * @see update_price() */ public $total_tva; /** * @var float Total local tax 1 amount * @see update_price() */ public $total_localtax1; /** * @var float Total local tax 2 amount * @see update_price() */ public $total_localtax2; /** * @var float Total amount with taxes * @see update_price() */ public $total_ttc; /** * @var CommonObjectLine[] */ public $lines; /** * @var mixed Contains comments * @see fetchComments() */ public $comments = array(); /** * @var string The name */ public $name; /** * @var string The lastname */ public $lastname; /** * @var string The firstname */ public $firstname; /** * @var string The civility code, not an integer */ public $civility_id; // Dates /** * @var integer|string date_creation */ public $date_creation; /** * @var integer|string $date_validation; */ public $date_validation; // Date validation /** * @var integer|string $date_modification; */ public $date_modification; // Date last change (tms field) public $next_prev_filter; /** * @var array List of child tables. To test if we can delete object. */ protected $childtables = array(); /** * @var array List of child tables. To know object to delete on cascade. * If name matches '@ClassNAme:FilePathClass;ParentFkFieldName' it will * call method deleteByParentField(parentId, ParentFkFieldName) to fetch and delete child object */ protected $childtablesoncascade = array(); // No constructor as it is an abstract class /** * Check an object id/ref exists * If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch * * @param string $element String of element ('product', 'facture', ...) * @param int $id Id of object * @param string $ref Ref of object to check * @param string $ref_ext Ref ext of object to check * @return int <0 if KO, 0 if OK but not found, >0 if OK and exists */ public static function isExistingObject($element, $id, $ref = '', $ref_ext = '') { global $db, $conf; $sql = "SELECT rowid, ref, ref_ext"; $sql .= " FROM ".MAIN_DB_PREFIX.$element; $sql .= " WHERE entity IN (".getEntity($element).")"; if ($id > 0) $sql .= " AND rowid = ".$db->escape($id); elseif ($ref) $sql .= " AND ref = '".$db->escape($ref)."'"; elseif ($ref_ext) $sql .= " AND ref_ext = '".$db->escape($ref_ext)."'"; else { $error = 'ErrorWrongParameters'; dol_print_error(get_class()."::isExistingObject ".$error, LOG_ERR); return -1; } if ($ref || $ref_ext) $sql .= " AND entity = ".$conf->entity; dol_syslog(get_class()."::isExistingObject", LOG_DEBUG); $resql = $db->query($sql); if ($resql) { $num = $db->num_rows($resql); if ($num > 0) return 1; else return 0; } return -1; } /** * Method to output saved errors * * @return string String with errors */ public function errorsToString() { return $this->error.(is_array($this->errors) ? (($this->error != '' ? ', ' : '').join(', ', $this->errors)) : ''); } /** * Return customer ref for screen output. * * @param string $objref Customer ref * @return string Customer ref formated */ public function getFormatedCustomerRef($objref) { global $hookmanager; $parameters = array('objref'=>$objref); $action = ''; $reshook = $hookmanager->executeHooks('getFormatedCustomerRef', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks if ($reshook > 0) { return $hookmanager->resArray['objref']; } return $objref.(isset($hookmanager->resArray['objref']) ? $hookmanager->resArray['objref'] : ''); } /** * Return supplier ref for screen output. * * @param string $objref Supplier ref * @return string Supplier ref formated */ public function getFormatedSupplierRef($objref) { global $hookmanager; $parameters = array('objref'=>$objref); $action = ''; $reshook = $hookmanager->executeHooks('getFormatedSupplierRef', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks if ($reshook > 0) { return $hookmanager->resArray['objref']; } return $objref.(isset($hookmanager->resArray['objref']) ? $hookmanager->resArray['objref'] : ''); } /** * Return full name (civility+' '+name+' '+lastname) * * @param Translate $langs Language object for translation of civility (used only if option is 1) * @param int $option 0=No option, 1=Add civility * @param int $nameorder -1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname, 2=Firstname, 3=Firstname if defined else lastname * @param int $maxlen Maximum length * @return string String with full name */ public function getFullName($langs, $option = 0, $nameorder = -1, $maxlen = 0) { //print "lastname=".$this->lastname." name=".$this->name." nom=".$this->nom."
\n"; $lastname = $this->lastname; $firstname = $this->firstname; if (empty($lastname)) $lastname = (isset($this->lastname) ? $this->lastname : (isset($this->name) ? $this->name : (isset($this->nom) ? $this->nom : (isset($this->societe) ? $this->societe : (isset($this->company) ? $this->company : ''))))); $ret = ''; if ($option && $this->civility_code) { if ($langs->transnoentitiesnoconv("Civility".$this->civility_code) != "Civility".$this->civility_code) $ret .= $langs->transnoentitiesnoconv("Civility".$this->civility_code).' '; else $ret .= $this->civility_code.' '; } $ret .= dolGetFirstLastname($firstname, $lastname, $nameorder); return dol_trunc($ret, $maxlen); } /** * Return clicable link of object (with eventually picto) * * @param string $option Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link) * @return string HTML Code for Kanban thumb. */ public function getKanbanView($option = '') { $return = '
'; $return .= '
'; $return .= ''; $return .= ''; // Can be image $return .= ''; $return .= '
'; $return .= ''.(method_exists($this, 'getNomUrl') ? $this->getNomUrl() : $this->ref).''; $return .= '
'; $return .= '
'; $return .= '
'; return $return; } /** * Return full address of contact * * @param int $withcountry 1=Add country into address string * @param string $sep Separator to use to build string * @param int $withregion 1=Add region into address string * @param string $extralangcode User extralanguages as value * @return string Full address string */ public function getFullAddress($withcountry = 0, $sep = "\n", $withregion = 0, $extralangcode = '') { if ($withcountry && $this->country_id && (empty($this->country_code) || empty($this->country))) { require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php'; $tmparray = getCountry($this->country_id, 'all'); $this->country_code = $tmparray['code']; $this->country = $tmparray['label']; } if ($withregion && $this->state_id && (empty($this->state_code) || empty($this->state) || empty($this->region) || empty($this->region_code))) { require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php'; $tmparray = getState($this->state_id, 'all', 0, 1); $this->state_code = $tmparray['code']; $this->state = $tmparray['label']; $this->region_code = $tmparray['region_code']; $this->region = $tmparray['region']; } return dol_format_address($this, $withcountry, $sep, '', 0, $extralangcode); } /** * Return full address for banner * * @param string $htmlkey HTML id to make banner content unique * @param Object $object Object (thirdparty, thirdparty of contact for contact, null for a member) * @return string Full address string */ public function getBannerAddress($htmlkey, $object) { global $conf, $langs, $form, $extralanguages; $countriesusingstate = array('AU', 'US', 'IN', 'GB', 'ES', 'UK', 'TR'); // See also option MAIN_FORCE_STATE_INTO_ADDRESS $contactid = 0; $thirdpartyid = 0; $elementforaltlanguage = $this->element; if ($this->element == 'societe') { $thirdpartyid = $this->id; } if ($this->element == 'contact') { $contactid = $this->id; $thirdpartyid = $object->fk_soc; } if ($this->element == 'user') { $contactid = $this->contact_id; $thirdpartyid = $object->fk_soc; } $out = ''; $outdone = 0; $coords = $this->getFullAddress(1, ', ', $conf->global->MAIN_SHOW_REGION_IN_STATE_SELECT); if ($coords) { if (!empty($conf->use_javascript_ajax)) { // Add picto with tooltip on map $namecoords = ''; if ($this->element == 'contact' && !empty($conf->global->MAIN_SHOW_COMPANY_NAME_IN_BANNER_ADDRESS)) { $namecoords .= $object->name.'
'; } $namecoords .= $this->getFullName($langs, 1).'
'.$coords; // hideonsmatphone because copyToClipboard call jquery dialog that does not work with jmobile $out .= ''; $out .= img_picto($langs->trans("Address"), 'map-marker-alt'); $out .= ' '; } $out .= dol_print_address($coords, 'address_'.$htmlkey.'_'.$this->id, $this->element, $this->id, 1, ', '); $outdone++; $outdone++; // List of extra languages $arrayoflangcode = array(); if (!empty($conf->global->PDF_USE_ALSO_LANGUAGE_CODE)) $arrayoflangcode[] = $conf->global->PDF_USE_ALSO_LANGUAGE_CODE; if (is_array($arrayoflangcode) && count($arrayoflangcode)) { if (!is_object($extralanguages)) { include_once DOL_DOCUMENT_ROOT.'/core/class/extralanguages.class.php'; $extralanguages = new ExtraLanguages($this->db); } $extralanguages->fetch_name_extralanguages($elementforaltlanguage); if (!empty($extralanguages->attributes[$elementforaltlanguage]['address']) || !empty($extralanguages->attributes[$elementforaltlanguage]['town'])) { $out .= "\n"; $this->fetchValuesForExtraLanguages(); if (!is_object($form)) $form = new Form($this->db); $htmltext = ''; // If there is extra languages foreach ($arrayoflangcode as $extralangcode) { $s = picto_from_langcode($extralangcode, 'class="pictoforlang paddingright"'); $coords = $this->getFullAddress(1, ', ', $conf->global->MAIN_SHOW_REGION_IN_STATE_SELECT, $extralangcode); $htmltext .= $s.dol_print_address($coords, 'address_'.$htmlkey.'_'.$this->id, $this->element, $this->id, 1, ', '); } $out .= $form->textwithpicto('', $htmltext, -1, 'language', 'opacitymedium paddingleft'); } } } if (!in_array($this->country_code, $countriesusingstate) && empty($conf->global->MAIN_FORCE_STATE_INTO_ADDRESS) // If MAIN_FORCE_STATE_INTO_ADDRESS is on, state is already returned previously with getFullAddress && empty($conf->global->SOCIETE_DISABLE_STATE) && $this->state) { if (!empty($conf->global->MAIN_SHOW_REGION_IN_STATE_SELECT) && $conf->global->MAIN_SHOW_REGION_IN_STATE_SELECT == 1 && $this->region) { $out .= ($outdone ? ' - ' : '').$this->region.' - '.$this->state; } else { $out .= ($outdone ? ' - ' : '').$this->state; } $outdone++; } if (!empty($this->phone) || !empty($this->phone_pro) || !empty($this->phone_mobile) || !empty($this->phone_perso) || !empty($this->fax) || !empty($this->office_phone) || !empty($this->user_mobile) || !empty($this->office_fax)) $out .= ($outdone ? '
' : ''); if (!empty($this->phone) && empty($this->phone_pro)) { // For objects that store pro phone into ->phone $out .= dol_print_phone($this->phone, $this->country_code, $contactid, $thirdpartyid, 'AC_TEL', ' ', 'phone', $langs->trans("PhonePro")); $outdone++; } if (!empty($this->phone_pro)) { $out .= dol_print_phone($this->phone_pro, $this->country_code, $contactid, $thirdpartyid, 'AC_TEL', ' ', 'phone', $langs->trans("PhonePro")); $outdone++; } if (!empty($this->phone_mobile)) { $out .= dol_print_phone($this->phone_mobile, $this->country_code, $contactid, $thirdpartyid, 'AC_TEL', ' ', 'mobile', $langs->trans("PhoneMobile")); $outdone++; } if (!empty($this->phone_perso)) { $out .= dol_print_phone($this->phone_perso, $this->country_code, $contactid, $thirdpartyid, 'AC_TEL', ' ', 'phone', $langs->trans("PhonePerso")); $outdone++; } if (!empty($this->office_phone)) { $out .= dol_print_phone($this->office_phone, $this->country_code, $contactid, $thirdpartyid, 'AC_TEL', ' ', 'phone', $langs->trans("PhonePro")); $outdone++; } if (!empty($this->user_mobile)) { $out .= dol_print_phone($this->user_mobile, $this->country_code, $contactid, $thirdpartyid, 'AC_TEL', ' ', 'mobile', $langs->trans("PhoneMobile")); $outdone++; } if (!empty($this->fax)) { $out .= dol_print_phone($this->fax, $this->country_code, $contactid, $thirdpartyid, 'AC_FAX', ' ', 'fax', $langs->trans("Fax")); $outdone++; } if (!empty($this->office_fax)) { $out .= dol_print_phone($this->office_fax, $this->country_code, $contactid, $thirdpartyid, 'AC_FAX', ' ', 'fax', $langs->trans("Fax")); $outdone++; } if ($out) $out .= '
'; $outdone = 0; if (!empty($this->email)) { $out .= dol_print_email($this->email, $this->id, $object->id, 'AC_EMAIL', 0, 0, 1); $outdone++; } if (!empty($this->url)) { //$out.=dol_print_url($this->url,'_goout',0,1);//steve changed to blank $out .= dol_print_url($this->url, '_blank', 0, 1); $outdone++; } if (!empty($conf->socialnetworks->enabled)) { $outsocialnetwork = ''; if (is_array($this->socialnetworks) && count($this->socialnetworks) > 0) { foreach ($this->socialnetworks as $key => $value) { $outsocialnetwork .= dol_print_socialnetworks($value, $this->id, $object->id, $key); $outdone++; } } else { if ($this->skype) $outsocialnetwork .= dol_print_socialnetworks($this->skype, $this->id, $object->id, 'skype'); $outdone++; if ($this->jabberid) $outsocialnetwork .= dol_print_socialnetworks($this->jabberid, $this->id, $object->id, 'jabber'); $outdone++; if ($this->twitter) $outsocialnetwork .= dol_print_socialnetworks($this->twitter, $this->id, $object->id, 'twitter'); $outdone++; if ($this->facebook) $outsocialnetwork .= dol_print_socialnetworks($this->facebook, $this->id, $object->id, 'facebook'); $outdone++; if ($this->linkedin) $outsocialnetwork .= dol_print_socialnetworks($this->linkedin, $this->id, $object->id, 'linkedin'); $outdone++; } if ($outsocialnetwork) { $out .= '
'.$outsocialnetwork.'
'; } } if ($out) return ''."\n".$out.''."\n"; else return ''; } /** * Return the link of last main doc file for direct public download. * * @param string $modulepart Module related to document * @param int $initsharekey Init the share key if it was not yet defined * @param int $relativelink 0=Return full external link, 1=Return link relative to root of file * @return string Link or empty string if there is no download link */ public function getLastMainDocLink($modulepart, $initsharekey = 0, $relativelink = 0) { global $user, $dolibarr_main_url_root; if (empty($this->last_main_doc)) { return ''; // No way to known which document name to use } include_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmfiles.class.php'; $ecmfile = new EcmFiles($this->db); $result = $ecmfile->fetch(0, '', $this->last_main_doc); if ($result < 0) { $this->error = $ecmfile->error; $this->errors = $ecmfile->errors; return -1; } if (empty($ecmfile->id)) { // Add entry into index if ($initsharekey) { require_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php'; // TODO We can't, we dont' have full path of file, only last_main_doc adn ->element, so we must rebuild full path first /* $ecmfile->filepath = $rel_dir; $ecmfile->filename = $filename; $ecmfile->label = md5_file(dol_osencode($destfull)); // hash of file content $ecmfile->fullpath_orig = ''; $ecmfile->gen_or_uploaded = 'generated'; $ecmfile->description = ''; // indexed content $ecmfile->keyword = ''; // keyword content $ecmfile->share = getRandomPassword(true); $result = $ecmfile->create($user); if ($result < 0) { $this->error = $ecmfile->error; $this->errors = $ecmfile->errors; } */ } else return ''; } elseif (empty($ecmfile->share)) { // Add entry into index if ($initsharekey) { require_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php'; $ecmfile->share = getRandomPassword(true); $ecmfile->update($user); } else return ''; } // Define $urlwithroot $urlwithouturlroot = preg_replace('/'.preg_quote(DOL_URL_ROOT, '/').'$/i', '', trim($dolibarr_main_url_root)); // This is to use external domain name found into config file //if (DOL_URL_ROOT && ! preg_match('/\/$/', $urlwithouturlroot) && ! preg_match('/^\//', DOL_URL_ROOT)) $urlwithroot=$urlwithouturlroot.'/'.DOL_URL_ROOT; //else $urlwithroot = $urlwithouturlroot.DOL_URL_ROOT; //$urlwithroot=DOL_MAIN_URL_ROOT; // This is to use same domain name than current $forcedownload = 0; $paramlink = ''; //if (! empty($modulepart)) $paramlink.=($paramlink?'&':'').'modulepart='.$modulepart; // For sharing with hash (so public files), modulepart is not required. //if (! empty($ecmfile->entity)) $paramlink.='&entity='.$ecmfile->entity; // For sharing with hash (so public files), entity is not required. //$paramlink.=($paramlink?'&':'').'file='.urlencode($filepath); // No need of name of file for public link, we will use the hash if (!empty($ecmfile->share)) $paramlink .= ($paramlink ? '&' : '').'hashp='.$ecmfile->share; // Hash for public share if ($forcedownload) $paramlink .= ($paramlink ? '&' : '').'attachment=1'; if ($relativelink) { $linktoreturn = 'document.php'.($paramlink ? '?'.$paramlink : ''); } else { $linktoreturn = $urlwithroot.'/document.php'.($paramlink ? '?'.$paramlink : ''); } // Here $ecmfile->share is defined return $linktoreturn; } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Add a link between element $this->element and a contact * * @param int $fk_socpeople Id of thirdparty contact (if source = 'external') or id of user (if souce = 'internal') to link * @param int $type_contact Type of contact (code or id). Must be id or code found into table llx_c_type_contact. For example: SALESREPFOLL * @param string $source external=Contact extern (llx_socpeople), internal=Contact intern (llx_user) * @param int $notrigger Disable all triggers * @return int <0 if KO, >0 if OK */ public function add_contact($fk_socpeople, $type_contact, $source = 'external', $notrigger = 0) { // phpcs:enable global $user, $langs; dol_syslog(get_class($this)."::add_contact $fk_socpeople, $type_contact, $source, $notrigger"); // Check parameters if ($fk_socpeople <= 0) { $langs->load("errors"); $this->error = $langs->trans("ErrorWrongValueForParameterX", "1"); dol_syslog(get_class($this)."::add_contact ".$this->error, LOG_ERR); return -1; } if (!$type_contact) { $langs->load("errors"); $this->error = $langs->trans("ErrorWrongValueForParameterX", "2"); dol_syslog(get_class($this)."::add_contact ".$this->error, LOG_ERR); return -2; } $id_type_contact = 0; if (is_numeric($type_contact)) { $id_type_contact = $type_contact; } else { // We look for id type_contact $sql = "SELECT tc.rowid"; $sql .= " FROM ".MAIN_DB_PREFIX."c_type_contact as tc"; $sql .= " WHERE tc.element='".$this->db->escape($this->element)."'"; $sql .= " AND tc.source='".$this->db->escape($source)."'"; $sql .= " AND tc.code='".$this->db->escape($type_contact)."' AND tc.active=1"; //print $sql; $resql = $this->db->query($sql); if ($resql) { $obj = $this->db->fetch_object($resql); if ($obj) $id_type_contact = $obj->rowid; } } if ($id_type_contact == 0) { $this->error = 'CODE_NOT_VALID_FOR_THIS_ELEMENT'; 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"); return -3; } $datecreate = dol_now(); // Socpeople must have already been added by some trigger, then we have to check it to avoid DB_ERROR_RECORD_ALREADY_EXISTS error $TListeContacts = $this->liste_contact(-1, $source); $already_added = false; if (is_array($TListeContacts) && !empty($TListeContacts)) { foreach ($TListeContacts as $array_contact) { if ($array_contact['status'] == 4 && $array_contact['id'] == $fk_socpeople && $array_contact['fk_c_type_contact'] == $id_type_contact) { $already_added = true; break; } } } if (!$already_added) { $this->db->begin(); // Insert into database $sql = "INSERT INTO ".MAIN_DB_PREFIX."element_contact"; $sql .= " (element_id, fk_socpeople, datecreate, statut, fk_c_type_contact) "; $sql .= " VALUES (".$this->id.", ".$fk_socpeople." , "; $sql .= "'".$this->db->idate($datecreate)."'"; $sql .= ", 4, ".$id_type_contact; $sql .= ")"; $resql = $this->db->query($sql); if ($resql) { if (!$notrigger) { $result = $this->call_trigger(strtoupper($this->element).'_ADD_CONTACT', $user); if ($result < 0) { $this->db->rollback(); return -1; } } $this->db->commit(); return 1; } else { if ($this->db->errno() == 'DB_ERROR_RECORD_ALREADY_EXISTS') { $this->error = $this->db->errno(); $this->db->rollback(); echo 'err rollback'; return -2; } else { $this->error = $this->db->error(); $this->db->rollback(); return -1; } } } else return 0; } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Copy contact from one element to current * * @param CommonObject $objFrom Source element * @param string $source Nature of contact ('internal' or 'external') * @return int >0 if OK, <0 if KO */ public function copy_linked_contact($objFrom, $source = 'internal') { // phpcs:enable $contacts = $objFrom->liste_contact(-1, $source); foreach ($contacts as $contact) { if ($this->add_contact($contact['id'], $contact['fk_c_type_contact'], $contact['source']) < 0) { $this->error = $this->db->lasterror(); return -1; } } return 1; } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Update a link to contact line * * @param int $rowid Id of line contact-element * @param int $statut New status of link * @param int $type_contact_id Id of contact type (not modified if 0) * @param int $fk_socpeople Id of soc_people to update (not modified if 0) * @return int <0 if KO, >= 0 if OK */ public function update_contact($rowid, $statut, $type_contact_id = 0, $fk_socpeople = 0) { // phpcs:enable // Insert into database $sql = "UPDATE ".MAIN_DB_PREFIX."element_contact set"; $sql .= " statut = ".$statut; if ($type_contact_id) $sql .= ", fk_c_type_contact = ".((int) $type_contact_id); if ($fk_socpeople) $sql .= ", fk_socpeople = ".((int) $fk_socpeople); $sql .= " where rowid = ".$rowid; $resql = $this->db->query($sql); if ($resql) { return 0; } else { $this->error = $this->db->lasterror(); return -1; } } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Delete a link to contact line * * @param int $rowid Id of contact link line to delete * @param int $notrigger Disable all triggers * @return int >0 if OK, <0 if KO */ public function delete_contact($rowid, $notrigger = 0) { // phpcs:enable global $user; $this->db->begin(); $sql = "DELETE FROM ".MAIN_DB_PREFIX."element_contact"; $sql .= " WHERE rowid =".$rowid; dol_syslog(get_class($this)."::delete_contact", LOG_DEBUG); if ($this->db->query($sql)) { if (!$notrigger) { $result = $this->call_trigger(strtoupper($this->element).'_DELETE_CONTACT', $user); if ($result < 0) { $this->db->rollback(); return -1; } } $this->db->commit(); return 1; } else { $this->error = $this->db->lasterror(); $this->db->rollback(); return -1; } } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Delete all links between an object $this and all its contacts * * @param string $source '' or 'internal' or 'external' * @param string $code Type of contact (code or id) * @return int >0 if OK, <0 if KO */ public function delete_linked_contact($source = '', $code = '') { // phpcs:enable $temp = array(); $typeContact = $this->liste_type_contact($source, '', 0, 0, $code); foreach ($typeContact as $key => $value) { array_push($temp, $key); } $listId = implode(",", $temp); $sql = "DELETE FROM ".MAIN_DB_PREFIX."element_contact"; $sql .= " WHERE element_id = ".$this->id; if ($listId) $sql .= " AND fk_c_type_contact IN (".$listId.")"; dol_syslog(get_class($this)."::delete_linked_contact", LOG_DEBUG); if ($this->db->query($sql)) { return 1; } else { $this->error = $this->db->lasterror(); return -1; } } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Get array of all contacts for an object * * @param int $status Status of links to get (-1=all) * @param string $source Source of contact: 'external' or 'thirdparty' (llx_socpeople) or 'internal' (llx_user) * @param int $list 0:Return array contains all properties, 1:Return array contains just id * @param string $code Filter on this code of contact type ('SHIPPING', 'BILLING', ...) * @return array|int Array of contacts, -1 if error */ public function liste_contact($status = -1, $source = 'external', $list = 0, $code = '') { // phpcs:enable global $langs; $tab = array(); $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 if ($source == 'internal') $sql .= ", '-1' as socid, t.statut as statuscontact, t.login, t.photo"; if ($source == 'external' || $source == 'thirdparty') $sql .= ", t.fk_soc as socid, t.statut as statuscontact"; $sql .= ", t.civility as civility, t.lastname as lastname, t.firstname, t.email"; $sql .= ", tc.source, tc.element, tc.code, tc.libelle"; $sql .= " FROM ".MAIN_DB_PREFIX."c_type_contact tc"; $sql .= ", ".MAIN_DB_PREFIX."element_contact ec"; if ($source == 'internal') $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."user t on ec.fk_socpeople = t.rowid"; if ($source == 'external' || $source == 'thirdparty') $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."socpeople t on ec.fk_socpeople = t.rowid"; $sql .= " WHERE ec.element_id =".$this->id; $sql .= " AND ec.fk_c_type_contact=tc.rowid"; $sql .= " AND tc.element='".$this->db->escape($this->element)."'"; if ($code) $sql .= " AND tc.code = '".$this->db->escape($code)."'"; if ($source == 'internal') $sql .= " AND tc.source = 'internal'"; if ($source == 'external' || $source == 'thirdparty') $sql .= " AND tc.source = 'external'"; $sql .= " AND tc.active=1"; if ($status >= 0) $sql .= " AND ec.statut = ".$status; $sql .= " ORDER BY t.lastname ASC"; dol_syslog(get_class($this)."::liste_contact", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $num = $this->db->num_rows($resql); $i = 0; while ($i < $num) { $obj = $this->db->fetch_object($resql); if (!$list) { $transkey = "TypeContact_".$obj->element."_".$obj->source."_".$obj->code; $libelle_type = ($langs->trans($transkey) != $transkey ? $langs->trans($transkey) : $obj->libelle); $tab[$i] = array('source'=>$obj->source, 'socid'=>$obj->socid, 'id'=>$obj->id, 'nom'=>$obj->lastname, // For backward compatibility 'civility'=>$obj->civility, 'lastname'=>$obj->lastname, 'firstname'=>$obj->firstname, 'email'=>$obj->email, 'login'=>$obj->login, 'photo'=>$obj->photo, 'statuscontact'=>$obj->statuscontact, 'rowid'=>$obj->rowid, 'code'=>$obj->code, 'libelle'=>$libelle_type, 'status'=>$obj->statuslink, 'fk_c_type_contact'=>$obj->fk_c_type_contact); } else { $tab[$i] = $obj->id; } $i++; } return $tab; } else { $this->error = $this->db->lasterror(); dol_print_error($this->db); return -1; } } /** * Update status of a contact linked to object * * @param int $rowid Id of link between object and contact * @return int <0 if KO, >=0 if OK */ public function swapContactStatus($rowid) { $sql = "SELECT ec.datecreate, ec.statut, ec.fk_socpeople, ec.fk_c_type_contact,"; $sql .= " tc.code, tc.libelle"; //$sql.= ", s.fk_soc"; $sql .= " FROM (".MAIN_DB_PREFIX."element_contact as ec, ".MAIN_DB_PREFIX."c_type_contact as tc)"; //$sql.= " LEFT JOIN ".MAIN_DB_PREFIX."socpeople as s ON ec.fk_socpeople=s.rowid"; // Si contact de type external, alors il est lie a une societe $sql .= " WHERE ec.rowid =".$rowid; $sql .= " AND ec.fk_c_type_contact=tc.rowid"; $sql .= " AND tc.element = '".$this->db->escape($this->element)."'"; dol_syslog(get_class($this)."::swapContactStatus", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $obj = $this->db->fetch_object($resql); $newstatut = ($obj->statut == 4) ? 5 : 4; $result = $this->update_contact($rowid, $newstatut); $this->db->free($resql); return $result; } else { $this->error = $this->db->error(); dol_print_error($this->db); return -1; } } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Return array with list of possible values for type of contacts * * @param string $source 'internal', 'external' or 'all' * @param string $order Sort order by : 'position', 'code', 'rowid'... * @param int $option 0=Return array id->label, 1=Return array code->label * @param int $activeonly 0=all status of contact, 1=only the active * @param string $code Type of contact (Example: 'CUSTOMER', 'SERVICE') * @return array Array list of type of contacts (id->label if option=0, code->label if option=1) */ public function liste_type_contact($source = 'internal', $order = 'position', $option = 0, $activeonly = 0, $code = '') { // phpcs:enable global $langs; if (empty($order)) $order = 'position'; if ($order == 'position') $order .= ',code'; $tab = array(); $sql = "SELECT DISTINCT tc.rowid, tc.code, tc.libelle, tc.position"; $sql .= " FROM ".MAIN_DB_PREFIX."c_type_contact as tc"; $sql .= " WHERE tc.element='".$this->db->escape($this->element)."'"; if ($activeonly == 1) $sql .= " AND tc.active=1"; // only the active types if (!empty($source) && $source != 'all') $sql .= " AND tc.source='".$this->db->escape($source)."'"; if (!empty($code)) $sql .= " AND tc.code='".$this->db->escape($code)."'"; $sql .= $this->db->order($order, 'ASC'); //print "sql=".$sql; $resql = $this->db->query($sql); if ($resql) { $num = $this->db->num_rows($resql); $i = 0; while ($i < $num) { $obj = $this->db->fetch_object($resql); $transkey = "TypeContact_".$this->element."_".$source."_".$obj->code; $libelle_type = ($langs->trans($transkey) != $transkey ? $langs->trans($transkey) : $obj->libelle); if (empty($option)) $tab[$obj->rowid] = $libelle_type; else $tab[$obj->code] = $libelle_type; $i++; } return $tab; } else { $this->error = $this->db->lasterror(); //dol_print_error($this->db); return null; } } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Return array with list of possible values for type of contacts * * @param string $source 'internal', 'external' or 'all' * @param int $option 0=Return array id->label, 1=Return array code->label * @param int $activeonly 0=all status of contact, 1=only the active * @param string $code Type of contact (Example: 'CUSTOMER', 'SERVICE') * @param string $element Filter on 1 element type * @param string $excludeelement Exclude 1 element type. Example: 'agenda' * @return array Array list of type of contacts (id->label if option=0, code->label if option=1) */ public function listeTypeContacts($source = 'internal', $option = 0, $activeonly = 0, $code = '', $element = '', $excludeelement = '') { // phpcs:enable global $langs, $conf; $langs->loadLangs(array('bills', 'contracts', 'interventions', 'orders', 'projects', 'propal', 'ticket', 'agenda')); $tab = array(); $sql = "SELECT DISTINCT tc.rowid, tc.code, tc.libelle, tc.position, tc.element"; $sql .= " FROM ".MAIN_DB_PREFIX."c_type_contact as tc"; $sqlWhere = array(); if (!empty($element)) { $sqlWhere[] = " tc.element='".$this->db->escape($element)."'"; } if (!empty($excludeelement)) { $sqlWhere[] = " tc.element <> '".$this->db->escape($excludeelement)."'"; } if ($activeonly == 1) $sqlWhere[] = " tc.active=1"; // only the active types if (!empty($source) && $source != 'all') $sqlWhere[] = " tc.source='".$this->db->escape($source)."'"; if (!empty($code)) $sqlWhere[] = " tc.code='".$this->db->escape($code)."'"; if (count($sqlWhere) > 0) { $sql .= " WHERE ".implode(' AND ', $sqlWhere); } $sql .= $this->db->order('tc.element, tc.position', 'ASC'); dol_syslog(__METHOD__, LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $num = $this->db->num_rows($resql); if ($num > 0) { while ($obj = $this->db->fetch_object($resql)) { $modulename = $obj->element; if (strpos($obj->element, 'project') !== false) { $modulename = 'projet'; } elseif ($obj->element == 'contrat') { $element = 'contract'; } elseif ($obj->element == 'action') { $modulename = 'agenda'; } elseif (strpos($obj->element, 'supplier') !== false && $obj->element != 'supplier_proposal') { $modulename = 'fournisseur'; } elseif (strpos($obj->element, 'supplier') !== false && $obj->element != 'supplier_proposal') { $modulename = 'fournisseur'; } if ($conf->{$modulename}->enabled) { $libelle_element = $langs->trans('ContactDefault_'.$obj->element); $transkey = "TypeContact_".$obj->element."_".$source."_".$obj->code; $libelle_type = ($langs->trans($transkey) != $transkey ? $langs->trans($transkey) : $obj->libelle); if (empty($option)) $tab[$obj->rowid] = $libelle_element.' - '.$libelle_type; else $tab[$obj->rowid] = $libelle_element.' - '.$libelle_type; } } } return $tab; } else { $this->error = $this->db->lasterror(); return null; } } /** * Return id of contacts for a source and a contact code. * Example: contact client de facturation ('external', 'BILLING') * Example: contact client de livraison ('external', 'SHIPPING') * Example: contact interne suivi paiement ('internal', 'SALESREPFOLL') * * @param string $source 'external' or 'internal' * @param string $code 'BILLING', 'SHIPPING', 'SALESREPFOLL', ... * @param int $status limited to a certain status * @return array List of id for such contacts */ public function getIdContact($source, $code, $status = 0) { global $conf; $result = array(); $i = 0; //cas particulier pour les expeditions if ($this->element == 'shipping' && $this->origin_id != 0) { $id = $this->origin_id; $element = 'commande'; } elseif ($this->element == 'reception' && $this->origin_id != 0) { $id = $this->origin_id; $element = 'order_supplier'; } else { $id = $this->id; $element = $this->element; } $sql = "SELECT ec.fk_socpeople"; $sql .= " FROM ".MAIN_DB_PREFIX."element_contact as ec,"; if ($source == 'internal') $sql .= " ".MAIN_DB_PREFIX."user as c,"; if ($source == 'external') $sql .= " ".MAIN_DB_PREFIX."socpeople as c,"; $sql .= " ".MAIN_DB_PREFIX."c_type_contact as tc"; $sql .= " WHERE ec.element_id = ".$id; $sql .= " AND ec.fk_socpeople = c.rowid"; if ($source == 'internal') $sql .= " AND c.entity IN (".getEntity('user').")"; if ($source == 'external') $sql .= " AND c.entity IN (".getEntity('societe').")"; $sql .= " AND ec.fk_c_type_contact = tc.rowid"; $sql .= " AND tc.element = '".$this->db->escape($element)."'"; $sql .= " AND tc.source = '".$this->db->escape($source)."'"; if ($code) $sql .= " AND tc.code = '".$this->db->escape($code)."'"; $sql .= " AND tc.active = 1"; if ($status) $sql .= " AND ec.statut = ".$status; dol_syslog(get_class($this)."::getIdContact", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { while ($obj = $this->db->fetch_object($resql)) { $result[$i] = $obj->fk_socpeople; $i++; } } else { $this->error = $this->db->error(); return null; } return $result; } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Load object contact with id=$this->contact_id into $this->contact * * @param int $contactid Id du contact. Use this->contact_id if empty. * @return int <0 if KO, >0 if OK */ public function fetch_contact($contactid = null) { // phpcs:enable if (empty($contactid)) $contactid = $this->contact_id; if (empty($contactid)) return 0; require_once DOL_DOCUMENT_ROOT.'/contact/class/contact.class.php'; $contact = new Contact($this->db); $result = $contact->fetch($contactid); $this->contact = $contact; return $result; } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty * * @param int $force_thirdparty_id Force thirdparty id * @return int <0 if KO, >0 if OK */ public function fetch_thirdparty($force_thirdparty_id = 0) { // phpcs:enable global $conf; if (empty($this->socid) && empty($this->fk_soc) && empty($this->fk_thirdparty) && empty($force_thirdparty_id)) return 0; require_once DOL_DOCUMENT_ROOT.'/societe/class/societe.class.php'; $idtofetch = isset($this->socid) ? $this->socid : (isset($this->fk_soc) ? $this->fk_soc : $this->fk_thirdparty); if ($force_thirdparty_id) $idtofetch = $force_thirdparty_id; if ($idtofetch) { $thirdparty = new Societe($this->db); $result = $thirdparty->fetch($idtofetch); $this->thirdparty = $thirdparty; // Use first price level if level not defined for third party if (!empty($conf->global->PRODUIT_MULTIPRICES) && empty($this->thirdparty->price_level)) { $this->thirdparty->price_level = 1; } return $result; } else return -1; } /** * Looks for an object with ref matching the wildcard provided * It does only work when $this->table_ref_field is set * * @param string $ref Wildcard * @return int >1 = OK, 0 = Not found or table_ref_field not defined, <0 = KO */ public function fetchOneLike($ref) { if (!$this->table_ref_field) { return 0; } $sql = 'SELECT rowid FROM '.MAIN_DB_PREFIX.$this->table_element.' WHERE '.$this->table_ref_field.' LIKE "'.$this->db->escape($ref).'" LIMIT 1'; $query = $this->db->query($sql); if (!$this->db->num_rows($query)) { return 0; } $result = $this->db->fetch_object($query); return $this->fetch($result->rowid); } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Load data for barcode into properties ->barcode_type* * Properties ->barcode_type that is id of barcode. Type is used to find other properties, but * if it is not defined, ->element must be defined to know default barcode type. * * @return int <0 if KO, 0 if can't guess type of barcode (ISBN, EAN13...), >0 if OK (all barcode properties loaded) */ public function fetch_barcode() { // phpcs:enable global $conf; dol_syslog(get_class($this).'::fetch_barcode this->element='.$this->element.' this->barcode_type='.$this->barcode_type); $idtype = $this->barcode_type; 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 { if ($this->element == 'product') $idtype = $conf->global->PRODUIT_DEFAULT_BARCODE_TYPE; elseif ($this->element == 'societe') $idtype = $conf->global->GENBARCODE_BARCODETYPE_THIRDPARTY; else dol_syslog('Call fetch_barcode with barcode_type not defined and cant be guessed', LOG_WARNING); } if ($idtype > 0) { 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 { $sql = "SELECT rowid, code, libelle as label, coder"; $sql .= " FROM ".MAIN_DB_PREFIX."c_barcode_type"; $sql .= " WHERE rowid = ".$idtype; dol_syslog(get_class($this).'::fetch_barcode', LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $obj = $this->db->fetch_object($resql); $this->barcode_type = $obj->rowid; $this->barcode_type_code = $obj->code; $this->barcode_type_label = $obj->label; $this->barcode_type_coder = $obj->coder; return 1; } else { dol_print_error($this->db); return -1; } } } return 0; } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Load the project with id $this->fk_project into this->project * * @return int <0 if KO, >=0 if OK */ public function fetch_projet() { // phpcs:enable include_once DOL_DOCUMENT_ROOT.'/projet/class/project.class.php'; if (empty($this->fk_project) && !empty($this->fk_projet)) $this->fk_project = $this->fk_projet; // For backward compatibility if (empty($this->fk_project)) return 0; $project = new Project($this->db); $result = $project->fetch($this->fk_project); $this->projet = $project; // deprecated $this->project = $project; return $result; } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Load the product with id $this->fk_product into this->product * * @return int <0 if KO, >=0 if OK */ public function fetch_product() { // phpcs:enable include_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php'; if (empty($this->fk_product)) return 0; $product = new Product($this->db); $result = $product->fetch($this->fk_product); $this->product = $product; return $result; } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Load the user with id $userid into this->user * * @param int $userid Id du contact * @return int <0 if KO, >0 if OK */ public function fetch_user($userid) { // phpcs:enable $user = new User($this->db); $result = $user->fetch($userid); $this->user = $user; return $result; } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Read linked origin object * * @return void */ public function fetch_origin() { // phpcs:enable if ($this->origin == 'shipping') $this->origin = 'expedition'; if ($this->origin == 'delivery') $this->origin = 'livraison'; if ($this->origin == 'order_supplier') $this->origin = 'commandeFournisseur'; $origin = $this->origin; $classname = ucfirst($origin); $this->$origin = new $classname($this->db); $this->$origin->fetch($this->origin_id); } /** * Load object from specific field * * @param string $table Table element or element line * @param string $field Field selected * @param string $key Import key * @param string $element Element name * @return int <0 if KO, >0 if OK */ public function fetchObjectFrom($table, $field, $key, $element = null) { global $conf; $result = false; $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX.$table; $sql .= " WHERE ".$field." = '".$key."'"; if (!empty($element)) { $sql .= " AND entity IN (".getEntity($element).")"; } else { $sql .= " AND entity = ".$conf->entity; } dol_syslog(get_class($this).'::fetchObjectFrom', LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $row = $this->db->fetch_row($resql); // Test for avoid error -1 if ($row[0] > 0) { $result = $this->fetch($row[0]); } } return $result; } /** * Getter generic. Load value from a specific field * * @param string $table Table of element or element line * @param int $id Element id * @param string $field Field selected * @return int <0 if KO, >0 if OK */ public function getValueFrom($table, $id, $field) { $result = false; if (!empty($id) && !empty($field) && !empty($table)) { $sql = "SELECT ".$field." FROM ".MAIN_DB_PREFIX.$table; $sql .= " WHERE rowid = ".$id; dol_syslog(get_class($this).'::getValueFrom', LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $row = $this->db->fetch_row($resql); $result = $row[0]; } } return $result; } /** * Setter generic. Update a specific field into database. * Warning: Trigger is run only if param trigkey is provided. * * @param string $field Field to update * @param mixed $value New value * @param string $table To force other table element or element line (should not be used) * @param int $id To force other object id (should not be used) * @param string $format Data format ('text', 'date'). 'text' is used if not defined * @param string $id_field To force rowid field name. 'rowid' is used if not defined * @param User|string $fuser Update the user of last update field with this user. If not provided, current user is used except if value is 'none' * @param string $trigkey Trigger key to run (in most cases something like 'XXX_MODIFY') * @param string $fk_user_field Name of field to save user id making change * @return int <0 if KO, >0 if OK * @see updateExtraField() */ public function setValueFrom($field, $value, $table = '', $id = null, $format = '', $id_field = '', $fuser = null, $trigkey = '', $fk_user_field = 'fk_user_modif') { global $user, $langs, $conf; if (empty($table)) $table = $this->table_element; if (empty($id)) $id = $this->id; if (empty($format)) $format = 'text'; if (empty($id_field)) $id_field = 'rowid'; $error = 0; $this->db->begin(); // Special case if ($table == 'product' && $field == 'note_private') $field = 'note'; if (in_array($table, array('actioncomm', 'adherent', 'advtargetemailing', 'cronjob', 'establishment'))) $fk_user_field = 'fk_user_mod'; $sql = "UPDATE ".MAIN_DB_PREFIX.$table." SET "; if ($format == 'text') $sql .= $field." = '".$this->db->escape($value)."'"; elseif ($format == 'int') $sql .= $field." = ".$this->db->escape($value); elseif ($format == 'date') $sql .= $field." = ".($value ? "'".$this->db->idate($value)."'" : "null"); if ($fk_user_field) { if (!empty($fuser) && is_object($fuser)) $sql .= ", ".$fk_user_field." = ".$fuser->id; elseif (empty($fuser) || $fuser != 'none') $sql .= ", ".$fk_user_field." = ".$user->id; } $sql .= " WHERE ".$id_field." = ".$id; dol_syslog(__METHOD__."", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { if ($trigkey) { // call trigger with updated object values if (empty($this->fields) && method_exists($this, 'fetch')) { $result = $this->fetch($id); } else { $result = $this->fetchCommon($id); } if ($result >= 0) $result = $this->call_trigger($trigkey, (!empty($fuser) && is_object($fuser)) ? $fuser : $user); // This may set this->errors if ($result < 0) $error++; } if (!$error) { if (property_exists($this, $field)) $this->$field = $value; $this->db->commit(); return 1; } else { $this->db->rollback(); return -2; } } else { $this->error = $this->db->lasterror(); $this->db->rollback(); return -1; } } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Load properties id_previous and id_next by comparing $fieldid with $this->ref * * @param string $filter Optional filter. Example: " AND (t.field1 = 'aa' OR t.field2 = 'bb')" * @param string $fieldid Name of field to use for the select MAX and MIN * @param int $nodbprefix Do not include DB prefix to forge table name * @return int <0 if KO, >0 if OK */ public function load_previous_next_ref($filter, $fieldid, $nodbprefix = 0) { // phpcs:enable global $conf, $user; if (!$this->table_element) { dol_print_error('', get_class($this)."::load_previous_next_ref was called on objet with property table_element not defined"); return -1; } if ($fieldid == 'none') return 1; // Security on socid $socid = 0; if ($user->socid > 0) $socid = $user->socid; // this->ismultientitymanaged contains // 0=No test on entity, 1=Test with field entity, 'field@table'=Test with link by field@table $aliastablesociete = 's'; if ($this->element == 'societe') $aliastablesociete = 'te'; // te as table_element $sql = "SELECT MAX(te.".$fieldid.")"; $sql .= " FROM ".(empty($nodbprefix) ?MAIN_DB_PREFIX:'').$this->table_element." as te"; if ($this->element == 'user' && !empty($conf->global->MULTICOMPANY_TRANSVERSE_MODE)) { $sql .= ",".MAIN_DB_PREFIX."usergroup_user as ug"; } if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged)) { $tmparray = explode('@', $this->ismultientitymanaged); $sql .= ", ".MAIN_DB_PREFIX.$tmparray[1]." as ".($tmparray[1] == 'societe' ? 's' : 'parenttable'); // If we need to link to this table to limit select to entity } elseif ($this->restrictiononfksoc == 1 && $this->element != 'societe' && !$user->rights->societe->client->voir && !$socid) $sql .= ", ".MAIN_DB_PREFIX."societe as s"; // If we need to link to societe to limit select to socid elseif ($this->restrictiononfksoc == 2 && $this->element != 'societe' && !$user->rights->societe->client->voir && !$socid) $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."societe as s ON te.fk_soc = s.rowid"; // If we need to link to societe to limit select to socid if ($this->restrictiononfksoc && !$user->rights->societe->client->voir && !$socid) $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."societe_commerciaux as sc ON ".$aliastablesociete.".rowid = sc.fk_soc"; $sql .= " WHERE te.".$fieldid." < '".$this->db->escape($fieldid == 'rowid' ? $this->id : $this->ref)."'"; // ->ref must always be defined (set to id if field does not exists) if ($this->restrictiononfksoc == 1 && !$user->rights->societe->client->voir && !$socid) $sql .= " AND sc.fk_user = ".$user->id; if ($this->restrictiononfksoc == 2 && !$user->rights->societe->client->voir && !$socid) $sql .= " AND (sc.fk_user = ".$user->id.' OR te.fk_soc IS NULL)'; if (!empty($filter)) { if (!preg_match('/^\s*AND/i', $filter)) $sql .= " AND "; // For backward compatibility $sql .= $filter; } if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged)) { $tmparray = explode('@', $this->ismultientitymanaged); $sql .= ' AND te.'.$tmparray[0].' = '.($tmparray[1] == 'societe' ? 's' : 'parenttable').'.rowid'; // If we need to link to this table to limit select to entity } elseif ($this->restrictiononfksoc == 1 && $this->element != 'societe' && !$user->rights->societe->client->voir && !$socid) $sql .= ' AND te.fk_soc = s.rowid'; // If we need to link to societe to limit select to socid if (isset($this->ismultientitymanaged) && $this->ismultientitymanaged == 1) { if ($this->element == 'user' && !empty($conf->global->MULTICOMPANY_TRANSVERSE_MODE)) { if (!empty($user->admin) && empty($user->entity) && $conf->entity == 1) { $sql .= " AND te.entity IS NOT NULL"; // Show all users } else { $sql .= " AND ug.fk_user = te.rowid"; $sql .= " AND ug.entity IN (".getEntity($this->element).")"; } } else { $sql .= ' AND te.entity IN ('.getEntity($this->element).')'; } } if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged) && $this->element != 'societe') { $tmparray = explode('@', $this->ismultientitymanaged); $sql .= ' AND parenttable.entity IN ('.getEntity($tmparray[1]).')'; } if ($this->restrictiononfksoc == 1 && $socid && $this->element != 'societe') $sql .= ' AND te.fk_soc = '.$socid; if ($this->restrictiononfksoc == 2 && $socid && $this->element != 'societe') $sql .= ' AND (te.fk_soc = '.$socid.' OR te.fk_soc IS NULL)'; if ($this->restrictiononfksoc && $socid && $this->element == 'societe') $sql .= ' AND te.rowid = '.$socid; //print 'socid='.$socid.' restrictiononfksoc='.$this->restrictiononfksoc.' ismultientitymanaged = '.$this->ismultientitymanaged.' filter = '.$filter.' -> '.$sql."
"; $result = $this->db->query($sql); if (!$result) { $this->error = $this->db->lasterror(); return -1; } $row = $this->db->fetch_row($result); $this->ref_previous = $row[0]; $sql = "SELECT MIN(te.".$fieldid.")"; $sql .= " FROM ".(empty($nodbprefix) ?MAIN_DB_PREFIX:'').$this->table_element." as te"; if ($this->element == 'user' && !empty($conf->global->MULTICOMPANY_TRANSVERSE_MODE)) { $sql .= ",".MAIN_DB_PREFIX."usergroup_user as ug"; } if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged)) { $tmparray = explode('@', $this->ismultientitymanaged); $sql .= ", ".MAIN_DB_PREFIX.$tmparray[1]." as ".($tmparray[1] == 'societe' ? 's' : 'parenttable'); // If we need to link to this table to limit select to entity } elseif ($this->restrictiononfksoc == 1 && $this->element != 'societe' && !$user->rights->societe->client->voir && !$socid) $sql .= ", ".MAIN_DB_PREFIX."societe as s"; // If we need to link to societe to limit select to socid elseif ($this->restrictiononfksoc == 2 && $this->element != 'societe' && !$user->rights->societe->client->voir && !$socid) $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."societe as s ON te.fk_soc = s.rowid"; // If we need to link to societe to limit select to socid if ($this->restrictiononfksoc && !$user->rights->societe->client->voir && !$socid) $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."societe_commerciaux as sc ON ".$aliastablesociete.".rowid = sc.fk_soc"; $sql .= " WHERE te.".$fieldid." > '".$this->db->escape($fieldid == 'rowid' ? $this->id : $this->ref)."'"; // ->ref must always be defined (set to id if field does not exists) if ($this->restrictiononfksoc == 1 && !$user->rights->societe->client->voir && !$socid) $sql .= " AND sc.fk_user = ".$user->id; if ($this->restrictiononfksoc == 2 && !$user->rights->societe->client->voir && !$socid) $sql .= " AND (sc.fk_user = ".$user->id.' OR te.fk_soc IS NULL)'; if (!empty($filter)) { if (!preg_match('/^\s*AND/i', $filter)) $sql .= " AND "; // For backward compatibility $sql .= $filter; } if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged)) { $tmparray = explode('@', $this->ismultientitymanaged); $sql .= ' AND te.'.$tmparray[0].' = '.($tmparray[1] == 'societe' ? 's' : 'parenttable').'.rowid'; // If we need to link to this table to limit select to entity } elseif ($this->restrictiononfksoc == 1 && $this->element != 'societe' && !$user->rights->societe->client->voir && !$socid) $sql .= ' AND te.fk_soc = s.rowid'; // If we need to link to societe to limit select to socid if (isset($this->ismultientitymanaged) && $this->ismultientitymanaged == 1) { if ($this->element == 'user' && !empty($conf->global->MULTICOMPANY_TRANSVERSE_MODE)) { if (!empty($user->admin) && empty($user->entity) && $conf->entity == 1) { $sql .= " AND te.entity IS NOT NULL"; // Show all users } else { $sql .= " AND ug.fk_user = te.rowid"; $sql .= " AND ug.entity IN (".getEntity($this->element).")"; } } else { $sql .= ' AND te.entity IN ('.getEntity($this->element).')'; } } if (isset($this->ismultientitymanaged) && !is_numeric($this->ismultientitymanaged) && $this->element != 'societe') { $tmparray = explode('@', $this->ismultientitymanaged); $sql .= ' AND parenttable.entity IN ('.getEntity($tmparray[1]).')'; } if ($this->restrictiononfksoc == 1 && $socid && $this->element != 'societe') $sql .= ' AND te.fk_soc = '.$socid; if ($this->restrictiononfksoc == 2 && $socid && $this->element != 'societe') $sql .= ' AND (te.fk_soc = '.$socid.' OR te.fk_soc IS NULL)'; if ($this->restrictiononfksoc && $socid && $this->element == 'societe') $sql .= ' AND te.rowid = '.$socid; //print 'socid='.$socid.' restrictiononfksoc='.$this->restrictiononfksoc.' ismultientitymanaged = '.$this->ismultientitymanaged.' filter = '.$filter.' -> '.$sql."
"; // 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 $result = $this->db->query($sql); if (!$result) { $this->error = $this->db->lasterror(); return -2; } $row = $this->db->fetch_row($result); $this->ref_next = $row[0]; return 1; } /** * Return list of id of contacts of object * * @param string $source Source of contact: external (llx_socpeople) or internal (llx_user) or thirdparty (llx_societe) * @return array Array of id of contacts (if source=external or internal) * Array of id of third parties with at least one contact on object (if source=thirdparty) */ public function getListContactId($source = 'external') { $contactAlreadySelected = array(); $tab = $this->liste_contact(-1, $source); $num = count($tab); $i = 0; while ($i < $num) { if ($source == 'thirdparty') $contactAlreadySelected[$i] = $tab[$i]['socid']; else $contactAlreadySelected[$i] = $tab[$i]['id']; $i++; } return $contactAlreadySelected; } /** * Link element with a project * * @param int $projectid Project id to link element to * @return int <0 if KO, >0 if OK */ public function setProject($projectid) { if (!$this->table_element) { dol_syslog(get_class($this)."::setProject was called on objet with property table_element not defined", LOG_ERR); return -1; } $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element; if (!empty($this->fields['fk_project'])) // Common case { if ($projectid) $sql .= ' SET fk_project = '.$projectid; else $sql .= ' SET fk_project = NULL'; $sql .= ' WHERE rowid = '.$this->id; } elseif ($this->table_element == 'actioncomm') // Special case for actioncomm { if ($projectid) $sql .= ' SET fk_project = '.$projectid; else $sql .= ' SET fk_project = NULL'; $sql .= ' WHERE id = '.$this->id; } else // Special case for old architecture objects { if ($projectid) $sql .= ' SET fk_projet = '.$projectid; else $sql .= ' SET fk_projet = NULL'; $sql .= ' WHERE rowid = '.$this->id; } dol_syslog(get_class($this)."::setProject", LOG_DEBUG); if ($this->db->query($sql)) { $this->fk_project = $projectid; return 1; } else { dol_print_error($this->db); return -1; } } /** * Change the payments methods * * @param int $id Id of new payment method * @return int >0 if OK, <0 if KO */ public function setPaymentMethods($id) { dol_syslog(get_class($this).'::setPaymentMethods('.$id.')'); if ($this->statut >= 0 || $this->element == 'societe') { // TODO uniformize field name $fieldname = 'fk_mode_reglement'; if ($this->element == 'societe') $fieldname = 'mode_reglement'; if (get_class($this) == 'Fournisseur') $fieldname = 'mode_reglement_supplier'; $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element; $sql .= ' SET '.$fieldname.' = '.(($id > 0 || $id == '0') ? $id : 'NULL'); $sql .= ' WHERE rowid='.$this->id; if ($this->db->query($sql)) { $this->mode_reglement_id = $id; // for supplier if (get_class($this) == 'Fournisseur') $this->mode_reglement_supplier_id = $id; return 1; } else { dol_syslog(get_class($this).'::setPaymentMethods Erreur '.$sql.' - '.$this->db->error()); $this->error = $this->db->error(); return -1; } } else { dol_syslog(get_class($this).'::setPaymentMethods, status of the object is incompatible'); $this->error = 'Status of the object is incompatible '.$this->statut; return -2; } } /** * Change the multicurrency code * * @param string $code multicurrency code * @return int >0 if OK, <0 if KO */ public function setMulticurrencyCode($code) { dol_syslog(get_class($this).'::setMulticurrencyCode('.$code.')'); if ($this->statut >= 0 || $this->element == 'societe') { $fieldname = 'multicurrency_code'; $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element; $sql .= ' SET '.$fieldname." = '".$this->db->escape($code)."'"; $sql .= ' WHERE rowid='.$this->id; if ($this->db->query($sql)) { $this->multicurrency_code = $code; list($fk_multicurrency, $rate) = MultiCurrency::getIdAndTxFromCode($this->db, $code); if ($rate) $this->setMulticurrencyRate($rate, 2); return 1; } else { dol_syslog(get_class($this).'::setMulticurrencyCode Erreur '.$sql.' - '.$this->db->error()); $this->error = $this->db->error(); return -1; } } else { dol_syslog(get_class($this).'::setMulticurrencyCode, status of the object is incompatible'); $this->error = 'Status of the object is incompatible '.$this->statut; return -2; } } /** * Change the multicurrency rate * * @param double $rate multicurrency rate * @param int $mode mode 1 : amounts in company currency will be recalculated, mode 2 : amounts in foreign currency will be recalculated * @return int >0 if OK, <0 if KO */ public function setMulticurrencyRate($rate, $mode = 1) { dol_syslog(get_class($this).'::setMulticurrencyRate('.$rate.','.$mode.')'); if ($this->statut >= 0 || $this->element == 'societe') { $fieldname = 'multicurrency_tx'; $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element; $sql .= ' SET '.$fieldname.' = '.$rate; $sql .= ' WHERE rowid='.$this->id; if ($this->db->query($sql)) { $this->multicurrency_tx = $rate; // Update line price if (!empty($this->lines)) { foreach ($this->lines as &$line) { // Amounts in company currency will be recalculated if ($mode == 1) { $line->subprice = 0; } // Amounts in foreign currency will be recalculated if ($mode == 2) { $line->multicurrency_subprice = 0; } switch ($this->element) { case 'propal': $this->updateline( $line->id, $line->subprice, $line->qty, $line->remise_percent, $line->tva_tx, $line->localtax1_tx, $line->localtax2_tx, ($line->description ? $line->description : $line->desc), 'HT', $line->info_bits, $line->special_code, $line->fk_parent_line, $line->skip_update_total, $line->fk_fournprice, $line->pa_ht, $line->label, $line->product_type, $line->date_start, $line->date_end, $line->array_options, $line->fk_unit, $line->multicurrency_subprice ); break; case 'commande': $this->updateline( $line->id, ($line->description ? $line->description : $line->desc), $line->subprice, $line->qty, $line->remise_percent, $line->tva_tx, $line->localtax1_tx, $line->localtax2_tx, 'HT', $line->info_bits, $line->date_start, $line->date_end, $line->product_type, $line->fk_parent_line, $line->skip_update_total, $line->fk_fournprice, $line->pa_ht, $line->label, $line->special_code, $line->array_options, $line->fk_unit, $line->multicurrency_subprice ); break; case 'facture': $this->updateline( $line->id, ($line->description ? $line->description : $line->desc), $line->subprice, $line->qty, $line->remise_percent, $line->date_start, $line->date_end, $line->tva_tx, $line->localtax1_tx, $line->localtax2_tx, 'HT', $line->info_bits, $line->product_type, $line->fk_parent_line, $line->skip_update_total, $line->fk_fournprice, $line->pa_ht, $line->label, $line->special_code, $line->array_options, $line->situation_percent, $line->fk_unit, $line->multicurrency_subprice ); break; case 'supplier_proposal': $this->updateline( $line->id, $line->subprice, $line->qty, $line->remise_percent, $line->tva_tx, $line->localtax1_tx, $line->localtax2_tx, ($line->description ? $line->description : $line->desc), 'HT', $line->info_bits, $line->special_code, $line->fk_parent_line, $line->skip_update_total, $line->fk_fournprice, $line->pa_ht, $line->label, $line->product_type, $line->array_options, $line->ref_fourn, $line->multicurrency_subprice ); break; case 'order_supplier': $this->updateline( $line->id, ($line->description ? $line->description : $line->desc), $line->subprice, $line->qty, $line->remise_percent, $line->tva_tx, $line->localtax1_tx, $line->localtax2_tx, 'HT', $line->info_bits, $line->product_type, false, $line->date_start, $line->date_end, $line->array_options, $line->fk_unit, $line->multicurrency_subprice ); break; case 'invoice_supplier': $this->updateline( $line->id, ($line->description ? $line->description : $line->desc), $line->subprice, $line->tva_tx, $line->localtax1_tx, $line->localtax2_tx, $line->qty, 0, 'HT', $line->info_bits, $line->product_type, $line->remise_percent, false, $line->date_start, $line->date_end, $line->array_options, $line->fk_unit, $line->multicurrency_subprice ); break; default: dol_syslog(get_class($this).'::setMulticurrencyRate no updateline defined', LOG_DEBUG); break; } } } return 1; } else { dol_syslog(get_class($this).'::setMulticurrencyRate Erreur '.$sql.' - '.$this->db->error()); $this->error = $this->db->error(); return -1; } } else { dol_syslog(get_class($this).'::setMulticurrencyRate, status of the object is incompatible'); $this->error = 'Status of the object is incompatible '.$this->statut; return -2; } } /** * Change the payments terms * * @param int $id Id of new payment terms * @return int >0 if OK, <0 if KO */ public function setPaymentTerms($id) { dol_syslog(get_class($this).'::setPaymentTerms('.$id.')'); if ($this->statut >= 0 || $this->element == 'societe') { // TODO uniformize field name $fieldname = 'fk_cond_reglement'; if ($this->element == 'societe') $fieldname = 'cond_reglement'; if (get_class($this) == 'Fournisseur') $fieldname = 'cond_reglement_supplier'; $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element; $sql .= ' SET '.$fieldname.' = '.(($id > 0 || $id == '0') ? $id : 'NULL'); $sql .= ' WHERE rowid='.$this->id; if ($this->db->query($sql)) { $this->cond_reglement_id = $id; // for supplier if (get_class($this) == 'Fournisseur') $this->cond_reglement_supplier_id = $id; $this->cond_reglement = $id; // for compatibility return 1; } else { dol_syslog(get_class($this).'::setPaymentTerms Erreur '.$sql.' - '.$this->db->error()); $this->error = $this->db->error(); return -1; } } else { dol_syslog(get_class($this).'::setPaymentTerms, status of the object is incompatible'); $this->error = 'Status of the object is incompatible '.$this->statut; return -2; } } /** * Change the retained warranty payments terms * * @param int $id Id of new payment terms * @return int >0 if OK, <0 if KO */ public function setRetainedWarrantyPaymentTerms($id) { dol_syslog(get_class($this).'::setRetainedWarrantyPaymentTerms('.$id.')'); if ($this->statut >= 0 || $this->element == 'societe') { $fieldname = 'retained_warranty_fk_cond_reglement'; $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element; $sql .= ' SET '.$fieldname.' = '.$id; $sql .= ' WHERE rowid='.$this->id; if ($this->db->query($sql)) { $this->retained_warranty_fk_cond_reglement = $id; return 1; } else { dol_syslog(get_class($this).'::setRetainedWarrantyPaymentTerms Erreur '.$sql.' - '.$this->db->error()); $this->error = $this->db->error(); return -1; } } else { dol_syslog(get_class($this).'::setRetainedWarrantyPaymentTerms, status of the object is incompatible'); $this->error = 'Status of the object is incompatible '.$this->statut; return -2; } } /** * Define delivery address * @deprecated * * @param int $id Address id * @return int <0 si ko, >0 si ok */ public function setDeliveryAddress($id) { $fieldname = 'fk_delivery_address'; if ($this->element == 'delivery' || $this->element == 'shipping') $fieldname = 'fk_address'; $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element." SET ".$fieldname." = ".$id; $sql .= " WHERE rowid = ".$this->id." AND fk_statut = 0"; if ($this->db->query($sql)) { $this->fk_delivery_address = $id; return 1; } else { $this->error = $this->db->error(); dol_syslog(get_class($this).'::setDeliveryAddress Erreur '.$sql.' - '.$this->error); return -1; } } /** * Change the shipping method * * @param int $shipping_method_id Id of shipping method * @param bool $notrigger false=launch triggers after, true=disable triggers * @param User $userused Object user * * @return int 1 if OK, 0 if KO */ public function setShippingMethod($shipping_method_id, $notrigger = false, $userused = null) { global $user; if (empty($userused)) $userused = $user; $error = 0; if (!$this->table_element) { dol_syslog(get_class($this)."::setShippingMethod was called on objet with property table_element not defined", LOG_ERR); return -1; } $this->db->begin(); if ($shipping_method_id < 0) $shipping_method_id = 'NULL'; dol_syslog(get_class($this).'::setShippingMethod('.$shipping_method_id.')'); $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element; $sql .= " SET fk_shipping_method = ".$shipping_method_id; $sql .= " WHERE rowid=".$this->id; $resql = $this->db->query($sql); if (!$resql) { dol_syslog(get_class($this).'::setShippingMethod Error ', LOG_DEBUG); $this->error = $this->db->lasterror(); $error++; } else { if (!$notrigger) { // Call trigger $this->context = array('shippingmethodupdate'=>1); $result = $this->call_trigger(strtoupper(get_class($this)).'_MODIFY', $userused); if ($result < 0) $error++; // End call trigger } } if ($error) { $this->db->rollback(); return -1; } else { $this->shipping_method_id = ($shipping_method_id == 'NULL') ?null:$shipping_method_id; $this->db->commit(); return 1; } } /** * Change the warehouse * * @param int $warehouse_id Id of warehouse * @return int 1 if OK, 0 if KO */ public function setWarehouse($warehouse_id) { if (!$this->table_element) { dol_syslog(get_class($this)."::setWarehouse was called on objet with property table_element not defined", LOG_ERR); return -1; } if ($warehouse_id < 0) $warehouse_id = 'NULL'; dol_syslog(get_class($this).'::setWarehouse('.$warehouse_id.')'); $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element; $sql .= " SET fk_warehouse = ".$warehouse_id; $sql .= " WHERE rowid=".$this->id; if ($this->db->query($sql)) { $this->warehouse_id = ($warehouse_id == 'NULL') ?null:$warehouse_id; return 1; } else { dol_syslog(get_class($this).'::setWarehouse Error ', LOG_DEBUG); $this->error = $this->db->error(); return 0; } } /** * Set last model used by doc generator * * @param User $user User object that make change * @param string $modelpdf Modele name * @return int <0 if KO, >0 if OK */ public function setDocModel($user, $modelpdf) { if (!$this->table_element) { dol_syslog(get_class($this)."::setDocModel was called on objet with property table_element not defined", LOG_ERR); return -1; } $newmodelpdf = dol_trunc($modelpdf, 255); $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element; $sql .= " SET model_pdf = '".$this->db->escape($newmodelpdf)."'"; $sql .= " WHERE rowid = ".$this->id; // if ($this->element == 'facture') $sql.= " AND fk_statut < 2"; // if ($this->element == 'propal') $sql.= " AND fk_statut = 0"; dol_syslog(get_class($this)."::setDocModel", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $this->model_pdf = $modelpdf; $this->modelpdf = $modelpdf; // For bakward compatibility return 1; } else { dol_print_error($this->db); return 0; } } /** * Change the bank account * * @param int $fk_account Id of bank account * @param bool $notrigger false=launch triggers after, true=disable triggers * @param User $userused Object user * @return int 1 if OK, 0 if KO */ public function setBankAccount($fk_account, $notrigger = false, $userused = null) { global $user; if (empty($userused)) $userused = $user; $error = 0; if (!$this->table_element) { dol_syslog(get_class($this)."::setBankAccount was called on objet with property table_element not defined", LOG_ERR); return -1; } $this->db->begin(); if ($fk_account < 0) $fk_account = 'NULL'; dol_syslog(get_class($this).'::setBankAccount('.$fk_account.')'); $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element; $sql .= " SET fk_account = ".$fk_account; $sql .= " WHERE rowid=".$this->id; $resql = $this->db->query($sql); if (!$resql) { dol_syslog(get_class($this).'::setBankAccount Error '.$sql.' - '.$this->db->error()); $this->error = $this->db->lasterror(); $error++; } else { if (!$notrigger) { // Call trigger $this->context = array('bankaccountupdate'=>1); $result = $this->call_trigger(strtoupper(get_class($this)).'_MODIFY', $userused); if ($result < 0) $error++; // End call trigger } } if ($error) { $this->db->rollback(); return -1; } else { $this->fk_account = ($fk_account == 'NULL') ?null:$fk_account; $this->db->commit(); return 1; } } // TODO: Move line related operations to CommonObjectLine? // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Save a new position (field rang) for details lines. * You can choose to set position for lines with already a position or lines without any position defined. * * @param boolean $renum True to renum all already ordered lines, false to renum only not already ordered lines. * @param string $rowidorder ASC or DESC * @param boolean $fk_parent_line Table with fk_parent_line field or not * @return int <0 if KO, >0 if OK */ public function line_order($renum = false, $rowidorder = 'ASC', $fk_parent_line = true) { // phpcs:enable if (!$this->table_element_line) { dol_syslog(get_class($this)."::line_order was called on objet with property table_element_line not defined", LOG_ERR); return -1; } if (!$this->fk_element) { dol_syslog(get_class($this)."::line_order was called on objet with property fk_element not defined", LOG_ERR); return -1; } // Count number of lines to reorder (according to choice $renum) $nl = 0; $sql = 'SELECT count(rowid) FROM '.MAIN_DB_PREFIX.$this->table_element_line; $sql .= ' WHERE '.$this->fk_element.'='.$this->id; if (!$renum) $sql .= ' AND rang = 0'; if ($renum) $sql .= ' AND rang <> 0'; dol_syslog(get_class($this)."::line_order", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $row = $this->db->fetch_row($resql); $nl = $row[0]; } else dol_print_error($this->db); if ($nl > 0) { // The goal of this part is to reorder all lines, with all children lines sharing the same // counter that parents. $rows = array(); // We first search all lines that are parent lines (for multilevel details lines) $sql = 'SELECT rowid FROM '.MAIN_DB_PREFIX.$this->table_element_line; $sql .= ' WHERE '.$this->fk_element.' = '.$this->id; if ($fk_parent_line) $sql .= ' AND fk_parent_line IS NULL'; $sql .= ' ORDER BY rang ASC, rowid '.$rowidorder; dol_syslog(get_class($this)."::line_order search all parent lines", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $i = 0; $num = $this->db->num_rows($resql); while ($i < $num) { $row = $this->db->fetch_row($resql); $rows[] = $row[0]; // Add parent line into array rows $childrens = $this->getChildrenOfLine($row[0]); if (!empty($childrens)) { foreach ($childrens as $child) { array_push($rows, $child); } } $i++; } // Now we set a new number for each lines (parent and children with children included into parent tree) if (!empty($rows)) { foreach ($rows as $key => $row) { $this->updateRangOfLine($row, ($key + 1)); } } } else { dol_print_error($this->db); } } return 1; } /** * Get children of line * * @param int $id Id of parent line * @param int $includealltree 0 = 1st level child, 1 = All level child * @return array Array with list of children lines id */ public function getChildrenOfLine($id, $includealltree = 0) { $rows = array(); $sql = 'SELECT rowid FROM '.MAIN_DB_PREFIX.$this->table_element_line; $sql .= ' WHERE '.$this->fk_element.' = '.$this->id; $sql .= ' AND fk_parent_line = '.$id; $sql .= ' ORDER BY rang ASC'; dol_syslog(get_class($this)."::getChildrenOfLine search children lines for line ".$id."", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { if ($this->db->num_rows($resql) > 0) { while ($row = $this->db->fetch_row($resql)) { $rows[] = $row[0]; if (!empty($includealltree)) $rows = array_merge($rows, $this->getChildrenOfLine($row[0]), $includealltree); } } } return $rows; } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Update a line to have a lower rank * * @param int $rowid Id of line * @param boolean $fk_parent_line Table with fk_parent_line field or not * @return void */ public function line_up($rowid, $fk_parent_line = true) { // phpcs:enable $this->line_order(false, 'ASC', $fk_parent_line); // Get rang of line $rang = $this->getRangOfLine($rowid); // Update position of line $this->updateLineUp($rowid, $rang); } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Update a line to have a higher rank * * @param int $rowid Id of line * @param boolean $fk_parent_line Table with fk_parent_line field or not * @return void */ public function line_down($rowid, $fk_parent_line = true) { // phpcs:enable $this->line_order(false, 'ASC', $fk_parent_line); // Get rang of line $rang = $this->getRangOfLine($rowid); // Get max value for rang $max = $this->line_max(); // Update position of line $this->updateLineDown($rowid, $rang, $max); } /** * Update position of line (rang) * * @param int $rowid Id of line * @param int $rang Position * @return void */ public function updateRangOfLine($rowid, $rang) { $fieldposition = 'rang'; // @todo Rename 'rang' into 'position' if (in_array($this->table_element_line, array('bom_bomline', 'ecm_files', 'emailcollector_emailcollectoraction'))) $fieldposition = 'position'; $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element_line.' SET '.$fieldposition.' = '.$rang; $sql .= ' WHERE rowid = '.$rowid; dol_syslog(get_class($this)."::updateRangOfLine", LOG_DEBUG); if (!$this->db->query($sql)) { dol_print_error($this->db); } } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Update position of line with ajax (rang) * * @param array $rows Array of rows * @return void */ public function line_ajaxorder($rows) { // phpcs:enable $num = count($rows); for ($i = 0; $i < $num; $i++) { $this->updateRangOfLine($rows[$i], ($i + 1)); } } /** * Update position of line up (rang) * * @param int $rowid Id of line * @param int $rang Position * @return void */ public function updateLineUp($rowid, $rang) { if ($rang > 1) { $fieldposition = 'rang'; if (in_array($this->table_element_line, array('ecm_files', 'emailcollector_emailcollectoraction'))) $fieldposition = 'position'; $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element_line.' SET '.$fieldposition.' = '.$rang; $sql .= ' WHERE '.$this->fk_element.' = '.$this->id; $sql .= ' AND rang = '.($rang - 1); if ($this->db->query($sql)) { $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element_line.' SET '.$fieldposition.' = '.($rang - 1); $sql .= ' WHERE rowid = '.$rowid; if (!$this->db->query($sql)) { dol_print_error($this->db); } } else { dol_print_error($this->db); } } } /** * Update position of line down (rang) * * @param int $rowid Id of line * @param int $rang Position * @param int $max Max * @return void */ public function updateLineDown($rowid, $rang, $max) { if ($rang < $max) { $fieldposition = 'rang'; if (in_array($this->table_element_line, array('ecm_files', 'emailcollector_emailcollectoraction'))) $fieldposition = 'position'; $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element_line.' SET '.$fieldposition.' = '.$rang; $sql .= ' WHERE '.$this->fk_element.' = '.$this->id; $sql .= ' AND rang = '.($rang + 1); if ($this->db->query($sql)) { $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element_line.' SET '.$fieldposition.' = '.($rang + 1); $sql .= ' WHERE rowid = '.$rowid; if (!$this->db->query($sql)) { dol_print_error($this->db); } } else { dol_print_error($this->db); } } } /** * Get position of line (rang) * * @param int $rowid Id of line * @return int Value of rang in table of lines */ public function getRangOfLine($rowid) { $sql = 'SELECT rang FROM '.MAIN_DB_PREFIX.$this->table_element_line; $sql .= ' WHERE rowid ='.$rowid; dol_syslog(get_class($this)."::getRangOfLine", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $row = $this->db->fetch_row($resql); return $row[0]; } } /** * Get rowid of the line relative to its position * * @param int $rang Rang value * @return int Rowid of the line */ public function getIdOfLine($rang) { $sql = 'SELECT rowid FROM '.MAIN_DB_PREFIX.$this->table_element_line; $sql .= ' WHERE '.$this->fk_element.' = '.$this->id; $sql .= ' AND rang = '.$rang; $resql = $this->db->query($sql); if ($resql) { $row = $this->db->fetch_row($resql); return $row[0]; } } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Get max value used for position of line (rang) * * @param int $fk_parent_line Parent line id * @return int Max value of rang in table of lines */ public function line_max($fk_parent_line = 0) { // phpcs:enable $positionfield = 'rang'; if ($this->table_element == 'bom') $positionfield = 'position'; // Search the last rang with fk_parent_line if ($fk_parent_line) { $sql = 'SELECT max('.$positionfield.') FROM '.MAIN_DB_PREFIX.$this->table_element_line; $sql .= ' WHERE '.$this->fk_element.' = '.$this->id; $sql .= ' AND fk_parent_line = '.$fk_parent_line; dol_syslog(get_class($this)."::line_max", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $row = $this->db->fetch_row($resql); if (!empty($row[0])) { return $row[0]; } else { return $this->getRangOfLine($fk_parent_line); } } } // If not, search the last rang of element else { $sql = 'SELECT max('.$positionfield.') FROM '.MAIN_DB_PREFIX.$this->table_element_line; $sql .= ' WHERE '.$this->fk_element.' = '.$this->id; dol_syslog(get_class($this)."::line_max", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $row = $this->db->fetch_row($resql); return $row[0]; } } } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Update external ref of element * * @param string $ref_ext Update field ref_ext * @return int <0 if KO, >0 if OK */ public function update_ref_ext($ref_ext) { // phpcs:enable if (!$this->table_element) { dol_syslog(get_class($this)."::update_ref_ext was called on objet with property table_element not defined", LOG_ERR); return -1; } $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element; $sql .= " SET ref_ext = '".$this->db->escape($ref_ext)."'"; $sql .= " WHERE ".(isset($this->table_rowid) ? $this->table_rowid : 'rowid')." = ".$this->id; dol_syslog(get_class($this)."::update_ref_ext", LOG_DEBUG); if ($this->db->query($sql)) { $this->ref_ext = $ref_ext; return 1; } else { $this->error = $this->db->error(); return -1; } } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Update note of element * * @param string $note New value for note * @param string $suffix '', '_public' or '_private' * @return int <0 if KO, >0 if OK */ public function update_note($note, $suffix = '') { // phpcs:enable global $user; if (!$this->table_element) { $this->error = 'update_note was called on objet with property table_element not defined'; dol_syslog(get_class($this)."::update_note was called on objet with property table_element not defined", LOG_ERR); return -1; } if (!in_array($suffix, array('', '_public', '_private'))) { $this->error = 'update_note Parameter suffix must be empty, \'_private\' or \'_public\''; dol_syslog(get_class($this)."::update_note Parameter suffix must be empty, '_private' or '_public'", LOG_ERR); return -2; } $newsuffix = $suffix; // Special cas if ($this->table_element == 'product' && $newsuffix == '_private') $newsuffix = ''; $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element; $sql .= " SET note".$newsuffix." = ".(!empty($note) ? ("'".$this->db->escape($note)."'") : "NULL"); $sql .= " ,".(in_array($this->table_element, array('actioncomm', 'adherent', 'advtargetemailing', 'cronjob', 'establishment')) ? "fk_user_mod" : "fk_user_modif")." = ".$user->id; $sql .= " WHERE rowid =".$this->id; dol_syslog(get_class($this)."::update_note", LOG_DEBUG); if ($this->db->query($sql)) { if ($suffix == '_public') $this->note_public = $note; elseif ($suffix == '_private') $this->note_private = $note; else { $this->note = $note; // deprecated $this->note_private = $note; } return 1; } else { $this->error = $this->db->lasterror(); return -1; } } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Update public note (kept for backward compatibility) * * @param string $note New value for note * @return int <0 if KO, >0 if OK * @deprecated * @see update_note() */ public function update_note_public($note) { // phpcs:enable return $this->update_note($note, '_public'); } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). * Must be called at end of methods addline or updateline. * * @param int $exclspec >0 = Exclude special product (product_type=9) * @param string $roundingadjust 'none'=Do nothing, 'auto'=Use default method (MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND if defined, or '0'), '0'=Force mode total of rounding, '1'=Force mode rounding of total * @param int $nodatabaseupdate 1=Do not update database. Update only properties of object. * @param Societe $seller If roundingadjust is '0' or '1' or maybe 'auto', it means we recalculate total for lines before calculating total for object and for this, we need seller object. * @return int <0 if KO, >0 if OK */ public function update_price($exclspec = 0, $roundingadjust = 'none', $nodatabaseupdate = 0, $seller = null) { // phpcs:enable global $conf, $hookmanager, $action; $parameters = array('exclspec' => $exclspec, 'roundingadjust' => $roundingadjust, 'nodatabaseupdate' => $nodatabaseupdate, 'seller' => $seller); $reshook = $hookmanager->executeHooks('updateTotalPrice', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks if ($reshook > 0) { return 1; // replacement code } elseif ($reshook < 0) { return -1; // failure } // reshook = 0 => execute normal code // Some external module want no update price after a trigger because they have another method to calculate the total (ex: with an extrafield) $MODULE = ""; if ($this->element == 'propal') $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_PROPOSAL"; elseif ($this->element == 'commande' || $this->element == 'order') $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_ORDER"; elseif ($this->element == 'facture' || $this->element == 'invoice') $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_INVOICE"; elseif ($this->element == 'facture_fourn' || $this->element == 'supplier_invoice' || $this->element == 'invoice_supplier') $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_SUPPLIER_INVOICE"; elseif ($this->element == 'order_supplier' || $this->element == 'supplier_order') $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_SUPPLIER_ORDER"; elseif ($this->element == 'supplier_proposal') $MODULE = "MODULE_DISALLOW_UPDATE_PRICE_SUPPLIER_PROPOSAL"; if (!empty($MODULE)) { if (!empty($conf->global->$MODULE)) { $modsactivated = explode(',', $conf->global->$MODULE); foreach ($modsactivated as $mod) { if ($conf->$mod->enabled) return 1; // update was disabled by specific setup } } } include_once DOL_DOCUMENT_ROOT.'/core/lib/price.lib.php'; if ($roundingadjust == '-1') $roundingadjust = 'auto'; // For backward compatibility $forcedroundingmode = $roundingadjust; if ($forcedroundingmode == 'auto' && isset($conf->global->MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND)) $forcedroundingmode = $conf->global->MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND; elseif ($forcedroundingmode == 'auto') $forcedroundingmode = '0'; $error = 0; $multicurrency_tx = !empty($this->multicurrency_tx) ? $this->multicurrency_tx : 1; // Define constants to find lines to sum $fieldtva = 'total_tva'; $fieldlocaltax1 = 'total_localtax1'; $fieldlocaltax2 = 'total_localtax2'; $fieldup = 'subprice'; if ($this->element == 'facture_fourn' || $this->element == 'invoice_supplier') { $fieldtva = 'tva'; $fieldup = 'pu_ht'; } if ($this->element == 'expensereport') { $fieldup = 'value_unit'; } $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,'; $sql .= ' tva_tx as vatrate, localtax1_tx, localtax2_tx, localtax1_type, localtax2_type, info_bits, product_type'; if ($this->table_element_line == 'facturedet') $sql .= ', situation_percent'; $sql .= ', multicurrency_total_ht, multicurrency_total_tva, multicurrency_total_ttc'; $sql .= ' FROM '.MAIN_DB_PREFIX.$this->table_element_line; $sql .= ' WHERE '.$this->fk_element.' = '.$this->id; if ($exclspec) { $product_field = 'product_type'; if ($this->table_element_line == 'contratdet') $product_field = ''; // contratdet table has no product_type field if ($product_field) $sql .= ' AND '.$product_field.' <> 9'; } $sql .= ' ORDER by rowid'; // We want to be sure to always use same order of line to not change lines differently when option MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND is used dol_syslog(get_class($this)."::update_price", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $this->total_ht = 0; $this->total_tva = 0; $this->total_localtax1 = 0; $this->total_localtax2 = 0; $this->total_ttc = 0; $total_ht_by_vats = array(); $total_tva_by_vats = array(); $total_ttc_by_vats = array(); $this->multicurrency_total_ht = 0; $this->multicurrency_total_tva = 0; $this->multicurrency_total_ttc = 0; $num = $this->db->num_rows($resql); $i = 0; while ($i < $num) { $obj = $this->db->fetch_object($resql); // Note: There is no check on detail line and no check on total, if $forcedroundingmode = 'none' $parameters = array('fk_element' => $obj->rowid); $reshook = $hookmanager->executeHooks('changeRoundingMode', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks 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' { // This part of code is to fix data. We should not call it too often. $localtax_array = array($obj->localtax1_type, $obj->localtax1_tx, $obj->localtax2_type, $obj->localtax2_tx); $tmpcal = calcul_price_total($obj->qty, $obj->up, $obj->remise_percent, $obj->vatrate, $obj->localtax1_tx, $obj->localtax2_tx, 0, 'HT', $obj->info_bits, $obj->product_type, $seller, $localtax_array, (isset($obj->situation_percent) ? $obj->situation_percent : 100), $multicurrency_tx); $diff_when_using_price_ht = price2num($tmpcal[1] - $obj->total_tva, 'MT', 1); // If price was set with tax price adn unit price HT has a low number of digits, then we may have a diff on recalculation from unit price HT. $diff_on_current_total = price2num($obj->total_ttc - $obj->total_ht - $obj->total_tva - $obj->total_localtax1 - $obj->total_localtax2, 'MT', 1); //var_dump($obj->total_ht.' '.$obj->total_tva.' '.$obj->total_localtax1.' '.$obj->total_localtax2.' =? '.$obj->total_ttc); //var_dump($diff_when_using_price_ht.' '.$diff_on_current_total); if ($diff_when_using_price_ht && $diff_on_current_total) { $sqlfix = "UPDATE ".MAIN_DB_PREFIX.$this->table_element_line." SET ".$fieldtva." = ".$tmpcal[1].", total_ttc = ".$tmpcal[2]." WHERE rowid = ".$obj->rowid; dol_syslog('We found unconsistent 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, LOG_WARNING); $resqlfix = $this->db->query($sqlfix); if (!$resqlfix) dol_print_error($this->db, 'Failed to update line'); $obj->total_tva = $tmpcal[1]; $obj->total_ttc = $tmpcal[2]; } } $this->total_ht += $obj->total_ht; // The field visible at end of line detail $this->total_tva += $obj->total_tva; $this->total_localtax1 += $obj->total_localtax1; $this->total_localtax2 += $obj->total_localtax2; $this->total_ttc += $obj->total_ttc; $this->multicurrency_total_ht += $obj->multicurrency_total_ht; // The field visible at end of line detail $this->multicurrency_total_tva += $obj->multicurrency_total_tva; $this->multicurrency_total_ttc += $obj->multicurrency_total_ttc; if (!isset($total_ht_by_vats[$obj->vatrate])) $total_ht_by_vats[$obj->vatrate] = 0; if (!isset($total_tva_by_vats[$obj->vatrate])) $total_tva_by_vats[$obj->vatrate] = 0; if (!isset($total_ttc_by_vats[$obj->vatrate])) $total_ttc_by_vats[$obj->vatrate] = 0; $total_ht_by_vats[$obj->vatrate] += $obj->total_ht; $total_tva_by_vats[$obj->vatrate] += $obj->total_tva; $total_ttc_by_vats[$obj->vatrate] += $obj->total_ttc; if ($forcedroundingmode == '1') // Check if we need adjustement onto line for vat. TODO This works on the company currency but not on multicurrency { $tmpvat = price2num($total_ht_by_vats[$obj->vatrate] * $obj->vatrate / 100, 'MT', 1); $diff = price2num($total_tva_by_vats[$obj->vatrate] - $tmpvat, 'MT', 1); //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":"")."
\n"; if ($diff) { if (abs($diff) > 0.1) { $errmsg = 'A rounding difference was detected into TOTAL but is too high to be corrected. Some data in your line may be corrupted. Try to edit each line manually.'; dol_syslog($errmsg, LOG_WARNING); dol_print_error('', $errmsg); exit; } $sqlfix = "UPDATE ".MAIN_DB_PREFIX.$this->table_element_line." SET ".$fieldtva." = ".($obj->total_tva - $diff).", total_ttc = ".($obj->total_ttc - $diff)." WHERE rowid = ".$obj->rowid; dol_syslog('We found a difference of '.$diff.' for line rowid = '.$obj->rowid.". We fix the total_vat and total_ttc of line by running sqlfix = ".$sqlfix); $resqlfix = $this->db->query($sqlfix); if (!$resqlfix) dol_print_error($this->db, 'Failed to update line'); $this->total_tva -= $diff; $this->total_ttc -= $diff; $total_tva_by_vats[$obj->vatrate] -= $diff; $total_ttc_by_vats[$obj->vatrate] -= $diff; } } $i++; } // Add revenue stamp to total $this->total_ttc += isset($this->revenuestamp) ? $this->revenuestamp : 0; $this->multicurrency_total_ttc += isset($this->revenuestamp) ? ($this->revenuestamp * $multicurrency_tx) : 0; // Situations totals if ($this->situation_cycle_ref && $this->situation_counter > 1 && method_exists($this, 'get_prev_sits') && $this->type != $this::TYPE_CREDIT_NOTE) { $prev_sits = $this->get_prev_sits(); foreach ($prev_sits as $sit) { // $sit is an object Facture loaded with a fetch. $this->total_ht -= $sit->total_ht; $this->total_tva -= $sit->total_tva; $this->total_localtax1 -= $sit->total_localtax1; $this->total_localtax2 -= $sit->total_localtax2; $this->total_ttc -= $sit->total_ttc; $this->multicurrency_total_ht -= $sit->multicurrency_total_ht; $this->multicurrency_total_tva -= $sit->multicurrency_total_tva; $this->multicurrency_total_ttc -= $sit->multicurrency_total_ttc; } } $this->db->free($resql); // Now update global field total_ht, total_ttc and tva $fieldht = 'total_ht'; $fieldtva = 'tva'; $fieldlocaltax1 = 'localtax1'; $fieldlocaltax2 = 'localtax2'; $fieldttc = 'total_ttc'; // Specific code for backward compatibility with old field names if ($this->element == 'facture' || $this->element == 'facturerec') $fieldht = 'total'; if ($this->element == 'facture_fourn' || $this->element == 'invoice_supplier') $fieldtva = 'total_tva'; if ($this->element == 'propal') $fieldttc = 'total'; if ($this->element == 'expensereport') $fieldtva = 'total_tva'; if ($this->element == 'supplier_proposal') $fieldttc = 'total'; if (empty($nodatabaseupdate)) { $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element.' SET'; $sql .= " ".$fieldht."='".price2num($this->total_ht)."',"; $sql .= " ".$fieldtva."='".price2num($this->total_tva)."',"; $sql .= " ".$fieldlocaltax1."='".price2num($this->total_localtax1)."',"; $sql .= " ".$fieldlocaltax2."='".price2num($this->total_localtax2)."',"; $sql .= " ".$fieldttc."='".price2num($this->total_ttc)."'"; $sql .= ", multicurrency_total_ht='".price2num($this->multicurrency_total_ht, 'MT', 1)."'"; $sql .= ", multicurrency_total_tva='".price2num($this->multicurrency_total_tva, 'MT', 1)."'"; $sql .= ", multicurrency_total_ttc='".price2num($this->multicurrency_total_ttc, 'MT', 1)."'"; $sql .= ' WHERE rowid = '.$this->id; dol_syslog(get_class($this)."::update_price", LOG_DEBUG); $resql = $this->db->query($sql); if (!$resql) { $error++; $this->error = $this->db->lasterror(); $this->errors[] = $this->db->lasterror(); } } if (!$error) { return 1; } else { return -1; } } else { dol_print_error($this->db, 'Bad request in update_price'); return -1; } } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Add objects linked in llx_element_element. * * @param string $origin Linked element type * @param int $origin_id Linked element id * @return int <=0 if KO, >0 if OK * @see fetchObjectLinked(), updateObjectLinked(), deleteObjectLinked() */ public function add_object_linked($origin = null, $origin_id = null) { // phpcs:enable $origin = (!empty($origin) ? $origin : $this->origin); $origin_id = (!empty($origin_id) ? $origin_id : $this->origin_id); // Special case if ($origin == 'order') $origin = 'commande'; if ($origin == 'invoice') $origin = 'facture'; if ($origin == 'invoice_template') $origin = 'facturerec'; if ($origin == 'supplierorder') $origin = 'order_supplier'; $this->db->begin(); $sql = "INSERT INTO ".MAIN_DB_PREFIX."element_element ("; $sql .= "fk_source"; $sql .= ", sourcetype"; $sql .= ", fk_target"; $sql .= ", targettype"; $sql .= ") VALUES ("; $sql .= $origin_id; $sql .= ", '".$this->db->escape($origin)."'"; $sql .= ", ".$this->id; $sql .= ", '".$this->db->escape($this->element)."'"; $sql .= ")"; dol_syslog(get_class($this)."::add_object_linked", LOG_DEBUG); if ($this->db->query($sql)) { $this->db->commit(); return 1; } else { $this->error = $this->db->lasterror(); $this->db->rollback(); return 0; } } /** * Fetch array of objects linked to current object (object of enabled modules only). Links are loaded into * this->linkedObjectsIds array and * this->linkedObjects array if $loadalsoobjects = 1 * Possible usage for parameters: * - all parameters empty -> we look all link to current object (current object can be source or target) * - source id+type -> will get target list linked to source * - target id+type -> will get source list linked to target * - source id+type + target type -> will get target list of the type * - target id+type + target source -> will get source list of the type * * @param int $sourceid Object source id (if not defined, id of object) * @param string $sourcetype Object source type (if not defined, element name of object) * @param int $targetid Object target id (if not defined, id of object) * @param string $targettype Object target type (if not defined, elemennt name of object) * @param string $clause 'OR' or 'AND' clause used when both source id and target id are provided * @param int $alsosametype 0=Return only links to object that differs from source type. 1=Include also link to objects of same type. * @param string $orderby SQL 'ORDER BY' clause * @param int $loadalsoobjects Load also array this->linkedObjects (Use 0 to increase performances) * @return int <0 if KO, >0 if OK * @see add_object_linked(), updateObjectLinked(), deleteObjectLinked() */ public function fetchObjectLinked($sourceid = null, $sourcetype = '', $targetid = null, $targettype = '', $clause = 'OR', $alsosametype = 1, $orderby = 'sourcetype', $loadalsoobjects = 1) { global $conf; $this->linkedObjectsIds = array(); $this->linkedObjects = array(); $justsource = false; $justtarget = false; $withtargettype = false; $withsourcetype = false; if (!empty($sourceid) && !empty($sourcetype) && empty($targetid)) { $justsource = true; // the source (id and type) is a search criteria if (!empty($targettype)) $withtargettype = true; } if (!empty($targetid) && !empty($targettype) && empty($sourceid)) { $justtarget = true; // the target (id and type) is a search criteria if (!empty($sourcetype)) $withsourcetype = true; } $sourceid = (!empty($sourceid) ? $sourceid : $this->id); $targetid = (!empty($targetid) ? $targetid : $this->id); $sourcetype = (!empty($sourcetype) ? $sourcetype : $this->element); $targettype = (!empty($targettype) ? $targettype : $this->element); /*if (empty($sourceid) && empty($targetid)) { dol_syslog('Bad usage of function. No source nor target id defined (nor as parameter nor as object id)', LOG_ERR); return -1; }*/ // Links between objects are stored in table element_element $sql = 'SELECT rowid, fk_source, sourcetype, fk_target, targettype'; $sql .= ' FROM '.MAIN_DB_PREFIX.'element_element'; $sql .= " WHERE "; if ($justsource || $justtarget) { if ($justsource) { $sql .= "fk_source = ".$sourceid." AND sourcetype = '".$this->db->escape($sourcetype)."'"; if ($withtargettype) $sql .= " AND targettype = '".$this->db->escape($targettype)."'"; } elseif ($justtarget) { $sql .= "fk_target = ".$targetid." AND targettype = '".$this->db->escape($targettype)."'"; if ($withsourcetype) $sql .= " AND sourcetype = '".$this->db->escape($sourcetype)."'"; } } else { $sql .= "(fk_source = ".$sourceid." AND sourcetype = '".$this->db->escape($sourcetype)."')"; $sql .= " ".$clause." (fk_target = ".$targetid." AND targettype = '".$this->db->escape($targettype)."')"; } $sql .= ' ORDER BY '.$orderby; dol_syslog(get_class($this)."::fetchObjectLink", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $num = $this->db->num_rows($resql); $i = 0; while ($i < $num) { $obj = $this->db->fetch_object($resql); if ($justsource || $justtarget) { if ($justsource) { $this->linkedObjectsIds[$obj->targettype][$obj->rowid] = $obj->fk_target; } elseif ($justtarget) { $this->linkedObjectsIds[$obj->sourcetype][$obj->rowid] = $obj->fk_source; } } else { if ($obj->fk_source == $sourceid && $obj->sourcetype == $sourcetype) { $this->linkedObjectsIds[$obj->targettype][$obj->rowid] = $obj->fk_target; } if ($obj->fk_target == $targetid && $obj->targettype == $targettype) { $this->linkedObjectsIds[$obj->sourcetype][$obj->rowid] = $obj->fk_source; } } $i++; } if (!empty($this->linkedObjectsIds)) { $tmparray = $this->linkedObjectsIds; foreach ($tmparray as $objecttype => $objectids) // $objecttype is a module name ('facture', 'mymodule', ...) or a module name with a suffix ('project_task', 'mymodule_myobj', ...) { // Parse element/subelement (ex: project_task, cabinetmed_consultation, ...) $module = $element = $subelement = $objecttype; if ($objecttype != 'supplier_proposal' && $objecttype != 'order_supplier' && $objecttype != 'invoice_supplier' && preg_match('/^([^_]+)_([^_]+)/i', $objecttype, $regs)) { $module = $element = $regs[1]; $subelement = $regs[2]; } $classpath = $element.'/class'; // To work with non standard classpath or module name if ($objecttype == 'facture') { $classpath = 'compta/facture/class'; } elseif ($objecttype == 'facturerec') { $classpath = 'compta/facture/class'; $module = 'facture'; } elseif ($objecttype == 'propal') { $classpath = 'comm/propal/class'; } elseif ($objecttype == 'supplier_proposal') { $classpath = 'supplier_proposal/class'; } elseif ($objecttype == 'shipping') { $classpath = 'expedition/class'; $subelement = 'expedition'; $module = 'expedition_bon'; } elseif ($objecttype == 'delivery') { $classpath = 'delivery/class'; $subelement = 'delivery'; $module = 'livraison_bon'; } elseif ($objecttype == 'invoice_supplier' || $objecttype == 'order_supplier') { $classpath = 'fourn/class'; $module = 'fournisseur'; } elseif ($objecttype == 'fichinter') { $classpath = 'fichinter/class'; $subelement = 'fichinter'; $module = 'ficheinter'; } elseif ($objecttype == 'subscription') { $classpath = 'adherents/class'; $module = 'adherent'; } elseif ($objecttype == 'contact') { $module = 'societe'; } // Set classfile $classfile = strtolower($subelement); $classname = ucfirst($subelement); if ($objecttype == 'order') { $classfile = 'commande'; $classname = 'Commande'; } elseif ($objecttype == 'invoice_supplier') { $classfile = 'fournisseur.facture'; $classname = 'FactureFournisseur'; } elseif ($objecttype == 'order_supplier') { $classfile = 'fournisseur.commande'; $classname = 'CommandeFournisseur'; } elseif ($objecttype == 'supplier_proposal') { $classfile = 'supplier_proposal'; $classname = 'SupplierProposal'; } elseif ($objecttype == 'facturerec') { $classfile = 'facture-rec'; $classname = 'FactureRec'; } elseif ($objecttype == 'subscription') { $classfile = 'subscription'; $classname = 'Subscription'; } elseif ($objecttype == 'project' || $objecttype == 'projet') { $classpath = 'projet/class'; $classfile = 'project'; $classname = 'Project'; } // Here $module, $classfile and $classname are set if ($conf->$module->enabled && (($element != $this->element) || $alsosametype)) { if ($loadalsoobjects) { dol_include_once('/'.$classpath.'/'.$classfile.'.class.php'); //print '/'.$classpath.'/'.$classfile.'.class.php '.class_exists($classname); if (class_exists($classname)) { foreach ($objectids as $i => $objectid) // $i is rowid into llx_element_element { $object = new $classname($this->db); $ret = $object->fetch($objectid); if ($ret >= 0) { $this->linkedObjects[$objecttype][$i] = $object; } } } } } else { unset($this->linkedObjectsIds[$objecttype]); } } } return 1; } else { dol_print_error($this->db); return -1; } } /** * Update object linked of a current object * * @param int $sourceid Object source id * @param string $sourcetype Object source type * @param int $targetid Object target id * @param string $targettype Object target type * @return int >0 if OK, <0 if KO * @see add_object_linked(), fetObjectLinked(), deleteObjectLinked() */ public function updateObjectLinked($sourceid = null, $sourcetype = '', $targetid = null, $targettype = '') { $updatesource = false; $updatetarget = false; if (!empty($sourceid) && !empty($sourcetype) && empty($targetid) && empty($targettype)) $updatesource = true; elseif (empty($sourceid) && empty($sourcetype) && !empty($targetid) && !empty($targettype)) $updatetarget = true; $sql = "UPDATE ".MAIN_DB_PREFIX."element_element SET "; if ($updatesource) { $sql .= "fk_source = ".$sourceid; $sql .= ", sourcetype = '".$this->db->escape($sourcetype)."'"; $sql .= " WHERE fk_target = ".$this->id; $sql .= " AND targettype = '".$this->db->escape($this->element)."'"; } elseif ($updatetarget) { $sql .= "fk_target = ".$targetid; $sql .= ", targettype = '".$this->db->escape($targettype)."'"; $sql .= " WHERE fk_source = ".$this->id; $sql .= " AND sourcetype = '".$this->db->escape($this->element)."'"; } dol_syslog(get_class($this)."::updateObjectLinked", LOG_DEBUG); if ($this->db->query($sql)) { return 1; } else { $this->error = $this->db->lasterror(); return -1; } } /** * Delete all links between an object $this * * @param int $sourceid Object source id * @param string $sourcetype Object source type * @param int $targetid Object target id * @param string $targettype Object target type * @param int $rowid Row id of line to delete. If defined, other parameters are not used. * @return int >0 if OK, <0 if KO * @see add_object_linked(), updateObjectLinked(), fetchObjectLinked() */ public function deleteObjectLinked($sourceid = null, $sourcetype = '', $targetid = null, $targettype = '', $rowid = '') { $deletesource = false; $deletetarget = false; if (!empty($sourceid) && !empty($sourcetype) && empty($targetid) && empty($targettype)) $deletesource = true; elseif (empty($sourceid) && empty($sourcetype) && !empty($targetid) && !empty($targettype)) $deletetarget = true; $sourceid = (!empty($sourceid) ? $sourceid : $this->id); $sourcetype = (!empty($sourcetype) ? $sourcetype : $this->element); $targetid = (!empty($targetid) ? $targetid : $this->id); $targettype = (!empty($targettype) ? $targettype : $this->element); $sql = "DELETE FROM ".MAIN_DB_PREFIX."element_element"; $sql .= " WHERE"; if ($rowid > 0) { $sql .= " rowid = ".$rowid; } else { if ($deletesource) { $sql .= " fk_source = ".$sourceid." AND sourcetype = '".$this->db->escape($sourcetype)."'"; $sql .= " AND fk_target = ".$this->id." AND targettype = '".$this->db->escape($this->element)."'"; } elseif ($deletetarget) { $sql .= " fk_target = ".$targetid." AND targettype = '".$this->db->escape($targettype)."'"; $sql .= " AND fk_source = ".$this->id." AND sourcetype = '".$this->db->escape($this->element)."'"; } else { $sql .= " (fk_source = ".$this->id." AND sourcetype = '".$this->db->escape($this->element)."')"; $sql .= " OR"; $sql .= " (fk_target = ".$this->id." AND targettype = '".$this->db->escape($this->element)."')"; } } dol_syslog(get_class($this)."::deleteObjectLinked", LOG_DEBUG); if ($this->db->query($sql)) { return 1; } else { $this->error = $this->db->lasterror(); $this->errors[] = $this->error; return -1; } } /** * Set status of an object * * @param int $status Status to set * @param int $elementId Id of element to force (use this->id by default) * @param string $elementType Type of element to force (use this->table_element by default) * @param string $trigkey Trigger key to use for trigger * @return int <0 if KO, >0 if OK */ public function setStatut($status, $elementId = null, $elementType = '', $trigkey = '') { global $user, $langs, $conf; $savElementId = $elementId; // To be used later to know if we were using the method using the id of this or not. $elementId = (!empty($elementId) ? $elementId : $this->id); $elementTable = (!empty($elementType) ? $elementType : $this->table_element); $this->db->begin(); $fieldstatus = "fk_statut"; if ($elementTable == 'facture_rec') $fieldstatus = "suspended"; if ($elementTable == 'mailing') $fieldstatus = "statut"; if ($elementTable == 'cronjob') $fieldstatus = "status"; if ($elementTable == 'user') $fieldstatus = "statut"; if ($elementTable == 'expensereport') $fieldstatus = "fk_statut"; if ($elementTable == 'commande_fournisseur_dispatch') $fieldstatus = "status"; if (is_array($this->fields) && array_key_exists('status', $this->fields)) $fieldstatus = 'status'; $sql = "UPDATE ".MAIN_DB_PREFIX.$elementTable; $sql .= " SET ".$fieldstatus." = ".$status; // If status = 1 = validated, update also fk_user_valid if ($status == 1 && $elementTable == 'expensereport') $sql .= ", fk_user_valid = ".$user->id; $sql .= " WHERE rowid=".$elementId; dol_syslog(get_class($this)."::setStatut", LOG_DEBUG); if ($this->db->query($sql)) { $error = 0; // Try autoset of trigkey if (empty($trigkey)) { if ($this->element == 'supplier_proposal' && $status == 2) $trigkey = 'SUPPLIER_PROPOSAL_SIGN'; // 2 = SupplierProposal::STATUS_SIGNED. Can't use constant into this generic class if ($this->element == 'supplier_proposal' && $status == 3) $trigkey = 'SUPPLIER_PROPOSAL_REFUSE'; // 3 = SupplierProposal::STATUS_REFUSED. Can't use constant into this generic class if ($this->element == 'supplier_proposal' && $status == 4) $trigkey = 'SUPPLIER_PROPOSAL_CLOSE'; // 4 = SupplierProposal::STATUS_CLOSED. Can't use constant into this generic class if ($this->element == 'fichinter' && $status == 3) $trigkey = 'FICHINTER_CLASSIFY_DONE'; if ($this->element == 'fichinter' && $status == 2) $trigkey = 'FICHINTER_CLASSIFY_BILLED'; if ($this->element == 'fichinter' && $status == 1) $trigkey = 'FICHINTER_CLASSIFY_UNBILLED'; } if ($trigkey) { // Call trigger $result = $this->call_trigger($trigkey, $user); if ($result < 0) $error++; // End call triggers } if (!$error) { $this->db->commit(); if (empty($savElementId)) // If the element we update was $this (so $elementId is null) { $this->statut = $status; $this->status = $status; } return 1; } else { $this->db->rollback(); dol_syslog(get_class($this)."::setStatut ".$this->error, LOG_ERR); return -1; } } else { $this->error = $this->db->lasterror(); $this->db->rollback(); return -1; } } /** * Load type of canvas of an object if it exists * * @param int $id Record id * @param string $ref Record ref * @return int <0 if KO, 0 if nothing done, >0 if OK */ public function getCanvas($id = 0, $ref = '') { global $conf; if (empty($id) && empty($ref)) return 0; if (!empty($conf->global->MAIN_DISABLE_CANVAS)) return 0; // To increase speed. Not enabled by default. // Clean parameters $ref = trim($ref); $sql = "SELECT rowid, canvas"; $sql .= " FROM ".MAIN_DB_PREFIX.$this->table_element; $sql .= " WHERE entity IN (".getEntity($this->element).")"; if (!empty($id)) $sql .= " AND rowid = ".$id; if (!empty($ref)) $sql .= " AND ref = '".$this->db->escape($ref)."'"; $resql = $this->db->query($sql); if ($resql) { $obj = $this->db->fetch_object($resql); if ($obj) { $this->canvas = $obj->canvas; return 1; } else return 0; } else { dol_print_error($this->db); return -1; } } /** * Get special code of a line * * @param int $lineid Id of line * @return int Special code */ public function getSpecialCode($lineid) { $sql = 'SELECT special_code FROM '.MAIN_DB_PREFIX.$this->table_element_line; $sql .= ' WHERE rowid = '.$lineid; $resql = $this->db->query($sql); if ($resql) { $row = $this->db->fetch_row($resql); return $row[0]; } } /** * Function to check if an object is used by others. * Check is done into this->childtables. There is no check into llx_element_element. * * @param int $id Force id of object * @return int <0 if KO, 0 if not used, >0 if already used */ public function isObjectUsed($id = 0) { global $langs; if (empty($id)) $id = $this->id; // Check parameters if (!isset($this->childtables) || !is_array($this->childtables) || count($this->childtables) == 0) { dol_print_error('Called isObjectUsed on a class with property this->childtables not defined'); return -1; } $arraytoscan = $this->childtables; // For backward compatibility, we check if array is old format array('table1', 'table2', ...) $tmparray = array_keys($this->childtables); if (is_numeric($tmparray[0])) { $arraytoscan = array_flip($this->childtables); } // Test if child exists $haschild = 0; foreach ($arraytoscan as $table => $elementname) { //print $id.'-'.$table.'-'.$elementname.'
'; // Check if third party can be deleted $sql = "SELECT COUNT(*) as nb from ".MAIN_DB_PREFIX.$table; $sql .= " WHERE ".$this->fk_element." = ".$id; $resql = $this->db->query($sql); if ($resql) { $obj = $this->db->fetch_object($resql); if ($obj->nb > 0) { $langs->load("errors"); //print 'Found into table '.$table.', type '.$langs->transnoentitiesnoconv($elementname).', haschild='.$haschild; $haschild += $obj->nb; if (is_numeric($elementname)) // old usage { $this->errors[] = $langs->trans("ErrorRecordHasAtLeastOneChildOfType", $table); } else // new usage: $elementname=Translation key { $this->errors[] = $langs->trans("ErrorRecordHasAtLeastOneChildOfType", $langs->transnoentitiesnoconv($elementname)); } break; // We found at least one, we stop here } } else { $this->errors[] = $this->db->lasterror(); return -1; } } if ($haschild > 0) { $this->errors[] = "ErrorRecordHasChildren"; return $haschild; } else return 0; } /** * Function to say how many lines object contains * * @param int $predefined -1=All, 0=Count free product/service only, 1=Count predefined product/service only, 2=Count predefined product, 3=Count predefined service * @return int <0 if KO, 0 if no predefined products, nb of lines with predefined products if found */ public function hasProductsOrServices($predefined = -1) { $nb = 0; foreach ($this->lines as $key => $val) { $qualified = 0; if ($predefined == -1) $qualified = 1; if ($predefined == 1 && $val->fk_product > 0) $qualified = 1; if ($predefined == 0 && $val->fk_product <= 0) $qualified = 1; if ($predefined == 2 && $val->fk_product > 0 && $val->product_type == 0) $qualified = 1; if ($predefined == 3 && $val->fk_product > 0 && $val->product_type == 1) $qualified = 1; if ($qualified) $nb++; } dol_syslog(get_class($this).'::hasProductsOrServices we found '.$nb.' qualified lines of products/servcies'); return $nb; } /** * Function that returns the total amount HT of discounts applied for all lines. * * @return float */ public function getTotalDiscount() { $total_discount = 0.00; $sql = "SELECT subprice as pu_ht, qty, remise_percent, total_ht"; $sql .= " FROM ".MAIN_DB_PREFIX.$this->table_element."det"; $sql .= " WHERE ".$this->fk_element." = ".$this->id; dol_syslog(get_class($this).'::getTotalDiscount', LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $num = $this->db->num_rows($resql); $i = 0; while ($i < $num) { $obj = $this->db->fetch_object($resql); $pu_ht = $obj->pu_ht; $qty = $obj->qty; $total_ht = $obj->total_ht; $total_discount_line = floatval(price2num(($pu_ht * $qty) - $total_ht, 'MT')); $total_discount += $total_discount_line; $i++; } } //print $total_discount; exit; return price2num($total_discount); } /** * Return into unit=0, the calculated total of weight and volume of all lines * qty * Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line. * * @return array array('weight'=>...,'volume'=>...) */ public function getTotalWeightVolume() { $totalWeight = 0; $totalVolume = 0; // defined for shipment only $totalOrdered = ''; // defined for shipment only $totalToShip = ''; foreach ($this->lines as $line) { if (isset($line->qty_asked)) { if (empty($totalOrdered)) $totalOrdered = 0; // Avoid warning because $totalOrdered is '' $totalOrdered += $line->qty_asked; // defined for shipment only } if (isset($line->qty_shipped)) { if (empty($totalToShip)) $totalToShip = 0; // Avoid warning because $totalToShip is '' $totalToShip += $line->qty_shipped; // defined for shipment only } elseif ($line->element == 'commandefournisseurdispatch' && isset($line->qty)) { if (empty($totalToShip)) $totalToShip = 0; $totalToShip += $line->qty; // defined for reception only } // Define qty, weight, volume, weight_units, volume_units if ($this->element == 'shipping') { // for shipments $qty = $line->qty_shipped ? $line->qty_shipped : 0; } else { $qty = $line->qty ? $line->qty : 0; } $weight = $line->weight ? $line->weight : 0; ($weight == 0 && !empty($line->product->weight)) ? $weight = $line->product->weight : 0; $volume = $line->volume ? $line->volume : 0; ($volume == 0 && !empty($line->product->volume)) ? $volume = $line->product->volume : 0; $weight_units = $line->weight_units; ($weight_units == 0 && !empty($line->product->weight_units)) ? $weight_units = $line->product->weight_units : 0; $volume_units = $line->volume_units; ($volume_units == 0 && !empty($line->product->volume_units)) ? $volume_units = $line->product->volume_units : 0; $weightUnit = 0; $volumeUnit = 0; if (!empty($weight_units)) $weightUnit = $weight_units; if (!empty($volume_units)) $volumeUnit = $volume_units; if (empty($totalWeight)) $totalWeight = 0; // Avoid warning because $totalWeight is '' if (empty($totalVolume)) $totalVolume = 0; // Avoid warning because $totalVolume is '' //var_dump($line->volume_units); if ($weight_units < 50) // < 50 means a standard unit (power of 10 of official unit), > 50 means an exotic unit (like inch) { $trueWeightUnit = pow(10, $weightUnit); $totalWeight += $weight * $qty * $trueWeightUnit; } else { if ($weight_units == 99) { // conversion 1 Pound = 0.45359237 KG $trueWeightUnit = 0.45359237; $totalWeight += $weight * $qty * $trueWeightUnit; } elseif ($weight_units == 98) { // conversion 1 Ounce = 0.0283495 KG $trueWeightUnit = 0.0283495; $totalWeight += $weight * $qty * $trueWeightUnit; } else { $totalWeight += $weight * $qty; // This may be wrong if we mix different units } } if ($volume_units < 50) // >50 means a standard unit (power of 10 of official unit), > 50 means an exotic unit (like inch) { //print $line->volume."x".$line->volume_units."x".($line->volume_units < 50)."x".$volumeUnit; $trueVolumeUnit = pow(10, $volumeUnit); //print $line->volume; $totalVolume += $volume * $qty * $trueVolumeUnit; } else { $totalVolume += $volume * $qty; // This may be wrong if we mix different units } } return array('weight'=>$totalWeight, 'volume'=>$totalVolume, 'ordered'=>$totalOrdered, 'toship'=>$totalToShip); } /** * Set extra parameters * * @return int <0 if KO, >0 if OK */ public function setExtraParameters() { $this->db->begin(); $extraparams = (!empty($this->extraparams) ? json_encode($this->extraparams) : null); $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element; $sql .= " SET extraparams = ".(!empty($extraparams) ? "'".$this->db->escape($extraparams)."'" : "null"); $sql .= " WHERE rowid = ".$this->id; dol_syslog(get_class($this)."::setExtraParameters", LOG_DEBUG); $resql = $this->db->query($sql); if (!$resql) { $this->error = $this->db->lasterror(); $this->db->rollback(); return -1; } else { $this->db->commit(); return 1; } } // -------------------- // TODO: All functions here must be redesigned and moved as they are not business functions but output functions // -------------------- /* This is to show add lines */ /** * Show add free and predefined products/services form * * @param int $dateSelector 1=Show also date range input fields * @param Societe $seller Object thirdparty who sell * @param Societe $buyer Object thirdparty who buy * @param string $defaulttpldir Directory where to find the template * @return void */ public function formAddObjectLine($dateSelector, $seller, $buyer, $defaulttpldir = '/core/tpl') { global $conf, $user, $langs, $object, $hookmanager, $extrafields; global $form; // Line extrafield if (!is_object($extrafields)) { require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php'; $extrafields = new ExtraFields($this->db); } $extrafields->fetch_name_optionals_label($this->table_element_line); // Output template part (modules that overwrite templates must declare this into descriptor) // Use global variables + $dateSelector + $seller and $buyer // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook 'formAddObjectLine'. $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir)); foreach ($dirtpls as $module => $reldir) { if (!empty($module)) { $tpl = dol_buildpath($reldir.'/objectline_create.tpl.php'); } else { $tpl = DOL_DOCUMENT_ROOT.$reldir.'/objectline_create.tpl.php'; } if (empty($conf->file->strict_mode)) { $res = @include $tpl; } else { $res = include $tpl; // for debug } if ($res) break; } } /* This is to show array of line of details */ /** * Return HTML table for object lines * TODO Move this into an output class file (htmlline.class.php) * If lines are into a template, title must also be into a template * But for the moment we don't know if it's possible as we keep a method available on overloaded objects. * * @param string $action Action code * @param string $seller Object of seller third party * @param string $buyer Object of buyer third party * @param int $selected Object line selected * @param int $dateSelector 1=Show also date range input fields * @param string $defaulttpldir Directory where to find the template * @return void */ public function printObjectLines($action, $seller, $buyer, $selected = 0, $dateSelector = 0, $defaulttpldir = '/core/tpl') { global $conf, $hookmanager, $langs, $user, $form, $extrafields, $object; // TODO We should not use global var for this global $inputalsopricewithtax, $usemargins, $disableedit, $disablemove, $disableremove, $outputalsopricetotalwithtax; // Define usemargins $usemargins = 0; if (!empty($conf->margin->enabled) && !empty($this->element) && in_array($this->element, array('facture', 'facturerec', 'propal', 'commande'))) $usemargins = 1; $num = count($this->lines); // Line extrafield if (!is_object($extrafields)) { require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php'; $extrafields = new ExtraFields($this->db); } $extrafields->fetch_name_optionals_label($this->table_element_line); $parameters = array('num'=>$num, 'dateSelector'=>$dateSelector, 'seller'=>$seller, 'buyer'=>$buyer, 'selected'=>$selected, 'table_element_line'=>$this->table_element_line); $reshook = $hookmanager->executeHooks('printObjectLineTitle', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks if (empty($reshook)) { // Output template part (modules that overwrite templates must declare this into descriptor) // Use global variables + $dateSelector + $seller and $buyer // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook. $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir)); foreach ($dirtpls as $module => $reldir) { if (!empty($module)) { $tpl = dol_buildpath($reldir.'/objectline_title.tpl.php'); } else { $tpl = DOL_DOCUMENT_ROOT.$reldir.'/objectline_title.tpl.php'; } if (empty($conf->file->strict_mode)) { $res = @include $tpl; } else { $res = include $tpl; // for debug } if ($res) break; } } $i = 0; print "\n"; foreach ($this->lines as $line) { //Line extrafield $line->fetch_optionals(); //if (is_object($hookmanager) && (($line->product_type == 9 && ! empty($line->special_code)) || ! empty($line->fk_parent_line))) if (is_object($hookmanager)) // Old code is commented on preceding line. { if (empty($line->fk_parent_line)) { $parameters = array('line'=>$line, 'num'=>$num, 'i'=>$i, 'dateSelector'=>$dateSelector, 'seller'=>$seller, 'buyer'=>$buyer, 'selected'=>$selected, 'table_element_line'=>$line->table_element); $reshook = $hookmanager->executeHooks('printObjectLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks } else { $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); $reshook = $hookmanager->executeHooks('printObjectSubLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks } } if (empty($reshook)) { $this->printObjectLine($action, $line, '', $num, $i, $dateSelector, $seller, $buyer, $selected, $extrafields, $defaulttpldir); } $i++; } print "\n"; } /** * Return HTML content of a detail line * TODO Move this into an output class file (htmlline.class.php) * * @param string $action GET/POST action * @param CommonObjectLine $line Selected object line to output * @param string $var Is it a an odd line (true) * @param int $num Number of line (0) * @param int $i I * @param int $dateSelector 1=Show also date range input fields * @param string $seller Object of seller third party * @param string $buyer Object of buyer third party * @param int $selected Object line selected * @param Extrafields $extrafields Object of extrafields * @param string $defaulttpldir Directory where to find the template (deprecated) * @return void */ public function printObjectLine($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected = 0, $extrafields = null, $defaulttpldir = '/core/tpl') { global $conf, $langs, $user, $object, $hookmanager; global $form; global $object_rights, $disableedit, $disablemove, $disableremove; // TODO We should not use global var for this ! $object_rights = $this->getRights(); $element = $this->element; $text = ''; $description = ''; // Line in view mode if ($action != 'editline' || $selected != $line->id) { // Product if ($line->fk_product > 0) { $product_static = new Product($this->db); $product_static->fetch($line->fk_product); $product_static->ref = $line->ref; //can change ref in hook $product_static->label = $line->label; //can change label in hook $text = $product_static->getNomUrl(1); // Define output language and label if (!empty($conf->global->MAIN_MULTILANGS)) { if (property_exists($this, 'socid') && !is_object($this->thirdparty)) { dol_print_error('', 'Error: Method printObjectLine was called on an object and object->fetch_thirdparty was not done before'); return; } $prod = new Product($this->db); $prod->fetch($line->fk_product); $outputlangs = $langs; $newlang = ''; if (empty($newlang) && GETPOST('lang_id', 'aZ09')) $newlang = GETPOST('lang_id', 'aZ09'); if (!empty($conf->global->PRODUIT_TEXTS_IN_THIRDPARTY_LANGUAGE) && empty($newlang) && is_object($this->thirdparty)) $newlang = $this->thirdparty->default_lang; // To use language of customer if (!empty($newlang)) { $outputlangs = new Translate("", $conf); $outputlangs->setDefaultLang($newlang); } $label = (!empty($prod->multilangs[$outputlangs->defaultlang]["label"])) ? $prod->multilangs[$outputlangs->defaultlang]["label"] : $line->product_label; } else { $label = $line->product_label; } $text .= ' - '.(!empty($line->label) ? $line->label : $label); $description .= (!empty($conf->global->PRODUIT_DESC_IN_FORM) ? '' : dol_htmlentitiesbr($line->description)); // Description is what to show on popup. We shown nothing if already into desc. } $line->pu_ttc = price2num($line->subprice * (1 + ($line->tva_tx / 100)), 'MU'); // Output template part (modules that overwrite templates must declare this into descriptor) // Use global variables + $dateSelector + $seller and $buyer // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook printObjectLine and printObjectSubLine. $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir)); foreach ($dirtpls as $module => $reldir) { if (!empty($module)) { $tpl = dol_buildpath($reldir.'/objectline_view.tpl.php'); } else { $tpl = DOL_DOCUMENT_ROOT.$reldir.'/objectline_view.tpl.php'; } if (empty($conf->file->strict_mode)) { $res = @include $tpl; } else { $res = include $tpl; // for debug } if ($res) break; } } // Line in update mode if ($this->statut == 0 && $action == 'editline' && $selected == $line->id) { $label = (!empty($line->label) ? $line->label : (($line->fk_product > 0) ? $line->product_label : '')); $line->pu_ttc = price2num($line->subprice * (1 + ($line->tva_tx / 100)), 'MU'); // Output template part (modules that overwrite templates must declare this into descriptor) // Use global variables + $dateSelector + $seller and $buyer // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook printObjectLine and printObjectSubLine. $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir)); foreach ($dirtpls as $module => $reldir) { if (!empty($module)) { $tpl = dol_buildpath($reldir.'/objectline_edit.tpl.php'); } else { $tpl = DOL_DOCUMENT_ROOT.$reldir.'/objectline_edit.tpl.php'; } if (empty($conf->file->strict_mode)) { $res = @include $tpl; } else { $res = include $tpl; // for debug } if ($res) break; } } } /* This is to show array of line of details of source object */ /** * Return HTML table table of source object lines * TODO Move this and previous function into output html class file (htmlline.class.php). * If lines are into a template, title must also be into a template * But for the moment we don't know if it's possible, so we keep the method available on overloaded objects. * * @param string $restrictlist ''=All lines, 'services'=Restrict to services only * @param array $selectedLines Array of lines id for selected lines * @return void */ public function printOriginLinesList($restrictlist = '', $selectedLines = array()) { global $langs, $hookmanager, $conf, $form; print ''; print ''.$langs->trans('Ref').''; print ''.$langs->trans('Description').''; print ''.$langs->trans('VATRate').''; print ''.$langs->trans('PriceUHT').''; if (!empty($conf->multicurrency->enabled)) print ''.$langs->trans('PriceUHTCurrency').''; print ''.$langs->trans('Qty').''; if ($conf->global->PRODUCT_USE_UNITS) { print ''.$langs->trans('Unit').''; } print ''.$langs->trans('ReductionShort').''; print ''.$form->showCheckAddButtons('checkforselect', 1).''; print ''; $i = 0; if (!empty($this->lines)) { foreach ($this->lines as $line) { if (is_object($hookmanager) && (($line->product_type == 9 && !empty($line->special_code)) || !empty($line->fk_parent_line))) { if (empty($line->fk_parent_line)) { $parameters = array('line'=>$line, 'i'=>$i); $action = ''; $hookmanager->executeHooks('printOriginObjectLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks } } else { $this->printOriginLine($line, '', $restrictlist, '/core/tpl', $selectedLines); } $i++; } } } /** * Return HTML with a line of table array of source object lines * TODO Move this and previous function into output html class file (htmlline.class.php). * If lines are into a template, title must also be into a template * But for the moment we don't know if it's possible as we keep a method available on overloaded objects. * * @param CommonObjectLine $line Line * @param string $var Var * @param string $restrictlist ''=All lines, 'services'=Restrict to services only (strike line if not) * @param string $defaulttpldir Directory where to find the template * @param array $selectedLines Array of lines id for selected lines * @return void */ public function printOriginLine($line, $var, $restrictlist = '', $defaulttpldir = '/core/tpl', $selectedLines = array()) { global $langs, $conf; //var_dump($line); if (!empty($line->date_start)) { $date_start = $line->date_start; } else { $date_start = $line->date_debut_prevue; if ($line->date_debut_reel) $date_start = $line->date_debut_reel; } if (!empty($line->date_end)) { $date_end = $line->date_end; } else { $date_end = $line->date_fin_prevue; if ($line->date_fin_reel) $date_end = $line->date_fin_reel; } $this->tpl['id'] = $line->id; $this->tpl['label'] = ''; if (!empty($line->fk_parent_line)) $this->tpl['label'] .= img_picto('', 'rightarrow'); if (($line->info_bits & 2) == 2) // TODO Not sure this is used for source object { $discount = new DiscountAbsolute($this->db); $discount->fk_soc = $this->socid; $this->tpl['label'] .= $discount->getNomUrl(0, 'discount'); } elseif (!empty($line->fk_product)) { $productstatic = new Product($this->db); $productstatic->id = $line->fk_product; $productstatic->ref = $line->ref; $productstatic->type = $line->fk_product_type; if (empty($productstatic->ref)) { $line->fetch_product(); $productstatic = $line->product; } $this->tpl['label'] .= $productstatic->getNomUrl(1); $this->tpl['label'] .= ' - '.(!empty($line->label) ? $line->label : $line->product_label); // Dates if ($line->product_type == 1 && ($date_start || $date_end)) { $this->tpl['label'] .= get_date_range($date_start, $date_end); } } else { $this->tpl['label'] .= ($line->product_type == -1 ? ' ' : ($line->product_type == 1 ? img_object($langs->trans(''), 'service') : img_object($langs->trans(''), 'product'))); if (!empty($line->desc)) { $this->tpl['label'] .= $line->desc; } else { $this->tpl['label'] .= ($line->label ? ' '.$line->label : ''); } // Dates if ($line->product_type == 1 && ($date_start || $date_end)) { $this->tpl['label'] .= get_date_range($date_start, $date_end); } } if (!empty($line->desc)) { if ($line->desc == '(CREDIT_NOTE)') // TODO Not sure this is used for source object { $discount = new DiscountAbsolute($this->db); $discount->fetch($line->fk_remise_except); $this->tpl['description'] = $langs->transnoentities("DiscountFromCreditNote", $discount->getNomUrl(0)); } elseif ($line->desc == '(DEPOSIT)') // TODO Not sure this is used for source object { $discount = new DiscountAbsolute($this->db); $discount->fetch($line->fk_remise_except); $this->tpl['description'] = $langs->transnoentities("DiscountFromDeposit", $discount->getNomUrl(0)); } elseif ($line->desc == '(EXCESS RECEIVED)') { $discount = new DiscountAbsolute($this->db); $discount->fetch($line->fk_remise_except); $this->tpl['description'] = $langs->transnoentities("DiscountFromExcessReceived", $discount->getNomUrl(0)); } elseif ($line->desc == '(EXCESS PAID)') { $discount = new DiscountAbsolute($this->db); $discount->fetch($line->fk_remise_except); $this->tpl['description'] = $langs->transnoentities("DiscountFromExcessPaid", $discount->getNomUrl(0)); } else { $this->tpl['description'] = dol_trunc($line->desc, 60); } } else { $this->tpl['description'] = ' '; } // VAT Rate $this->tpl['vat_rate'] = vatrate($line->tva_tx, true); $this->tpl['vat_rate'] .= (($line->info_bits & 1) == 1) ? '*' : ''; if (!empty($line->vat_src_code) && !preg_match('/\(/', $this->tpl['vat_rate'])) $this->tpl['vat_rate'] .= ' ('.$line->vat_src_code.')'; $this->tpl['price'] = price($line->subprice); $this->tpl['multicurrency_price'] = price($line->multicurrency_subprice); $this->tpl['qty'] = (($line->info_bits & 2) != 2) ? $line->qty : ' '; if ($conf->global->PRODUCT_USE_UNITS) $this->tpl['unit'] = $langs->transnoentities($line->getLabelOfUnit('long')); $this->tpl['remise_percent'] = (($line->info_bits & 2) != 2) ? vatrate($line->remise_percent, true) : ' '; // Is the line strike or not $this->tpl['strike'] = 0; if ($restrictlist == 'services' && $line->product_type != Product::TYPE_SERVICE) $this->tpl['strike'] = 1; // Output template part (modules that overwrite templates must declare this into descriptor) // Use global variables + $dateSelector + $seller and $buyer $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir)); foreach ($dirtpls as $module => $reldir) { if (!empty($module)) { $tpl = dol_buildpath($reldir.'/originproductline.tpl.php'); } else { $tpl = DOL_DOCUMENT_ROOT.$reldir.'/originproductline.tpl.php'; } if (empty($conf->file->strict_mode)) { $res = @include $tpl; } else { $res = include $tpl; // for debug } if ($res) break; } } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Add resources to the current object : add entry into llx_element_resources * Need $this->element & $this->id * * @param int $resource_id Resource id * @param string $resource_type 'resource' * @param int $busy Busy or not * @param int $mandatory Mandatory or not * @return int <=0 if KO, >0 if OK */ public function add_element_resource($resource_id, $resource_type, $busy = 0, $mandatory = 0) { // phpcs:enable $this->db->begin(); $sql = "INSERT INTO ".MAIN_DB_PREFIX."element_resources ("; $sql .= "resource_id"; $sql .= ", resource_type"; $sql .= ", element_id"; $sql .= ", element_type"; $sql .= ", busy"; $sql .= ", mandatory"; $sql .= ") VALUES ("; $sql .= $resource_id; $sql .= ", '".$this->db->escape($resource_type)."'"; $sql .= ", '".$this->db->escape($this->id)."'"; $sql .= ", '".$this->db->escape($this->element)."'"; $sql .= ", '".$this->db->escape($busy)."'"; $sql .= ", '".$this->db->escape($mandatory)."'"; $sql .= ")"; dol_syslog(get_class($this)."::add_element_resource", LOG_DEBUG); if ($this->db->query($sql)) { $this->db->commit(); return 1; } else { $this->error = $this->db->lasterror(); $this->db->rollback(); return 0; } } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Delete a link to resource line * * @param int $rowid Id of resource line to delete * @param int $element element name (for trigger) TODO: use $this->element into commonobject class * @param int $notrigger Disable all triggers * @return int >0 if OK, <0 if KO */ public function delete_resource($rowid, $element, $notrigger = 0) { // phpcs:enable global $user; $this->db->begin(); $sql = "DELETE FROM ".MAIN_DB_PREFIX."element_resources"; $sql .= " WHERE rowid=".$rowid; dol_syslog(get_class($this)."::delete_resource", LOG_DEBUG); $resql = $this->db->query($sql); if (!$resql) { $this->error = $this->db->lasterror(); $this->db->rollback(); return -1; } else { if (!$notrigger) { $result = $this->call_trigger(strtoupper($element).'_DELETE_RESOURCE', $user); if ($result < 0) { $this->db->rollback(); return -1; } } $this->db->commit(); return 1; } } /** * Overwrite magic function to solve problem of cloning object that are kept as references * * @return void */ public function __clone() { // Force a copy of this->lines, otherwise it will point to same object. if (isset($this->lines) && is_array($this->lines)) { $nboflines = count($this->lines); for ($i = 0; $i < $nboflines; $i++) { $this->lines[$i] = clone $this->lines[$i]; } } } /** * Common function for all objects extending CommonObject for generating documents * * @param string $modelspath Relative folder where generators are placed * @param string $modele Generator to use. Caller must set it to obj->model_pdf or GETPOST('model_pdf','alpha') for example. * @param Translate $outputlangs Output language to use * @param int $hidedetails 1 to hide details. 0 by default * @param int $hidedesc 1 to hide product description. 0 by default * @param int $hideref 1 to hide product reference. 0 by default * @param null|array $moreparams Array to provide more information * @return int >0 if OK, <0 if KO * @see addFileIntoDatabaseIndex() */ protected function commonGenerateDocument($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams = null) { global $conf, $langs, $user, $hookmanager, $action; $srctemplatepath = ''; $parameters = array('modelspath'=>$modelspath, 'modele'=>$modele, 'outputlangs'=>$outputlangs, 'hidedetails'=>$hidedetails, 'hidedesc'=>$hidedesc, 'hideref'=>$hideref, 'moreparams'=>$moreparams); $reshook = $hookmanager->executeHooks('commonGenerateDocument', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks if (empty($reshook)) { dol_syslog("commonGenerateDocument modele=".$modele." outputlangs->defaultlang=".(is_object($outputlangs) ? $outputlangs->defaultlang : 'null')); // Increase limit for PDF build $err = error_reporting(); error_reporting(0); @set_time_limit(120); error_reporting($err); // If selected model is a filename template (then $modele="modelname" or "modelname:filename") $tmp = explode(':', $modele, 2); if (!empty($tmp[1])) { $modele = $tmp[0]; $srctemplatepath = $tmp[1]; } // Search template files $file = ''; $classname = ''; $filefound = ''; $dirmodels = array('/'); if (is_array($conf->modules_parts['models'])) $dirmodels = array_merge($dirmodels, $conf->modules_parts['models']); foreach ($dirmodels as $reldir) { foreach (array('doc', 'pdf') as $prefix) { if (in_array(get_class($this), array('Adherent'))) $file = $prefix."_".$modele.".class.php"; // Member module use prefix_module.class.php else $file = $prefix."_".$modele.".modules.php"; // On verifie l'emplacement du modele $file = dol_buildpath($reldir.$modelspath.$file, 0); if (file_exists($file)) { $filefound = $file; $classname = $prefix.'_'.$modele; break; } } if ($filefound) break; } // If generator was found if ($filefound) { global $db; // Required to solve a conception default making an include of code using $db instead of $this->db just after. require_once $file; $obj = new $classname($this->db); // If generator is ODT, we must have srctemplatepath defined, if not we set it. if ($obj->type == 'odt' && empty($srctemplatepath)) { $varfortemplatedir = $obj->scandir; if ($varfortemplatedir && !empty($conf->global->$varfortemplatedir)) { $dirtoscan = $conf->global->$varfortemplatedir; $listoffiles = array(); // Now we add first model found in directories scanned $listofdir = explode(',', $dirtoscan); foreach ($listofdir as $key => $tmpdir) { $tmpdir = trim($tmpdir); $tmpdir = preg_replace('/DOL_DATA_ROOT/', DOL_DATA_ROOT, $tmpdir); if (!$tmpdir) { unset($listofdir[$key]); continue; } if (is_dir($tmpdir)) { $tmpfiles = dol_dir_list($tmpdir, 'files', 0, '\.od(s|t)$', '', 'name', SORT_ASC, 0); if (count($tmpfiles)) $listoffiles = array_merge($listoffiles, $tmpfiles); } } if (count($listoffiles)) { foreach ($listoffiles as $record) { $srctemplatepath = $record['fullname']; break; } } } if (empty($srctemplatepath)) { $this->error = 'ErrorGenerationAskedForOdtTemplateWithSrcFileNotDefined'; return -1; } } if ($obj->type == 'odt' && !empty($srctemplatepath)) { if (!dol_is_file($srctemplatepath)) { dol_syslog("Failed to locate template file ".$srctemplatepath, LOG_WARNING); $this->error = 'ErrorGenerationAskedForOdtTemplateWithSrcFileNotFound'; return -1; } } // We save charset_output to restore it because write_file can change it if needed for // output format that does not support UTF8. $sav_charset_output = $outputlangs->charset_output; if (in_array(get_class($this), array('Adherent'))) { $arrayofrecords = array(); // The write_file of templates of adherent class need this var $resultwritefile = $obj->write_file($this, $outputlangs, $srctemplatepath, 'member', 1, $moreparams); } else { $resultwritefile = $obj->write_file($this, $outputlangs, $srctemplatepath, $hidedetails, $hidedesc, $hideref, $moreparams); } // After call of write_file $obj->result['fullpath'] is set with generated file. It will be used to update the ECM database index. if ($resultwritefile > 0) { $outputlangs->charset_output = $sav_charset_output; // We delete old preview require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php'; dol_delete_preview($this); // Index file in database if (!empty($obj->result['fullpath'])) { $destfull = $obj->result['fullpath']; $upload_dir = dirname($destfull); $destfile = basename($destfull); $rel_dir = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $upload_dir); if (!preg_match('/[\\/]temp[\\/]|[\\/]thumbs|\.meta$/', $rel_dir)) // If not a tmp dir { $filename = basename($destfile); $rel_dir = preg_replace('/[\\/]$/', '', $rel_dir); $rel_dir = preg_replace('/^[\\/]/', '', $rel_dir); include_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmfiles.class.php'; $ecmfile = new EcmFiles($this->db); $result = $ecmfile->fetch(0, '', ($rel_dir ? $rel_dir.'/' : '').$filename); // Set the public "share" key $setsharekey = false; if ($this->element == 'propal') { $useonlinesignature = $conf->global->MAIN_FEATURES_LEVEL; // Replace this with 1 when feature to make online signature is ok if ($useonlinesignature) $setsharekey = true; if (!empty($conf->global->PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD)) $setsharekey = true; } if ($this->element == 'commande' && !empty($conf->global->ORDER_ALLOW_EXTERNAL_DOWNLOAD)) { $setsharekey = true; } if ($this->element == 'facture' && !empty($conf->global->INVOICE_ALLOW_EXTERNAL_DOWNLOAD)) { $setsharekey = true; } if ($this->element == 'bank_account' && !empty($conf->global->BANK_ACCOUNT_ALLOW_EXTERNAL_DOWNLOAD)) { $setsharekey = true; } if ($setsharekey) { if (empty($ecmfile->share)) // Because object not found or share not set yet { require_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php'; $ecmfile->share = getRandomPassword(true); } } if ($result > 0) { $ecmfile->label = md5_file(dol_osencode($destfull)); // hash of file content $ecmfile->fullpath_orig = ''; $ecmfile->gen_or_uploaded = 'generated'; $ecmfile->description = ''; // indexed content $ecmfile->keyword = ''; // keyword content $result = $ecmfile->update($user); if ($result < 0) { setEventMessages($ecmfile->error, $ecmfile->errors, 'warnings'); } } else { $ecmfile->entity = $conf->entity; $ecmfile->filepath = $rel_dir; $ecmfile->filename = $filename; $ecmfile->label = md5_file(dol_osencode($destfull)); // hash of file content $ecmfile->fullpath_orig = ''; $ecmfile->gen_or_uploaded = 'generated'; $ecmfile->description = ''; // indexed content $ecmfile->keyword = ''; // keyword content $ecmfile->src_object_type = $this->table_element; $ecmfile->src_object_id = $this->id; $result = $ecmfile->create($user); if ($result < 0) { setEventMessages($ecmfile->error, $ecmfile->errors, 'warnings'); } } /*$this->result['fullname']=$destfull; $this->result['filepath']=$ecmfile->filepath; $this->result['filename']=$ecmfile->filename;*/ //var_dump($obj->update_main_doc_field);exit; // Update the last_main_doc field into main object (if documenent generator has property ->update_main_doc_field set) $update_main_doc_field = 0; if (!empty($obj->update_main_doc_field)) $update_main_doc_field = 1; if ($update_main_doc_field && !empty($this->table_element)) { $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element." SET last_main_doc = '".$this->db->escape($ecmfile->filepath.'/'.$ecmfile->filename)."'"; $sql .= ' WHERE rowid = '.$this->id; $resql = $this->db->query($sql); if (!$resql) { dol_print_error($this->db); } else { $this->last_main_doc = $ecmfile->filepath.'/'.$ecmfile->filename; } } } } else { 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); } // Success in building document. We build meta file. dol_meta_create($this); return 1; } else { $outputlangs->charset_output = $sav_charset_output; dol_print_error($this->db, "Error generating document for ".__CLASS__.". Error: ".$obj->error, $obj->errors); return -1; } } else { if (!$filefound) { $this->error = $langs->trans("Error").' Failed to load doc generator with modelpaths='.$modelspath.' - modele='.$modele; dol_print_error('', $this->error); } else { $this->error = $langs->trans("Error")." ".$langs->trans("ErrorFileDoesNotExists", $filefound); dol_print_error('', $this->error); } return -1; } } else return $reshook; } /** * Build thumb * @todo Move this into files.lib.php * * @param string $file Path file in UTF8 to original file to create thumbs from. * @return void */ public function addThumbs($file) { global $maxwidthsmall, $maxheightsmall, $maxwidthmini, $maxheightmini, $quality; require_once DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php'; // This define also $maxwidthsmall, $quality, ... $file_osencoded = dol_osencode($file); if (file_exists($file_osencoded)) { // Create small thumbs for company (Ratio is near 16/9) // Used on logon for example vignette($file_osencoded, $maxwidthsmall, $maxheightsmall, '_small', $quality); // Create mini thumbs for company (Ratio is near 16/9) // Used on menu or for setup page for example vignette($file_osencoded, $maxwidthmini, $maxheightmini, '_mini', $quality); } } /* Functions common to commonobject and commonobjectline */ /* For default values */ /** * Return the default value to use for a field when showing the create form of object. * Return values in this order: * 1) If parameter is available into POST, we return it first. * 2) If not but an alternate value was provided as parameter of function, we return it. * 3) If not but a constant $conf->global->OBJECTELEMENT_FIELDNAME is set, we return it (It is better to use the dedicated table). * 4) Return value found into database (TODO No yet implemented) * * @param string $fieldname Name of field * @param string $alternatevalue Alternate value to use * @return string|string[] Default value (can be an array if the GETPOST return an array) **/ public function getDefaultCreateValueFor($fieldname, $alternatevalue = null) { global $conf, $_POST; // If param here has been posted, we use this value first. if (GETPOSTISSET($fieldname)) return GETPOST($fieldname, 'alphanohtml', 3); if (isset($alternatevalue)) return $alternatevalue; $newelement = $this->element; if ($newelement == 'facture') $newelement = 'invoice'; if ($newelement == 'commande') $newelement = 'order'; if (empty($newelement)) { dol_syslog("Ask a default value using common method getDefaultCreateValueForField on an object with no property ->element defined. Return empty string.", LOG_WARNING); return ''; } $keyforfieldname = strtoupper($newelement.'_DEFAULT_'.$fieldname); //var_dump($keyforfieldname); if (isset($conf->global->$keyforfieldname)) return $conf->global->$keyforfieldname; // TODO Ad here a scan into table llx_overwrite_default with a filter on $this->element and $fieldname } /* For triggers */ // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Call trigger based on this instance. * Some context information may also be provided into array property this->context. * NB: Error from trigger are stacked in interface->errors * NB2: If return code of triggers are < 0, action calling trigger should cancel all transaction. * * @param string $triggerName trigger's name to execute * @param User $user Object user * @return int Result of run_triggers */ public function call_trigger($triggerName, $user) { // phpcs:enable global $langs, $conf; if (!is_object($langs)) { // If lang was not defined, we set it. It is required by run_triggers. include_once DOL_DOCUMENT_ROOT.'/core/class/translate.class.php'; $langs = new Translate('', $conf); } include_once DOL_DOCUMENT_ROOT.'/core/class/interfaces.class.php'; $interface = new Interfaces($this->db); $result = $interface->run_triggers($triggerName, $this, $user, $langs, $conf); if ($result < 0) { if (!empty($this->errors)) { $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. } else { $this->errors = $interface->errors; } } return $result; } /* Functions for data in other language */ /** * Function to get alternative languages of a data into $this->array_languages * This method is NOT called by method fetch of objects but must be called separately. * * @return int <0 if error, 0 if no values of alternative languages to find nor found, 1 if a value was found and loaded * @see fetch_optionnals() */ public function fetchValuesForExtraLanguages() { // To avoid SQL errors. Probably not the better solution though if (!$this->element) { return 0; } if (!($this->id > 0)) { return 0; } if (is_array($this->array_languages)) { return 1; } $this->array_languages = array(); $element = $this->element; if ($element == 'categorie') $element = 'categories'; // For compatibility // Request to get translation values for object $sql = "SELECT rowid, property, lang , value"; $sql .= " FROM ".MAIN_DB_PREFIX."object_lang"; $sql .= " WHERE type_object = '".$this->db->escape($element)."'"; $sql .= " AND fk_object = ".$this->id; //dol_syslog(get_class($this)."::fetch_optionals get extrafields data for ".$this->table_element, LOG_DEBUG); // Too verbose $resql = $this->db->query($sql); if ($resql) { $numrows = $this->db->num_rows($resql); if ($numrows) { $i = 0; while ($i < $numrows) { $obj = $this->db->fetch_object($resql); $key = $obj->property; $value = $obj->value; $codelang = $obj->lang; $type = $this->fields[$key]['type']; // we can add this attribute to object if (preg_match('/date/', $type)) { $this->array_languages[$key][$codelang] = $this->db->jdate($value); } else { $this->array_languages[$key][$codelang] = $value; } $i++; } } $this->db->free($resql); if ($numrows) return $numrows; else return 0; } else { dol_print_error($this->db); return -1; } } /** * Fill array_options property of object by extrafields value (using for data sent by forms) * * @param string $onlykey Only the following key is filled. When we make update of only one language field ($action = 'update_languages'), calling page must set this to avoid to have other languages being reset. * @return int 1 if array_options set, 0 if no value, -1 if error (field required missing for example) */ public function setValuesForExtraLanguages($onlykey = '') { global $_POST, $langs; // Get extra fields foreach ($_POST as $postfieldkey => $postfieldvalue) { $tmparray = explode('-', $postfieldkey); if ($tmparray[0] != 'field') continue; $element = $tmparray[1]; $key = $tmparray[2]; $codelang = $tmparray[3]; //var_dump("postfieldkey=".$postfieldkey." element=".$element." key=".$key." codelang=".$codelang); if (!empty($onlykey) && $key != $onlykey) continue; if ($element != $this->element) continue; $key_type = $this->fields[$key]['type']; $enabled = 1; if (isset($this->fields[$key]['enabled'])) { $enabled = dol_eval($this->fields[$key]['enabled'], 1); } /*$perms = 1; if (isset($this->fields[$key]['perms'])) { $perms = dol_eval($this->fields[$key]['perms'], 1); }*/ if (empty($enabled)) continue; //if (empty($perms)) continue; if (in_array($key_type, array('date'))) { // Clean parameters // TODO GMT date in memory must be GMT so we should add gm=true in parameters $value_key = dol_mktime(0, 0, 0, $_POST[$postfieldkey."month"], $_POST[$postfieldkey."day"], $_POST[$postfieldkey."year"]); } elseif (in_array($key_type, array('datetime'))) { // Clean parameters // TODO GMT date in memory must be GMT so we should add gm=true in parameters $value_key = dol_mktime($_POST[$postfieldkey."hour"], $_POST[$postfieldkey."min"], 0, $_POST[$postfieldkey."month"], $_POST[$postfieldkey."day"], $_POST[$postfieldkey."year"]); } elseif (in_array($key_type, array('checkbox', 'chkbxlst'))) { $value_arr = GETPOST($postfieldkey, 'array'); // check if an array if (!empty($value_arr)) { $value_key = implode($value_arr, ','); } else { $value_key = ''; } } elseif (in_array($key_type, array('price', 'double'))) { $value_arr = GETPOST($postfieldkey, 'alpha'); $value_key = price2num($value_arr); } else { $value_key = GETPOST($postfieldkey); if (in_array($key_type, array('link')) && $value_key == '-1') $value_key = ''; } $this->array_languages[$key][$codelang] = $value_key; /*if ($nofillrequired) { $langs->load('errors'); setEventMessages($langs->trans('ErrorFieldsRequired').' : '.implode(', ', $error_field_required), null, 'errors'); return -1; }*/ } return 1; } /* Functions for extrafields */ /** * Function to make a fetch but set environment to avoid to load computed values before. * * @param int $id ID of object * @return int >0 if OK, 0 if not found, <0 if KO */ public function fetchNoCompute($id) { global $conf; $savDisableCompute = $conf->disable_compute; $conf->disable_compute = 1; $ret = $this->fetch($id); $conf->disable_compute = $savDisableCompute; return $ret; } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Function to get extra fields of an object into $this->array_options * This method is in most cases called by method fetch of objects but you can call it separately. * * @param int $rowid Id of line. Use the id of object if not defined. Deprecated. Function must be called without parameters. * @param array $optionsArray Array resulting of call of extrafields->fetch_name_optionals_label(). Deprecated. Function must be called without parameters. * @return int <0 if error, 0 if no values of extrafield to find nor found, 1 if an attribute is found and value loaded * @see fetchValuesForExtraLanguages() */ public function fetch_optionals($rowid = null, $optionsArray = null) { // phpcs:enable global $conf, $extrafields; if (empty($rowid)) $rowid = $this->id; if (empty($rowid)) $rowid = $this->rowid; // To avoid SQL errors. Probably not the better solution though if (!$this->table_element) { return 0; } $this->array_options = array(); if (!is_array($optionsArray)) { // If $extrafields is not a known object, we initialize it. Best practice is to have $extrafields defined into card.php or list.php page. if (!isset($extrafields) || !is_object($extrafields)) { require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php'; $extrafields = new ExtraFields($this->db); } // Load array of extrafields for elementype = $this->table_element if (empty($extrafields->attributes[$this->table_element]['loaded'])) { $extrafields->fetch_name_optionals_label($this->table_element); } $optionsArray = (!empty($extrafields->attributes[$this->table_element]['label']) ? $extrafields->attributes[$this->table_element]['label'] : null); } else { global $extrafields; dol_syslog("Warning: fetch_optionals was called with param optionsArray defined when you should pass null now", LOG_WARNING); } $table_element = $this->table_element; if ($table_element == 'categorie') $table_element = 'categories'; // For compatibility // Request to get complementary values if (is_array($optionsArray) && count($optionsArray) > 0) { $sql = "SELECT rowid"; foreach ($optionsArray as $name => $label) { if (empty($extrafields->attributes[$this->table_element]['type'][$name]) || $extrafields->attributes[$this->table_element]['type'][$name] != 'separate') { $sql .= ", ".$name; } } $sql .= " FROM ".MAIN_DB_PREFIX.$table_element."_extrafields"; $sql .= " WHERE fk_object = ".((int) $rowid); //dol_syslog(get_class($this)."::fetch_optionals get extrafields data for ".$this->table_element, LOG_DEBUG); // Too verbose $resql = $this->db->query($sql); if ($resql) { $numrows = $this->db->num_rows($resql); if ($numrows) { $tab = $this->db->fetch_array($resql); foreach ($tab as $key => $value) { // 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) if ($key != 'rowid' && $key != 'tms' && $key != 'fk_member' && !is_int($key)) { // we can add this attribute to object if (!empty($extrafields) && in_array($extrafields->attributes[$this->table_element]['type'][$key], array('date', 'datetime'))) { //var_dump($extrafields->attributes[$this->table_element]['type'][$key]); $this->array_options["options_".$key] = $this->db->jdate($value); } else { $this->array_options["options_".$key] = $value; } //var_dump('key '.$key.' '.$value.' type='.$extrafields->attributes[$this->table_element]['type'][$key].' '.$this->array_options["options_".$key]); } } // If field is a computed field, value must become result of compute foreach ($tab as $key => $value) { if (!empty($extrafields) && !empty($extrafields->attributes[$this->table_element]['computed'][$key])) { //var_dump($conf->disable_compute); if (empty($conf->disable_compute)) { $this->array_options["options_".$key] = dol_eval($extrafields->attributes[$this->table_element]['computed'][$key], 1, 0); } } } } $this->db->free($resql); if ($numrows) return $numrows; else return 0; } else { dol_print_error($this->db); return -1; } } return 0; } /** * Delete all extra fields values for the current object. * * @return int <0 if KO, >0 if OK * @see deleteExtraLanguages(), insertExtraField(), updateExtraField(), setValueFrom() */ public function deleteExtraFields() { global $conf; if (!empty($conf->global->MAIN_EXTRAFIELDS_DISABLED)) return 0; $this->db->begin(); $table_element = $this->table_element; if ($table_element == 'categorie') $table_element = 'categories'; // For compatibility $sql_del = "DELETE FROM ".MAIN_DB_PREFIX.$table_element."_extrafields WHERE fk_object = ".$this->id; dol_syslog(get_class($this)."::deleteExtraFields delete", LOG_DEBUG); $resql = $this->db->query($sql_del); if (!$resql) { $this->error = $this->db->lasterror(); $this->db->rollback(); return -1; } else { $this->db->commit(); return 1; } } /** * Add/Update all extra fields values for the current object. * Data to describe values to insert/update are stored into $this->array_options=array('options_codeforfield1'=>'valueforfield1', 'options_codeforfield2'=>'valueforfield2', ...) * This function delete record with all extrafields and insert them again from the array $this->array_options. * * @param string $trigger If defined, call also the trigger (for example COMPANY_MODIFY) * @param User $userused Object user * @return int -1=error, O=did nothing, 1=OK * @see insertExtraLanguages(), updateExtraField(), deleteExtraField(), setValueFrom() */ public function insertExtraFields($trigger = '', $userused = null) { global $conf, $langs, $user; if (!empty($conf->global->MAIN_EXTRAFIELDS_DISABLED)) return 0; if (empty($userused)) $userused = $user; $error = 0; if (!empty($this->array_options)) { // Check parameters $langs->load('admin'); require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php'; $extrafields = new ExtraFields($this->db); $target_extrafields = $extrafields->fetch_name_optionals_label($this->table_element); //Eliminate copied source object extra_fields that do not exist in target object $new_array_options = array(); foreach ($this->array_options as $key => $value) { if (in_array(substr($key, 8), array_keys($target_extrafields))) // We remove the 'options_' from $key for test $new_array_options[$key] = $value; elseif (in_array($key, array_keys($target_extrafields))) // We test on $key that does not contains the 'options_' prefix $new_array_options['options_'.$key] = $value; } foreach ($new_array_options as $key => $value) { $attributeKey = substr($key, 8); // Remove 'options_' prefix $attributeType = $extrafields->attributes[$this->table_element]['type'][$attributeKey]; $attributeLabel = $extrafields->attributes[$this->table_element]['label'][$attributeKey]; $attributeParam = $extrafields->attributes[$this->table_element]['param'][$attributeKey]; $attributeRequired = $extrafields->attributes[$this->table_element]['required'][$attributeKey]; $attrfieldcomputed = $extrafields->attributes[$this->table_element]['computed'][$attributeKey]; if ($attributeRequired) { $mandatorypb = false; if ($attributeType == 'link' && $this->array_options[$key] == '-1') $mandatorypb = true; if ($this->array_options[$key] === '') $mandatorypb = true; if ($mandatorypb) { dol_syslog("Mandatory extra field ".$key." is empty"); $this->errors[] = $langs->trans('ErrorFieldRequired', $attributeLabel); return -1; } } //dol_syslog("attributeLabel=".$attributeLabel, LOG_DEBUG); //dol_syslog("attributeType=".$attributeType, LOG_DEBUG); if (!empty($attrfieldcomputed)) { if (!empty($conf->global->MAIN_STORE_COMPUTED_EXTRAFIELDS)) { $value = dol_eval($attrfieldcomputed, 1, 0); dol_syslog($langs->trans("Extrafieldcomputed")." sur ".$attributeLabel."(".$value.")", LOG_DEBUG); $new_array_options[$key] = $value; } else { $new_array_options[$key] = null; } } switch ($attributeType) { case 'int': if (!is_numeric($value) && $value != '') { $this->errors[] = $langs->trans("ExtraFieldHasWrongValue", $attributeLabel); return -1; } elseif ($value == '') { $new_array_options[$key] = null; } break; case 'price': case 'double': $value = price2num($value); if (!is_numeric($value) && $value != '') { dol_syslog($langs->trans("ExtraFieldHasWrongValue")." for ".$attributeLabel."(".$value."is not '".$attributeType."')", LOG_DEBUG); $this->errors[] = $langs->trans("ExtraFieldHasWrongValue", $attributeLabel); return -1; } elseif ($value == '') { $new_array_options[$key] = null; } //dol_syslog("double value"." sur ".$attributeLabel."(".$value." is '".$attributeType."')", LOG_DEBUG); $new_array_options[$key] = $value; break; /*case 'select': // Not required, we chosed value='0' for undefined values if ($value=='-1') { $this->array_options[$key] = null; } break;*/ case 'password': $algo = ''; if ($this->array_options[$key] != '' && is_array($extrafields->attributes[$this->table_element]['param'][$attributeKey]['options'])) { // If there is an encryption choice, we use it to crypt data before insert $tmparrays = array_keys($extrafields->attributes[$this->table_element]['param'][$attributeKey]['options']); $algo = reset($tmparrays); if ($algo != '') { //global $action; // $action may be 'create', 'update', 'update_extras'... //var_dump($action); //var_dump($this->oldcopy);exit; 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 { //var_dump($this->oldcopy->array_options[$key]); var_dump($this->array_options[$key]); if ($this->array_options[$key] == $this->oldcopy->array_options[$key]) // If old value crypted in database is same than submited new value, it means we don't change it, so we don't update. { $new_array_options[$key] = $this->array_options[$key]; // Value is kept } else { // var_dump($algo); $newvalue = dol_hash($this->array_options[$key], $algo); $new_array_options[$key] = $newvalue; } } else { $new_array_options[$key] = $this->array_options[$key]; // Value is kept } } } else // Common usage { $new_array_options[$key] = $this->array_options[$key]; } break; case 'date': case 'datetime': // If data is a string instead of a timestamp, we convert it if (!is_int($this->array_options[$key])) { $this->array_options[$key] = strtotime($this->array_options[$key]); } $new_array_options[$key] = $this->db->idate($this->array_options[$key]); break; case 'link': $param_list = array_keys($attributeParam['options']); // 0 : ObjectName // 1 : classPath $InfoFieldList = explode(":", $param_list[0]); dol_include_once($InfoFieldList[1]); if ($InfoFieldList[0] && class_exists($InfoFieldList[0])) { if ($value == '-1') // -1 is key for no defined in combo list of objects { $new_array_options[$key] = ''; } elseif ($value) { $object = new $InfoFieldList[0]($this->db); if (is_numeric($value)) $res = $object->fetch($value); else $res = $object->fetch('', $value); if ($res > 0) $new_array_options[$key] = $object->id; else { $this->error = "Id/Ref '".$value."' for object '".$object->element."' not found"; $this->db->rollback(); return -1; } } } else { dol_syslog('Error bad setup of extrafield', LOG_WARNING); } break; } } $this->db->begin(); $table_element = $this->table_element; if ($table_element == 'categorie') $table_element = 'categories'; // For compatibility dol_syslog(get_class($this)."::insertExtraFields delete then insert", LOG_DEBUG); $sql_del = "DELETE FROM ".MAIN_DB_PREFIX.$table_element."_extrafields WHERE fk_object = ".$this->id; $this->db->query($sql_del); $sql = "INSERT INTO ".MAIN_DB_PREFIX.$table_element."_extrafields (fk_object"; foreach ($new_array_options as $key => $value) { $attributeKey = substr($key, 8); // Remove 'options_' prefix // Add field of attribut if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] != 'separate') // Only for other type than separator $sql .= ",".$attributeKey; } // We must insert a default value for fields for other entities that are mandatory to avoid not null error if (is_array($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities'])) { foreach ($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities'] as $tmpkey => $tmpval) { if (!isset($extrafields->attributes[$this->table_element]['type'][$tmpkey])) // If field not already added previously { $sql .= ",".$tmpkey; } } } $sql .= ") VALUES (".$this->id; foreach ($new_array_options as $key => $value) { $attributeKey = substr($key, 8); // Remove 'options_' prefix // Add field of attribute if ($extrafields->attributes[$this->table_element]['type'][$attributeKey] != 'separate') // Only for other type than separator) { if ($new_array_options[$key] != '' || $new_array_options[$key] == '0') { $sql .= ",'".$this->db->escape($new_array_options[$key])."'"; } else { $sql .= ",null"; } } } // We must insert a default value for fields for other entities that are mandatory to avoid not null error if (is_array($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities'])) { foreach ($extrafields->attributes[$this->table_element]['mandatoryfieldsofotherentities'] as $tmpkey => $tmpval) { if (!isset($extrafields->attributes[$this->table_element]['type'][$tmpkey])) // If field not already added previously { if (in_array($tmpval, array('int', 'double', 'price'))) $sql .= ", 0"; else $sql .= ", ''"; } } } $sql .= ")"; $resql = $this->db->query($sql); if (!$resql) { $this->error = $this->db->lasterror(); $error++; } if (!$error && $trigger) { // Call trigger $this->context = array('extrafieldaddupdate'=>1); $result = $this->call_trigger($trigger, $userused); if ($result < 0) $error++; // End call trigger } if ($error) { $this->db->rollback(); return -1; } else { $this->db->commit(); return 1; } } else return 0; } /** * Add/Update all extra fields values for the current object. * Data to describe values to insert/update are stored into $this->array_options=array('options_codeforfield1'=>'valueforfield1', 'options_codeforfield2'=>'valueforfield2', ...) * This function delete record with all extrafields and insert them again from the array $this->array_options. * * @param string $trigger If defined, call also the trigger (for example COMPANY_MODIFY) * @param User $userused Object user * @return int -1=error, O=did nothing, 1=OK * @see insertExtraFields(), updateExtraField(), setValueFrom() */ public function insertExtraLanguages($trigger = '', $userused = null) { global $conf, $langs, $user; if (empty($userused)) $userused = $user; $error = 0; if (!empty($conf->global->MAIN_EXTRALANGUAGES_DISABLED)) return 0; // For avoid conflicts if trigger used if (is_array($this->array_languages)) { $new_array_languages = $this->array_languages; foreach ($new_array_languages as $key => $value) { $attributeKey = $key; $attributeType = $this->fields[$attributeKey]['type']; $attributeLabel = $this->fields[$attributeKey]['label']; //dol_syslog("attributeLabel=".$attributeLabel, LOG_DEBUG); //dol_syslog("attributeType=".$attributeType, LOG_DEBUG); switch ($attributeType) { case 'int': if (!is_numeric($value) && $value != '') { $this->errors[] = $langs->trans("ExtraLanguageHasWrongValue", $attributeLabel); return -1; } elseif ($value == '') { $new_array_languages[$key] = null; } break; case 'double': $value = price2num($value); if (!is_numeric($value) && $value != '') { dol_syslog($langs->trans("ExtraLanguageHasWrongValue")." sur ".$attributeLabel."(".$value."is not '".$attributeType."')", LOG_DEBUG); $this->errors[] = $langs->trans("ExtraLanguageHasWrongValue", $attributeLabel); return -1; } elseif ($value == '') { $new_array_languages[$key] = null; } //dol_syslog("double value"." sur ".$attributeLabel."(".$value." is '".$attributeType."')", LOG_DEBUG); $new_array_languages[$key] = $value; break; /*case 'select': // Not required, we chosed value='0' for undefined values if ($value=='-1') { $this->array_options[$key] = null; } break;*/ } } $this->db->begin(); $table_element = $this->table_element; if ($table_element == 'categorie') $table_element = 'categories'; // For compatibility dol_syslog(get_class($this)."::insertExtraLanguages delete then insert", LOG_DEBUG); foreach ($new_array_languages as $key => $langcodearray) { // $key = 'name', 'town', ... foreach ($langcodearray as $langcode => $value) { $sql_del = "DELETE FROM ".MAIN_DB_PREFIX."object_lang"; $sql_del .= " WHERE fk_object = ".$this->id." AND property = '".$this->db->escape($key)."' AND type_object = '".$this->db->escape($table_element)."'"; $sql_del .= " AND lang = '".$this->db->escape($langcode)."'"; $this->db->query($sql_del); if ($value !== '') { $sql = "INSERT INTO ".MAIN_DB_PREFIX."object_lang (fk_object, property, type_object, lang, value"; $sql .= ") VALUES (".$this->id.", '".$this->db->escape($key)."', '".$this->db->escape($table_element)."', '".$this->db->escape($langcode)."', '".$this->db->escape($value)."'"; $sql .= ")"; $resql = $this->db->query($sql); if (!$resql) { $this->error = $this->db->lasterror(); $error++; break; } } } } if (!$error && $trigger) { // Call trigger $this->context = array('extralanguagesaddupdate'=>1); $result = $this->call_trigger($trigger, $userused); if ($result < 0) $error++; // End call trigger } if ($error) { $this->db->rollback(); return -1; } else { $this->db->commit(); return 1; } } else return 0; } /** * Update an extra field value for the current object. * Data to describe values to update are stored into $this->array_options=array('options_codeforfield1'=>'valueforfield1', 'options_codeforfield2'=>'valueforfield2', ...) * * @param string $key Key of the extrafield to update (without starting 'options_') * @param string $trigger If defined, call also the trigger (for example COMPANY_MODIFY) * @param User $userused Object user * @return int -1=error, O=did nothing, 1=OK * @see updateExtraLanguages(), insertExtraFields(), deleteExtraFields(), setValueFrom() */ public function updateExtraField($key, $trigger = null, $userused = null) { global $conf, $langs, $user; if (!empty($conf->global->MAIN_EXTRAFIELDS_DISABLED)) return 0; if (empty($userused)) $userused = $user; $error = 0; if (!empty($this->array_options) && isset($this->array_options["options_".$key])) { // Check parameters $langs->load('admin'); require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php'; $extrafields = new ExtraFields($this->db); $extrafields->fetch_name_optionals_label($this->table_element); $value = $this->array_options["options_".$key]; $attributeType = $extrafields->attributes[$this->table_element]['type'][$key]; $attributeLabel = $extrafields->attributes[$this->table_element]['label'][$key]; $attributeParam = $extrafields->attributes[$this->table_element]['param'][$key]; $attributeRequired = $extrafields->attributes[$this->table_element]['required'][$key]; //dol_syslog("attributeLabel=".$attributeLabel, LOG_DEBUG); //dol_syslog("attributeType=".$attributeType, LOG_DEBUG); switch ($attributeType) { case 'int': if (!is_numeric($value) && $value != '') { $this->errors[] = $langs->trans("ExtraFieldHasWrongValue", $attributeLabel); return -1; } elseif ($value === '') { $this->array_options["options_".$key] = null; } break; case 'double': $value = price2num($value); if (!is_numeric($value) && $value != '') { dol_syslog($langs->trans("ExtraFieldHasWrongValue")." sur ".$attributeLabel."(".$value."is not '".$attributeType."')", LOG_DEBUG); $this->errors[] = $langs->trans("ExtraFieldHasWrongValue", $attributeLabel); return -1; } elseif ($value === '') { $this->array_options["options_".$key] = null; } //dol_syslog("double value"." sur ".$attributeLabel."(".$value." is '".$attributeType."')", LOG_DEBUG); $this->array_options["options_".$key] = $value; break; /*case 'select': // Not required, we chosed value='0' for undefined values if ($value=='-1') { $this->array_options[$key] = null; } break;*/ case 'price': $this->array_options["options_".$key] = price2num($this->array_options["options_".$key]); break; case 'date': $this->array_options["options_".$key] = $this->db->idate($this->array_options["options_".$key]); break; case 'datetime': $this->array_options["options_".$key] = $this->db->idate($this->array_options["options_".$key]); break; case 'link': $param_list = array_keys($attributeParam['options']); // 0 : ObjectName // 1 : classPath $InfoFieldList = explode(":", $param_list[0]); dol_include_once($InfoFieldList[1]); if ($value) { $object = new $InfoFieldList[0]($this->db); $object->fetch(0, $value); $this->array_options["options_".$key] = $object->id; } break; } $this->db->begin(); $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element."_extrafields SET ".$key."='".$this->db->escape($this->array_options["options_".$key])."'"; $sql .= " WHERE fk_object = ".$this->id; $resql = $this->db->query($sql); if (!$resql) { $error++; $this->error = $this->db->lasterror(); } if (!$error && $trigger) { // Call trigger $this->context = array('extrafieldupdate'=>1); $result = $this->call_trigger($trigger, $userused); if ($result < 0) $error++; // End call trigger } if ($error) { dol_syslog(__METHOD__.$this->error, LOG_ERR); $this->db->rollback(); return -1; } else { $this->db->commit(); return 1; } } else return 0; } /** * Update an extra language value for the current object. * Data to describe values to update are stored into $this->array_options=array('options_codeforfield1'=>'valueforfield1', 'options_codeforfield2'=>'valueforfield2', ...) * * @param string $key Key of the extrafield (without starting 'options_') * @param string $trigger If defined, call also the trigger (for example COMPANY_MODIFY) * @param User $userused Object user * @return int -1=error, O=did nothing, 1=OK * @see updateExtraFields(), insertExtraLanguages() */ public function updateExtraLanguages($key, $trigger = null, $userused = null) { global $conf, $langs, $user; if (empty($userused)) $userused = $user; $error = 0; if (!empty($conf->global->MAIN_EXTRALANGUAGES_DISABLED)) return 0; // For avoid conflicts if trigger used return 0; } /** * Return HTML string to put an input field into a page * Code very similar with showInputField of extra fields * * @param array $val Array of properties for field to show (used only if ->fields not defined) * @param string $key Key of attribute * @param string $value Preselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value) * @param string $moreparam To add more parameters on html input tag * @param string $keysuffix Prefix string to add into name and id of field (can be used to avoid duplicate names) * @param string $keyprefix Suffix string to add into name and id of field (can be used to avoid duplicate names) * @param string|int $morecss Value for css to define style/length of field. May also be a numeric. * @param int $nonewbutton Force to not show the new button on field that are links to object * @return string */ public function showInputField($val, $key, $value, $moreparam = '', $keysuffix = '', $keyprefix = '', $morecss = 0, $nonewbutton = 0) { global $conf, $langs, $form; if (!is_object($form)) { require_once DOL_DOCUMENT_ROOT.'/core/class/html.form.class.php'; $form = new Form($this->db); } if (!empty($this->fields)) { $val = $this->fields[$key]; } $out = ''; $type = ''; $param = array(); $param['options'] = array(); $reg = array(); $size = $this->fields[$key]['size']; // Because we work on extrafields if (preg_match('/^(integer|link):(.*):(.*):(.*):(.*)/i', $val['type'], $reg)) { $param['options'] = array($reg[2].':'.$reg[3].':'.$reg[4].':'.$reg[5] => 'N'); $type = 'link'; } elseif (preg_match('/^(integer|link):(.*):(.*):(.*)/i', $val['type'], $reg)) { $param['options'] = array($reg[2].':'.$reg[3].':'.$reg[4] => 'N'); $type = 'link'; } elseif (preg_match('/^(integer|link):(.*):(.*)/i', $val['type'], $reg)) { $param['options'] = array($reg[2].':'.$reg[3] => 'N'); $type = 'link'; } elseif (preg_match('/^sellist:(.*):(.*):(.*):(.*)/i', $val['type'], $reg)) { $param['options'] = array($reg[1].':'.$reg[2].':'.$reg[3].':'.$reg[4] => 'N'); $type = 'sellist'; } elseif (preg_match('/varchar\((\d+)\)/', $val['type'], $reg)) { $param['options'] = array(); $type = 'varchar'; $size = $reg[1]; } elseif (preg_match('/varchar/', $val['type'])) { $param['options'] = array(); $type = 'varchar'; } elseif (is_array($this->fields[$key]['arrayofkeyval'])) { $param['options'] = $this->fields[$key]['arrayofkeyval']; $type = 'select'; } else { $param['options'] = array(); $type = $this->fields[$key]['type']; } $label = $this->fields[$key]['label']; //$elementtype=$this->fields[$key]['elementtype']; // Seems not used $default = $this->fields[$key]['default']; $computed = $this->fields[$key]['computed']; $unique = $this->fields[$key]['unique']; $required = $this->fields[$key]['required']; $autofocusoncreate = $this->fields[$key]['autofocusoncreate']; $langfile = $this->fields[$key]['langfile']; $list = $this->fields[$key]['list']; $hidden = (in_array(abs($this->fields[$key]['visible']), array(0, 2)) ? 1 : 0); $objectid = $this->id; if ($computed) { if (!preg_match('/^search_/', $keyprefix)) return ''.$langs->trans("AutomaticallyCalculated").''; else return ''; } // Set value of $morecss. For this, we use in priority showsize from parameters, then $val['css'] then autodefine if (empty($morecss) && !empty($val['css'])) { $morecss = $val['css']; } elseif (empty($morecss)) { if ($type == 'date') { $morecss = 'minwidth100imp'; } elseif ($type == 'datetime' || $type == 'link') // link means an foreign key to another primary id { $morecss = 'minwidth200imp'; } elseif (in_array($type, array('int', 'integer', 'price')) || preg_match('/^double(\([0-9],[0-9]\)){0,1}/', $type)) { $morecss = 'maxwidth75'; } elseif ($type == 'url') { $morecss = 'minwidth400'; } elseif ($type == 'boolean') { $morecss = ''; } else { if (round($size) < 12) { $morecss = 'minwidth100'; } elseif (round($size) <= 48) { $morecss = 'minwidth200'; } else { $morecss = 'minwidth400'; } } } if (in_array($type, array('date', 'datetime'))) { $tmp = explode(',', $size); $newsize = $tmp[0]; $showtime = in_array($type, array('datetime')) ? 1 : 0; // Do not show current date when field not required (see selectDate() method) if (!$required && $value == '') $value = '-1'; // TODO Must also support $moreparam $out = $form->selectDate($value, $keyprefix.$key.$keysuffix, $showtime, $showtime, $required, '', 1, (($keyprefix != 'search_' && $keyprefix != 'search_options_') ? 1 : 0), 0, 1); } elseif (in_array($type, array('duration'))) { $out = $form->select_duration($keyprefix.$key.$keysuffix, $value, 0, 'text', 0, 1); } elseif (in_array($type, array('int', 'integer'))) { $tmp = explode(',', $size); $newsize = $tmp[0]; $out = ''; } elseif (in_array($type, array('real'))) { $out = ''; } elseif (preg_match('/varchar/', $type)) { $out = ''; } elseif (in_array($type, array('mail', 'phone', 'url'))) { $out = ''; } elseif (preg_match('/^text/', $type)) { if (!preg_match('/search_/', $keyprefix)) // If keyprefix is search_ or search_options_, we must just use a simple text field { require_once DOL_DOCUMENT_ROOT.'/core/class/doleditor.class.php'; $doleditor = new DolEditor($keyprefix.$key.$keysuffix, $value, '', 200, 'dolibarr_notes', 'In', false, false, false, ROWS_5, '90%'); $out = $doleditor->Create(1); } else { $out = ''; } } elseif (preg_match('/^html/', $type)) { if (!preg_match('/search_/', $keyprefix)) // If keyprefix is search_ or search_options_, we must just use a simple text field { require_once DOL_DOCUMENT_ROOT.'/core/class/doleditor.class.php'; $doleditor = new DolEditor($keyprefix.$key.$keysuffix, $value, '', 200, 'dolibarr_notes', 'In', false, false, !empty($conf->fckeditor->enabled) && $conf->global->FCKEDITOR_ENABLE_SOCIETE, ROWS_5, '90%'); $out = $doleditor->Create(1); } else { $out = ''; } } elseif ($type == 'boolean') { $checked = ''; if (!empty($value)) { $checked = ' checked value="1" '; } else { $checked = ' value="1" '; } $out = ''; } elseif ($type == 'price') { if (!empty($value)) { // $value in memory is a php numeric, we format it into user number format. $value = price($value); } $out = ' '.$langs->getCurrencySymbol($conf->currency); } elseif (preg_match('/^double(\([0-9],[0-9]\)){0,1}/', $type)) { if (!empty($value)) { // $value in memory is a php numeric, we format it into user number format. $value = price($value); } $out = ' '; } elseif ($type == 'select') { $out = ''; if (!empty($conf->use_javascript_ajax) && !empty($conf->global->MAIN_EXTRAFIELDS_USE_SELECT2)) { include_once DOL_DOCUMENT_ROOT.'/core/lib/ajax.lib.php'; $out .= ajax_combobox($keyprefix.$key.$keysuffix, array(), 0); } $out .= ''; } elseif ($type == 'sellist') { $out = ''; if (!empty($conf->use_javascript_ajax) && !empty($conf->global->MAIN_EXTRAFIELDS_USE_SELECT2)) { include_once DOL_DOCUMENT_ROOT.'/core/lib/ajax.lib.php'; $out .= ajax_combobox($keyprefix.$key.$keysuffix, array(), 0); } $out .= ''; } elseif ($type == 'checkbox') { $value_arr = explode(',', $value); $out = $form->multiselectarray($keyprefix.$key.$keysuffix, (empty($param['options']) ?null:$param['options']), $value_arr, '', 0, '', 0, '100%'); } elseif ($type == 'radio') { $out = ''; foreach ($param['options'] as $keyopt => $val) { $out .= ''.$val.'
'; } } elseif ($type == 'chkbxlst') { if (is_array($value)) { $value_arr = $value; } else { $value_arr = explode(',', $value); } if (is_array($param['options'])) { $param_list = array_keys($param['options']); $InfoFieldList = explode(":", $param_list[0]); $parentName = ''; $parentField = ''; // 0 : tableName // 1 : label field name // 2 : key fields name (if differ of rowid) // 3 : key field parent (for dependent lists) // 4 : where clause filter on column or table extrafield, syntax field='value' or extra.field=value $keyList = (empty($InfoFieldList[2]) ? 'rowid' : $InfoFieldList[2].' as rowid'); if (count($InfoFieldList) > 3 && !empty($InfoFieldList[3])) { list ($parentName, $parentField) = explode('|', $InfoFieldList[3]); $keyList .= ', '.$parentField; } if (count($InfoFieldList) > 4 && !empty($InfoFieldList[4])) { if (strpos($InfoFieldList[4], 'extra.') !== false) { $keyList = 'main.'.$InfoFieldList[2].' as rowid'; } else { $keyList = $InfoFieldList[2].' as rowid'; } } $fields_label = explode('|', $InfoFieldList[1]); if (is_array($fields_label)) { $keyList .= ', '; $keyList .= implode(', ', $fields_label); } $sqlwhere = ''; $sql = 'SELECT '.$keyList; $sql .= ' FROM '.MAIN_DB_PREFIX.$InfoFieldList[0]; if (!empty($InfoFieldList[4])) { // can use SELECT request if (strpos($InfoFieldList[4], '$SEL$') !== false) { $InfoFieldList[4] = str_replace('$SEL$', 'SELECT', $InfoFieldList[4]); } // current object id can be use into filter if (strpos($InfoFieldList[4], '$ID$') !== false && !empty($objectid)) { $InfoFieldList[4] = str_replace('$ID$', $objectid, $InfoFieldList[4]); } else { $InfoFieldList[4] = str_replace('$ID$', '0', $InfoFieldList[4]); } // We have to join on extrafield table if (strpos($InfoFieldList[4], 'extra') !== false) { $sql .= ' as main, '.MAIN_DB_PREFIX.$InfoFieldList[0].'_extrafields as extra'; $sqlwhere .= ' WHERE extra.fk_object=main.'.$InfoFieldList[2].' AND '.$InfoFieldList[4]; } else { $sqlwhere .= ' WHERE '.$InfoFieldList[4]; } } else { $sqlwhere .= ' WHERE 1=1'; } // Some tables may have field, some other not. For the moment we disable it. if (in_array($InfoFieldList[0], array('tablewithentity'))) { $sqlwhere .= ' AND entity = '.$conf->entity; } // $sql.=preg_replace('/^ AND /','',$sqlwhere); // print $sql; $sql .= $sqlwhere; dol_syslog(get_class($this).'::showInputField type=chkbxlst', LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $num = $this->db->num_rows($resql); $i = 0; $data = array(); while ($i < $num) { $labeltoshow = ''; $obj = $this->db->fetch_object($resql); $notrans = false; // Several field into label (eq table:code|libelle:rowid) $fields_label = explode('|', $InfoFieldList[1]); if (count($fields_label) > 1) { $notrans = true; foreach ($fields_label as $field_toshow) { $labeltoshow .= $obj->$field_toshow.' '; } } else { $labeltoshow = $obj->{$InfoFieldList[1]}; } $labeltoshow = dol_trunc($labeltoshow, 45); if (is_array($value_arr) && in_array($obj->rowid, $value_arr)) { foreach ($fields_label as $field_toshow) { $translabel = $langs->trans($obj->$field_toshow); if ($translabel != $obj->$field_toshow) { $labeltoshow = dol_trunc($translabel, 18).' '; } else { $labeltoshow = dol_trunc($obj->$field_toshow, 18).' '; } } $data[$obj->rowid] = $labeltoshow; } else { if (!$notrans) { $translabel = $langs->trans($obj->{$InfoFieldList[1]}); if ($translabel != $obj->{$InfoFieldList[1]}) { $labeltoshow = dol_trunc($translabel, 18); } else { $labeltoshow = dol_trunc($obj->{$InfoFieldList[1]}, 18); } } if (empty($labeltoshow)) { $labeltoshow = '(not defined)'; } if (is_array($value_arr) && in_array($obj->rowid, $value_arr)) { $data[$obj->rowid] = $labeltoshow; } if (!empty($InfoFieldList[3]) && $parentField) { $parent = $parentName.':'.$obj->{$parentField}; } $data[$obj->rowid] = $labeltoshow; } $i++; } $this->db->free($resql); $out = $form->multiselectarray($keyprefix.$key.$keysuffix, $data, $value_arr, '', 0, '', 0, '100%'); } else { print 'Error in request '.$sql.' '.$this->db->lasterror().'. Check setup of extra parameters.
'; } } } elseif ($type == 'link') { $param_list = array_keys($param['options']); // $param_list='ObjectName:classPath[:AddCreateButtonOrNot[:Filter]]' $param_list_array = explode(':', $param_list[0]); $showempty = (($required && $default != '') ? 0 : 1); if (!empty($param_list_array[2])) { // If the entry into $fields is set to add a create button $morecss .= ' widthcentpercentminusx'; } $out = $form->selectForForms($param_list[0], $keyprefix.$key.$keysuffix, $value, $showempty, '', '', $morecss, $moreparam, 0, empty($val['disabled']) ? 0 : 1); if (!empty($param_list_array[2])) { // If the entry into $fields is set to add a create button if (!GETPOSTISSET('backtopage') && empty($val['disabled']) && empty($nonewbutton)) // To avoid to open several times the 'Create Object' button and to avoid to have button if field is protected by a "disabled". { list($class, $classfile) = explode(':', $param_list[0]); if (file_exists(dol_buildpath(dirname(dirname($classfile)).'/card.php'))) $url_path = dol_buildpath(dirname(dirname($classfile)).'/card.php', 1); else $url_path = dol_buildpath(dirname(dirname($classfile)).'/'.strtolower($class).'_card.php', 1); $paramforthenewlink = ''; $paramforthenewlink .= (GETPOSTISSET('action') ? '&action='.GETPOST('action', 'aZ09') : ''); $paramforthenewlink .= (GETPOSTISSET('id') ? '&id='.GETPOST('id', 'int') : ''); $paramforthenewlink .= '&fk_'.strtolower($class).'=--IDFORBACKTOPAGE--'; // TODO Add Javascript code to add input fields already filled into $paramforthenewlink so we won't loose them when going back to main page $out .= ''; } } } elseif ($type == 'password') { // If prefix is 'search_', field is used as a filter, we use a common text field. $out = ''; } elseif ($type == 'array') { $newval = $val; $newval['type'] = 'varchar(256)'; $out = ''; $inputs = array(); if (!empty($value)) { foreach ($value as $option) { $out .= ' '; $out .= $this->showInputField($newval, $keyprefix.$key.$keysuffix.'[]', $option, $moreparam, '', '', $morecss).'
'; } } $out .= ''; $newInput = ' '; $newInput .= $this->showInputField($newval, $keyprefix.$key.$keysuffix.'[]', '', $moreparam, '', '', $morecss).'
'; if (!empty($conf->use_javascript_ajax)) { $out .= ' '; } } if (!empty($hidden)) { $out = ''; } /* Add comments if ($type == 'date') $out.=' (YYYY-MM-DD)'; elseif ($type == 'datetime') $out.=' (YYYY-MM-DD HH:MM:SS)'; */ return $out; } /** * Return HTML string to show a field into a page * Code very similar with showOutputField of extra fields * * @param array $val Array of properties of field to show * @param string $key Key of attribute * @param string $value Preselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value) * @param string $moreparam To add more parametes on html input tag * @param string $keysuffix Prefix string to add into name and id of field (can be used to avoid duplicate names) * @param string $keyprefix Suffix string to add into name and id of field (can be used to avoid duplicate names) * @param mixed $morecss Value for css to define size. May also be a numeric. * @return string */ public function showOutputField($val, $key, $value, $moreparam = '', $keysuffix = '', $keyprefix = '', $morecss = '') { global $conf, $langs, $form; if (!is_object($form)) { require_once DOL_DOCUMENT_ROOT.'/core/class/html.form.class.php'; $form = new Form($this->db); } $objectid = $this->id; $label = $val['label']; $type = $val['type']; $size = $val['css']; $reg = array(); // Convert var to be able to share same code than showOutputField of extrafields if (preg_match('/varchar\((\d+)\)/', $type, $reg)) { $type = 'varchar'; // convert varchar(xx) int varchar $size = $reg[1]; } elseif (preg_match('/varchar/', $type)) $type = 'varchar'; // convert varchar(xx) int varchar if (is_array($val['arrayofkeyval'])) $type = 'select'; if (preg_match('/^integer:(.*):(.*)/i', $val['type'], $reg)) $type = 'link'; $default = $val['default']; $computed = $val['computed']; $unique = $val['unique']; $required = $val['required']; $param = array(); $param['options'] = array(); if (is_array($val['arrayofkeyval'])) $param['options'] = $val['arrayofkeyval']; if (preg_match('/^integer:(.*):(.*)/i', $val['type'], $reg)) { $type = 'link'; $param['options'] = array($reg[1].':'.$reg[2]=>$reg[1].':'.$reg[2]); } elseif (preg_match('/^sellist:(.*):(.*):(.*):(.*)/i', $val['type'], $reg)) { $param['options'] = array($reg[1].':'.$reg[2].':'.$reg[3].':'.$reg[4] => 'N'); $type = 'sellist'; } $langfile = $val['langfile']; $list = $val['list']; $help = $val['help']; $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) if ($hidden) return ''; // If field is a computed field, value must become result of compute if ($computed) { // Make the eval of compute string //var_dump($computed); $value = dol_eval($computed, 1, 0); } if (empty($morecss)) { if ($type == 'date') { $morecss = 'minwidth100imp'; } elseif ($type == 'datetime' || $type == 'timestamp') { $morecss = 'minwidth200imp'; } elseif (in_array($type, array('int', 'double', 'price'))) { $morecss = 'maxwidth75'; } elseif ($type == 'url') { $morecss = 'minwidth400'; } elseif ($type == 'boolean') { $morecss = ''; } else { if (round($size) < 12) { $morecss = 'minwidth100'; } elseif (round($size) <= 48) { $morecss = 'minwidth200'; } else { $morecss = 'minwidth400'; } } } // Format output value differently according to properties of field if ($key == 'ref' && method_exists($this, 'getNomUrl')) $value = $this->getNomUrl(1, '', 0, '', 1); elseif ($key == 'status' && method_exists($this, 'getLibStatut')) $value = $this->getLibStatut(3); elseif ($type == 'date') { if (!empty($value)) { $value = dol_print_date($value, 'day'); } else { $value = ''; } } elseif ($type == 'datetime' || $type == 'timestamp') { if (!empty($value)) { $value = dol_print_date($value, 'dayhour'); } else { $value = ''; } } elseif ($type == 'duration') { include_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php'; if (!is_null($value) && $value !== '') { $value = convertSecondToTime($value, 'allhourmin'); } } elseif ($type == 'double' || $type == 'real') { if (!is_null($value) && $value !== '') { $value = price($value); } } elseif ($type == 'boolean') { $checked = ''; if (!empty($value)) { $checked = ' checked '; } $value = ''; } elseif ($type == 'mail') { $value = dol_print_email($value, 0, 0, 0, 64, 1, 1); } elseif ($type == 'url') { $value = dol_print_url($value, '_blank', 32, 1); } elseif ($type == 'phone') { $value = dol_print_phone($value, '', 0, 0, '', ' ', 1); } elseif ($type == 'price') { if (!is_null($value) && $value !== '') { $value = price($value, 0, $langs, 0, 0, -1, $conf->currency); } } elseif ($type == 'select') { $value = $param['options'][$value]; } elseif ($type == 'sellist') { $param_list = array_keys($param['options']); $InfoFieldList = explode(":", $param_list[0]); $selectkey = "rowid"; $keyList = 'rowid'; if (count($InfoFieldList) >= 3) { $selectkey = $InfoFieldList[2]; $keyList = $InfoFieldList[2].' as rowid'; } $fields_label = explode('|', $InfoFieldList[1]); if (is_array($fields_label)) { $keyList .= ', '; $keyList .= implode(', ', $fields_label); } $sql = 'SELECT '.$keyList; $sql .= ' FROM '.MAIN_DB_PREFIX.$InfoFieldList[0]; if (strpos($InfoFieldList[4], 'extra') !== false) { $sql .= ' as main'; } if ($selectkey == 'rowid' && empty($value)) { $sql .= " WHERE ".$selectkey."=0"; } elseif ($selectkey == 'rowid') { $sql .= " WHERE ".$selectkey."=".$this->db->escape($value); } else { $sql .= " WHERE ".$selectkey."='".$this->db->escape($value)."'"; } //$sql.= ' AND entity = '.$conf->entity; dol_syslog(get_class($this).':showOutputField:$type=sellist', LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $value = ''; // value was used, so now we reste it to use it to build final output $obj = $this->db->fetch_object($resql); // Several field into label (eq table:code|libelle:rowid) $fields_label = explode('|', $InfoFieldList[1]); if (is_array($fields_label) && count($fields_label) > 1) { foreach ($fields_label as $field_toshow) { $translabel = ''; if (!empty($obj->$field_toshow)) { $translabel = $langs->trans($obj->$field_toshow); } if ($translabel != $field_toshow) { $value .= dol_trunc($translabel, 18).' '; } else { $value .= $obj->$field_toshow.' '; } } } else { $translabel = ''; if (!empty($obj->{$InfoFieldList[1]})) { $translabel = $langs->trans($obj->{$InfoFieldList[1]}); } if ($translabel != $obj->{$InfoFieldList[1]}) { $value = dol_trunc($translabel, 18); } else { $value = $obj->{$InfoFieldList[1]}; } } } else dol_syslog(get_class($this).'::showOutputField error '.$this->db->lasterror(), LOG_WARNING); } elseif ($type == 'radio') { $value = $param['options'][$value]; } elseif ($type == 'checkbox') { $value_arr = explode(',', $value); $value = ''; if (is_array($value_arr) && count($value_arr) > 0) { $toprint = array(); foreach ($value_arr as $keyval=>$valueval) { $toprint[] = '
  • '.$param['options'][$valueval].'
  • '; } $value = '
      '.implode(' ', $toprint).'
    '; } } elseif ($type == 'chkbxlst') { $value_arr = explode(',', $value); $param_list = array_keys($param['options']); $InfoFieldList = explode(":", $param_list[0]); $selectkey = "rowid"; $keyList = 'rowid'; if (count($InfoFieldList) >= 3) { $selectkey = $InfoFieldList[2]; $keyList = $InfoFieldList[2].' as rowid'; } $fields_label = explode('|', $InfoFieldList[1]); if (is_array($fields_label)) { $keyList .= ', '; $keyList .= implode(', ', $fields_label); } $sql = 'SELECT '.$keyList; $sql .= ' FROM '.MAIN_DB_PREFIX.$InfoFieldList[0]; if (strpos($InfoFieldList[4], 'extra') !== false) { $sql .= ' as main'; } // $sql.= " WHERE ".$selectkey."='".$this->db->escape($value)."'"; // $sql.= ' AND entity = '.$conf->entity; dol_syslog(get_class($this).':showOutputField:$type=chkbxlst', LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $value = ''; // value was used, so now we reste it to use it to build final output $toprint = array(); while ($obj = $this->db->fetch_object($resql)) { // Several field into label (eq table:code|libelle:rowid) $fields_label = explode('|', $InfoFieldList[1]); if (is_array($value_arr) && in_array($obj->rowid, $value_arr)) { if (is_array($fields_label) && count($fields_label) > 1) { foreach ($fields_label as $field_toshow) { $translabel = ''; if (!empty($obj->$field_toshow)) { $translabel = $langs->trans($obj->$field_toshow); } if ($translabel != $field_toshow) { $toprint[] = '
  • '.dol_trunc($translabel, 18).'
  • '; } else { $toprint[] = '
  • '.$obj->$field_toshow.'
  • '; } } } else { $translabel = ''; if (!empty($obj->{$InfoFieldList[1]})) { $translabel = $langs->trans($obj->{$InfoFieldList[1]}); } if ($translabel != $obj->{$InfoFieldList[1]}) { $toprint[] = '
  • '.dol_trunc($translabel, 18).'
  • '; } else { $toprint[] = '
  • '.$obj->{$InfoFieldList[1]}.'
  • '; } } } } $value = '
      '.implode(' ', $toprint).'
    '; } else { dol_syslog(get_class($this).'::showOutputField error '.$this->db->lasterror(), LOG_WARNING); } } elseif ($type == 'link') { $out = ''; // only if something to display (perf) if ($value) { $param_list = array_keys($param['options']); // $param_list='ObjectName:classPath' $InfoFieldList = explode(":", $param_list[0]); $classname = $InfoFieldList[0]; $classpath = $InfoFieldList[1]; $getnomurlparam = (empty($InfoFieldList[2]) ? 3 : $InfoFieldList[2]); if (!empty($classpath)) { dol_include_once($InfoFieldList[1]); if ($classname && class_exists($classname)) { $object = new $classname($this->db); $object->fetch($value); $value = $object->getNomUrl($getnomurlparam); } } else { dol_syslog('Error bad setup of extrafield', LOG_WARNING); return 'Error bad setup of extrafield'; } } else $value = ''; } elseif (preg_match('/^(text|html)/', $type)) { $value = dol_htmlentitiesbr($value); } elseif ($type == 'password') { $value = preg_replace('/./i', '*', $value); } elseif ($type == 'array') { $value = implode('
    ', $value); } //print $type.'-'.$size.'-'.$value; $out = $value; return $out; } /** * Function to show lines of extrafields with output datas. * This function is responsible to output the and according to correct number of columns received into $params['colspan'] * * @param Extrafields $extrafields Extrafield Object * @param string $mode Show output ('view') or input ('create' or 'edit') for extrafield * @param array $params Optional parameters. Example: array('style'=>'class="oddeven"', 'colspan'=>$colspan) * @param string $keysuffix Suffix string to add after name and id of field (can be used to avoid duplicate names) * @param string $keyprefix Prefix string to add before name and id of field (can be used to avoid duplicate names) * @param string $onetrtd All fields in same tr td (TODO field not used ?) * @return string */ public function showOptionals($extrafields, $mode = 'view', $params = null, $keysuffix = '', $keyprefix = '', $onetrtd = 0) { global $db, $conf, $langs, $action, $form, $hookmanager; if (!is_object($form)) $form = new Form($db); $out = ''; $parameters = array(); $reshook = $hookmanager->executeHooks('showOptionals', $parameters, $this, $action); // Note that $action and $object may have been modified by hook if (empty($reshook)) { if (is_array($extrafields->attributes[$this->table_element]['label']) && count($extrafields->attributes[$this->table_element]['label']) > 0) { $out .= "\n"; $out .= ' '; $out .= "\n"; $extrafields_collapse_num = ''; $e = 0; foreach ($extrafields->attributes[$this->table_element]['label'] as $key=>$label) { // Show only the key field in params if (is_array($params) && array_key_exists('onlykey', $params) && $key != $params['onlykey']) continue; // Test on 'enabled' ('enabled' is different than 'list' = 'visibility') $enabled = 1; if ($enabled && isset($extrafields->attributes[$this->table_element]['enabled'][$key])) { $enabled = dol_eval($extrafields->attributes[$this->table_element]['enabled'][$key], 1); } if (empty($enabled)) continue; $visibility = 1; if ($visibility && isset($extrafields->attributes[$this->table_element]['list'][$key])) { $visibility = dol_eval($extrafields->attributes[$this->table_element]['list'][$key], 1); } $perms = 1; if ($perms && isset($extrafields->attributes[$this->table_element]['perms'][$key])) { $perms = dol_eval($extrafields->attributes[$this->table_element]['perms'][$key], 1); } if (($mode == 'create') && abs($visibility) != 1 && abs($visibility) != 3) continue; // <> -1 and <> 1 and <> 3 = not visible on forms, only on list elseif (($mode == 'edit') && abs($visibility) != 1 && abs($visibility) != 3 && abs($visibility) != 4) continue; // <> -1 and <> 1 and <> 3 = not visible on forms, only on list and <> 4 = not visible at the creation elseif ($mode == 'view' && empty($visibility)) continue; if (empty($perms)) continue; // Load language if required if (!empty($extrafields->attributes[$this->table_element]['langfile'][$key])) { $langs->load($extrafields->attributes[$this->table_element]['langfile'][$key]); } $colspan = ''; if (is_array($params) && count($params) > 0) { if (array_key_exists('cols', $params)) { $colspan = $params['cols']; } elseif (array_key_exists('colspan', $params)) { // For backward compatibility. Use cols instead now. $reg = array(); if (preg_match('/colspan="(\d+)"/', $params['colspan'], $reg)) { $colspan = $reg[1]; } else { $colspan = $params['colspan']; } } } switch ($mode) { case "view": $value = $this->array_options["options_".$key.$keysuffix]; // Value may be clean or formated later break; case "create": case "edit": // We get the value of property found with GETPOST so it takes into account: // default values overwrite, restore back to list link, ... (but not 'default value in database' of field) $check = 'alphanohtml'; if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('html', 'text'))) { $check = 'restricthtml'; } $getposttemp = GETPOST($keyprefix.'options_'.$key.$keysuffix, $check, 3); // GETPOST can get value from GET, POST or setup of default values overwrite. // GETPOST("options_" . $key) can be 'abc' or array(0=>'abc') if (is_array($getposttemp) || $getposttemp != '' || GETPOSTISSET($keyprefix.'options_'.$key.$keysuffix)) { if (is_array($getposttemp)) { // $getposttemp is an array but following code expects a comma separated string $value = implode(",", $getposttemp); } else { $value = $getposttemp; } } else { $value = $this->array_options["options_".$key]; // No GET, no POST, no default value, so we take value of object. } //var_dump($keyprefix.' - '.$key.' - '.$keysuffix.' - '.$keyprefix.'options_'.$key.$keysuffix.' - '.$this->array_options["options_".$key.$keysuffix].' - '.$getposttemp.' - '.$value); break; } if ($extrafields->attributes[$this->table_element]['type'][$key] == 'separate') { $extrafields_collapse_num = ''; $extrafield_param = $extrafields->attributes[$this->table_element]['param'][$key]; if (!empty($extrafield_param) && is_array($extrafield_param)) { $extrafield_param_list = array_keys($extrafield_param['options']); if (count($extrafield_param_list) > 0) { $extrafield_collapse_display_value = intval($extrafield_param_list[0]); if ($extrafield_collapse_display_value == 1 || $extrafield_collapse_display_value == 2) { $extrafields_collapse_num = $extrafields->attributes[$this->table_element]['pos'][$key]; } } } $out .= $extrafields->showSeparator($key, $this, ($colspan + 1)); } else { $class = (!empty($extrafields->attributes[$this->table_element]['hidden'][$key]) ? 'hideobject ' : ''); $csstyle = ''; if (is_array($params) && count($params) > 0) { if (array_key_exists('class', $params)) { $class .= $params['class'].' '; } if (array_key_exists('style', $params)) { $csstyle = $params['style']; } } // add html5 elements $domData = ' data-element="extrafield"'; $domData .= ' data-targetelement="'.$this->element.'"'; $domData .= ' data-targetid="'.$this->id.'"'; $html_id = (empty($this->id) ? '' : 'extrarow-'.$this->element.'_'.$key.'_'.$this->id); if (!empty($conf->global->MAIN_EXTRAFIELDS_USE_TWO_COLUMS) && ($e % 2) == 0) { $colspan = '0'; } if ($action == 'selectlines') { $colspan++; } // Convert date into timestamp format (value in memory must be a timestamp) if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('date', 'datetime'))) { $datenotinstring = $this->array_options['options_'.$key]; if (!is_numeric($this->array_options['options_'.$key])) // For backward compatibility { $datenotinstring = $this->db->jdate($datenotinstring); } $value = (GETPOSTISSET($keyprefix.'options_'.$key.$keysuffix) || $value) ? dol_mktime(GETPOST($keyprefix.'options_'.$key.$keysuffix."hour", 'int', 3), GETPOST($keyprefix.'options_'.$key.$keysuffix."min", 'int', 3), 0, GETPOST($keyprefix.'options_'.$key.$keysuffix."month", 'int', 3), GETPOST($keyprefix.'options_'.$key.$keysuffix."day", 'int', 3), GETPOST($keyprefix.'options_'.$key.$keysuffix."year", 'int', 3)) : $datenotinstring; } // Convert float submited string into real php numeric (value in memory must be a php numeric) if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('price', 'double'))) { $value = (GETPOSTISSET($keyprefix.'options_'.$key.$keysuffix) || $value) ? price2num($value) : $this->array_options['options_'.$key]; } // HTML, text, select, integer and varchar: take into account default value in database if in create mode if (in_array($extrafields->attributes[$this->table_element]['type'][$key], array('html', 'text', 'varchar', 'select', 'int'))) { if ($action == 'create') $value = (GETPOSTISSET($keyprefix.'options_'.$key.$keysuffix) || $value) ? $value : $extrafields->attributes[$this->table_element]['default'][$key]; } $labeltoshow = $langs->trans($label); $helptoshow = $langs->trans($extrafields->attributes[$this->table_element]['help'][$key]); $out .= ''; $out .= 'attributes[$this->table_element]['help'][$key])) $out .= $form->textwithpicto($labeltoshow, $helptoshow); else $out .= $labeltoshow; if ($mode != 'view' && !empty($extrafields->attributes[$this->table_element]['required'][$key])) $out .= ' *'; } else { if ($mode != 'view' && !empty($extrafields->attributes[$this->table_element]['required'][$key])) $out .= ' fieldrequired'; $out .= '">'; if (!empty($extrafields->attributes[$this->table_element]['help'][$key])) $out .= $form->textwithpicto($labeltoshow, $helptoshow); else $out .= $labeltoshow; } $out .= ''; $html_id = !empty($this->id) ? $this->element.'_extras_'.$key.'_'.$this->id : ''; $out .= ''; switch ($mode) { case "view": $out .= $extrafields->showOutputField($key, $value); break; case "create": $out .= $extrafields->showInputField($key, $value, '', $keysuffix, '', 0, $this->id, $this->table_element); break; case "edit": $out .= $extrafields->showInputField($key, $value, '', $keysuffix, '', 0, $this->id, $this->table_element); break; } $out .= ''; /*for($ii = 0; $ii < ($colspan - 1); $ii++) { $out .=''; }*/ if (!empty($conf->global->MAIN_EXTRAFIELDS_USE_TWO_COLUMS) && (($e % 2) == 1)) $out .= ''; else $out .= ''; $e++; } } $out .= "\n"; // Add code to manage list depending on others if (!empty($conf->use_javascript_ajax)) { $out .= ' '."\n"; } $out .= ' '."\n"; } } $out .= $hookmanager->resPrint; return $out; } /** * Returns the rights used for this class * @return stdClass */ public function getRights() { global $user; $element = $this->element; if ($element == 'facturerec') $element = 'facture'; return $user->rights->{$element}; } /** * Function used to replace a thirdparty id with another one. * This function is meant to be called from replaceThirdparty with the appropiate tables * Column name fk_soc MUST be used to identify thirdparties * * @param DoliDB $db Database handler * @param int $origin_id Old thirdparty id (the thirdparty to delete) * @param int $dest_id New thirdparty id (the thirdparty that will received element of the other) * @param string[] $tables Tables that need to be changed * @param int $ignoreerrors Ignore errors. Return true even if errors. We need this when replacement can fails like for categories (categorie of old thirdparty may already exists on new one) * @return bool True if success, False if error */ public static function commonReplaceThirdparty(DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors = 0) { foreach ($tables as $table) { $sql = 'UPDATE '.MAIN_DB_PREFIX.$table.' SET fk_soc = '.$dest_id.' WHERE fk_soc = '.$origin_id; if (!$db->query($sql)) { if ($ignoreerrors) return true; // TODO Not enough. If there is A-B on kept thirdarty and B-C on old one, we must get A-B-C after merge. Not A-B. //$this->errors = $db->lasterror(); return false; } } return true; } /** * Get buy price to use for margin calculation. This function is called when buy price is unknown. * Set buy price = sell price if ForceBuyingPriceIfNull configured, * else if calculation MARGIN_TYPE = 'costprice' and costprice is defined, use costprice as buyprice * else if calculation MARGIN_TYPE = 'pmp' and pmp is calculated, use pmp as buyprice * else set min buy price as buy price * * @param float $unitPrice Product unit price * @param float $discountPercent Line discount percent * @param int $fk_product Product id * @return float <0 if KO, buyprice if OK */ public function defineBuyPrice($unitPrice = 0.0, $discountPercent = 0.0, $fk_product = 0) { global $conf; $buyPrice = 0; if (($unitPrice > 0) && (isset($conf->global->ForceBuyingPriceIfNull) && $conf->global->ForceBuyingPriceIfNull == 1)) // In most cases, test here is false { $buyPrice = $unitPrice * (1 - $discountPercent / 100); } else { // Get cost price for margin calculation if (!empty($fk_product)) { if (isset($conf->global->MARGIN_TYPE) && $conf->global->MARGIN_TYPE == 'costprice') { require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php'; $product = new Product($this->db); $result = $product->fetch($fk_product); if ($result <= 0) { $this->errors[] = 'ErrorProductIdDoesNotExists'; return -1; } if ($product->cost_price > 0) { $buyPrice = $product->cost_price; } elseif ($product->pmp > 0) { $buyPrice = $product->pmp; } } elseif (isset($conf->global->MARGIN_TYPE) && $conf->global->MARGIN_TYPE == 'pmp') { require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php'; $product = new Product($this->db); $result = $product->fetch($fk_product); if ($result <= 0) { $this->errors[] = 'ErrorProductIdDoesNotExists'; return -1; } if ($product->pmp > 0) { $buyPrice = $product->pmp; } } if (empty($buyPrice) && isset($conf->global->MARGIN_TYPE) && in_array($conf->global->MARGIN_TYPE, array('1', 'pmp', 'costprice'))) { require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.product.class.php'; $productFournisseur = new ProductFournisseur($this->db); if (($result = $productFournisseur->find_min_price_product_fournisseur($fk_product)) > 0) { $buyPrice = $productFournisseur->fourn_unitprice; } elseif ($result < 0) { $this->errors[] = $productFournisseur->error; return -2; } } } } return $buyPrice; } // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** * Show photos of an object (nbmax maximum), into several columns * * @param string $modulepart 'product', 'ticket', ... * @param string $sdir Directory to scan (full absolute path) * @param int $size 0=original size, 1='small' use thumbnail if possible * @param int $nbmax Nombre maximum de photos (0=pas de max) * @param int $nbbyrow Number of image per line or -1 to use div. Used only if size=1. * @param int $showfilename 1=Show filename * @param int $showaction 1=Show icon with action links (resize, delete) * @param int $maxHeight Max height of original image when size='small' (so we can use original even if small requested). If 0, always use 'small' thumb image. * @param int $maxWidth Max width of original image when size='small' * @param int $nolink Do not add a href link to view enlarged imaged into a new tab * @param int $notitle Do not add title tag on image * @param int $usesharelink Use the public shared link of image (if not available, the 'nophoto' image will be shown instead) * @return string Html code to show photo. Number of photos shown is saved in this->nbphoto */ public function show_photos($modulepart, $sdir, $size = 0, $nbmax = 0, $nbbyrow = 5, $showfilename = 0, $showaction = 0, $maxHeight = 120, $maxWidth = 160, $nolink = 0, $notitle = 0, $usesharelink = 0) { // phpcs:enable global $conf, $user, $langs; include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php'; include_once DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php'; $sortfield = 'position_name'; $sortorder = 'asc'; $dir = $sdir.'/'; $pdir = '/'; $dir .= get_exdir(0, 0, 0, 0, $this, $modulepart).$this->ref.'/'; $pdir .= get_exdir(0, 0, 0, 0, $this, $modulepart).$this->ref.'/'; // For backward compatibility if ($modulepart == 'product' && !empty($conf->global->PRODUCT_USE_OLD_PATH_FOR_PHOTO)) { $dir = $sdir.'/'.get_exdir($this->id, 2, 0, 0, $this, $modulepart).$this->id."/photos/"; $pdir = '/'.get_exdir($this->id, 2, 0, 0, $this, $modulepart).$this->id."/photos/"; } // Defined relative dir to DOL_DATA_ROOT $relativedir = ''; if ($dir) { $relativedir = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $dir); $relativedir = preg_replace('/^[\\/]/', '', $relativedir); $relativedir = preg_replace('/[\\/]$/', '', $relativedir); } $dirthumb = $dir.'thumbs/'; $pdirthumb = $pdir.'thumbs/'; $return = ''."\n"; $nbphoto = 0; $filearray = dol_dir_list($dir, "files", 0, '', '(\.meta|_preview.*\.png)$', $sortfield, (strtolower($sortorder) == 'desc' ?SORT_DESC:SORT_ASC), 1); /*if (! empty($conf->global->PRODUCT_USE_OLD_PATH_FOR_PHOTO)) // For backward compatiblity, we scan also old dirs { $filearrayold=dol_dir_list($dirold,"files",0,'','(\.meta|_preview.*\.png)$',$sortfield,(strtolower($sortorder)=='desc'?SORT_DESC:SORT_ASC),1); $filearray=array_merge($filearray, $filearrayold); }*/ completeFileArrayWithDatabaseInfo($filearray, $relativedir); if (count($filearray)) { if ($sortfield && $sortorder) { $filearray = dol_sort_array($filearray, $sortfield, $sortorder); } foreach ($filearray as $key => $val) { $photo = ''; $file = $val['name']; //if (! utf8_check($file)) $file=utf8_encode($file); // To be sure file is stored in UTF8 in memory //if (dol_is_file($dir.$file) && image_format_supported($file) >= 0) if (image_format_supported($file) >= 0) { $nbphoto++; $photo = $file; $viewfilename = $file; if ($size == 1 || $size == 'small') { // Format vignette // Find name of thumb file $photo_vignette = basename(getImageFileNameForSize($dir.$file, '_small')); if (!dol_is_file($dirthumb.$photo_vignette)) $photo_vignette = ''; // Get filesize of original file $imgarray = dol_getImageSize($dir.$photo); if ($nbbyrow > 0) { if ($nbphoto == 1) $return .= ''; if ($nbphoto % $nbbyrow == 1) $return .= ''; $return .= ''; if (($nbphoto % $nbbyrow) == 0) $return .= ''; } elseif ($nbbyrow < 0) $return .= ''; } if (empty($size)) { // Format origine $return .= ''; if ($showfilename) $return .= '
    '.$viewfilename; if ($showaction) { // Special case for product if ($modulepart == 'product' && ($user->rights->produit->creer || $user->rights->service->creer)) { // Link to resize $return .= ''.img_picto($langs->trans("Resize"), 'resize', '').'   '; // Link to delete $return .= ''; $return .= img_delete().''; } } } // On continue ou on arrete de boucler ? if ($nbmax && $nbphoto >= $nbmax) break; } } if ($size == 1 || $size == 'small') { if ($nbbyrow > 0) { // Ferme tableau while ($nbphoto % $nbbyrow) { $return .= ''; $nbphoto++; } if ($nbphoto) $return .= '
    '; } elseif ($nbbyrow < 0) $return .= '
    '; $return .= "\n"; $relativefile = preg_replace('/^\//', '', $pdir.$photo); if (empty($nolink)) { $urladvanced = getAdvancedPreviewUrl($modulepart, $relativefile, 0, 'entity='.$this->entity); if ($urladvanced) $return .= ''; else $return .= ''; } // Show image (width height=$maxHeight) // Si fichier vignette disponible et image source trop grande, on utilise la vignette, sinon on utilise photo origine $alt = $langs->transnoentitiesnoconv('File').': '.$relativefile; $alt .= ' - '.$langs->transnoentitiesnoconv('Size').': '.$imgarray['width'].'x'.$imgarray['height']; if ($notitle) $alt = ''; if ($usesharelink) { if ($val['share']) { if (empty($maxHeight) || $photo_vignette && $imgarray['height'] > $maxHeight) { $return .= ''; $return .= ''; } else { $return .= ''; $return .= ''; } } else { $return .= ''; $return .= ''; } } else { if (empty($maxHeight) || $photo_vignette && $imgarray['height'] > $maxHeight) { $return .= ''; $return .= ''; } else { $return .= ''; $return .= ''; } } if (empty($nolink)) $return .= ''; $return .= "\n"; if ($showfilename) $return .= '
    '.$viewfilename; if ($showaction) { $return .= '
    '; // On propose la generation de la vignette si elle n'existe pas et si la taille est superieure aux limites if ($photo_vignette && (image_format_supported($photo) > 0) && ($this->imgWidth > $maxWidth || $this->imgHeight > $maxHeight)) { $return .= ''.img_picto($langs->trans('GenerateThumb'), 'refresh').'  '; } // Special cas for product if ($modulepart == 'product' && ($user->rights->produit->creer || $user->rights->service->creer)) { // Link to resize $return .= ''.img_picto($langs->trans("Resize"), 'resize', '').'   '; // Link to delete $return .= ''; $return .= img_delete().''; } } $return .= "\n"; if ($nbbyrow > 0) { $return .= '
     
    '; } } } $this->nbphoto = $nbphoto; return $return; } /** * Function test if type is array * * @param array $info content informations of field * @return bool true if array */ protected function isArray($info) { if (is_array($info)) { if (isset($info['type']) && $info['type'] == 'array') return true; else return false; } return false; } /** * Function test if type is date * * @param array $info content informations of field * @return bool true if date */ public function isDate($info) { if (isset($info['type']) && ($info['type'] == 'date' || $info['type'] == 'datetime' || $info['type'] == 'timestamp')) return true; return false; } /** * Function test if type is duration * * @param array $info content informations of field * @return bool true if field of type duration */ public function isDuration($info) { if (is_array($info)) { if (isset($info['type']) && ($info['type'] == 'duration')) return true; else return false; } else return false; } /** * Function test if type is integer * * @param array $info content informations of field * @return bool true if integer */ public function isInt($info) { if (is_array($info)) { if (isset($info['type']) && ($info['type'] == 'int' || preg_match('/^integer/i', $info['type']))) return true; else return false; } else return false; } /** * Function test if type is float * * @param array $info content informations of field * @return bool true if float */ public function isFloat($info) { if (is_array($info)) { if (isset($info['type']) && (preg_match('/^(double|real|price)/i', $info['type']))) return true; else return false; } return false; } /** * Function test if type is text * * @param array $info content informations of field * @return bool true if type text */ public function isText($info) { if (is_array($info)) { if (isset($info['type']) && $info['type'] == 'text') return true; else return false; } return false; } /** * Function test if field can be null * * @param array $info content informations of field * @return bool true if it can be null */ protected function canBeNull($info) { if (is_array($info)) { if (isset($info['notnull']) && $info['notnull'] != '1') return true; else return false; } return true; } /** * Function test if field is forced to null if zero or empty * * @param array $info content informations of field * @return bool true if forced to null */ protected function isForcedToNullIfZero($info) { if (is_array($info)) { if (isset($info['notnull']) && $info['notnull'] == '-1') return true; else return false; } return false; } /** * Function test if is indexed * * @param array $info content informations of field * @return bool */ protected function isIndex($info) { if (is_array($info)) { if (isset($info['index']) && $info['index'] == true) return true; else return false; } return false; } /** * Function to prepare a part of the query for insert. * Note $this->${field} are set by the page that make the createCommon or the updateCommon. * $this->${field} should be a clean value. The page can run * * @return array */ protected function setSaveQuery() { global $conf; $queryarray = array(); foreach ($this->fields as $field => $info) // Loop on definition of fields { // Depending on field type ('datetime', ...) if ($this->isDate($info)) { if (empty($this->{$field})) { $queryarray[$field] = null; } else { $queryarray[$field] = $this->db->idate($this->{$field}); } } elseif ($this->isArray($info)) { if (!empty($this->{$field})) { if (!is_array($this->{$field})) { $this->{$field} = array($this->{$field}); } $queryarray[$field] = serialize($this->{$field}); } else { $queryarray[$field] = null; } } elseif ($this->isDuration($info)) { // $this->{$field} may be null, '', 0, '0', 123, '123' if ($this->{$field} != '' || !empty($info['notnull'])) $queryarray[$field] = (int) $this->{$field}; // If '0', it may be set to null later if $info['notnull'] == -1 else $queryarray[$field] = null; } elseif ($this->isInt($info) || $this->isFloat($info)) { if ($field == 'entity' && is_null($this->{$field})) $queryarray[$field] = $conf->entity; else { // $this->{$field} may be null, '', 0, '0', 123, '123' if ($this->{$field} != '' || !empty($info['notnull'])) { if ($this->isInt($info)) $queryarray[$field] = (int) $this->{$field}; // If '0', it may be set to null later if $info['notnull'] == -1 if ($this->isFloat($info)) $queryarray[$field] = (double) $this->{$field}; // If '0', it may be set to null later if $info['notnull'] == -1 } else $queryarray[$field] = null; } } else { $queryarray[$field] = $this->{$field}; } if ($info['type'] == 'timestamp' && empty($queryarray[$field])) unset($queryarray[$field]); if (!empty($info['notnull']) && $info['notnull'] == -1 && empty($queryarray[$field])) $queryarray[$field] = null; // May force 0 to null } return $queryarray; } /** * Function to load data from a SQL pointer into properties of current object $this * * @param stdClass $obj Contain data of object from database * @return void */ public function setVarsFromFetchObj(&$obj) { foreach ($this->fields as $field => $info) { if ($this->isDate($info)) { if (empty($obj->{$field}) || $obj->{$field} === '0000-00-00 00:00:00' || $obj->{$field} === '1000-01-01 00:00:00') $this->{$field} = 0; else $this->{$field} = strtotime($obj->{$field}); } elseif ($this->isArray($info)) { if (!empty($obj->{$field})) { $this->{$field} = @unserialize($obj->{$field}); // Hack for data not in UTF8 if ($this->{$field } === false) @unserialize(utf8_decode($obj->{$field})); } else { $this->{$field} = array(); } } elseif ($this->isInt($info)) { if ($field == 'rowid') $this->id = (int) $obj->{$field}; else { if ($this->isForcedToNullIfZero($info)) { if (empty($obj->{$field})) $this->{$field} = null; else $this->{$field} = (double) $obj->{$field}; } else { if (!is_null($obj->{$field}) || (isset($info['notnull']) && $info['notnull'] == 1)) { $this->{$field} = (int) $obj->{$field}; } else { $this->{$field} = null; } } } } elseif ($this->isFloat($info)) { if ($this->isForcedToNullIfZero($info)) { if (empty($obj->{$field})) $this->{$field} = null; else $this->{$field} = (double) $obj->{$field}; } else { if (!is_null($obj->{$field}) || (isset($info['notnull']) && $info['notnull'] == 1)) { $this->{$field} = (double) $obj->{$field}; } else { $this->{$field} = null; } } } else { $this->{$field} = $obj->{$field}; } } // If there is no 'ref' field, we force property ->ref to ->id for a better compatibility with common functions. if (!isset($this->fields['ref']) && isset($this->id)) $this->ref = $this->id; } /** * Function to concat keys of fields * * @return string */ protected function getFieldList() { $keys = array_keys($this->fields); return implode(',', $keys); } /** * Add quote to field value if necessary * * @param string|int $value Value to protect * @param array $fieldsentry Properties of field * @return string */ protected function quote($value, $fieldsentry) { if (is_null($value)) return 'NULL'; elseif (preg_match('/^(int|double|real|price)/i', $fieldsentry['type'])) return $this->db->escape("$value"); elseif ($fieldsentry['type'] == 'boolean') { if ($value) return 'true'; else return 'false'; } else return "'".$this->db->escape($value)."'"; } /** * Create object into database * * @param User $user User that creates * @param bool $notrigger false=launch triggers after, true=disable triggers * @return int <0 if KO, Id of created object if OK */ public function createCommon(User $user, $notrigger = false) { global $langs; dol_syslog(get_class($this)."::createCommon create", LOG_DEBUG); $error = 0; $now = dol_now(); $fieldvalues = $this->setSaveQuery(); if (array_key_exists('date_creation', $fieldvalues) && empty($fieldvalues['date_creation'])) $fieldvalues['date_creation'] = $this->db->idate($now); if (array_key_exists('fk_user_creat', $fieldvalues) && !($fieldvalues['fk_user_creat'] > 0)) $fieldvalues['fk_user_creat'] = $user->id; unset($fieldvalues['rowid']); // The field 'rowid' is reserved field name for autoincrement field so we don't need it into insert. if (array_key_exists('ref', $fieldvalues)) $fieldvalues['ref'] = dol_string_nospecial($fieldvalues['ref']); // If field is a ref, we sanitize data $keys = array(); $values = array(); // Array to store string forged for SQL syntax foreach ($fieldvalues as $k => $v) { $keys[$k] = $k; $value = $this->fields[$k]; $values[$k] = $this->quote($v, $value); // May return string 'NULL' if $value is null } // Clean and check mandatory foreach ($keys as $key) { // If field is an implicit foreign key field if (preg_match('/^integer:/i', $this->fields[$key]['type']) && $values[$key] == '-1') $values[$key] = ''; if (!empty($this->fields[$key]['foreignkey']) && $values[$key] == '-1') $values[$key] = ''; if (isset($this->fields[$key]['notnull']) && $this->fields[$key]['notnull'] == 1 && (!isset($values[$key]) || $values[$key] === 'NULL') && is_null($this->fields[$key]['default'])) { $error++; $this->errors[] = $langs->trans("ErrorFieldRequired", $this->fields[$key]['label']); } // If value is null and there is a default value for field if (isset($this->fields[$key]['notnull']) && $this->fields[$key]['notnull'] == 1 && (!isset($values[$key]) || $values[$key] === 'NULL') && !is_null($this->fields[$key]['default'])) { $values[$key] = $this->fields[$key]['default']; } // If field is an implicit foreign key field if (preg_match('/^integer:/i', $this->fields[$key]['type']) && empty($values[$key])) { if (isset($this->fields[$key]['default'])) $values[$key] = $this->fields[$key]['default']; else $values[$key] = 'null'; } if (!empty($this->fields[$key]['foreignkey']) && empty($values[$key])) $values[$key] = 'null'; } if ($error) return -1; $this->db->begin(); if (!$error) { $sql = 'INSERT INTO '.MAIN_DB_PREFIX.$this->table_element; $sql .= ' ('.implode(", ", $keys).')'; $sql .= ' VALUES ('.implode(", ", $values).')'; $res = $this->db->query($sql); if ($res === false) { $error++; $this->errors[] = $this->db->lasterror(); } } if (!$error) { $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX.$this->table_element); } // If we have a field ref with a default value of (PROV) if (!$error) { if (key_exists('ref', $this->fields) && $this->fields['ref']['notnull'] > 0 && !is_null($this->fields['ref']['default']) && $this->fields['ref']['default'] == '(PROV)') { $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element." SET ref = '(PROV".$this->id.")' WHERE (ref = '(PROV)' OR ref = '') AND rowid = ".$this->id; $resqlupdate = $this->db->query($sql); if ($resqlupdate === false) { $error++; $this->errors[] = $this->db->lasterror(); } else { $this->ref = '(PROV'.$this->id.')'; } } } // Create extrafields if (!$error) { $result = $this->insertExtraFields(); if ($result < 0) $error++; } // Create lines if (!empty($this->table_element_line) && !empty($this->fk_element)) { $num = (is_array($this->lines) ? count($this->lines) : 0); for ($i = 0; $i < $num; $i++) { $line = $this->lines[$i]; $keyforparent = $this->fk_element; $line->$keyforparent = $this->id; // Test and convert into object this->lines[$i]. When coming from REST API, we may still have an array //if (! is_object($line)) $line=json_decode(json_encode($line), false); // convert recursively array into object. if (!is_object($line)) $line = (object) $line; $result = $line->create($user, 1); if ($result < 0) { $this->error = $this->db->lasterror(); $this->db->rollback(); return -1; } } } // Triggers if (!$error && !$notrigger) { // Call triggers $result = $this->call_trigger(strtoupper(get_class($this)).'_CREATE', $user); if ($result < 0) { $error++; } // End call triggers } // Commit or rollback if ($error) { $this->db->rollback(); return -1; } else { $this->db->commit(); return $this->id; } } /** * Load object in memory from the database * * @param int $id Id object * @param string $ref Ref * @param string $morewhere More SQL filters (' AND ...') * @return int <0 if KO, 0 if not found, >0 if OK */ public function fetchCommon($id, $ref = null, $morewhere = '') { if (empty($id) && empty($ref) && empty($morewhere)) return -1; $fieldlist = $this->getFieldList(); if (empty($fieldlist)) return 0; $sql = 'SELECT '.$fieldlist; $sql .= ' FROM '.MAIN_DB_PREFIX.$this->table_element; if (!empty($id)) $sql .= ' WHERE rowid = '.$id; elseif (!empty($ref)) $sql .= " WHERE ref = ".$this->quote($ref, $this->fields['ref']); else $sql .= ' WHERE 1 = 1'; // usage with empty id and empty ref is very rare if (empty($id) && isset($this->ismultientitymanaged) && $this->ismultientitymanaged == 1) $sql .= ' AND entity IN ('.getEntity($this->table_element).')'; if ($morewhere) $sql .= $morewhere; $sql .= ' LIMIT 1'; // This is a fetch, to be sure to get only one record $res = $this->db->query($sql); if ($res) { $obj = $this->db->fetch_object($res); if ($obj) { $this->setVarsFromFetchObj($obj); // Retreive all extrafield // fetch optionals attributes and labels $this->fetch_optionals(); return $this->id; } else { return 0; } } else { $this->error = $this->db->lasterror(); $this->errors[] = $this->error; return -1; } } /** * Load object in memory from the database * * @param string $morewhere More SQL filters (' AND ...') * @return int <0 if KO, 0 if not found, >0 if OK */ public function fetchLinesCommon($morewhere = '') { $objectlineclassname = get_class($this).'Line'; if (!class_exists($objectlineclassname)) { $this->error = 'Error, class '.$objectlineclassname.' not found during call of fetchLinesCommon'; return -1; } $objectline = new $objectlineclassname($this->db); $sql = 'SELECT '.$objectline->getFieldList(); $sql .= ' FROM '.MAIN_DB_PREFIX.$objectline->table_element; $sql .= ' WHERE fk_'.$this->element.' = '.$this->id; if ($morewhere) $sql .= $morewhere; if (isset($objectline->fields['position'])) { $sql .= $this->db->order('position', 'ASC'); } $resql = $this->db->query($sql); if ($resql) { $num_rows = $this->db->num_rows($resql); $i = 0; while ($i < $num_rows) { $obj = $this->db->fetch_object($resql); if ($obj) { $newline = new $objectlineclassname($this->db); $newline->setVarsFromFetchObj($obj); $this->lines[] = $newline; } $i++; } return 1; } else { $this->error = $this->db->lasterror(); $this->errors[] = $this->error; return -1; } } /** * Update object into database * * @param User $user User that modifies * @param bool $notrigger false=launch triggers after, true=disable triggers * @return int <0 if KO, >0 if OK */ public function updateCommon(User $user, $notrigger = false) { global $conf, $langs; dol_syslog(get_class($this)."::updateCommon update", LOG_DEBUG); $error = 0; $now = dol_now(); $fieldvalues = $this->setSaveQuery(); if (array_key_exists('date_modification', $fieldvalues) && empty($fieldvalues['date_modification'])) $fieldvalues['date_modification'] = $this->db->idate($now); if (array_key_exists('fk_user_modif', $fieldvalues) && !($fieldvalues['fk_user_modif'] > 0)) $fieldvalues['fk_user_modif'] = $user->id; unset($fieldvalues['rowid']); // The field 'rowid' is reserved field name for autoincrement field so we don't need it into update. if (array_key_exists('ref', $fieldvalues)) $fieldvalues['ref'] = dol_string_nospecial($fieldvalues['ref']); // If field is a ref, we sanitize data $keys = array(); $values = array(); $tmp = array(); foreach ($fieldvalues as $k => $v) { $keys[$k] = $k; $value = $this->fields[$k]; $values[$k] = $this->quote($v, $value); $tmp[] = $k.'='.$this->quote($v, $this->fields[$k]); } // Clean and check mandatory foreach ($keys as $key) { if (preg_match('/^integer:/i', $this->fields[$key]['type']) && $values[$key] == '-1') $values[$key] = ''; // This is an implicit foreign key field if (!empty($this->fields[$key]['foreignkey']) && $values[$key] == '-1') $values[$key] = ''; // This is an explicit foreign key field //var_dump($key.'-'.$values[$key].'-'.($this->fields[$key]['notnull'] == 1)); /* if ($this->fields[$key]['notnull'] == 1 && empty($values[$key])) { $error++; $this->errors[]=$langs->trans("ErrorFieldRequired", $this->fields[$key]['label']); }*/ } $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element.' SET '.implode(',', $tmp).' WHERE rowid='.$this->id; $this->db->begin(); if (!$error) { $res = $this->db->query($sql); if ($res === false) { $error++; $this->errors[] = $this->db->lasterror(); } } // Update extrafield if (!$error) { $result = $this->insertExtraFields(); if ($result < 0) { $error++; } } // Triggers if (!$error && !$notrigger) { // Call triggers $result = $this->call_trigger(strtoupper(get_class($this)).'_MODIFY', $user); if ($result < 0) { $error++; } //Do also here what you must do to rollback action if trigger fail // End call triggers } // Commit or rollback if ($error) { $this->db->rollback(); return -1; } else { $this->db->commit(); return $this->id; } } /** * Delete object in database * * @param User $user User that deletes * @param bool $notrigger false=launch triggers after, true=disable triggers * @param int $forcechilddeletion 0=no, 1=Force deletion of children * @return int <=0 if KO, >0 if OK */ public function deleteCommon(User $user, $notrigger = false, $forcechilddeletion = 0) { dol_syslog(get_class($this)."::deleteCommon delete", LOG_DEBUG); $error = 0; $this->db->begin(); if ($forcechilddeletion) // Force also delete of childtables that should lock deletion in standard case when option force is off { foreach ($this->childtables as $table) { $sql = 'DELETE FROM '.MAIN_DB_PREFIX.$table.' WHERE '.$this->fk_element.' = '.$this->id; $resql = $this->db->query($sql); if (!$resql) { $this->error = $this->db->lasterror(); $this->errors[] = $this->error; $this->db->rollback(); return -1; } } } elseif (!empty($this->fk_element) && !empty($this->childtables)) // If object has childs linked with a foreign key field, we check all child tables. { $objectisused = $this->isObjectUsed($this->id); if (!empty($objectisused)) { dol_syslog(get_class($this)."::deleteCommon Can't delete record as it has some child", LOG_WARNING); $this->error = 'ErrorRecordHasChildren'; $this->errors[] = $this->error; $this->db->rollback(); return 0; } } // Delete cascade first if (is_array($this->childtablesoncascade) && !empty($this->childtablesoncascade)) { foreach ($this->childtablesoncascade as $table) { $deleteFromObject = explode(':', $table); if (count($deleteFromObject) >= 2) { $className = str_replace('@', '', $deleteFromObject[0]); $filePath = $deleteFromObject[1]; $columnName = $deleteFromObject[2]; if (dol_include_once($filePath)) { $childObject = new $className($this->db); if (method_exists($childObject, 'deleteByParentField')) { $result = $childObject->deleteByParentField($this->id, $columnName); if ($result < 0) { $error++; $this->errors[] = $childObject->error; break; } } else { $error++; $this->errors[] = "You defined a cascade delete on an object $childObject but there is no method deleteByParentField for it"; break; } } else { $error++; $this->errors[] = 'Cannot include child class file '.$filePath; break; } } else { // Delete record in child table $sql = 'DELETE FROM '.MAIN_DB_PREFIX.$table.' WHERE '.$this->fk_element.' = '.$this->id; $resql = $this->db->query($sql); if (!$resql) { $error++; $this->error = $this->db->lasterror(); $this->errors[] = $this->error; break; } } } } if (!$error) { if (!$notrigger) { // Call triggers $result = $this->call_trigger(strtoupper(get_class($this)).'_DELETE', $user); if ($result < 0) { $error++; } // Do also here what you must do to rollback action if trigger fail // End call triggers } } if (!$error && !empty($this->isextrafieldmanaged)) { $result = $this->deleteExtraFields(); if ($result < 0) { $error++; } } if (!$error) { $sql = 'DELETE FROM '.MAIN_DB_PREFIX.$this->table_element.' WHERE rowid='.$this->id; $res = $this->db->query($sql); if ($res === false) { $error++; $this->errors[] = $this->db->lasterror(); } } // Commit or rollback if ($error) { $this->db->rollback(); return -1; } else { $this->db->commit(); return 1; } } /** * Delete all child object from a parent ID * * @param int $parentId Parent Id * @param string $parentField Name of Foreign key parent column * @return int <0 if KO, >0 if OK * @throws Exception */ public function deleteByParentField($parentId = 0, $parentField = '') { global $user; $error = 0; $deleted = 0; if (!empty($parentId) && !empty($parentField)) { $this->db->begin(); $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX.$this->table_element; $sql .= ' WHERE '.$parentField.' = '.(int) $parentId; $resql = $this->db->query($sql); if (!$resql) { $this->errors[] = $this->db->lasterror(); $error++; } else { while ($obj = $this->db->fetch_object($resql)) { $result = $this->fetch($obj->rowid); if ($result < 0) { $error++; $this->errors[] = $this->error; } else { if (get_class($this) == 'Contact') { // TODO special code because delete() for contact has not been standardized like other delete. $result = $this->delete(); } else { $result = $this->delete($user); } if ($result < 0) { $error++; $this->errors[] = $this->error; } else { $deleted++; } } } } if (empty($error)) { $this->db->commit(); return $deleted; } else { $this->error = implode(', ', $this->errors); $this->db->rollback(); return $error * -1; } } return $deleted; } /** * Delete a line of object in database * * @param User $user User that delete * @param int $idline Id of line to delete * @param bool $notrigger false=launch triggers after, true=disable triggers * @return int >0 if OK, <0 if KO */ public function deleteLineCommon(User $user, $idline, $notrigger = false) { global $conf; $error = 0; $tmpforobjectclass = get_class($this); $tmpforobjectlineclass = ucfirst($tmpforobjectclass).'Line'; // Call trigger $result = $this->call_trigger('LINE'.strtoupper($tmpforobjectclass).'_DELETE', $user); if ($result < 0) return -1; // End call triggers $this->db->begin(); $sql = "DELETE FROM ".MAIN_DB_PREFIX.$this->table_element_line; $sql .= " WHERE rowid=".$idline; dol_syslog(get_class($this)."::deleteLineCommon", LOG_DEBUG); $resql = $this->db->query($sql); if (!$resql) { $this->error = "Error ".$this->db->lasterror(); $error++; } if (empty($error)) { // Remove extrafields $tmpobjectline = new $tmpforobjectlineclass($this->db); if (!isset($tmpobjectline->isextrafieldmanaged) || !empty($tmpobjectline->isextrafieldmanaged)) { $tmpobjectline->id = $idline; $result = $tmpobjectline->deleteExtraFields(); if ($result < 0) { $error++; $this->error = "Error ".get_class($this)."::deleteLineCommon deleteExtraFields error -4 ".$tmpobjectline->error; } } } if (empty($error)) { $this->db->commit(); return 1; } else { dol_syslog(get_class($this)."::deleteLineCommon ERROR:".$this->error, LOG_ERR); $this->db->rollback(); return -1; } } /** * Set to a status * * @param User $user Object user that modify * @param int $status New status to set (often a constant like self::STATUS_XXX) * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers * @param string $triggercode Trigger code to use * @return int <0 if KO, >0 if OK */ public function setStatusCommon($user, $status, $notrigger = 0, $triggercode = '') { $error = 0; $this->db->begin(); $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element; $sql .= " SET status = ".$status; $sql .= " WHERE rowid = ".$this->id; if ($this->db->query($sql)) { if (!$error) { $this->oldcopy = clone $this; } if (!$error && !$notrigger) { // Call trigger $result = $this->call_trigger($triggercode, $user); if ($result < 0) $error++; } if (!$error) { $this->status = $status; $this->db->commit(); return 1; } else { $this->db->rollback(); return -1; } } else { $this->error = $this->db->error(); $this->db->rollback(); return -1; } } /** * Initialise object with example values * Id must be 0 if object instance is a specimen * * @return void */ public function initAsSpecimenCommon() { global $user; $this->id = 0; if (array_key_exists('label', $this->fields)) $this->label = 'This is label'; if (array_key_exists('note_public', $this->fields)) $this->note_public = 'Public note'; if (array_key_exists('note_private', $this->fields)) $this->note_private = 'Private note'; if (array_key_exists('date_creation', $this->fields)) $this->date_creation = (dol_now() - 3600 * 24); if (array_key_exists('date_modification', $this->fields)) $this->date_modification = (dol_now() - 3600 * 24); if (array_key_exists('fk_user_creat', $this->fields)) $this->fk_user_creat = $user->id; if (array_key_exists('fk_user_modif', $this->fields)) $this->fk_user_modif = $user->id; if (array_key_exists('date', $this->fields)) $this->date = dol_now(); // ... } /* Part for comments */ /** * Load comments linked with current task * @return boolean 1 if ok */ public function fetchComments() { require_once DOL_DOCUMENT_ROOT.'/core/class/comment.class.php'; $comment = new Comment($this->db); $result = $comment->fetchAllFor($this->element, $this->id); if ($result < 0) { $this->errors = array_merge($this->errors, $comment->errors); return -1; } else { $this->comments = $comment->comments; } return count($this->comments); } /** * Return nb comments already posted * * @return int */ public function getNbComments() { return count($this->comments); } /** * Trim object parameters * @param string[] $parameters array of parameters to trim * * @return void */ public function trimParameters($parameters) { if (!is_array($parameters)) return; foreach ($parameters as $parameter) { if (isset($this->$parameter)) { $this->$parameter = trim($this->$parameter); } } } /* Part for categories/tags */ /** * Sets object to given categories. * * Deletes object from existing categories not supplied. * Adds it to non existing supplied categories. * Existing categories are left untouch. * * @param string $type_categ Category type ('customer', 'supplier', 'website_page', ...) * @return int Array of category objects or < 0 if KO */ public function getCategoriesCommon($type_categ) { require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php'; // Get current categories $c = new Categorie($this->db); $existing = $c->containing($this->id, $type_categ, 'id'); return $existing; } /** * Sets object to given categories. * * Deletes object from existing categories not supplied. * Adds it to non existing supplied categories. * Existing categories are left untouch. * * @param int[]|int $categories Category ID or array of Categories IDs * @param string $type_categ Category type ('customer', 'supplier', 'website_page', ...) * @return int <0 if KO, >0 if OK */ public function setCategoriesCommon($categories, $type_categ) { require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php'; // Handle single category if (!is_array($categories)) { $categories = array($categories); } // Get current categories $c = new Categorie($this->db); $existing = $c->containing($this->id, $type_categ, 'id'); // Diff if (is_array($existing)) { $to_del = array_diff($existing, $categories); $to_add = array_diff($categories, $existing); } else { $to_del = array(); // Nothing to delete $to_add = $categories; } $error = 0; // Process foreach ($to_del as $del) { if ($c->fetch($del) > 0) { $c->del_type($this, $type_categ); } } foreach ($to_add as $add) { if ($c->fetch($add) > 0) { $result = $c->add_type($this, $type_categ); if ($result < 0) { $error++; $this->error = $c->error; $this->errors = $c->errors; break; } } } return $error ? -1 : 1; } /** * Copy related categories to another object * * @param int $fromId Id object source * @param int $toId Id object cible * @param string $type Type of category ('product', ...) * @return int < 0 si erreur, > 0 si ok */ public function cloneCategories($fromId, $toId, $type = '') { $this->db->begin(); if (empty($type)) $type = $this->table_element; require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php'; $categorystatic = new Categorie($this->db); $sql = "INSERT INTO ".MAIN_DB_PREFIX."categorie_".(empty($categorystatic->MAP_CAT_TABLE[$type]) ? $type : $categorystatic->MAP_CAT_TABLE[$type])." (fk_categorie, fk_product)"; $sql .= " SELECT fk_categorie, $toId FROM ".MAIN_DB_PREFIX."categorie_".(empty($categorystatic->MAP_CAT_TABLE[$type]) ? $type : $categorystatic->MAP_CAT_TABLE[$type]); $sql .= " WHERE fk_product = ".((int) $fromId); if (!$this->db->query($sql)) { $this->error = $this->db->lasterror(); $this->db->rollback(); return -1; } $this->db->commit(); return 1; } /** * Delete related files of object in database * * @return bool */ public function deleteEcmFiles() { global $conf; $this->db->begin(); switch ($this->element){ case 'propal': $element = 'propale'; break; case 'product': $element = 'produit'; break; case 'order_supplier': $element ='fournisseur/commande'; break; case 'invoice_supplier': $element = 'fournisseur/facture/' . get_exdir($this->id, 2, 0, 1, $this, 'invoice_supplier'); break; case 'shipping': $element = 'expedition/sending'; break; default: $element = $this->element; } $sql = "DELETE FROM ".MAIN_DB_PREFIX."ecm_files"; $sql.= " WHERE filename LIKE '".$this->db->escape($this->ref)."%'"; $sql.= " AND filepath = '".$this->db->escape($element)."/".$this->db->escape($this->ref)."' AND entity = ".$conf->entity; if (!$this->db->query($sql)) { $this->error = $this->db->lasterror(); $this->db->rollback(); return false; } $this->db->commit(); return true; } }