dolibarr 24.0.0-beta
functions.lib.php File Reference

A set of functions for Dolibarr This file contains all frequently used functions. More...

Go to the source code of this file.

Functions

if(!function_exists( 'utf8_encode')) if(!function_exists('utf8_decode')) if(!function_exists( 'str_starts_with')) if(!function_exists('str_ends_with')) if(!function_exists( 'str_contains')) formatLogObject ($data)
 Return a string serialized to be output on log with dol_syslog() An option allow to output log in one line instead of a structured human tree.
 
 getMultidirOutput ($object, $module='', $forobject=0, $mode='output')
 Return the full path of the directory where a module (or an object of a module) stores its files.
 
 getMultidirTemp ($object, $module='', $forobject=0)
 Return the full path of the directory where a module (or an object of a module) stores its temporary files.
 
 getMultidirVersion ($object, $module='', $forobject=0)
 Return the full path of the directory where a module (or an object of a module) stores its versioned files.
 
 getDolGlobalString ($key, $default='')
 Return a Dolibarr global constant string value.
 
 getDolGlobalLoginBadCharUnauthorized ()
 Return the list of unauthorized characters in user logins.
 
 getDolGlobalInt ($key, $default=0)
 Return a Dolibarr global constant int value.
 
 getDolGlobalFloat ($key, $default=0)
 Return a Dolibarr global constant float value.
 
 getDolGlobalBool ($key, $default=false)
 Return a Dolibarr global constant boolean value.
 
 getDolCurrency ()
 Return the main currency ('EUR', 'USD', ...)
 
 getDolOptimizeSmallScreen ()
 Return if render must be optimized for small screen.
 
 getDolEntity ()
 Return the current entity.
 
 getDolDBType ()
 Return the current entity.
 
 getDolDefaultContextPage ($s)
 Return the default context page string.
 
 getDolUserString ($key, $default='', $tmpuser=null)
 Return Dolibarr user constant string value.
 
 getDolUserInt ($key, $default=0, $tmpuser=null)
 Return Dolibarr user constant int value.
 
 isModEnabled ($module)
 Is Dolibarr module enabled.
 
 getWarningDelay ($module, $parmlevel1, $parmlevel2='')
 Return a warning delay You can use it like this: if (getWarningDelay('module', 'paramlevel1')) It replaces old syntax: if ($conf->module->user->rights->module->level1)
 
 isDolTms ($timestamp)
 isDolTms check if a timestamp is valid.
 
 getDoliDBInstance ($type, $host, $user, $pass, $name, $port)
 Return a DoliDB instance (database handler).
 
 getEntity ($element, $shared=1, $currentobject=null)
 Get list of entity id to use.
 
 setEntity ($currentobject)
 Set entity id to use when to create an object.
 
 isASecretKey ($keyname)
 Return if string has a name dedicated to store a secret.
 
 num2Alpha ($n)
 Return a numeric value into an Excel like column number.
 
 getBrowserInfo ($user_agent)
 Return information about user browser.
 
 dol_shutdown ()
 Function called at end of web php process.
 
 GETPOSTISSET ($paramname)
 Return true if we are in a context of submitting the parameter $paramname from a POST of a form.
 
 GETPOSTISARRAY ($paramname, $method=0)
 Return true if the parameter $paramname is submit from a POST OR GET as an array.
 
 GETPOSTINT ($paramname, $method=0)
 Return the value of a $_GET or $_POST supervariable, converted into integer.
 
 GETPOSTFLOAT ($paramname, $rounding='', $option=2)
 Return the value of a $_GET or $_POST supervariable, converted into float.
 
 GETPOSTDATE ($prefix, $hourTime='', $gm='auto', $saverestore='')
 Helper function that combines values of a dolibarr DatePicker (such as Form\selectDate) for year, month, day (and optionally hour, minute, second) fields to return a timestamp.
 
 GETPOST ($paramname, $check='alphanohtml', $method=0, $filter=null, $options=null, $noreplace=0)
 Return value of a param into GET or POST supervariable.
 
 sanitizeVal ($out='', $check='alphanohtml', $filter=null, $options=null)
 Return a sanitized or empty value after checking value against a rule.
 
 dolSetCookie (string $cookiename, string $cookievalue, int $expire=-1)
 Set a cookie.
 
if(!function_exists( 'dol_getprefix')) dol_include_once ($relpath, $classname='')
 Make an include_once using default root and alternate root if it fails.
 
 dol_buildpath ($path, $type=0, $returnemptyifnotfound=0)
 Return path of url or filesystem.
 
 dolBuildUrl ($url, $params=[], $addtoken=false, $anchor='')
 Return path of url.
 
 dol_get_object_properties ($obj, $properties=[])
 Get properties for an object - including magic properties when requested.
 
 dol_clone ($srcobject, $native=2)
 Create a clone of instance of object (new instance with same value for each properties) With native = 0: Deprecated.
 
 dol_clone_in_array ($srcobject, $startlevel=0)
 Create a clone of instance of object into a full array, using recursive call.
 
 dol_size ($size, $type='')
 Optimize a size for some browsers (phone, smarphone...)
 
 dol_sanitizeFileName ($str, $newstr='_', $unaccent=1, $includequotes=0, $allowdash=0)
 Clean a string to use it as a file name.
 
 dol_sanitizePathName ($str, $newstr='_', $unaccent=0, $allowdash=0)
 Clean a string to use it as a path name.
 
 dol_sanitizeUrl ($stringtoclean, $type=1)
 Clean a string to use it as an URL (into a href or src attribute)
 
 dol_sanitizeEmail ($stringtoclean)
 Clean a string to use it as an Email.
 
 dol_sanitizeKeyCode ($str)
 Clean a string to use it as a key or code.
 
 dol_string_unaccent ($str)
 Clean a string from all accent characters to be used as ref, login or by dol_sanitizeFileName.
 
 dol_string_nospecial ($str, $newstr='_', $badcharstoreplace='', $badcharstoremove='', $keepspaces=0)
 Clean a string from all punctuation characters to use it as a ref or login.
 
 dol_string_nounprintableascii ($str, $removetabcrlf=1)
 Clean a string from all non printable ASCII chars (0x00-0x1F and 0x7F).
 
 dolSlugify ($stringtoslugify)
 Returns text slugified (lowercase and no special char, separator is "-").
 
 dol_escape_js ($stringtoescape, $mode=0, $noescapebackslashn=0)
 Returns text escaped for inclusion into JavaScript code.
 
 dol_escape_uri ($stringtoescape)
 Returns text escaped by RFC 3986 for inclusion into a clickable link.
 
 dol_escape_json ($stringtoescape)
 Returns text escaped for inclusion into javascript code.
 
 dol_escape_php ($stringtoescape, $stringforquotes=2)
 Returns text escaped for inclusion into a php string, build with double quotes " or '.
 
 dol_escape_all ($stringtoescape)
 Returns text escaped for all protocols (so only alpha chars and numbers)
 
 dol_escape_xml ($stringtoescape)
 Returns text escaped for inclusion into a XML string.
 
 dolPrintLabel ($s, $escapeonlyhtmltags=0)
 Return a string label (so on 1 line only and that should not contains any HTML) ready to be output on HTML page.
 
 dolPrintText ($s)
 Return a string label (possible on several lines and that should not contains any HTML) ready to be output on HTML page.
 
 dolPrintHTML ($s, $allowiframe=0, $moreallowedtags=array())
 Return a string (that can be on several lines) ready to be output on a HTML page.
 
 dolPrintHTMLForAttribute ($s, $escapeonlyhtmltags=0, $allowothertags=array())
 Return a string ready to be output into an HTML attribute (alt, title, data-html, ...) With dolPrintHTMLForAttribute(), the content is HTML encode, even if it is already HTML content.
 
 dolPrintHTMLForAttributeUrl ($s)
 Return a string ready to be output on a href attribute (this one need a special because we need content is HTML with no way to detect it is HTML).
 
 dolPrintHTMLForTextArea ($s, $allowiframe=0)
 Return a string ready to be output on input textarea.
 
 dolPrintPassword ($s)
 Return a string ready to be output on an HTML attribute (alt, title, ...)
 
 dol_escape_htmltag ($stringtoescape, $keepb=0, $keepn=0, $noescapetags='', $escapeonlyhtmltags=0, $cleanalsojavascript=0)
 Returns text escaped for inclusion in HTML alt or title or value tags, or into values of HTML input fields.
 
 dol_strtolower ($string, $encoding="UTF-8")
 Convert a string to lower.
 
 dol_strtoupper ($string, $encoding="UTF-8")
 Convert a string to upper.
 
 dol_ucfirst ($string, $encoding="UTF-8")
 Convert first character of the first word of a string to upper.
 
 dol_ucwords ($string, $encoding="UTF-8")
 Convert first character of all the words of a string to upper.
 
 getCallerInfoString ()
 Get caller info as a string that can be appended to a log message.
 
 dol_syslog ($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
 Write log message into outputs.
 
 dolButtonToOpenExportDialog ($name, $label, $buttonstring, $exportSiteName, $overwriteGitUrl, $website)
 Create a dialog with two buttons for export and overwrite of a website.
 
 dolButtonToOpenUrlInDialogPopup ($name, $label, $buttonstring, $url, $disabled='', $morecss='classlink button bordertransp', $jsonopen='', $jsonclose='', $accesskey='')
 Return HTML code to output a button to open a dialog popup box.
 
 dol_fiche_head ($links=array(), $active='0', $title='', $notab=0, $picto='', $pictoisfullpath=0, $morehtmlright='', $morecss='', $limittoshow=0, $moretabssuffix='')
 Show tab header of a card.
 
 dol_get_fiche_head ($links=array(), $active='', $title='', $notab=0, $picto='', $pictoisfullpath=0, $morehtmlright='', $morecss='', $limittoshow=0, $moretabssuffix='', $dragdropfile=0, $morecssdiv='')
 Show tabs of a record.
 
 dol_fiche_end ($notab=0)
 Show tab footer of a card.
 
 dol_get_fiche_end ($notab=0)
 Return tab footer of a card.
 
 fieldLabel ($langkey, $fieldkey, $fieldrequired=0)
 Show a string with the label tag dedicated to the HTML edit field.
 
 dol_format_address ($object, $withcountry=0, $sep="\n", $outputlangs=null, $mode=0, $extralangcode='')
 Return a formatted address (part address/zip/town/state) according to country rules.
 
 dol_strftime ($fmt, $ts=false, $is_gmt=false)
 Format a string.
 
 dol_print_date ($time, $format='', $tzoutput='auto', $outputlangs=null, $encodetooutput=false, $decorate=0)
 Output date in a string format according to outputlangs (or langs if not defined).
 
 dol_getdate ($timestamp, $fast=false, $forcetimezone='')
 Return an array with locale date info.
 
 dol_mktime ($hour, $minute, $second, $month, $day, $year, $gm='auto', $check=1)
 Return a timestamp date built from detailed information (by default a local PHP server timestamp) Replace function mktime not available under Windows if year < 1970 PHP mktime is restricted to the years 1901-2038 on Unix and 1970-2038 on Windows.
 
 dol_now ($mode='gmt')
 Return date for now.
 
 dol_print_size ($size, $shortvalue=0, $shortunit=0)
 Return string with formatted size.
 
 dol_print_url ($url, $target='_blank', $max=32, $withpicto=0, $morecss='')
 Show Url link.
 
 dol_print_email ($email, $contactid=0, $socid=0, $addlink=0, $max=0, $showinvalid=1, $withpicto=0, $morecss='paddingrightonly')
 Show EMail link formatted for HTML output.
 
 dolOutputDates ($datep, $datef=null, $fullday=0, $addseconds=0, $pictotoadd='', $tzoutput='tzuserrel', $reduceformat=0)
 Print decorated date-hour.
 
 getArrayOfSocialNetworks ()
 Get array of social network dictionary.
 
 dol_print_socialnetworks ($value, $contactid, $socid, $type, $dictsocialnetworks=array())
 Show social network link.
 
 dol_print_profids ($profID, $profIDtype, $countrycode='', $addcpButton=1)
 Format professional IDs according to their country.
 
 dol_print_phone ($phone, $countrycode='', $contactid=0, $socid=0, $addlink='', $separ="&nbsp;", $withpicto='', $titlealt='', $adddivfloat=0, $morecss='paddingright')
 Format phone numbers according to country.
 
 dol_print_ip ($ip, $mode=0, $showname=0)
 Return an IP formatted to be shown on screen.
 
 getUserRemoteIP ($trusted=0)
 Return the real IP of remote user.
 
 dolGetCountryCodeFromIp ($ip)
 Return a country code from IP.
 
 dol_user_country ()
 Return country code for current user.
 
 dol_print_address ($address, $htmlid, $element, $id, $noprint=0, $charfornl='')
 Format address string.
 
 isValidEmail ($address, $acceptsupervisorkey=0, $acceptuserkey=0)
 Return true if email syntax is ok.
 
 isValidMXRecord ($domain)
 Return if the domain name has a valid MX record.
 
 isValidPhone ($phone)
 Return true if phone number syntax is ok TODO Decide what to do with this.
 
 dolGetFirstLetters ($s, $nbofchar=1)
 Return first letters of a strings.
 
 dol_strlen ($string, $stringencoding='UTF-8')
 Make a strlen call.
 
 dol_substr ($string, $start, $length=null, $stringencoding='', $trunconbytes=0)
 Make a substring.
 
 dol_trunc ($string, $size=40, $trunc='right', $stringencoding='UTF-8', $nodot=0, $display=0)
 Truncate a string to a particular length adding '…' if string larger than length.
 
 getPictoForType ($key, $morecss='')
 Return the picto for a data type.
 
 img_picto ($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2, $allowothertags=array())
 Show picto whatever it's its name (generic function)
 
 getImgPictoConv ($mode='fa')
 Get array to convert the Dolibarr picto keys into Font awesome keys.
 
 img_object ($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $allowothertags=array())
 Show a picto called object_picto (generic function)
 
 img_weather ($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $morecss='')
 Show weather picto.
 
 img_picto_common ($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $notitle=0)
 Show picto (generic function)
 
 img_action ($titlealt, $numaction, $picto='', $moreatt='')
 Show logo action.
 
 img_edit_add ($titlealt='default', $other='')
 Show logo "+".
 
 img_edit_remove ($titlealt='default', $other='')
 Show logo "-".
 
 img_edit ($titlealt='default', $float=0, $other='')
 Show logo edit/modify fiche.
 
 img_view ($titlealt='default', $float=0, $other='class="valignmiddle"')
 Show logo view card.
 
 img_delete ($titlealt='default', $other='class="pictodelete"', $morecss='')
 Show delete logo.
 
 img_printer ($titlealt="default", $other='')
 Show printer logo.
 
 img_split ($titlealt='default', $other='class="pictosplit"')
 Show split logo.
 
 img_help ($usehelpcursor=1, $usealttitle=1)
 Show help logo with cursor "?".
 
 img_info ($titlealt='default')
 Show info logo.
 
 img_warning ($titlealt='default', $moreatt='', $morecss='pictowarning')
 Show warning logo.
 
 img_error ($titlealt='default')
 Show error logo.
 
 img_next ($titlealt='default', $moreatt='')
 Show next logo.
 
 img_previous ($titlealt='default', $moreatt='')
 Show previous logo.
 
 img_down ($titlealt='default', $selected=0, $moreclass='')
 Show down arrow logo.
 
 img_up ($titlealt='default', $selected=0, $moreclass='')
 Show top arrow logo.
 
 img_left ($titlealt='default', $selected=0, $moreatt='')
 Show left arrow logo.
 
 img_right ($titlealt='default', $selected=0, $moreatt='')
 Show right arrow logo.
 
 img_allow ($allow, $titlealt='default')
 Show tick logo if allowed.
 
 img_credit_card ($brand, $morecss='fa-2x inline-block valignmiddle')
 Return image of a credit card according to its brand name.
 
 img_mime ($file, $titlealt='', $morecss='')
 Show MIME img of a file.
 
 img_search ($titlealt='default', $other='')
 Show search logo.
 
 img_searchclear ($titlealt='default', $other='')
 Show search logo.
 
 info_admin ($text, $infoonimgalt=0, $nodiv=0, $admin='1', $morecss='hideonsmartphone', $textfordropdown='', $picto='', $textonpictotooltip='')
 Show information in HTML for admin users or standard users.
 
 dol_print_error ($db=null, $error='', $errors=null)
 Displays error message system with all the information to facilitate the diagnosis and the escalation of the bugs.
 
 dol_print_error_email ($prefixcode, $errormessage='', $errormessages=array(), $morecss='error', $email='')
 Show a public email and error code to contact if technical error.
 
 print_liste_field_titre ($name, $file="", $field="", $begin="", $param="", $moreattrib="", $sortfield="", $sortorder="", $prefix="", $tooltip="", $forcenowrapcolumntitle=0)
 Show title line of an array.
 
 getTitleFieldOfList ($name, $thead=0, $file="", $field="", $begin="", $moreparam="", $moreattrib="", $sortfield="", $sortorder="", $prefix="", $disablesortlink=0, $tooltip='', $forcenowrapcolumntitle=0)
 Get title line of an array.
 
 print_titre ($title)
 Show a title.
 
 print_fiche_titre ($title, $mesg='', $picto='generic', $pictoisfullpath=0, $id='')
 Show a title with picto.
 
 load_fiche_titre ($title, $morehtmlright='', $picto='generic', $pictoisfullpath=0, $id='', $morecssontable='', $morehtmlcenter='', $morecssonpicto='widthpictotitle')
 Load a title with picto.
 
 print_barre_liste ($title, $page, $file, $options='', $sortfield='', $sortorder='', $morehtmlcenter='', $num=-1, $totalnboflines='', $picto='generic', $pictoisfullpath=0, $morehtmlright='', $morecss='', $limit=-1, $selectlimitsuffix=0, $hidenavigation=0, $pagenavastextinput=0, $morehtmlrightbeforearrow='')
 Print a title with navigation controls for pagination.
 
 print_fleche_navigation ($page, $file, $options='', $nextpage=0, $betweenarrows='', $afterarrows='', $limit=-1, $totalnboflines=0, $selectlimitsuffix='', $beforearrows='', $hidenavigation=0)
 Function to show navigation arrows into lists.
 
 vatrate ($rate, $addpercent=false, $info_bits=0, $usestarfornpr=0, $html=0)
 Return a string with VAT rate label formatted for view output Used into pdf and HTML pages.
 
 price ($amount, $form=0, $outlangs='', $trunc=1, $rounding=-1, $forcerounding=-1, $currency_code='')
 Function to format a value into an amount for visual output Function used into PDF and HTML pages.
 
 price2num ($amount, $rounding='', $option=0)
 Function that return a number with universal decimal format (decimal separator is '.
 
 showDimensionInBestUnit ($dimension, $unit, $type, $outputlangs, $round=-1, $forceunitoutput='no', $use_short_label=0)
 Output a dimension with best unit.
 
 get_localtax ($vatrate, $local, $thirdparty_buyer=null, $thirdparty_seller=null, $vatnpr=0)
 Return localtax rate for a particular VAT rate, when selling a product with vat $vatrate, from a $thirdparty_buyer to a $thirdparty_seller Note: This function get information into the table llx_tva using the VAT rate as key.
 
 isOnlyOneLocalTax ($local)
 Return true if LocalTax (1 or 2) is unique.
 
 get_localtax_by_third ($local)
 Get values of localtaxes (1 or 2) for company country for the common vat with the highest value.
 
 getTaxesFromId ($vatrate, $buyer=null, $seller=null, $firstparamisid=1)
 Get tax (VAT) main information from Id.
 
 getLocalTaxesFromRate ($vatrate, $local, $buyer, $seller, $firstparamisid=0)
 Get type and rate of localtaxes for a particular vat rate/country of a thirdparty.
 
 get_product_vat_for_country ($idprod, $thirdpartytouseforcountry, $idprodfournprice=0)
 Return vat rate of a product in a particular country, or default country vat if product is unknown.
 
 get_product_localtax_for_country ($idprod, $local, $thirdpartytouseforcountry)
 Return localtax vat rate of a product in a particular country or default country vat if product is unknown.
 
 get_default_tva (Societe $thirdparty_seller, Societe $thirdparty_buyer, $idprod=0, $idprodfournprice=0)
 Function that return vat rate of a product line (according to seller, buyer and product vat rate) VATRULE 0: If we are in mode SERVICE_ARE_ECOMMERCE_200238EC and customer is not a company with a vat id, we use default product VAT in buyer country VATRULE 1: If seller does not use VAT, default VAT is 0.
 
 get_default_npr (Societe $thirdparty_seller, Societe $thirdparty_buyer, $idprod=0, $idprodfournprice=0)
 Function that returns whether VAT must be recoverable collected VAT (e.g.: VAT NPR in France)
 
 get_default_localtax ($thirdparty_seller, $thirdparty_buyer, $local, $idprod=0)
 Function that return localtax of a product line (according to seller, buyer and product vat rate) If the seller is not subject to VAT, then default VAT=0.
 
 yn ($yesno, $format=1, $color=0)
 Return yes or no in current language.
 
 get_exdir ($num, $level, $alpha, $withoutslash, $object, $modulepart='')
 Return a path to have a the directory according to object where files are stored.
 
 dol_mkdir ($dir, $dataroot='', $newmask='')
 Creation of a directory (this can create recursive subdir)
 
 dolChmod ($filepath, $newmask='')
 Change mod of a file.
 
 picto_required ()
 Return picto saying a field is required.
 
 dol_string_nohtmltag ($stringtoclean, $removelinefeed=1, $pagecodeto='UTF-8', $strip_tags=0, $removedoublespaces=1)
 Clean a string from all HTML tags and entities.
 
 dol_string_onlythesehtmltags ($stringtoclean, $cleanalsosomestyles=1, $removeclassattribute=1, $cleanalsojavascript=0, $allowiframe=0, $allowed_tags=array(), $allowlink=0, $allowscript=0, $allowstyle=0, $allowphp=0)
 Clean a string to keep only desirable HTML tags.
 
 dol_string_onlythesehtmlattributes ($stringtoclean, $allowed_attributes=null)
 Clean a string from some undesirable HTML tags.
 
 dol_string_neverthesehtmltags ($stringtoclean, $disallowed_tags=array('textarea'), $cleanalsosomestyles=0)
 Clean a string from some undesirable HTML tags.
 
 dolGetFirstLineOfText ($text, $nboflines=1, $charset='UTF-8')
 Return first line of text.
 
 dol_nl2br ($stringtoencode, $nl2brmode=0, $forxml=false)
 Replace CRLF in string with a HTML BR tag.
 
 dol_htmlwithnojs ($stringtoencode, $nouseofiframesandbox=0, $check='restricthtml')
 Sanitize a HTML to remove js, dangerous content and external links.
 
 dol_htmlentitiesbr ($stringtoencode, $nl2brmode=0, $pagecodefrom='UTF-8', $removelasteolbr=1)
 This function is called to encode a string into a HTML string but differs from htmlentities because a detection is done before to see if text is already HTML or not.
 
 dol_htmlentitiesbr_decode ($stringtodecode, $pagecodeto='UTF-8')
 This function is called to decode a HTML string (it decodes entities and br tags)
 
 dol_htmlcleanlastbr ($stringtodecode)
 This function remove all ending
and br at end.
 
 dol_html_entity_decode ($a, $b, $c='UTF-8', $keepsomeentities=0)
 Replace html_entity_decode functions to manage errors.
 
 dol_htmlentities ($string, $flags=ENT_QUOTES|ENT_SUBSTITUTE, $encoding='UTF-8', $double_encode=false)
 Replace htmlentities functions.
 
 dol_string_is_good_iso ($s, $clean=0)
 Check if a string is a correct iso string If not, it will not be considered as HTML encoded even if it is by FPDF.
 
 dol_nboflines ($s, $maxchar=0)
 Return nb of lines of a clear text.
 
 dol_nboflines_bis ($text, $maxlinesize=0, $charset='UTF-8')
 Return nb of lines of a formatted text with
and
(WARNING: string must not have mixed
and br separators)
 
 dol_textishtml ($msg, $option=0)
 Return if a text is a html content.
 
 dol_concatdesc ($text1, $text2, $forxml=false, $invert=false)
 Concat 2 descriptions with a new line between them (second operand after first one with appropriate new line separator) text1 html + text2 html => text1 + '
' + text2 text1 html + text2 txt => text1 + '
' + dol_nl2br(text2) text1 txt + text2 html => dol_nl2br(text1) + '
' + text2 text1 txt + text2 txt => text1 + '
' + text2.
 
 dol_concat ($text1, $text2)
 Concat 2 strings.
 
 safeArrayMap ($callback, array $array)
 Add a function to replace array_map with allowed callback.
 
 make_substitutions ($text, $substitutionarray, $outputlangs=null, $converttextinhtmlifnecessary=0)
 Make substitution into a text string, replacing keys with vals from $substitutionarray (oldval=>newval), and texts like __(TranslationKey|langfile)__, [CONSTANTKEY] or [CONSTANTKEY|urlencode] are also replaced.
 
 complete_substitutions_array (&$substitutionarray, $outputlangs, $object=null, $parameters=null, $callfunc="completesubstitutionarray")
 Complete the $substitutionarray with more entries coming from external module that had set the "substitutions=1" into module_part array.
 
 print_date_range ($date_start, $date_end, $format='', $outputlangs=null)
 Format output for start and end date.
 
 get_date_range ($date_start, $date_end, $format='', $outputlangs=null, $withparenthesis=1)
 Format output for start and end date.
 
 dolGetFirstLastname ($firstname, $lastname, $nameorder=-1)
 Return firstname and lastname in correct order.
 
 setEventMessage ($mesgs, $style='mesgs', $noduplicate=0, $attop=0)
 Set event message in dol_events session object.
 
 setEventMessages ($mesg, $mesgs, $style='mesgs', $messagekey='', $noduplicate=0, $attop=0)
 Set event messages in dol_events session object.
 
 dol_htmloutput_events ($disabledoutputofmessages=0)
 Print formatted messages to output (Used to show messages on html output).
 
 get_htmloutput_mesg ($mesgstring='', $mesgarray=[], $style='ok', $keepembedded=0)
 Get formatted messages to output (Used to show messages on html output).
 
 get_htmloutput_errors ($mesgstring='', $mesgarray=array(), $keepembedded=0)
 Get formatted error messages to output (Used to show messages on html output).
 
 dol_htmloutput_mesg ($mesgstring='', $mesgarray=array(), $style='ok', $keepembedded=0)
 Print formatted messages to output (Used to show messages on html output).
 
 dol_htmloutput_errors ($mesgstring='', $mesgarray=array(), $keepembedded=0)
 Print formatted error messages to output (Used to show messages on html output).
 
 dol_sort_array (&$array, $index, $order='asc', $natsort=0, $case_sensitive=0, $keepindex=0)
 Advanced sort array by the value of a given key, which produces ascending (default) or descending output and uses optionally natural case insensitive sorting (which can be optionally case sensitive as well).
 
 utf8_check ($str)
 Check if a string is in UTF8.
 
 utf8_valid ($str)
 Check if a string is in UTF8.
 
 ascii_check ($str)
 Check if a string is in ASCII.
 
 dol_osencode ($str)
 Return a string encoded into OS filesystem encoding.
 
 dol_getIdFromCode ($db, $key, $tablename, $fieldkey='code', $fieldid='id', $entityfilter=0, $filters='', $useCache=true)
 Return an id or code from a code or id.
 
 isStringVarMatching ($var, $regextext, $matchrule=1)
 Check if a variable with name $var start with $regextext.
 
 verifCond ($strToEvaluate, $onlysimplestring='1')
 Verify if condition in string is ok or not.
 
 dol_eval ($s, $returnvalue=1, $hideerrors=1, $onlysimplestring='1')
 Replace eval function to add more security.
 
 dol_eval_new ($s)
 Replace eval function to add more security.
 
 dol_eval_standard ($s, $hideerrors=1, $onlysimplestring='1')
 Replace eval function to add more security.
 
 dol_validElement ($element)
 Return if var element is ok.
 
 picto_from_langcode ($codelang, $moreatt='', $notitlealt=0)
 Return img flag of country for a language code or country code.
 
 getLanguageCodeFromCountryCode ($countrycode)
 Return default language from country code.
 
 complete_head_from_modules ($conf, $langs, $object, &$head, &$h, $type, $mode='add', $filterorigmodule='')
 Complete or removed entries into a head array (used to build tabs).
 
 printCommonFooter ($zone='private')
 Print common footer : conf->global->MAIN_HTML_FOOTER js for switch of menu hider js for conf->global->MAIN_GOOGLE_AN_ID js for conf->global->MAIN_SHOW_TUNING_INFO or $_SERVER["MAIN_SHOW_TUNING_INFO"] js for conf->logbuffer.
 
 dolExplodeIntoArray ($string, $delimiter=';', $kv='=')
 Split a string with 2 keys into key array.
 
 dolExplodeKeepIfQuotes ($input)
 Explode a search string into an array but do not explode when keys are inside quotes.
 
 dol_set_focus ($selector)
 Set focus onto field with selector (similar behaviour of 'autofocus' HTML5 tag)
 
 dol_getmypid ()
 Return getmypid() or random PID when function is disabled Some web hosts disable this php function for security reasons and sometimes we can't redeclare function.
 
 natural_search ($fields, $value, $mode=0, $nofirstand=0, $sqltoadd='')
 Generate natural SQL search string for a criteria (this criteria can be tested on one or several fields)
 
 showSimpleOrderTable ($outputlangs, $object)
 Returns simple order table template as string.
 

Variables

const MODULE_MAPPING array( 'adherent' => 'member', 'member_type' => 'adherent_type', 'banque' => 'bank', 'contrat' => 'contract', 'entrepot' => 'stock', 'projet' => 'project', 'categorie' => 'category', 'commande' => 'order', 'expedition' => 'shipping', 'facture' => 'invoice', 'fichinter' => 'intervention', 'ficheinter' => 'intervention', 'propale' => 'propal', 'societe' => 'thirdparty', 'socpeople' => 'contact', 'fournisseur' => 'supplier', 'actioncomm' => 'agenda', 'product_price' => 'productprice', 'product_fournisseur_price' => 'productsupplierprice', )
 This mapping defines the conversion to the current internal names from the alternative allowed names (including effectively deprecated and future new names (not yet used as internal names).
 

Detailed Description

A set of functions for Dolibarr This file contains all frequently used functions.

Definition in file functions.lib.php.

Function Documentation

◆ ascii_check()

ascii_check ( $str)

Check if a string is in ASCII.

Parameters
string$strString to check
Returns
boolean True if string is ASCII, False if not (byte value > 0x7F)

Definition at line 11767 of file functions.lib.php.

Referenced by CMailFile\__construct(), dolDecrypt(), Login\index(), and CMailFile\sendfile().

◆ complete_head_from_modules()

complete_head_from_modules ( $conf,
$langs,
$object,
& $head,
& $h,
$type,
$mode = 'add',
$filterorigmodule = '' )

Complete or removed entries into a head array (used to build tabs).

For example, with value added by external modules. Such values are declared into $conf->modules_parts['tab']. Or by change using hook completeTabsHead

Parameters
Conf$confObject conf
Translate$langsObject langs
?Object$objectObject object
array<array{0:string,1:string,2:string}>$head List of head tabs (updated by this function)
int$hNew position to fill (updated by this function)
string$typeValue for object where objectvalue can be 'thirdparty' to add a tab in third party view 'intervention' to add a tab in intervention view 'supplier_order' to add a tab in purchase order view 'supplier_invoice' to add a tab in purchase invoice view 'invoice' to add a tab in sales invoice view 'order' to add a tab in sales order view 'contract' to add a table in contract view 'product' to add a tab in product view 'propal' to add a tab in propal view 'user' to add a tab in user view 'group' to add a tab in group view 'member' to add a tab in foundation member view 'categories_x' to add a tab in category view ('x': type of category (0=product, 1=supplier, 2=customer, 3=member) 'ecm' to add a tab for another ecm view 'stock' to add a tab for warehouse view
'add'|'remove'$mode 'add' to complete head, 'remove' to remove entries
string$filterorigmoduleFilter on module origin: 'external' will show only external modules. 'core' only core modules. No filter (default) will add both.
Returns
void

Definition at line 12901 of file functions.lib.php.

Referenced by account_statement_prepare_head(), accounting_prepare_head(), accounting_transaction_prepare_head(), accountingTransactionTemplatePrepareHead(), actions_prepare_head(), adminProductAttributePrepareHead(), agenda_prepare_head(), aiAdminPrepareHead(), assetAdminPrepareHead(), assetModelPrepareHead(), assetPrepareHead(), availabilitiesPrepareHead(), bank_admin_prepare_head(), bank_prepare_head(), blockedlogadmin_prepare_head(), bomAdminPrepareHead(), bomPrepareHead(), bon_prelevement_prepare_head(), bookcalAdminPrepareHead(), calendarPrepareHead(), calendars_prepare_head(), categories_prepare_head(), categoriesadmin_prepare_head(), commande_prepare_head(), company_admin_prepare_head(), conferenceorboothAttendeePrepareHead(), conferenceorboothPrepareHead(), conferenceorboothProjectPrepareHead(), conferenceorboothThirdpartyPrepareHead(), contact_prepare_head(), contract_admin_prepare_head(), contract_prepare_head(), cron_prepare_head(), cronadmin_prepare_head(), datapolicyAdminPrepareHead(), dav_admin_prepare_head(), defaultvalues_prepare_head(), delivery_prepare_head(), donation_admin_prepare_head(), donation_prepare_head(), ecm_admin_prepare_head(), ecm_prepare_dasboard_head(), email_admin_prepare_head(), emailcollectorPrepareHead(), emailing_prepare_head(), establishment_prepare_head(), evaluationPrepareHead(), eventorganizationAdminPrepareHead(), expedition_admin_prepare_head(), expedition_prepare_head(), expensereport_admin_prepare_head(), expensereport_prepare_head(), facture_prepare_head(), facturefourn_prepare_head(), fichinter_admin_prepare_head(), fichinter_prepare_head(), fichinter_rec_prepare_head(), fiscalyear_prepare_head(), group_prepare_head(), holiday_admin_prepare_head(), holiday_prepare_head(), hrm_admin_prepare_head(), hrmAdminPrepareHead(), ihm_prepare_head(), intracommreportAdminPrepareHead(), intracommreportPrepareHead(), inventoryAdminPrepareHead(), inventoryPrepareHead(), invoice_admin_prepare_head(), invoice_rec_prepare_head(), jobPrepareHead(), knowledgemanagementAdminPrepareHead(), knowledgerecordPrepareHead(), ldap_prepare_head(), loan_prepare_head(), marges_admin_prepare_head(), marges_prepare_head(), member_admin_prepare_head(), member_prepare_head(), member_stats_prepare_head(), member_type_prepare_head(), membership_stats_prepare_head(), memoPrepareHead(), modulehelp_prepare_head(), moPrepareHead(), mrpAdminPrepareHead(), multicurrencyAdminPrepareHead(), mymoduleAdminPrepareHead(), myobjectPrepareHead(), oauthadmin_prepare_head(), opensurvey_prepare_head(), order_admin_prepare_head(), ordersupplier_prepare_head(), partnershipAdminPrepareHead(), partnershipPrepareHead(), payment_expensereport_prepare_head(), paypaladmin_prepare_head(), pdf_admin_prepare_head(), positionCardPrepareHead(), prelevement_prepare_head(), product_admin_prepare_head(), product_lot_admin_prepare_head(), product_prepare_head(), productAttributePrepareHead(), productlot_prepare_head(), project_admin_prepare_head(), project_prepare_head(), project_timesheet_prepare_head(), propal_admin_prepare_head(), propal_prepare_head(), quickmemoAdminPrepareHead(), reception_admin_prepare_head(), reception_prepare_head(), recruitmentAdminPrepareHead(), recruitmentCandidaturePrepareHead(), recruitmentjobpositionPrepareHead(), resource_admin_prepare_head(), resource_prepare_head(), shipping_prepare_head(), skilldetPrepareHead(), skillPrepareHead(), skillrankPrepareHead(), societe_admin_prepare_head(), societe_prepare_head(), stock_admin_prepare_head(), stock_prepare_head(), stocktransferAdminPrepareHead(), stocktransferPrepareHead(), stripeadmin_prepare_head(), subscription_prepare_head(), supplier_invoice_admin_prepare_head(), supplier_invoice_rec_prepare_head(), supplier_proposal_admin_prepare_head(), supplier_proposal_prepare_head(), supplierorder_admin_prepare_head(), takepos_admin_prepare_head(), targetPrepareHead(), task_prepare_head(), tax_prepare_head(), ticket_prepare_head(), ticketAdminPrepareHead(), translation_prepare_head(), triggerhistoryPrepareHead(), user_admin_prepare_head(), user_prepare_head(), various_payment_prepare_head(), vat_prepare_head(), webhookAdminPrepareHead(), webportalAdminPrepareHead(), websiteaccountPrepareHead(), websiteconfigPrepareHead(), workstationAdminPrepareHead(), workstationPrepareHead(), and zapierAdminPrepareHead().

◆ complete_substitutions_array()

complete_substitutions_array ( & $substitutionarray,
$outputlangs,
$object = null,
$parameters = null,
$callfunc = "completesubstitutionarray" )

Complete the $substitutionarray with more entries coming from external module that had set the "substitutions=1" into module_part array.

In this case, method completesubstitutionarray provided by module is called.

Parameters
array<string,string|float|null>$substitutionarray Array substitution old value => new value value
Translate$outputlangsOutput language
?CommonObject$objectSource object
?mixed$parametersAdd more parameters (useful to pass product lines)
string$callfuncWhat is the name of the custom function that will be called? (default: completesubstitutionarray)
Returns
void
See also
make_substitutions()

Definition at line 11200 of file functions.lib.php.

Referenced by BordereauChequeBlochet\_pagefoot(), Facture\create(), FactureFournisseur\create(), FactureRec\createRecurringInvoices(), PartnershipUtils\doCancelStatusOfMemberPartnership(), PartnershipUtils\doWarningOfPartnershipIfDolibarrBacklinkNotfound(), Adherent\makeSubstitution(), EmailCollector\overwritePropertiesOfObject(), pdf_pagefoot(), pdf_watermark(), Notify\send(), ActionComm\sendEmailsReminder(), Facture\sendEmailsRemindersOnInvoiceDueDate(), FactureFournisseur\sendEmailsRemindersOnSupplierInvoiceDueDate(), Holiday\sendPreviousMonthHRInformations(), Adherent\sendReminderForExpiredSubscription(), ActionComm\sendSmsReminder(), FormAI\setSubstitFromObject(), pdf_octopus\tableFirstPage(), doc_generic_asset_odt\write_file(), doc_generic_member_odt\write_file(), doc_generic_odt\write_file(), doc_generic_product_odt\write_file(), doc_generic_project_odt\write_file(), doc_generic_stock_odt\write_file(), doc_generic_ticket_odt\write_file(), doc_generic_user_odt\write_file(), doc_generic_usergroup_odt\write_file(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_baleine\write_file(), pdf_beluga\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_soleil\write_file(), pdf_sponge\write_file(), pdf_standard\write_file(), pdf_standard_asset\write_file(), pdf_standard_expensereport\write_file(), pdf_standard_member\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_standard_stock\write_file(), pdf_strato\write_file(), pdf_timespent\write_file(), pdf_vinci\write_file(), and pdf_zenith\write_file().

◆ dol_buildpath()

dol_buildpath ( $path,
$type = 0,
$returnemptyifnotfound = 0 )

Return path of url or filesystem.

Can check into alternate dir or alternate dir + main dir depending on value of $returnemptyifnotfound.

Parameters
string$pathRelative path to file (if mode=0) or relative url (if mode=1). Ie: mydir/myfile, ../myfile
int$type0=Used for a Filesystem path, 1=Used for an URL path (output relative), 2=Used for an URL path (output full path using same host that current url), 3=Used for an URL path (output full path using host defined into $dolibarr_main_url_root of conf file, for an access from internet)
int$returnemptyifnotfound0:If $type==0 and if file was not found into alternate dir, return default path into main dir (no test on it) 1:If $type==0 and if file was not found into alternate dir, return empty string 2:If $type==0 and if file was not found into alternate dir, test into main dir, return default path if found, empty string if not found
Returns
string Full filesystem path (if path=0) or '' if file not found, Full url path (if mode=1)

Definition at line 1640 of file functions.lib.php.

Referenced by Context\__construct(), aiAdminPrepareHead(), ajouter_sondage(), ToolProducts\analyze(), checkLoginPassEntity(), CommonObject\commonGenerateDocument(), ActionsMyModule\completeTabsHead(), InterfaceTicketEmail\composeAndSendCustomerMessage(), ToolCategories\createCategory(), Project\createFromClone(), doc_label_pdf_create(), evaluationPrepareHead(), ToolNavigation\execute(), fichinter_create(), CommonObject\formAddObjectLine(), ProductAttribute\formAddObjectLine(), Utils\generateDoc(), get_left_menu_home(), getAiChatAssistantConfig(), DolibarrCollector\getAssets(), Canvas\getCanvas(), ToolCategories\getCategoryDetails(), DolibarrModules\getChangeLog(), Ticket\getDefaultRef(), DolibarrModules\getDescLong(), DolibarrModules\getDescLongReadmeFound(), ToolProducts\getDetails(), MailingTargets\getEmailingSelectorsList(), Translate\getLabelFromNumber(), ConferenceOrBoothAttendee\getNextNumRef(), ExpenseReport\getNextNumRef(), Facture\getNextNumRef(), FactureFournisseur\getNextNumRef(), Fichinter\getNextNumRef(), KnowledgeRecord\getNextNumRef(), Mo\getNextNumRef(), MyObject\getNextNumRef(), Paiement\getNextNumRef(), PaiementFourn\getNextNumRef(), Partnership\getNextNumRef(), Position\getNextNumRef(), ProductFournisseurPrice\getNextNumRef(), RecruitmentJobPosition\getNextNumRef(), RemiseCheque\getNextNumRef(), Skill\getNextNumRef(), Skilldet\getNextNumRef(), StockTransfer\getNextNumRef(), StockTransferLine\getNextNumRef(), Target\getNextNumRef(), TimeSpent\getNextNumRef(), Workstation\getNextNumRef(), Asset\getNomUrl(), AssetModel\getNomUrl(), Availabilities\getNomUrl(), EmailCollectorAction\getNomUrl(), EmailCollectorFilter\getNomUrl(), Evaluation\getNomUrl(), EvaluationLine\getNomUrl(), IntracommReport\getNomUrl(), Inventory\getNomUrl(), Job\getNomUrl(), KnowledgeRecord\getNomUrl(), MyObject\getNomUrl(), Position\getNomUrl(), ProductAttribute\getNomUrl(), ProductFournisseurPrice\getNomUrl(), Project\getNomUrl(), Skill\getNomUrl(), Skilldet\getNomUrl(), SkillRank\getNomUrl(), StockTransfer\getNomUrl(), StockTransferLine\getNomUrl(), TimeSpent\getNomUrl(), Context\getRootConfigUrl(), ToolProducts\getSupplierPrices(), Interfaces\getTriggersList(), ModeleBoxes\getWidgetsList(), DolibarrModules\insert_module_parts(), intracommreportAdminPrepareHead(), intracommreportPrepareHead(), inventoryPrepareHead(), jobPrepareHead(), PrintingDriver\listDrivers(), llxHeaderTicket(), ActionsMyModule\loadDataForCustomReports(), members_card_pdf_create(), memoPrepareHead(), mymoduleAdminPrepareHead(), myobjectPrepareHead(), Ticket\newMessage(), positionCardPrepareHead(), Projects\post(), Tasks\post(), print_auguria_menu(), print_eldy_menu(), print_left_auguria_menu(), LinkField\printInputField(), CommonObject\printObjectLine(), ProductAttribute\printObjectLine(), CommonObject\printObjectLines(), ProductAttribute\printObjectLines(), CommonObject\printOriginLine(), ToolCategories\resolveCategoryIdFromName(), Interfaces\run_triggers(), ToolProducts\search(), ToolCategories\searchCategories(), FormCompany\select_state_ajax(), FormCompany\selectCompaniesForNewContact(), FormProjets\selectInvoiceAndLine(), sendMail(), Documentation\setMenu(), Conf\setValues(), show_skin(), showDirectPublicLink(), FormFile\showdocuments(), Form\showLinkedObjectBlock(), MenuManager\showmenu(), showSkins(), skilldetPrepareHead(), skillPrepareHead(), skillrankPrepareHead(), stocktransferAdminPrepareHead(), stocktransferPrepareHead(), top_htmlhead(), Lettering\updateGeneralMatching(), and ActionsTicket\viewTicketMessages().

◆ dol_clone()

dol_clone ( $srcobject,
$native = 2 )

Create a clone of instance of object (new instance with same value for each properties) With native = 0: Deprecated.

Property that are references are different memory area in the new object (full isolation clone). This means $this->objectproperty of the new object may not be valid (except this->db that is voluntarly kept). With native = 1: Use PHP clone. Property that are reference are same pointer. This means $this->db of new object is still valid but point to same this->db than original object. With native = 2: Property that are reference are different memory area in the new object (full isolation clone). Only scalar and array values are cloned. This means that the methods are not available and $this->db of new object is not valid. You can use it with: $object->oldcopy = dol_clone($object, 2); // @phan-suppress-current-line PhanTypeMismatchProperty

@template T

Parameters
T$srcobjectObject to clone
int$native0=Full isolation method, 1=Native PHP method, 2=Full isolation method keeping only scalar and array properties (recommended)
Returns
T Clone object
See also
https://php.net/manual/language.oop5.cloning.php @phan-suppress PhanTypeExpectedObjectPropAccess

Definition at line 1823 of file functions.lib.php.

Referenced by MouvementStock\_createSubProduct(), Ticket\assignUser(), Ticket\close(), CommonObject\fetch_optionals(), Product\load_virtual_stock(), Ticket\markAsRead(), Products\put(), InterfaceZapierTriggers\runTrigger(), sendMail(), Fichinter\setDraft(), Facture\setInputReason(), CommonObject\setPaymentMethods(), Ticket\setReadDate(), Fichinter\setRefClient(), CommonObject\setStatut(), ContratLigne\update(), Dolresource\update(), Facture\update(), Product\update(), and Productlot\update().

◆ dol_clone_in_array()

dol_clone_in_array ( $srcobject,
$startlevel = 0 )

Create a clone of instance of object into a full array, using recursive call.

It also cleans some properties.

Parameters
Object$srcobjectObject to clone
int$startlevelStart level to track recursive depth
Returns
array<string,mixed> Array

Definition at line 1868 of file functions.lib.php.

Referenced by InterfaceWebhookTriggers\runTrigger().

◆ dol_concat()

dol_concat ( $text1,
$text2 )

Concat 2 strings.

Can be used for dol_eval strings for example.

Parameters
string$text1Text 1
string$text2Text 2
Returns
string Text 1 + new line + Text2
See also
dol_textishtml()

Definition at line 10154 of file functions.lib.php.

◆ dol_concatdesc()

dol_concatdesc ( $text1,
$text2,
$forxml = false,
$invert = false )

Concat 2 descriptions with a new line between them (second operand after first one with appropriate new line separator) text1 html + text2 html => text1 + '
' + text2 text1 html + text2 txt => text1 + '
' + dol_nl2br(text2) text1 txt + text2 html => dol_nl2br(text1) + '
' + text2 text1 txt + text2 txt => text1 + '
' + text2.

Parameters
string$text1Text 1
string$text2Text 2
bool$forxmltrue=Use
instead of
if we have to add a br tag
bool$invertinvert order of description lines (we often use config MAIN_CHANGE_ORDER_CONCAT_DESCRIPTION in this parameter)
Returns
string Text 1 + new line + Text2
See also
dol_textishtml()

Definition at line 10131 of file functions.lib.php.

Referenced by Propal\classifyBilled(), Propal\closeProposal(), RecruitmentJobPosition\cloture(), CommandeFournisseur\commande(), constructGanttLine(), Facture\create(), FactureFournisseur\create(), doc_getlinedesc(), Societe\mergeCompany(), Adherent\mergeMembers(), Task\mergeTask(), pdf_getlinedesc(), InterfaceActionsAuto\runTrigger(), Adherent\sendReminderForExpiredSubscription(), pdf_octopus\tableFirstPage(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_soleil\write_file(), pdf_sponge\write_file(), pdf_standard_asset\write_file(), pdf_standard_expensereport\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_storm\write_file(), pdf_strato\write_file(), pdf_vinci\write_file(), and pdf_zenith\write_file().

◆ dol_escape_all()

dol_escape_all ( $stringtoescape)

Returns text escaped for all protocols (so only alpha chars and numbers)

Parameters
string$stringtoescapeString to escape
Returns
string Escaped string for XML content.

Definition at line 2357 of file functions.lib.php.

Referenced by Export\build_filterField(), and DolEditor\Create().

◆ dol_escape_htmltag()

dol_escape_htmltag ( $stringtoescape,
$keepb = 0,
$keepn = 0,
$noescapetags = '',
$escapeonlyhtmltags = 0,
$cleanalsojavascript = 0 )

Returns text escaped for inclusion in HTML alt or title or value tags, or into values of HTML input fields.

When we need to output strings on pages, we should use:

  • dolPrintLabel...
  • dolPrintHTML... that is dol_escape_htmltag(dol_htmlwithnojs(dol_string_onlythesehtmltags(dol_htmlentitiesbr(...), 1, 1, 1, 0)), 1, 1, 'common', 0, 1) for notes or descriptions into textarea, add 'common' if into a html content
  • dolPrintPassword that is a simple htmlspecialchars(... , ENT_COMPAT, 'UTF-8') for passwords.
Parameters
string$stringtoescapeString to escape
int$keepb1=Replace b tags with escaped value (except if in $noescapetags), 0=Remove them completely
int$keepn1=Preserve \r
strings, 0=Replace them with escaped value, -1=Remove them. Set to 1 when escaping for a <textarea>.
string$noescapetags'' (escape all html tags) or 'common' (do not escape some common tags) or 'common,a,b,c' or list of tags to not escape.
int$escapeonlyhtmltags1=Escape only html tags and double quotes, not the special chars like accents.
int$cleanalsojavascriptClean also javascript. @TODO switch this option to 1 by default.
Returns
string Escaped string
See also
dol_string_nohtmltag(), dol_string_onlythesehtmltags(), dol_string_nospecial(), dol_string_unaccent(), dol_htmlentitiesbr()

Definition at line 2510 of file functions.lib.php.

Referenced by pdf_standard_myobject\_pagehead(), ActionsStripeconnect\addMoreActionsButtons(), barcode_encode(), modPhpbarcode\buildBarCode(), Form\buttonsSaveCancel(), Form\constructProductListOption(), DolEditor\Create(), Documentation\docHeader(), DolGraph\draw_chart(), DolGraph\draw_jflot(), Form\editfieldval(), Form\form_conditions_reglement(), form_constantes(), Form\form_date(), Form\form_modes_reglement(), Form\form_remise_dispo(), Form\formconfirm(), mailing_contacts1\formFilter(), mailing_partnership\formFilter(), mailing_thirdparties\formFilter(), FormProjets\formOpportunityStatus(), FormSetup\generateAttributesStringFromArray(), FormSetup\generateOutput(), FormMail\get_form(), ExternalModules\get_next_link(), ExternalModules\get_previous_link(), getAiChatAssistantHtml(), ExternalModules\getCategories(), FormCategory\getFilterBox(), FormOther\getHTMLScannerForm(), DolibarrModules\getKanbanView(), Holiday\getKanbanView(), Product\getKanbanView(), Setup\getModulesList(), AccountingAccount\getNomUrl(), ActionComm\getNomUrl(), Adherent\getNomUrl(), Asset\getNomUrl(), BonPrelevement\getNomUrl(), BookkeepingTemplate\getNomUrl(), Commande\getNomUrl(), CommandeFournisseur\getNomUrl(), DiscountAbsolute\getNomUrl(), Don\getNomUrl(), EcmDirectory\getNomUrl(), EcmFiles\getNomUrl(), FactureFournisseur\getNomUrl(), FactureFournisseurRec\getNomUrl(), FactureRec\getNomUrl(), FichinterRec\getNomUrl(), Localtax\getNomUrl(), PaymentDonation\getNomUrl(), PaymentExpenseReport\getNomUrl(), PaymentLoan\getNomUrl(), PaymentSocialContribution\getNomUrl(), PaymentVAT\getNomUrl(), Position\getNomUrl(), ProductAttribute\getNomUrl(), Propal\getNomUrl(), Societe\getNomUrl(), Subscription\getNomUrl(), SupplierProposal\getNomUrl(), WebPortalInvoice\getNomUrl(), WebPortalMember\getNomUrl(), WebPortalOrder\getNomUrl(), WebPortalPartnership\getNomUrl(), WebPortalPropal\getNomUrl(), ExternalModules\getPagination(), ExternalModules\getProducts(), getRankOrderResults(), getSocialNetworkSharingLinks(), ActionComm\getTooltipContentArray(), Cronjob\getTooltipContentArray(), Societe\getTooltipContentArray(), ViewImageController\init(), left_menu(), FormFile\list_of_autoecmfiles(), FormFile\list_of_documents(), FormFile\listOfLinks(), Form\load_tva(), box_boms\loadBox(), box_clients\loadBox(), box_commandes\loadBox(), box_contacts\loadBox(), box_contracts\loadBox(), box_dolibarr_state_board\loadBox(), box_factures\loadBox(), box_factures_fourn\loadBox(), box_factures_fourn_imp\loadBox(), box_factures_imp\loadBox(), box_fediverse\loadBox(), box_ficheinter\loadBox(), box_fournisseurs\loadBox(), box_last_knowledgerecord\loadBox(), box_last_modified_knowledgerecord\loadBox(), box_last_modified_ticket\loadBox(), box_last_ticket\loadBox(), box_members_by_tags\loadBox(), box_members_by_type\loadBox(), box_members_last_modified\loadBox(), box_members_last_subscriptions\loadBox(), box_mos\loadBox(), box_produits\loadBox(), box_propales\loadBox(), box_prospect\loadBox(), box_services_contracts\loadBox(), box_services_expired\loadBox(), box_supplier_orders\loadBox(), main_area(), EmailCollector\overwritePropertiesOfObject(), print_auguria_menu(), print_eldy_menu(), print_text_menu_entry(), print_text_menu_entry_auguria(), print_text_menu_entry_empty(), printDropdownBookmarksList(), FormListWebPortal\printSearchInput(), projectLinesPerAction(), projectLinesPerDay(), projectLinesPerWeek(), Form\searchComponent(), FormAccounting\select_accounting_category(), Form\select_all_categories(), FormAccounting\select_auxaccount(), Form\select_company(), Form\select_contact(), Form\select_dolresources_forevent(), Form\select_dolusers(), Form\select_dolusers_forevent(), FormIntervention\select_interventions(), FormAdmin\select_language(), FormAdmin\select_menu(), Form\select_produits_fournisseurs_list(), Form\select_thirdparty_list(), FormEcm\selectAllSections(), Form\selectarray(), FormWebPortal\selectarray(), Form\selectAvailabilityDelay(), Form\selectCategories(), FormCompany\selectCompaniesForNewContact(), Form\selectCurrency(), Form\selectDate(), FormFiscalYear\selectFiscalYear(), Form\selectForFormsList(), FormTicket\selectGroupTickets(), Form\selectMassAction(), FormCompany\selectProspectStatus(), FormProjets\selectTasks(), FormAdmin\selectTypeOfFields(), Utils\sendBackup(), Adherent\sendReminderForExpiredSubscription(), show_actions_done(), show_contacts(), CommonObject\show_photos(), show_projects(), show_subsidiaries(), FormFile\showdocuments(), CommonObject\showInputField(), ExtraFields\showInputField(), FormWebPortal\showInputFieldForObject(), Form\showLinkToObjectBlock(), FormTicket\showMessageForm(), ExtraFields\showOutputField(), Form\showPhoneInput(), showSkins(), showSocialNetwork(), Form\textwithtooltip(), Diff\toHTML(), top_menu(), top_menu_user(), and treeOutputForAbsoluteDir().

◆ dol_escape_js()

dol_escape_js ( $stringtoescape,
$mode = 0,
$noescapebackslashn = 0 )

◆ dol_escape_json()

dol_escape_json ( $stringtoescape)

Returns text escaped for inclusion into javascript code.

Parameters
string$stringtoescapeString to escape
Returns
string Escaped string for JSON content.

Definition at line 2318 of file functions.lib.php.

Referenced by getStructuredData().

◆ dol_escape_php()

dol_escape_php ( $stringtoescape,
$stringforquotes = 2 )

Returns text escaped for inclusion into a php string, build with double quotes " or '.

Parameters
string$stringtoescapeString to escape
int<1,2>$stringforquotes 2=String for doublequotes, 1=String for simple quotes
Returns
string Escaped string for PHP content.

Definition at line 2330 of file functions.lib.php.

Referenced by rebuildObjectClass(), and write_conf_file().

◆ dol_escape_uri()

dol_escape_uri ( $stringtoescape)

Returns text escaped by RFC 3986 for inclusion into a clickable link.

This method can be used on the ...in links like href="javascript:..." because when clicking on such links, the browserfirst decode the strind and then interpret content that can be javascript. Usage of this escapement should be limited to links href="javascript:...". For common URL, use urlencode instead.

Parameters
string$stringtoescapeString to escape
Returns
string Escaped string.

Definition at line 2307 of file functions.lib.php.

◆ dol_escape_xml()

dol_escape_xml ( $stringtoescape)

Returns text escaped for inclusion into a XML string.

Parameters
string$stringtoescapeString to escape
Returns
string Escaped string for XML content.

Definition at line 2368 of file functions.lib.php.

Referenced by build_rssfile().

◆ dol_eval()

dol_eval ( $s,
$returnvalue = 1,
$hideerrors = 1,
$onlysimplestring = '1' )

Replace eval function to add more security.

This function is called by verifCond() for example.

Parameters
string$sString to evaluate
int<0,1>$returnvalue 0=No return (deprecated, used to execute eval($a=something)). 1=Value of eval is returned (used to eval($something)).
int<0,1>$hideerrors 1=Hide errors
string$onlysimplestring'0' (deprecated, do not use it anymore) = Accept all chars, '1' (most common use, recommended) = Accept only simple string with char 'a-z0-9\s^$_+-.*>&|=!?():"\',/@';', '2' (used for example for the compute property of extrafields) = Accept also '<[]'
Returns
string Return result of eval (even if type can be int, it is safer to assume string and find all potential typing issues as abs(dol_eval(...)).
See also
verifCond(), checkPHPCode() to see sanitizing rules that should be very close. @phan-suppress PhanPluginUnsafeEval

Definition at line 11947 of file functions.lib.php.

Referenced by InterfaceTicketEmail\composeAndSendCustomerMessage(), Facture\fetch(), FactureLigne\fetch(), Facture\fetch_lines(), CommonObject\fetch_optionals(), fillArrayOfFilterFields(), fillArrayOfGroupBy(), fillArrayOfMeasures(), fillArrayOfXAxis(), CommonObject\getTooltipContent(), CommonObject\insertExtraFields(), CommonObject\isObjectUsed(), box_scheduled_jobs\loadBox(), Form\selectForFormsList(), FormListWebPortal\setArrayFields(), FieldsManager\setCommonFieldInfos(), CommonObject\setValuesForExtraLanguages(), ExtraFields\showInputField(), CommonObject\showOptionals(), ExtraFields\showOutputField(), and CommonObject\updateExtraField().

◆ dol_eval_new()

dol_eval_new ( $s)

Replace eval function to add more security.

This function is called by dol_eval(), itself called by verifCond() or trans() and transnoentitiesnoconv().

Parameters
string$sString to evaluate
Returns
void|string Nothing or return result of eval (even if type can be int, it is safer to assume string and find all potential typing issues as abs(dol_eval(...)). If we return a string on error, it must start with 'Bad call of ...' or 'Bad string syntax to evaluate...' !!!
See also
verifCond(), checkPHPCode() to see sanitizing rules that should be very close. @phan-suppress PhanPluginUnsafeEval

Definition at line 11970 of file functions.lib.php.

◆ dol_eval_standard()

dol_eval_standard ( $s,
$hideerrors = 1,
$onlysimplestring = '1' )

Replace eval function to add more security.

This function is called by dol_eval(), itself called by verifCond() or trans() and transnoentitiesnoconv().

Parameters
string$sString to evaluate with eval($something)
int<0,1>$hideerrors 1=Hide errors
string$onlysimplestring'0' (deprecated, do not use it anymore)=Accept all chars, '1' (most common use)=Accept only simple string with char 'a-z0-9\s^$_+-.*>&|=!?():"\',/@';', '2' (used for example for the compute property of extrafields)=Accept also '<[]'
Returns
void|string Nothing or return result of eval (even if type can be int, it is safer to assume string and find all potential typing issues as abs(dol_eval(...)). If we return a string on error, it must start with 'Bad call of'... or 'Bad string syntax'... or 'Exception'... !!!
See also
verifCond(), checkPHPCode() to see sanitizing rules that should be very close. @phan-suppress PhanPluginUnsafeEval

Definition at line 12251 of file functions.lib.php.

◆ dol_fiche_end()

dol_fiche_end ( $notab = 0)

Show tab footer of a card.

Parameters
int<-1,1>$notab -1 or 0=Add tab footer, 1=no tab footer
Returns
void
Deprecated
Use print dol_get_fiche_end() instead

Definition at line 3312 of file functions.lib.php.

◆ dol_fiche_head()

dol_fiche_head ( $links = array(),
$active = '0',
$title = '',
$notab = 0,
$picto = '',
$pictoisfullpath = 0,
$morehtmlright = '',
$morecss = '',
$limittoshow = 0,
$moretabssuffix = '' )

Show tab header of a card.

Parameters
array<int,array<int<0,5>,string>>$links Array of tabs (0=>url, 1=>label, 2=>code, 3=>not used, 4=>text after link, 5=>morecssonlink). Currently initialized by calling a function xxx_admin_prepare_head. Note that label into $links[$i][1] must be already HTML escaped.
string$activeActive tab name (document', 'info', 'ldap', ....)
string$titleTitle
int$notab-1 or 0=Add tab header, 1=no tab header (if you set this to 1, using print dol_get_fiche_end() to close tab is not required), -2=Add tab header with no sepaaration under tab (to start a tab just after), -3=Add tab header but no footer separation
string$pictoAdd a picto on tab title
int$pictoisfullpathIf 1, image path is a full path. If you set this to 1, you can use url returned by dol_buildpath('/mymodule/img/myimg.png',1) for $picto.
string$morehtmlrightAdd more html content on right of tabs title
string$morecssMore Css
int$limittoshowLimit number of tabs to show. Use 0 to use automatic default value.
string$moretabssuffixA suffix to use when you have several dol_get_fiche_head() in same page
Returns
void
Deprecated
Use print dol_get_fiche_head() instead

Definition at line 3103 of file functions.lib.php.

◆ dol_format_address()

dol_format_address ( $object,
$withcountry = 0,
$sep = "\n",
$outputlangs = null,
$mode = 0,
$extralangcode = '' )

Return a formatted address (part address/zip/town/state) according to country rules.

See https://en.wikipedia.org/wiki/Address

Parameters
Object$objectA company or contact object
int$withcountry1=Add country into address string
string$sepSeparator to use to separate info when building string
?Translate$outputlangsObject lang that contains language for text translation.
int$mode0=Standard output, 1=Remove address
string$extralangcodeUser extralanguage $langcode as values for address, town
Returns
string Formatted string
See also
dol_print_address()

Definition at line 3760 of file functions.lib.php.

Referenced by CommonObject\getFullAddress(), Adherent\getTooltipContentArray(), Contact\getTooltipContentArray(), Societe\getTooltipContentArray(), and pdf_build_address().

◆ dol_get_fiche_end()

dol_get_fiche_end ( $notab = 0)

Return tab footer of a card.

Parameters
int<-1,1>$notab -1 or 0=Add tab footer, 1=no tab footer
Returns
string

Definition at line 3323 of file functions.lib.php.

Referenced by ActionsAdherentCardDefault\assign_values(), ActionsCardCommon\assign_values(), ActionsCardProduct\assign_values(), ActionsCardService\assign_values(), ActionsContactCardDefault\assign_values(), displayPositionCard(), journalHead(), and report_header().

◆ dol_get_fiche_head()

dol_get_fiche_head ( $links = array(),
$active = '',
$title = '',
$notab = 0,
$picto = '',
$pictoisfullpath = 0,
$morehtmlright = '',
$morecss = '',
$limittoshow = 0,
$moretabssuffix = '',
$dragdropfile = 0,
$morecssdiv = '' )

Show tabs of a record.

Parameters
array<int,array<int<0,5>,string>>$links Array of tabs (0=>url, 1=>label, 2=>code, 3=>not used, 4=>text after link, 5=>morecssonlink). Currently initialized by calling a function xxx_admin_prepare_head. Note that label into $links[$i][1] must be already HTML escaped.
string$activeActive tab name (using the old numeric int is deprecated)
string$titleTitle
int$notab-1 or 0=Add tab header, 1=no tab header (if you set this to 1, using print dol_get_fiche_end() to close tab is not required), -2=Add tab header with no separation under tab (to start a tab just after), -3=-2+'noborderbottom'
string$pictoAdd a picto on tab title
int$pictoisfullpathIf 1, image path is a full path. If you set this to 1, you can use url returned by dol_buildpath('/mymodule/img/myimg.png',1) for $picto.
string$morehtmlrightAdd more html content on right of tabs title
string$morecssMore CSS on the link
int$limittoshowLimit number of tabs to show. Use 0 to use automatic default value.
string$moretabssuffixA suffix to use when you have several dol_get_fiche_head() in same page
int$dragdropfile0 (default) or 1. 1 enable a drop zone for file to be upload, 0 disable it
string$morecssdivMore CSS on the div
Returns
string

Definition at line 3125 of file functions.lib.php.

Referenced by ActionsAdherentCardDefault\assign_values(), ActionsCardCommon\assign_values(), ActionsCardProduct\assign_values(), ActionsCardService\assign_values(), ActionsContactCardDefault\assign_values(), displayPositionCard(), journalHead(), and report_header().

◆ dol_get_object_properties()

dol_get_object_properties ( $obj,
$properties = [] )

Get properties for an object - including magic properties when requested.

Only returns properties that exist

Parameters
object$objObject to get properties from
string[]$propertiesOptional list of properties to get. When empty, only gets public properties.
Returns
array<string,mixed> Hash for retrieved values (key=name)

Definition at line 1781 of file functions.lib.php.

◆ dol_getdate()

dol_getdate ( $timestamp,
$fast = false,
$forcetimezone = '' )

Return an array with locale date info.

WARNING: This function use PHP server timezone by default to return locale information. Be aware to add the third parameter to "UTC" if you need to work on UTC.

Parameters
int$timestampTimestamp
boolean$fastFast mode. deprecated.
string$forcetimezone'' to use the PHP server timezone. Or use a form like 'gmt', 'Europe/Paris' or '+0200' to force timezone.
Returns
array{}|array{seconds:int<0,59>,minutes:int<0,59>,hours:int<0,23>,mday:int<1,31>,wday:int<0,6>,mon:int<1,12>,year:int<0,9999>,yday:int<0,366>,0:int} Array of information 'seconds' => $secs, 'minutes' => $min, 'hours' => $hour, 'mday' => $day, 'wday' => $dow, 0=sunday, 6=saturday 'mon' => $month, 'year' => $year, 'yday' => floor($secsInYear/$_day_power) '0' => original timestamp
See also
dol_print_date(), dol_stringtotime(), dol_mktime()

Definition at line 4162 of file functions.lib.php.

Referenced by modAdherent\__construct(), modFacture\__construct(), modHoliday\__construct(), modMultiCurrency\__construct(), modPartnership\__construct(), modSupplierInvoice\__construct(), DolibarrApiAccess\__isAllowed(), MouvementStock\_create(), Asset\calculationDepreciation(), ExpenseReport\computeTotalKm(), Facture\createFromClone(), FactureFournisseurRec\createRecurringInvoices(), FactureRec\createRecurringInvoices(), Project\createWeeklyReport(), dol_get_first_day_week(), dol_get_first_hour(), dol_get_last_hour(), dol_get_next_day(), dol_get_next_week(), dol_get_prev_day(), dol_get_prev_week(), dolWebsiteIncrementCounter(), Accountancy\exportData(), getCurrentPeriodOfFiscalYear(), MultiCurrency\getIdAndTxFromCode(), FactureRec\getNextDate(), Paiement\getNomUrl(), ActionComm\getTooltipContentArray(), Facture\initAsSpecimen(), FactureFournisseurRec\initAsSpecimen(), FactureRec\initAsSpecimen(), Paiement\initAsSpecimen(), PaiementFourn\initAsSpecimen(), RemiseCheque\initAsSpecimen(), box_birthdays\loadBox(), box_birthdays_members\loadBox(), box_graph_invoices_permonth\loadBox(), box_graph_invoices_peryear\loadBox(), box_graph_invoices_supplier_permonth\loadBox(), box_graph_orders_permonth\loadBox(), box_graph_orders_supplier_permonth\loadBox(), box_graph_product_distribution\loadBox(), box_graph_propales_permonth\loadBox(), projectLinesPerDay(), projectLinesPerWeek(), Holiday\sendPreviousMonthHRInformations(), and Adherent\sendReminderForExpiredSubscription().

◆ dol_getIdFromCode()

dol_getIdFromCode ( $db,
$key,
$tablename,
$fieldkey = 'code',
$fieldid = 'id',
$entityfilter = 0,
$filters = '',
$useCache = true )

Return an id or code from a code or id.

Store also Code-Id into a cache to speed up next request on same table and key.

Parameters
DoliDB$dbDatabase handler
string | int$keyCode (string) or Id (int) to get Id or Code
string$tablenameTable name without prefix. Example 'c_input_method'
string$fieldkeyField to search the key into
string$fieldidField to get
int$entityfilter1=Filter by entity
string$filtersFilters to add. WARNING: string must be escaped for SQL and not coming from user input.
bool$useCacheIf true (default), cache will be queried and updated.
Returns
int<-1,max>|string ID of code if OK, 0 if key empty, -1 if KO
See also
$langs->getLabelFromKey

Definition at line 11826 of file functions.lib.php.

Referenced by pdf_azur\_tableau_info(), Invoices\addPayment(), SupplierInvoices\addPayment(), Invoices\addPaymentDistributed(), Societe\create_from_member(), CommonInvoice\demande_prelevement(), Salary\demande_prelevement(), pdf_cyan\drawInfoTable(), FormProjets\formOpportunityStatus(), CommonDocGenerator\get_substitutionarray_contact(), CommonDocGenerator\get_substitutionarray_mysoc(), CommonDocGenerator\get_substitutionarray_thirdparty(), AccountancyCategory\getAvailableAccountsForCategory(), AccountancyCategory\getCptsCat(), CProductNature\getProductNatureFromCode(), CUnits\getUnitFromCode(), modTakePos\init(), listPublicHoliday(), Form\load_cache_vatrates(), box_funnel_of_prospection\loadBox(), num_public_holiday(), ToolInvoices\payInvoice(), Contacts\post(), Thirdparties\post(), print_projecttasks_array(), RemiseCheque\rejectCheck(), Notify\send(), BlockedLog\setObjectData(), Societe\setThirdpartyType(), Adherent\subscriptionComplementaryActions(), and Societe\update().

◆ dol_getmypid()

dol_getmypid ( )

Return getmypid() or random PID when function is disabled Some web hosts disable this php function for security reasons and sometimes we can't redeclare function.

Returns
int

Definition at line 13425 of file functions.lib.php.

◆ dol_html_entity_decode()

dol_html_entity_decode ( $a,
$b,
$c = 'UTF-8',
$keepsomeentities = 0 )

Replace html_entity_decode functions to manage errors.

Parameters
string$aOperand a
int$bOperand b (ENT_QUOTES|ENT_HTML5=convert simple, double quotes, colon, e accent, ...)
string$cOperand c
int$keepsomeentitiesEntities but &, <, >, " are not converted.
Returns
string String decoded

Definition at line 9928 of file functions.lib.php.

Referenced by Project\createFromClone(), Task\createFromClone(), Mailing\fetch(), ToolInvoices\getInvoice(), jsUnEscape(), and pdf_getlinedesc().

◆ dol_htmlcleanlastbr()

dol_htmlcleanlastbr ( $stringtodecode)

This function remove all ending
and br at end.

Parameters
string$stringtodecodeString to decode
Returns
string String decoded

Definition at line 9912 of file functions.lib.php.

Referenced by ActionComm\create(), csvClean(), getInvoice(), ExtraFields\getOptionalsFromPost(), getSupplierInvoicesForThirdParty(), and ActionComm\update().

◆ dol_htmlentities()

dol_htmlentities ( $string,
$flags = ENT_QUOTES | ENT_SUBSTITUTE,
$encoding = 'UTF-8',
$double_encode = false )

Replace htmlentities functions.

Goal of this function is to be sure to have default values of htmlentities that match what we need.

Parameters
string$stringThe input string to encode
int$flagsFlags (see PHP doc above)
string$encodingEncoding page code
bool$double_encodeWhen double_encode is turned off, PHP will not encode existing html entities
Returns
string $ret Encoded string
See also
dol_htmlentitiesbr()

Definition at line 9952 of file functions.lib.php.

Referenced by SharedDocumentsController\display(), FormSetupItem\generateInputFieldTextarea(), FormMail\get_form(), getHtmlOfLayout(), Form\getSearchFilterToolInput(), getTaskProgressView(), ActionComm\getTooltipContentArray(), box_task\loadBox(), run_sql(), Form\showrefnav(), and top_htmlhead().

◆ dol_htmlentitiesbr()

dol_htmlentitiesbr ( $stringtoencode,
$nl2brmode = 0,
$pagecodefrom = 'UTF-8',
$removelasteolbr = 1 )

This function is called to encode a string into a HTML string but differs from htmlentities because a detection is done before to see if text is already HTML or not.

Also, all entities but &,<,>," (because protected by code) and ' (because not included by the ENT_COMPAT mode) are converted. This permits to encode special chars to entities with no double encoding for already encoded HTML strings. This function also remove last EOL or BR if $removelasteolbr=1 (default). For PDF usage, you can show text by 2 ways:

  • writeHTMLCell -> param must be encoded into HTML.
  • MultiCell -> param must not be encoded into HTML. Because writeHTMLCell convert also
    into
    , if function is used to build PDF, nl2brmode must be 1. Note: When we output string on pages, we should use
  • dolPrintHTML... that is dol_escape_htmltag(dol_htmlwithnojs(dol_string_onlythesehtmltags(dol_htmlentitiesbr(), 1, 1, 1), 1, 1) for notes or descriptions,
  • dolPrintPassword that is a simple htmlspecialchars( , ENT_COMPAT, 'UTF-8') for passwords.
Parameters
string$stringtoencodeString to encode
int$nl2brmode0=Adding br before
, 1=Replacing
by br (for use with FPDF writeHTMLCell function for example)
string$pagecodefromPagecode stringtoencode is encoded
int$removelasteolbr1=Remove last br or lasts
(default), 0=Do nothing
Returns
string String encoded
See also
dol_escape_htmltag(), dolGetFirstLineOfText(), dol_string_onlythesehtmltags()

Definition at line 9862 of file functions.lib.php.

Referenced by pdf_octopus\drawInfoTable(), pdf_sponge\drawInfoTable(), Form\editfieldval(), Skill\getNomUrl(), box_services_contracts\loadBox(), Adherent\makeSubstitution(), pdf_getlinedesc(), pdf_getlinenum(), pdf_getlineref(), pdf_getlineref_supplier(), pdf_pagefoot(), CommonObject\printObjectLine(), HtmlField\printOutputField(), TextField\printOutputField(), VarcharField\printOutputField(), Adherent\sendEmail(), show_ldap_content(), ExtraFields\showOutputField(), pdf_octopus\tableFirstPage(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_baleine\write_file(), pdf_ban\write_file(), pdf_beluga\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_merou\write_file(), pdf_muscadet\write_file(), pdf_rouget\write_file(), pdf_sepamandate\write_file(), pdf_soleil\write_file(), pdf_sponge\write_file(), pdf_squille\write_file(), pdf_standard\write_file(), pdf_standard_asset\write_file(), pdf_standard_evaluation\write_file(), pdf_standard_expensereport\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_standard_stock\write_file(), pdf_storm\write_file(), pdf_strato\write_file(), pdf_timespent\write_file(), pdf_typhon\write_file(), pdf_vinci\write_file(), and pdf_zenith\write_file().

◆ dol_htmlentitiesbr_decode()

dol_htmlentitiesbr_decode ( $stringtodecode,
$pagecodeto = 'UTF-8' )

This function is called to decode a HTML string (it decodes entities and br tags)

Parameters
string$stringtodecodeString to decode
string$pagecodetoPage code for result
Returns
string String decoded

Definition at line 9896 of file functions.lib.php.

Referenced by pdf_standard_actions\_pages(), AdherentType\getMailOnExclude(), AdherentType\getMailOnResiliate(), AdherentType\getMailOnSubscription(), and AdherentType\getMailOnValid().

◆ dol_htmloutput_errors()

dol_htmloutput_errors ( $mesgstring = '',
$mesgarray = array(),
$keepembedded = 0 )

Print formatted error messages to output (Used to show messages on html output).

Parameters
string$mesgstringError message
string[]$mesgarrayError messages array
int<0,1>$keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)
Returns
void
See also
dol_print_error()
dol_htmloutput_mesg()

Definition at line 11616 of file functions.lib.php.

◆ dol_htmloutput_events()

dol_htmloutput_events ( $disabledoutputofmessages = 0)

Print formatted messages to output (Used to show messages on html output).

Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function, so there is no need to call it explicitly.

Parameters
int$disabledoutputofmessagesClear all messages stored into session without displaying them
Returns
void
See also
dol_htmloutput_mesg()

Definition at line 11429 of file functions.lib.php.

Referenced by Documentation\docFooter(), and llxFooterSurvey().

◆ dol_htmloutput_mesg()

dol_htmloutput_mesg ( $mesgstring = '',
$mesgarray = array(),
$style = 'ok',
$keepembedded = 0 )

Print formatted messages to output (Used to show messages on html output).

Parameters
string$mesgstringMessage string or message key
string[]$mesgarrayArray of message strings or message keys
string$styleWhich style to use ('ok', 'warning', 'error')
int$keepembeddedSet to 1 if message must be kept embedded into its html place (this disable jnotify)
Returns
void
See also
dol_print_error()
dol_htmloutput_errors()
setEventMessages()

Definition at line 11548 of file functions.lib.php.

Referenced by ActionsStripeconnect\addMoreActionsButtons(), and ActionsStripeconnect\formObjectOptions().

◆ dol_htmlwithnojs()

dol_htmlwithnojs ( $stringtoencode,
$nouseofiframesandbox = 0,
$check = 'restricthtml' )

Sanitize a HTML to remove js, dangerous content and external links.

This function is used by dolPrintHTML... function for example.

Parameters
string$stringtoencodeString to encode
int$nouseofiframesandbox0=Default, 1=Allow use of option MAIN_SECURITY_USE_SANDBOX_FOR_HTMLWITHNOJS for html sanitizing (not yet working)
string$check'restricthtmlnolink' or 'restricthtml' or 'restricthtmlallowclass' or 'restricthtmlallowiframe' or 'restricthtmlallowlinkscript' or 'restricthtmlallowunvalid'
Returns
string HTML sanitized
Parameters
array<int,string>$m Array of matches
Returns
string Translated string for the key
Parameters
array<int,string>$m Array of matches
Returns
string Translated string for the key
Parameters
string[]$m
Returns
string

Definition at line 9529 of file functions.lib.php.

Referenced by Form\editfieldval().

◆ dol_include_once()

if(!function_exists('dol_getprefix')) dol_include_once ( $relpath,
$classname = '' )

Make an include_once using default root and alternate root if it fails.

To link to a core file, use include(DOL_DOCUMENT_ROOT.'/pathtofile') To link to a module file from a module file, use include './mymodulefile'; To link to a module file from a core file, then this function can be used (call by hook / trigger / speciales pages)

Parameters
string$relpathRelative path to file (Ie: mydir/myfile, ./myfile, ...)
string$classnameClass name (deprecated)
Returns
bool True if load is a success, False if it fails

Definition at line 1598 of file functions.lib.php.

Referenced by FileUpload\__construct(), ToolProducts\analyze(), ActionsCardCommon\assign_values(), Societe\check_codeclient(), Societe\check_codefournisseur(), Societe\codeclient_modifiable(), Societe\codefournisseur_modifiable(), ModeleImports\commonImportInsert(), Product\create(), Project\createFromClone(), Propal\createFromClone(), Societe\delete(), CommonObject\deleteCommon(), dolGetElementUrl(), CommonObject\fetchObjectLinked(), CommonDocGenerator\fill_substitutionarray_with_extrafields(), fillArrayOfFilterFields(), fillArrayOfGroupBy(), fillArrayOfMeasures(), fillArrayOfXAxis(), Utils\generateDoc(), Product\get_barcode(), Societe\get_codecompta(), MouvementStock\get_origin(), Ticket\getDefaultRef(), ToolProducts\getDetails(), FieldsManager\getFieldClass(), LinkField\getObject(), ToolProducts\getProductCategories(), FormListWebPortal\init(), HookManager\initHooks(), CommonObject\insertExtraFields(), FormFile\list_of_autoecmfiles(), InfoBox\listBoxes(), migrate_reload_modules(), Projects\post(), Tasks\post(), AdvanceTargetingMailing\query_contact(), Cronjob\run_jobs(), FormWebPortal\selectForForms(), CSMSFile\sendfile(), Conf\setValues(), FormSms\show_form(), and ExtraFields\showOutputField().

◆ dol_mkdir()

dol_mkdir ( $dir,
$dataroot = '',
$newmask = '' )

Creation of a directory (this can create recursive subdir)

Parameters
string$dirDirectory to create (Separator must be '/'. Example: '/mydir/mysubdir')
string$datarootData root directory (To avoid having the data root in the loop. Using this will also lost the warning, on first dir, saying PHP has no permission when open_basedir is used)
string$newmaskMask for new file (Defaults to $conf->global->MAIN_UMASK or 0755 if unavailable). Example: '0444'
Returns
int Return integer < 0 if KO, 0 = already exists, > 0 if OK

Definition at line 8938 of file functions.lib.php.

Referenced by DolibarrApi\__construct(), Categorie\add_photo(), Product\add_photo(), mailing_xinputfile\add_to_target(), ActionComm\build_exportfile(), Ticket\copyFilesForTicket(), BlockedLog\create(), EcmDirectory\create(), Website\create(), DolibarrModules\create_dirs(), Project\createFromClone(), Task\createFromClone(), Website\createFromClone(), FileUpload\createScaledImage(), dol_add_file_process(), dol_filecache(), dol_meta_create(), dol_setcache(), dol_uncompress(), dolCopyDir(), dolSaveCssFile(), dolSaveHtaccessFile(), dolSaveHtmlHeader(), dolSaveIndexPage(), dolSaveJsFile(), dolSaveLicense(), dolSaveManifestJson(), dolSavePageAlias(), dolSaveReadme(), dolSaveRobotFile(), Ldap\dump(), Utils\dumpDatabase(), AccountancyExport\export(), Website\exportWebSite(), DiasporaHandler\fetch(), RedditHandler\fetch(), CMailFile\findHtmlImagesIsSrcData(), Utils\generateDoc(), IntracommReport\generateXMLFile(), Stats\getAllByProductEntry(), getAllImages(), Stats\getAmountByMonthWithPrevYear(), ExternalModules\getModuleZIP(), Stats\getNbByMonthWithPrevYear(), ExternalModules\getRemoteYamlFile(), ProjectStats\getTransformRateByMonthWithPrevYear(), ProjectStats\getWeightedAmountByMonthWithPrevYear(), FileUpload\handleFileUpload(), modBom\init(), modCommande\init(), modContrat\init(), modEventOrganization\init(), modExpedition\init(), modFacture\init(), modKnowledgeManagement\init(), modMrp\init(), modMyModule\init(), modPartnership\init(), modProjet\init(), modPropale\init(), modReception\init(), modRecruitment\init(), modSalaries\init(), modSociete\init(), modStock\init(), modSupplierInvoice\init(), modSupplierOrder\init(), modSupplierProposal\init(), modTicket\init(), modWebsite\init(), modWorkstation\init(), migrate_holiday_path(), migrate_product_photospath(), migrate_user_filespath(), migrate_user_photospath(), migrate_user_photospath2(), Website\overwriteTemplate(), RssParser\parser(), pdf_getInstance(), Documents\post(), Tickets\postNewMessage(), Website\purge(), Utils\purgeFiles(), rebuild_merge_pdf(), rebuildObjectClass(), rebuildObjectSql(), Cronjob\run_jobs(), InterfaceActionsAuto\runTrigger(), saveAttachment(), Website\update(), vignette(), BordereauChequeBlochet\write_file(), doc_generic_asset_odt\write_file(), doc_generic_member_odt\write_file(), doc_generic_odt\write_file(), doc_generic_product_odt\write_file(), doc_generic_project_odt\write_file(), doc_generic_stock_odt\write_file(), doc_generic_ticket_odt\write_file(), doc_generic_user_odt\write_file(), doc_generic_usergroup_odt\write_file(), html_cerfafr\write_file(), html_generic\write_file(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_balance\write_file(), pdf_baleine\write_file(), pdf_ban\write_file(), pdf_beluga\write_file(), pdf_bookkeeping\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_ledger\write_file(), pdf_merou\write_file(), pdf_muscadet\write_file(), pdf_octopus\write_file(), pdf_paiement\write_file(), pdf_rouget\write_file(), pdf_sepamandate\write_file(), pdf_soleil\write_file(), pdf_sponge\write_file(), pdf_squille\write_file(), pdf_standard\write_file(), pdf_standard_actions\write_file(), pdf_standard_asset\write_file(), pdf_standard_evaluation\write_file(), pdf_standard_expensereport\write_file(), pdf_standard_member\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_standard_stock\write_file(), pdf_standard_supplierpayment\write_file(), pdf_standardlabel\write_file(), pdf_storm\write_file(), pdf_strato\write_file(), pdf_tcpdflabel\write_file(), pdf_timespent\write_file(), pdf_typhon\write_file(), pdf_vinci\write_file(), pdf_zenith\write_file(), modPhpbarcode\writeBarCode(), modTcpdfbarcode\writeBarCode(), and pdf_standard_salary\writeFile().

◆ dol_mktime()

dol_mktime ( $hour,
$minute,
$second,
$month,
$day,
$year,
$gm = 'auto',
$check = 1 )

Return a timestamp date built from detailed information (by default a local PHP server timestamp) Replace function mktime not available under Windows if year < 1970 PHP mktime is restricted to the years 1901-2038 on Unix and 1970-2038 on Windows.

Parameters
int$hourHour (can be -1 for undefined)
int$minuteMinute (can be -1 for undefined)
int$secondSecond (can be -1 for undefined)
int$monthMonth (1 to 12)
int$dayDay (1 to 31)
int$yearYear
bool | int | string$gmTrue or 1 or 'gmt'=Input information are GMT values False or 0 or 'tzserver' = local to server TZ 'auto' 'tzuser' = local to user TZ taking dst into account at the current date. Not yet implemented. 'tzuserrel' = local to user TZ taking dst into account at the given date. Use this one to convert date input from user into a GMT date. 'tz,TimeZone' = use specified timezone
int$check0=No check on parameters (Can use day 32, etc...)
Returns
int|'' Date as a timestamp, '' if error
See also
dol_print_date(), dol_stringtotime(), dol_getdate()

Definition at line 4209 of file functions.lib.php.

Referenced by modAdherent\__construct(), modFacture\__construct(), modHoliday\__construct(), modMultiCurrency\__construct(), modPartnership\__construct(), modSupplierInvoice\__construct(), DolibarrApiAccess\__isAllowed(), DataPolicyCron\_anonymizeExtraFields(), MouvementStock\_create(), Product\_get_stats(), pdf_paiement\_pagehead(), mailing_fraise\add_to_target(), CommonInvoice\calculate_date_lim_reglement(), Facture\createFromClone(), Project\createFromClone(), Task\createFromClone(), FactureFournisseurRec\createRecurringInvoices(), FactureRec\createRecurringInvoices(), Project\createWeeklyReport(), dol_get_first_day(), dol_get_first_day_week(), dol_get_first_hour(), dol_get_last_day(), dol_get_last_hour(), dol_get_next_day(), dol_get_next_week(), dol_get_prev_day(), dol_get_prev_week(), dol_stringtotime(), dol_time_plus_duree(), dolSqlDateFilter(), dolWebsiteIncrementCounter(), Accountancy\exportData(), get_next_value(), getCurrentPeriodOfFiscalYear(), DataPolicyCron\getDataPolicies(), getDefaultDatesForTransfer(), MultiCurrency\getIdAndTxFromCode(), FactureRec\getNextDate(), ExtraFields\getOptionalsFromPost(), DateField\getPostFieldValue(), DatetimeField\getPostFieldValue(), DatetimegmtField\getPostFieldValue(), TimestampField\getPostFieldValue(), DateField\getPostSearchFieldValue(), DatetimeField\getPostSearchFieldValue(), DatetimegmtField\getPostSearchFieldValue(), TimestampField\getPostSearchFieldValue(), ICal\ical_date_to_unix(), Facture\initAsSpecimen(), FactureFournisseurRec\initAsSpecimen(), FactureRec\initAsSpecimen(), Paiement\initAsSpecimen(), PaiementFourn\initAsSpecimen(), RemiseCheque\initAsSpecimen(), DoliDB\jdate(), migrate_accountingbookkeeping(), FormListWebPortal\printSearchInput(), Adherent\sendReminderForExpiredSubscription(), AssetDepreciationOptions\setDeprecationOptionsFromPost(), FormListWebPortal\setSearchValues(), CommonObject\setValuesForExtraLanguages(), show_actions_done(), show_bookcal_day_events(), show_contacts(), CommonObject\showOptionals(), Holiday\updateSoldeCP(), and pdf_paiement\write_file().

◆ dol_nboflines()

dol_nboflines ( $s,
$maxchar = 0 )

Return nb of lines of a clear text.

Parameters
string$sString to check
int$maxcharNot yet used
Returns
int Number of lines
See also
dol_nboflines_bis(), dolGetFirstLineOfText()

Definition at line 10000 of file functions.lib.php.

Referenced by pdf_standard_actions\_pages().

◆ dol_nboflines_bis()

dol_nboflines_bis ( $text,
$maxlinesize = 0,
$charset = 'UTF-8' )

Return nb of lines of a formatted text with
and
(WARNING: string must not have mixed
and br separators)

Parameters
string$textText
int$maxlinesizeLinewidth in character count (default = 0 == nolimit)
string$charsetGive the charset used to encode the $text variable in memory.
Returns
int Number of lines
See also
dol_nboflines(), dolGetFirstLineOfText()

Definition at line 10021 of file functions.lib.php.

Referenced by pdf_aurore\_pagehead(), and Form\formconfirm().

◆ dol_nl2br()

dol_nl2br ( $stringtoencode,
$nl2brmode = 0,
$forxml = false )

Replace CRLF in string with a HTML BR tag.

WARNING: The content after operation contains some HTML tags (the
) so be sure to also have encoded the special chars of stringtoencode into HTML before with dol_htmlentitiesbr().

Parameters
string$stringtoencodeString to encode
int$nl2brmode0=Adding br before
, 1=Replacing
by br
bool$forxmlfalse=Use
, true=Use
Returns
string String encoded
See also
dol_htmlentitiesbr(), dol_nboflines(), dolGetFirstLineOfText()

Definition at line 9506 of file functions.lib.php.

Referenced by CMailFile\__construct(), DolEditor\__construct(), ActionsAdherentCardCommon\assign_values(), ActionsCardCommon\assign_values(), ActionsContactCardCommon\assign_values(), InterfaceTicketEmail\composeAndSendAdminMessage(), InterfaceTicketEmail\composeAndSendAssigneeMessage(), InterfaceTicketEmail\composeAndSendCustomerMessage(), Form\editInPlace(), Ai\generateContent(), FormSetupItem\generateOutputField(), FormMail\get_form(), Ticket\newMessage(), and FormTicket\showMessageForm().

◆ dol_now()

dol_now ( $mode = 'gmt')

Return date for now.

In most cases, we use this function without parameters (that means GMT time).

Parameters
'auto'|'gmt'|'tzserver'|'tzuser'|'tzuserrel'$mode 'auto' => for backward compatibility (avoid this), 'gmt' => we return GMT timestamp, 'tzserver' => we add the PHP server timezone 'tzref' => we add the company timezone. Not implemented. 'tzuser' or 'tzuserrel' => we add the user timezone
Returns
int $date Timestamp

Definition at line 4295 of file functions.lib.php.

Referenced by BonPrelevement\__construct(), Evaluation\__construct(), modAccounting\__construct(), modAdherent\__construct(), modAgenda\__construct(), modFacture\__construct(), modHoliday\__construct(), modMultiCurrency\__construct(), modPartnership\__construct(), modProduct\__construct(), modService\__construct(), modSociete\__construct(), modSupplierInvoice\__construct(), DolibarrApiAccess\__isAllowed(), MouvementStock\_create(), Product\_log_price(), pdf_balance\_pagehead(), pdf_ban\_pagehead(), pdf_bookkeeping\_pagehead(), pdf_ledger\_pagehead(), pdf_standard_stock\_pagehead(), Contrat\activateAll(), CommonObject\add_contact(), Product\add_fournisseur(), mailing_fraise\add_to_target(), mailing_thirdparties_services_expired\add_to_target(), Opensurveysondage\addComment(), Account\addline(), Holiday\addLogCP(), BonPrelevement\addNotification(), addObjectsToApiFile(), Tva\addPayment(), Task\addTimeSpent(), ai_log_request(), ToolProducts\analyze(), CommandeFournisseur\approve(), Partnership\approve(), archiveOrBackupFile(), build_calfile(), ActionComm\build_exportfile(), CommandeFournisseur\calcAndSetStatusDispatch(), callApiToGetObfuscationKey(), Mo\cancelConsumedAndProducedLines(), check_user_password_dolibarr(), checkNbPostsForASpeceificIp(), Propal\classifyBilled(), Product\clone_fournisseurs(), Product\clone_price(), SkillRank\cloneFromCurrentSkill(), CashControl\close(), Ticket\close(), Contrat\closeAll(), BookKeeping\closeFiscalPeriod(), Propal\closeProposal(), Commande\cloture(), RecruitmentJobPosition\cloture(), SupplierProposal\cloture(), InterfaceTicketEmail\composeAndSendAssigneeMessage(), InterfaceTicketEmail\composeAndSendCustomerMessage(), ExpenseReport\computeTotalKm(), Ticket\copyFilesForTicket(), AdherentStats\countMembersByTagAndStatus(), AdherentStats\countMembersByTypeAndStatus(), Account\create(), AccountancySystem\create(), AccountingAccount\create(), ActionComm\create(), AdvanceTargetingMailing\create(), BlockedLog\create(), BookKeeping\create(), Bookmark\create(), CashControl\create(), Categorie\create(), CEmailTemplate\create(), ChargeSociales\create(), Commande\create(), CommandeFournisseur\create(), CompanyBankAccount\create(), Contact\create(), Cronjob\create(), CurrencyRate\create(), Delivery\create(), DiscountAbsolute\create(), Dolresource\create(), Don\create(), EcmDirectory\create(), EcmFiles\create(), Entrepot\create(), Establishment\create(), Expedition\create(), ExpenseReport\create(), Facture\create(), FactureFournisseur\create(), FactureFournisseurRec\create(), FactureRec\create(), Fichinter\create(), FichinterRec\create(), Fiscalyear\create(), Holiday\create(), Link\create(), Loan\create(), LoanSchedule\create(), Mailing\create(), MultiCurrency\create(), Notify\create(), Paiement\create(), PaiementFourn\create(), PaymentDonation\create(), PaymentExpenseReport\create(), PaymentLoan\create(), PaymentSalary\create(), PaymentSocialContribution\create(), PaymentVarious\create(), PaymentVAT\create(), Product\create(), ProductCustomerPrice\create(), Productlot\create(), Project\create(), Propal\create(), Propalmergepdfproduct\create(), Reception\create(), ReceptionLineBatch\create(), RejetPrelevement\create(), RemiseCheque\create(), Salary\create(), Societe\create(), Subscription\create(), SupplierProposal\create(), Task\create(), Ticket\create(), Tva\create(), User\create(), UserBankAccount\create(), UserGroup\create(), Website\create(), ExtraFields\create_label(), createActionComm(), CommonObject\createCommon(), Thirdparties\createCompanyBankAccount(), createContact(), Facture\createDepositFromOrigin(), AssetModel\createFromClone(), Availabilities\createFromClone(), BookkeepingTemplate\createFromClone(), Calendar\createFromClone(), Commande\createFromClone(), CommandeFournisseur\createFromClone(), ConferenceOrBoothAttendee\createFromClone(), Cronjob\createFromClone(), CTicketCategory\createFromClone(), Evaluation\createFromClone(), Facture\createFromClone(), FactureFournisseur\createFromClone(), Job\createFromClone(), KnowledgeRecord\createFromClone(), Mailing\createFromClone(), Memo\createFromClone(), MyObject\createFromClone(), Partnership\createFromClone(), Position\createFromClone(), ProductFournisseurPrice\createFromClone(), Project\createFromClone(), Propal\createFromClone(), RecruitmentCandidature\createFromClone(), RecruitmentJobPosition\createFromClone(), Skill\createFromClone(), Skilldet\createFromClone(), SkillRank\createFromClone(), SupplierProposal\createFromClone(), Target\createFromClone(), Task\createFromClone(), TimeSpent\createFromClone(), Website\createFromClone(), Workstation\createFromClone(), Facture\createFromContract(), Facture\createFromOrder(), Commande\createFromProposal(), createInvoice(), createOrder(), createPayment(), SupplierProposal\createPriceFournisseur(), createProductOrService(), FactureFournisseurRec\createRecurringInvoices(), FactureRec\createRecurringInvoices(), BookKeeping\createStd(), createThirdParty(), Ticket\createTicketMessage(), Project\createWeeklyReport(), Stripe\customerStripe(), Mo\deleteLine(), Task\delTimeSpent(), CommonInvoice\demande_prelevement(), Salary\demande_prelevement(), CommandeFournisseur\dispatchProduct(), Contrat\doAutoRenewContracts(), PartnershipUtils\doCancelStatusOfMemberPartnership(), dol_cache_refresh(), dol_dir_list(), dol_getcache(), dol_setcache(), dolListSessions(), dolPrintSignatureImage(), dolSessionGC(), dolSessionWrite(), dolWebsiteIncrementCounter(), Availabilities\doScheduledJob(), ConferenceOrBooth\doScheduledJob(), KnowledgeRecord\doScheduledJob(), RecruitmentCandidature\doScheduledJob(), RecruitmentJobPosition\doScheduledJob(), StockTransferLine\doScheduledJob(), TriggerHistory\doScheduledJob(), PartnershipUtils\doWarningOfPartnershipIfDolibarrBacklinkNotfound(), Utils\dumpDatabase(), mod_syslog_file\export(), Accountancy\exportData(), Website\exportWebSite(), DiasporaHandler\fetch(), RedditHandler\fetch(), Contrat\fetch_lines(), BonPrelevement\generate(), Ai\generateContent(), Utils\generateDoc(), get_next_value(), CommonDocGenerator\get_substitutionarray_other(), Stats\getAllByProductEntry(), Stats\getAmountByMonthWithPrevYear(), AccountingJournal\getAssetData(), html_generic\getContents(), getCurrentPeriodOfFiscalYear(), getDefaultDatesForTransfer(), AccountingJournal\getDiscountCustomer(), AccountingJournal\getDiscountSupplier(), ContratLigne\getLibStatut(), Stats\getNbByMonthWithPrevYear(), mailing_thirdparties_services_expired\getNbOfRecipients(), BookkeepingTemplate\getNextNumRef(), mod_barcode_product_standard\getNextValue(), mod_barcode_thirdparty_standard\getNextValue(), mod_chequereceipt_mint\getNextValue(), mod_chequereceipt_thyme\getNextValue(), mod_codeclient_elephant\getNextValue(), mod_codeclient_monkey\getNextValue(), mod_codeproduct_elephant\getNextValue(), mod_commande_saphir\getNextValue(), mod_delivery_jade\getNextValue(), mod_facture_mercure\getNextValue(), mod_lot_advanced\getNextValue(), mod_lot_standard\getNextValue(), mod_member_advanced\getNextValue(), mod_member_custom\getNextValue(), mod_project_simple\getNextValue(), mod_project_universal\getNextValue(), mod_propale_saphir\getNextValue(), mod_reception_moonstone\getNextValue(), mod_sn_advanced\getNextValue(), mod_sn_standard\getNextValue(), mod_takepos_ref_universal\getNextValue(), mod_task_simple\getNextValue(), mod_task_universal\getNextValue(), mod_ticket_simple\getNextValue(), mod_ticket_universal\getNextValue(), getNumberInvoicesPieChart(), Societe\getOutstandingBills(), Stripe\getPaymentIntent(), ExternalModules\getProducts(), ExternalModules\getRemoteYamlFile(), Product\getSellPrice(), getServerTimeZoneInt(), Cronjob\getTooltipContentArray(), Opensurveysondage\getTooltipContentArray(), Contrat\getTotalizedLines(), ProjectStats\getTransformRateByMonthWithPrevYear(), ProjectStats\getWeightedAmountByMonthWithPrevYear(), ActionComm\hasDelay(), Adherent\hasDelay(), Commande\hasDelay(), CommandeFournisseur\hasDelay(), ExpenseReport\hasDelay(), Facture\hasDelay(), FactureFournisseur\hasDelay(), Mo\hasDelay(), Project\hasDelay(), Task\hasDelay(), Status\index(), mod_codeclient_elephant\info(), modBlockedLog\init(), modEmailCollector\init(), modTakePos\init(), ActionComm\initAsSpecimen(), Adherent\initAsSpecimen(), BOM\initAsSpecimen(), BookKeeping\initAsSpecimen(), ChargeSociales\initAsSpecimen(), CommandeFournisseur\initAsSpecimen(), CompanyBankAccount\initAsSpecimen(), Contrat\initAsSpecimen(), Cronjob\initAsSpecimen(), Delivery\initAsSpecimen(), Don\initAsSpecimen(), EcmFiles\initAsSpecimen(), Entrepot\initAsSpecimen(), Expedition\initAsSpecimen(), ExpenseReport\initAsSpecimen(), Facture\initAsSpecimen(), FactureFournisseur\initAsSpecimen(), FactureFournisseurRec\initAsSpecimen(), FactureRec\initAsSpecimen(), Fichinter\initAsSpecimen(), Holiday\initAsSpecimen(), Loan\initAsSpecimen(), Localtax\initAsSpecimen(), Menubase\initAsSpecimen(), Opensurveysondage\initAsSpecimen(), Paiement\initAsSpecimen(), PaiementFourn\initAsSpecimen(), PaymentDonation\initAsSpecimen(), PaymentExpenseReport\initAsSpecimen(), PaymentSalary\initAsSpecimen(), PaymentSocialContribution\initAsSpecimen(), PaymentVarious\initAsSpecimen(), PaymentVAT\initAsSpecimen(), Product\initAsSpecimen(), Productbatch\initAsSpecimen(), ProductCustomerPrice\initAsSpecimen(), Productlot\initAsSpecimen(), ProductStockEntrepot\initAsSpecimen(), Project\initAsSpecimen(), Propalmergepdfproduct\initAsSpecimen(), Reception\initAsSpecimen(), ReceptionLineBatch\initAsSpecimen(), RemiseCheque\initAsSpecimen(), Salary\initAsSpecimen(), Societe\initAsSpecimen(), Ticket\initAsSpecimen(), Tva\initAsSpecimen(), User\initAsSpecimen(), Website\initAsSpecimen(), CommonObject\initAsSpecimenCommon(), InterfaceLogevents\initEventData(), DolibarrModules\insert_cronjobs(), BookKeeping\insertAccountingReversal(), User\isNotIntoValidityDateRange(), Adherent\LibStatut(), Holiday\LibStatut(), User\LibStatut(), FormFile\listOfLinks(), Account\load_board(), Adherent\load_board(), BonPrelevement\load_board(), Contrat\load_board(), ExpenseReport\load_board(), Facture\load_board(), FactureFournisseur\load_board(), Holiday\load_board(), Mo\load_board(), Propal\load_board(), RemiseCheque\load_board(), SupplierProposal\load_board(), Ticket\load_board(), box_actions\loadBox(), box_actions_future\loadBox(), box_activity\loadBox(), box_birthdays\loadBox(), box_birthdays_members\loadBox(), box_contracts\loadBox(), box_factures\loadBox(), box_ficheinter\loadBox(), box_graph_invoices_permonth\loadBox(), box_graph_invoices_peryear\loadBox(), box_graph_invoices_supplier_permonth\loadBox(), box_graph_nb_ticket_last_x_days\loadBox(), box_graph_orders_permonth\loadBox(), box_graph_orders_supplier_permonth\loadBox(), box_graph_product_distribution\loadBox(), box_graph_propales_permonth\loadBox(), box_members_by_tags\loadBox(), box_members_by_type\loadBox(), box_propales\loadBox(), box_scheduled_jobs\loadBox(), box_services_contracts\loadBox(), box_services_expired\loadBox(), ActionComm\loadReminders(), CommonInvoice\makeStripeSepaRequest(), Ticket\markAsRead(), migrate_apiresttokens(), migrate_project_task_actors(), migrate_project_user_resp(), migrate_reset_blocked_log(), BookKeeping\newCloneMass(), Ticket\newMessage(), BookKeeping\newReturnAccount(), LoanSchedule\paimenttorecord(), ICal\parse(), PriceParser\parseExpression(), RssParser\parser(), ToolInvoices\payInvoice(), pdf_getlinedesc(), Invoices\post(), Projects\post(), SupplierInvoices\post(), SupplierOrders\post(), Tasks\post(), Tickets\postNewMessage(), printCodeForPing(), Mos\produceAndConsume(), Mos\produceAndConsumeAll(), projectLinesPerDay(), projectLinesPerWeek(), Utils\purgeFiles(), modBlockedLog\remove(), Contrat\reopen(), Cronjob\run_jobs(), InterfaceActionsAuto\runTrigger(), CMailFile\save_dump_mail_in_err(), Form\select_produits_list(), Form\selectDate(), Notify\send(), ActionComm\sendEmailsReminder(), Facture\sendEmailsRemindersOnInvoiceDueDate(), FactureFournisseur\sendEmailsRemindersOnSupplierInvoiceDueDate(), Holiday\sendPreviousMonthHRInformations(), Adherent\sendReminderForExpiredSubscription(), ActionComm\sendSmsReminder(), dolReceiptPrinter\sendToPrinter(), Stripe\sepaStripe(), ExpenseReport\set_cancel(), Societe\set_remise_client(), Societe\set_remise_supplier(), ExpenseReport\setApproved(), Facture\setCanceled(), Fichinter\setClose(), Project\setClose(), Expedition\setClosed(), Reception\setClosed(), ExpenseReport\setDeny(), Mailing\setDraft(), MailingTarget\setError(), Contact\setNoEmail(), Societe\setNoEmail(), MailingTarget\setNotSent(), Facture\setPaid(), FactureFournisseur\setPaid(), User\setPassword(), Societe\setPriceLevel(), MailingTarget\setRead(), MailingTarget\setReadAndUnsubscribed(), Ticket\setReadDate(), MailingTarget\setSent(), CommonObject\setStatut(), Fichinter\setValid(), ExpenseReport\setValidate(), show_actions_done(), show_array_actions_to_do(), show_array_last_actions_done(), FormActions\showactions(), Account\solde(), Adherent\subscription(), Adherent\subscriptionComplementaryActions(), BookKeeping\transformTransaction(), Cronjob\update(), Dolresource\update(), Link\update(), MailingTarget\update(), Product\update(), ProductCustomerPrice\update(), Productlot\update(), ProductStockEntrepot\update(), Salary\update(), Societe\update(), Website\update(), ProductFournisseur\update_buyprice(), ExtraFields\update_label(), User\update_last_login_date(), AssetAccountancyCodes\updateAccountancyCodes(), updateActionComm(), CommonObject\updateCommon(), Thirdparties\updateCompanyBankAccount(), updateContact(), AssetDepreciationOptions\updateDeprecationOptions(), Dolresource\updateElementResource(), Lettering\updateGeneralMatching(), Lettering\updateLettering(), FichinterRec\updateNbGenDone(), Memo\updatePosition(), updateProductOrService(), Contact\updateRoles(), Holiday\updateSoldeCP(), updateThirdParty(), Task\updateTimeSpent(), usageCron(), CashControl\valid(), Commande\valid(), CommandeFournisseur\valid(), Expedition\valid(), Mailing\valid(), Propal\valid(), Reception\valid(), SupplierProposal\valid(), Adherent\validate(), Asset\validate(), AssetModel\validate(), Availabilities\validate(), BOM\validate(), Calendar\validate(), ConferenceOrBooth\validate(), ConferenceOrBoothAttendee\validate(), Contrat\validate(), Evaluation\validate(), Facture\validate(), FactureFournisseur\validate(), Holiday\validate(), Inventory\validate(), Job\validate(), KnowledgeRecord\validate(), Mo\validate(), MyObject\validate(), Partnership\validate(), Position\validate(), ProductFournisseurPrice\validate(), RecruitmentCandidature\validate(), RecruitmentJobPosition\validate(), Skill\validate(), Skilldet\validate(), SkillRank\validate(), StockTransfer\validate(), StockTransferLine\validate(), Target\validate(), TimeSpent\validate(), BookKeeping\validateMovementForFiscalPeriod(), write_conf_file(), doc_generic_asset_odt\write_file(), doc_generic_member_odt\write_file(), doc_generic_odt\write_file(), doc_generic_product_odt\write_file(), doc_generic_project_odt\write_file(), doc_generic_stock_odt\write_file(), doc_generic_ticket_odt\write_file(), doc_generic_user_odt\write_file(), doc_generic_usergroup_odt\write_file(), html_cerfafr\write_file(), pdf_balance\write_file(), pdf_bookkeeping\write_file(), pdf_ledger\write_file(), and pdf_standard_member\write_file().

◆ dol_osencode()

dol_osencode ( $str)

Return a string encoded into OS filesystem encoding.

This function is used to define value to pass to filesystem PHP functions.

Parameters
string$strString to encode (UTF-8)
Returns
string Encoded string (UTF-8, ISO-8859-1)

Definition at line 11791 of file functions.lib.php.

Referenced by ExternalModules\_downloadFile(), CMailFile\_encode_file(), Product\add_photo(), addFileIntoDatabaseIndex(), CommonObject\addThumbs(), Documents\builddoc(), checkLoginPassEntity(), completeFileArrayWithDatabaseInfo(), Website\create(), Website\createFromClone(), Documents\delete(), EcmDirectory\delete(), Product\delete_photo(), dol_check_secure_access_document(), dol_copy(), dol_count_nb_of_line(), dol_delete_dir(), dol_delete_dir_recursive(), dol_delete_file(), dol_dir_is_emtpy(), dol_dir_list(), dol_filemtime(), dol_fileperm(), dol_filesize(), dol_getImageSize(), dol_imageResizeOrCrop(), dol_is_dir(), dol_is_file(), dol_is_link(), dol_is_writable(), dol_move(), dol_move_dir(), dol_move_uploaded_file(), dolCopyDir(), dolReplaceInFile(), Translate\file_exists(), Product\get_image_size(), MailingTargets\getEmailingSelectorsList(), getFromFile(), Translate\getLabelFromNumber(), Interfaces\getTriggersList(), ModeleBoxes\getWidgetsList(), ImportCsv\import_open_file(), Documents\index(), CommonObject\indexFile(), ViewImageController\init(), BOM\is_photo_available(), Product\is_photo_available(), Ticket\is_photo_available(), Categorie\isAnyPhotoAvailable(), Product\liste_photos(), listOfSessions(), Translate\load(), Export\load_arrays(), Import\load_arrays(), migrate_holiday_path(), migrate_product_photospath(), migrate_user_filespath(), migrate_user_photospath(), migrate_user_photospath2(), pdfExtractMetadata(), Website\purge(), purgeSessions(), rebuildObjectClass(), rebuildObjectSql(), Interfaces\run_triggers(), Conf\setValues(), and vignette().

◆ dol_print_address()

dol_print_address ( $address,
$htmlid,
$element,
$id,
$noprint = 0,
$charfornl = '' )

Format address string.

Parameters
string$addressAddress string, already formatted with dol_format_address()
string$htmlidHtml ID (for example 'gmap')
string$element'thirdparty'|'contact'|'member'|'user'|'other'
int$idId of object
int$noprintNo output. Result is the function return
string$charfornlChar to use instead of nl2br. '' means we use a standad nl2br.
Returns
?string Nothing if noprint is 0, formatted address if noprint is 1
See also
dol_format_address()

Definition at line 5304 of file functions.lib.php.

Referenced by WebPortalMember\getBannerAddressForWebPortal().

◆ dol_print_date()

dol_print_date ( $time,
$format = '',
$tzoutput = 'auto',
$outputlangs = null,
$encodetooutput = false,
$decorate = 0 )

Output date in a string format according to outputlangs (or langs if not defined).

Return charset is always UTF-8, except if encodetoouput is defined. In this case charset is output charset

Parameters
null | int | string$timeGM Timestamps date
string$formatOutput date format (tag of strftime function) "%d %b %Y", "%d/%m/%Y %H:%M", "%d/%m/%Y %H:%M:%S", "%B"=Long text of month, "%A"=Long text of day, "%b"=Short text of month, "%a"=Short text of day "day", "daytext", "dayhour", "dayhourldap", "dayhourtext", "dayrfc", "dayhourrfc", "...inputnoreduce", "...reduceformat"
string | bool$tzoutputtrue or 'gmt' => string is for Greenwich location false or 'tzserver' => output string is for local PHP server TZ usage 'tzuser' => output string is for user TZ (current browser TZ with current dst) => In a future, we should have same behaviour than 'tzuserrel' 'tzuserrel' => output string is for user TZ (current browser TZ with dst or not, depending on date position)
?Translate$outputlangsObject lang that contains language for text translation.
boolean$encodetooutputUse true to convert/encode string into the HTML rendering pagecode (false=keep UTF8 by default)
int | string$decorateUse 1 or a css to apply a HTML css style to decorate the date
Returns
string Formatted date or '' if time is null
See also
dol_mktime(), dol_stringtotime(), dol_getdate(), selectDate()

Definition at line 3884 of file functions.lib.php.

Referenced by modAccounting\__construct(), modAdherent\__construct(), modProduct\__construct(), modService\__construct(), modSociete\__construct(), printing_printgcp\__construct(), MouvementStock\_create(), Product\_get_stats(), Adherent\_load_ldap_info(), pdf_azur\_pagehead(), pdf_balance\_pagehead(), pdf_baleine\_pagehead(), pdf_ban\_pagehead(), pdf_beluga\_pagehead(), pdf_bookkeeping\_pagehead(), pdf_canelle\_pagehead(), pdf_cornas\_pagehead(), pdf_cyan\_pagehead(), pdf_eagle_proforma\_pagehead(), pdf_einstein\_pagehead(), pdf_eratosthene\_pagehead(), pdf_espadon\_pagehead(), pdf_ledger\_pagehead(), pdf_merou\_pagehead(), pdf_muscadet\_pagehead(), pdf_octopus\_pagehead(), pdf_paiement\_pagehead(), pdf_rouget\_pagehead(), pdf_sepamandate\_pagehead(), pdf_soleil\_pagehead(), pdf_sponge\_pagehead(), pdf_squille\_pagehead(), pdf_standard_asset\_pagehead(), pdf_standard_evaluation\_pagehead(), pdf_standard_expensereport\_pagehead(), pdf_standard_movementstock\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_standard_recruitmentjobposition\_pagehead(), pdf_standard_salary\_pagehead(), pdf_standard_stock\_pagehead(), pdf_standard_supplierpayment\_pagehead(), pdf_storm\_pagehead(), pdf_strato\_pagehead(), pdf_timespent\_pagehead(), pdf_typhon\_pagehead(), pdf_vinci\_pagehead(), pdf_zenith\_pagehead(), pdf_standard_actions\_pages(), pdf_aurore\_tableau_info(), pdf_azur\_tableau_info(), pdf_einstein\_tableau_info(), pdf_canelle\_tableau_versements(), mailing_fraise\add_to_target(), addObjectsToApiFile(), ToolProducts\analyze(), build_calfile(), BonPrelevement\buildRumNumber(), CommonInvoice\buildSwitzerlandQRString(), CommonInvoice\buildZATCAQRString(), Asset\calculationDepreciation(), callApiToGetObfuscationKey(), constructGanttLine(), convertSecondToTime(), Ticket\copyFilesForTicket(), BlockedLog\create(), Facture\create(), FactureFournisseur\create(), Mailing\createFromClone(), Task\createFromClone(), Project\createWeeklyReport(), pdf_octopus\defineColumnField(), CommandeFournisseur\dispatchProduct(), AbstractDocumentController\displayDocumentTable(), Contrat\doAutoRenewContracts(), doc_getlinedesc(), dol_meta_create(), dol_print_object_info(), dol_time_plus_duree(), dolPrintSignatureImage(), pdf_cyan\drawInfoTable(), pdf_eagle_proforma\drawInfoTable(), pdf_eratosthene\drawInfoTable(), pdf_octopus\drawPaymentsTable(), pdf_sponge\drawPaymentsTable(), pdf_octopus\drawTotalTable(), pdf_sponge\drawTotalTable(), Utils\dumpDatabase(), Form\editfieldval(), Form\editInPlace(), BonPrelevement\EnregDestinataire(), BonPrelevement\EnregDestinataireSEPA(), BonPrelevement\EnregEmetteur(), BonPrelevement\EnregEmetteurSEPA(), mod_syslog_file\export(), AccountancyExport\exportAgiris(), AccountancyExport\exportBob50(), AccountancyExport\exportCegid(), AccountancyExport\exportCharlemagne(), AccountancyExport\exportCiel(), AccountancyExport\exportCoala(), AccountancyExport\exportCogilog(), AccountancyExport\exportConfigurable(), AccountancyExport\exportEbp(), AccountancyExport\exportFEC(), AccountancyExport\exportFEC2(), AccountancyExport\exportGestimumV3(), AccountancyExport\exportGestimumV5(), AccountancyExport\exportISTEA(), AccountancyExport\exportiSuiteExpert(), AccountancyExport\exportLDCompta(), AccountancyExport\exportLDCompta10(), AccountancyExport\exportOpenConcerto(), AccountancyExport\exportQuadratus(), AccountancyExport\exportSAGE50SWISS(), Website\exportWebSite(), AccountancyExport\exportWinfic(), CommonDocGenerator\fill_substitutionarray_with_extrafields(), Form\form_date(), DiasporaHandler\formatDate(), MastodonHandler\formatDate(), RedditHandler\formatDate(), BonPrelevement\generate(), Ai\generateContent(), Utils\generateDoc(), CommonDocGenerator\get_substitutionarray_contact(), CommonDocGenerator\get_substitutionarray_lines(), doc_generic_project_odt\get_substitutionarray_object(), doc_generic_task_odt\get_substitutionarray_object(), CommonDocGenerator\get_substitutionarray_other(), doc_generic_project_odt\get_substitutionarray_project_file(), doc_generic_task_odt\get_substitutionarray_project_file(), doc_generic_project_odt\get_substitutionarray_project_reference(), doc_generic_task_odt\get_substitutionarray_project_reference(), CommonDocGenerator\get_substitutionarray_shipment(), doc_generic_project_odt\get_substitutionarray_task_file(), doc_generic_task_odt\get_substitutionarray_task_file(), doc_generic_project_odt\get_substitutionarray_tasks(), doc_generic_task_odt\get_substitutionarray_tasks(), doc_generic_project_odt\get_substitutionarray_taskstime(), doc_generic_task_odt\get_substitutionarray_taskstime(), CommonDocGenerator\get_substitutionarray_user(), getActionComm(), AccountingJournal\getAssetData(), ToolCategories\getCategoryDetails(), html_generic\getContents(), getCustomerInvoiceLatestEditTable(), getCustomerInvoiceUnpaidOpenTable(), getDefaultDatesForTransfer(), AccountingJournal\getDiscountCustomer(), AccountingJournal\getDiscountSupplier(), getInvoice(), ToolInvoices\getInvoice(), getInvoicesForThirdParty(), Memo\getJsMemo(), ChargeSociales\getKanbanView(), Contrat\getKanbanView(), Loan\getKanbanView(), Localtax\getKanbanView(), PaymentExpenseReport\getKanbanView(), PaymentVarious\getKanbanView(), RemiseCheque\getKanbanView(), Subscription\getKanbanView(), SupplierProposal\getKanbanView(), Tva\getKanbanView(), PriceGlobalVariableUpdater\getLastUpdated(), getLicenceHeader(), BookkeepingTemplate\getNextNumRef(), mod_asset_standard\getNextValue(), mod_bom_standard\getNextValue(), mod_chequereceipt_mint\getNextValue(), mod_codeclient_monkey\getNextValue(), mod_commande_fournisseur_muguet\getNextValue(), mod_commande_marbre\getNextValue(), mod_contract_serpis\getNextValue(), mod_delivery_jade\getNextValue(), mod_evaluation_standard\getNextValue(), mod_expedition_safor\getNextValue(), mod_expensereport_jade\getNextValue(), mod_facture_fournisseur_cactus\getNextValue(), mod_facture_mars\getNextValue(), mod_facture_terre\getNextValue(), mod_holiday_madonna\getNextValue(), mod_knowledgerecord_standard\getNextValue(), mod_lot_standard\getNextValue(), mod_member_advanced\getNextValue(), mod_mo_standard\getNextValue(), mod_myobject_standard\getNextValue(), mod_pacific\getNextValue(), mod_partnership_standard\getNextValue(), mod_payment_cicada\getNextValue(), mod_project_simple\getNextValue(), mod_propale_marbre\getNextValue(), mod_reception_beryl\getNextValue(), mod_recruitmentcandidature_standard\getNextValue(), mod_recruitmentjobposition_standard\getNextValue(), mod_sn_standard\getNextValue(), mod_stocktransfer_standard\getNextValue(), mod_supplier_payment_bronan\getNextValue(), mod_supplier_proposal_marbre\getNextValue(), mod_takepos_ref_simple\getNextValue(), mod_task_simple\getNextValue(), mod_ticket_simple\getNextValue(), BonPrelevement\getNomUrl(), ConferenceOrBoothAttendee\getNomUrl(), Don\getNomUrl(), FactureFournisseurRec\getNomUrl(), FactureRec\getNomUrl(), Loan\getNomUrl(), Paiement\getNomUrl(), PaiementFourn\getNomUrl(), PaymentExpenseReport\getNomUrl(), PaymentSocialContribution\getNomUrl(), PaymentVAT\getNomUrl(), Subscription\getNomUrl(), getOrder(), getOrdersForThirdParty(), mod_bookkeeping_argon\getPrefix(), getProductOrService(), ExternalModules\getProducts(), getProductsForCategory(), getProject(), getPurchaseInvoiceLatestEditTable(), ToolReports\getPurchaseReport(), ToolReports\getSalesReport(), getServerTimeZoneInt(), getStructuredData(), CommonDocGenerator\getSubstitutionarrayMember(), getSupplierInvoice(), getSupplierInvoicesForThirdParty(), ToolProducts\getSupplierPrices(), getThirdParty(), ToolReports\getThirdpartyTransactions(), ActionComm\getTooltipContentArray(), Commande\getTooltipContentArray(), CommandeFournisseur\getTooltipContentArray(), Cronjob\getTooltipContentArray(), Facture\getTooltipContentArray(), FactureFournisseur\getTooltipContentArray(), Fiscalyear\getTooltipContentArray(), Holiday\getTooltipContentArray(), Opensurveysondage\getTooltipContentArray(), PaymentSalary\getTooltipContentArray(), Productlot\getTooltipContentArray(), Project\getTooltipContentArray(), Propal\getTooltipContentArray(), Ticket\getTooltipContentArray(), User\getTooltipContentArray(), getUser(), BordereauChequeBlochet\Header(), DoliDB\idate(), Status\index(), printing_printgcp\listJobs(), box_accountancy_last_manual_entries\loadBox(), box_actions\loadBox(), box_actions_future\loadBox(), box_birthdays\loadBox(), box_birthdays_members\loadBox(), box_boms\loadBox(), box_clients\loadBox(), box_commandes\loadBox(), box_contacts\loadBox(), box_contracts\loadBox(), box_external_rss\loadBox(), box_factures\loadBox(), box_factures_fourn\loadBox(), box_factures_fourn_imp\loadBox(), box_factures_imp\loadBox(), box_fediverse\loadBox(), box_ficheinter\loadBox(), box_fournisseurs\loadBox(), box_goodcustomers\loadBox(), box_graph_nb_ticket_last_x_days\loadBox(), box_last_knowledgerecord\loadBox(), box_last_modified_knowledgerecord\loadBox(), box_last_modified_ticket\loadBox(), box_last_ticket\loadBox(), box_lastlogin\loadBox(), box_members_last_modified\loadBox(), box_members_last_subscriptions\loadBox(), box_members_subscriptions_by_year\loadBox(), box_mos\loadBox(), box_produits\loadBox(), box_propales\loadBox(), box_prospect\loadBox(), box_scheduled_jobs\loadBox(), box_services_contracts\loadBox(), box_services_expired\loadBox(), box_supplier_orders\loadBox(), box_supplier_orders_awaiting_reception\loadBox(), FormProduct\loadLotStock(), Adherent\makeSubstitution(), migrate_blockedlog_add_end_file(), numero_semaine(), ExpenseReport\offsetAlreadyGiven(), pdf_getlinedesc(), Projects\post(), Tasks\post(), printCodeForPing(), pdf_standard_expensereport\printLine(), DateField\printOutputField(), DatetimeField\printOutputField(), DatetimegmtField\printOutputField(), TimestampField\printOutputField(), projectLinesPerAction(), report_header(), Cronjob\reprogram_jobs(), MouvementStock\reverseMovement(), InterfaceActionsAuto\runTrigger(), CMailFile\save_dump_mail_in_err(), ToolInvoices\searchInvoices(), Form\selectDate(), Facture\sendEmailsRemindersOnInvoiceDueDate(), FactureFournisseur\sendEmailsRemindersOnSupplierInvoiceDueDate(), sendMail(), Holiday\sendPreviousMonthHRInformations(), dolReceiptPrinter\sendToPrinter(), BonPrelevement\set_infocredit(), BonPrelevement\set_infotrans(), vCard\setBirthday(), FormAI\setSubstitFromObject(), show_bookcal_day_events(), show_contacts(), show_projects(), FormActions\showactions(), Commande\showDelay(), CommandeFournisseur\showDelay(), FormFile\showdocuments(), ExtraFields\showOutputField(), showWebsiteTemplates(), pdf_standard_expensereport\tablePayments(), top_menu_user(), treeOutputForAbsoluteDir(), Product\update(), Lettering\updateGeneralMatching(), Holiday\updateSoldeCP(), usageCron(), Facture\validate(), ActionsTicket\viewTicketTimelineMessages(), write_conf_file(), doc_generic_asset_odt\write_file(), doc_generic_member_odt\write_file(), doc_generic_odt\write_file(), doc_generic_product_odt\write_file(), doc_generic_project_odt\write_file(), doc_generic_stock_odt\write_file(), doc_generic_ticket_odt\write_file(), doc_generic_user_odt\write_file(), doc_generic_usergroup_odt\write_file(), html_cerfafr\write_file(), pdf_balance\write_file(), pdf_baleine\write_file(), pdf_beluga\write_file(), pdf_bookkeeping\write_file(), pdf_ledger\write_file(), pdf_paiement\write_file(), pdf_soleil\write_file(), pdf_standard_member\write_file(), pdf_standard_movementstock\write_file(), pdf_strato\write_file(), and pdf_timespent\write_file().

◆ dol_print_email()

dol_print_email ( $email,
$contactid = 0,
$socid = 0,
$addlink = 0,
$max = 0,
$showinvalid = 1,
$withpicto = 0,
$morecss = 'paddingrightonly' )

Show EMail link formatted for HTML output.

Parameters
string$emailEMail to show (can be 'email' or 'Name of recipient <email>')
int$contactidId of contact if known
int$socidId of third party if known
int | string$addlink0=no link, 1=email has a html email link (+ link to create action if constant AGENDA_ADDACTIONFOREMAIL is on), 'thirdparty'=link to the thirdparty presend email
int$maxMax number of characters to show. Use -1 to hide the mail text and show only the picto.
int$showinvalid1=Show warning if syntax email is wrong
int | string$withpicto0=Show email, 1=Show picto of email + email, 2=Show only picto
string$morecssMore CSS
Returns
string HTML Link

Definition at line 4420 of file functions.lib.php.

Referenced by ActionsAdherentCardCommon\assign_values(), ActionsCardCommon\assign_values(), ActionsContactCardCommon\assign_values(), Form\editfieldval(), WebPortalMember\getBannerAddressForWebPortal(), Project\getKanbanView(), Societe\getKanbanView(), box_last_modified_ticket\loadBox(), box_last_ticket\loadBox(), EmailField\printOutputField(), and ExtraFields\showOutputField().

◆ dol_print_error()

dol_print_error ( $db = null,
$error = '',
$errors = null )

Displays error message system with all the information to facilitate the diagnosis and the escalation of the bugs.

This function must be called when a blocking technical error is encountered. However, one must try to call it only within php pages, classes must return their error through their property "error".

Parameters
DoliDB | null$dbDatabase handler
string | string[]$errorString or array of errors strings to show
string[] | null$errorsArray of errors
Returns
void
See also
dol_htmloutput_errors()

Definition at line 6917 of file functions.lib.php.

Referenced by modAgenda\__construct(), MouvementStock\_create(), Stats\_getAllByProduct(), Stats\_getAllByYear(), Stats\_getAmountByMonth(), Stats\_getAverageByMonth(), Stats\_getNbByMonth(), Stats\_getNbByYear(), Product\_log_price(), pdf_standard_movementstock\_pagehead(), pdf_standard_stock\_pagehead(), Product\add_sousproduit(), mailing_contacts1\add_to_target(), addDocumentModel(), Account\addline(), ActionsStripeconnect\addMoreActionsButtons(), Localtax\addPayment(), Tva\addPayment(), Paiement\addPaymentToBank(), PaymentDonation\addPaymentToBank(), PaymentExpenseReport\addPaymentToBank(), PaymentLoan\addPaymentToBank(), PaymentSalary\addPaymentToBank(), PaymentVAT\addPaymentToBank(), User\addrights(), UserGroup\addrights(), MailingTargets\addTargetsToDatabase(), Task\addTimeSpent(), ai_log_request(), ajouter_sondage(), Partnership\approve(), ActionsAdherentCardCommon\assign_post(), ActionsContactCardCommon\assign_post(), ProductAttribute\attributeOrder(), Export\build_filterField(), calcul_price_total(), MouvementStock\calculateBalanceForProductBefore(), Account\can_be_deleted(), Stripe\cardStripe(), BonPrelevement\checkIfSalaryBonPrelevement(), checkUserAccessToObject(), chequereceipt_pdf_create(), CommandeFournisseur\classifyBilled(), CommandeFournisseur\classifyUnBilled(), clean_data_ecm_directories(), cleanCorruptedTree(), ModeleImports\commonImportInsert(), DoliDBMysqli\connect(), Form\constructProductListOption(), Societe\contact_array(), Societe\contact_array_objects(), Societe\contact_get_property(), contact_prepare_head(), Societe\contact_property_array(), Categorie\containing(), Account\countAccountToReconcile(), Categorie\countNbOfCategories(), Commande\countNbOfShipments(), BlockedLog\countRecord(), Commande\create(), CommandeFournisseur\create(), Expedition\create(), Facture\create(), FactureFournisseur\create(), Fichinter\create(), Menubase\create(), PaymentVarious\create(), Propal\create(), SupplierProposal\create(), Holiday\createCPusers(), createNewDictionnary(), FactureFournisseurRec\createRecurringInvoices(), FactureRec\createRecurringInvoices(), Project\createWeeklyReport(), Stripe\customerStripe(), Product\del_sousproduit(), delDocumentModel(), BonPrelevement\delete(), DiscountAbsolute\delete(), PaymentLoan\delete(), ExtraFields\delete_label(), Facture\deleteLine(), User\delrights(), UserGroup\delrights(), doc_label_pdf_create(), dol_check_secure_access_document(), dol_dir_list_in_database(), dol_set_user_param(), dolibarr_del_const(), dolibarr_set_const(), dolSavePageContent(), dolSessionWrite(), facture_prepare_head(), facturefourn_prepare_head(), Bookmark\fetch(), Categorie\fetch(), CommandeFournisseurLigne\fetch(), CompanyBankAccount\fetch(), Don\fetch(), ExpenseReportLine\fetch(), Export\fetch(), Import\fetch(), Notify\fetch(), Paiement\fetch(), PaiementFourn\fetch(), SupplierProposalLine\fetch(), Ticket\fetch(), UserBankAccount\fetch(), Opensurveysondage\fetch_lines(), Adherent\fetch_login(), Adherent\fetch_name(), ActionComm\fetch_userassigned(), EmailCollector\fetchActions(), ExpeditionLineBatch\fetchAll(), ProductAttribute\fetchAll(), Task\fetchAllTimeSpent(), CommonObject\fetchBarCode(), EmailCollector\fetchFilters(), CommonObject\fetchObjectLinked(), ActionComm\fetchResources(), Task\fetchTimeSpentOnTask(), CommonObject\fetchValuesForExtraLanguages(), fichinter_create(), FormCompany\form_prospect_level(), mailing_advthirdparties\formFilter(), mailing_contacts1\formFilter(), mailing_fraise\formFilter(), mailing_partnership\formFilter(), mailing_thirdparties\formFilter(), FormCompany\formProspectContactLevel(), Utils\generateDoc(), Societe\generateDocument(), RemiseCheque\generatePdf(), Categorie\get_all_categories(), User\get_children(), Project\get_element_list(), Categorie\get_filles(), FormMail\get_form(), Categorie\get_full_arbo(), EcmDirectory\get_full_arbo(), Entrepot\get_full_arbo(), User\get_full_tree(), get_left_menu_accountancy(), Categorie\get_meres(), get_next_value(), FactureLigne\get_prev_progress(), Account\get_url(), Fiscalyear\getAccountancyEntriesByFiscalYear(), Fiscalyear\getAccountancyMovementsByFiscalYear(), FactureLigne\getAllPrevProgress(), ExpenseReportIk\getAllRanges(), ExpenseReportRule\getAllRule(), MouvementStock\getBatchCount(), CommonObject\getCanvas(), AccountancyCategory\getCats(), Project\getChildren(), Product\getChildsArbo(), Contact\getContactRoles(), Societe\getContacts(), getCountriesInEEC(), getCountriesInSEPA(), getCountry(), AccountancyCategory\getCptsCat(), getCustomerInvoiceDraftTable(), getCustomerInvoiceLatestEditTable(), getCustomerInvoiceUnpaidOpenTable(), getCustomerOrderPieChart(), getCustomerProposalPieChart(), MouvementStock\getDateLastMovementProductBatch(), CommandeFournisseur\getDispachedLines(), getDraftSupplierTable(), ExpenseReportLine\getExpAmount(), Product\getFather(), ActionsCardProduct\getFieldListCanvas(), ActionsCardService\getFieldListCanvas(), Tva\getIdForLabel(), CommandeFournisseur\getInputMethod(), Evaluation\getLastEvaluationForUser(), Categorie\getListForItem(), CommonInvoice\getListIdAvoirFromInvoice(), InterfaceNotification\getListOfManagedEvents(), getListOfModels(), CommonInvoice\getListOfPayments(), ExpenseReportIk\getMaxRangeNumber(), modStockTransfer\getNextId(), ConferenceOrBoothAttendee\getNextNumRef(), ExpenseReport\getNextNumRef(), Facture\getNextNumRef(), FactureFournisseur\getNextNumRef(), Fichinter\getNextNumRef(), KnowledgeRecord\getNextNumRef(), Mo\getNextNumRef(), MyObject\getNextNumRef(), Paiement\getNextNumRef(), PaiementFourn\getNextNumRef(), Partnership\getNextNumRef(), Position\getNextNumRef(), ProductFournisseurPrice\getNextNumRef(), RecruitmentJobPosition\getNextNumRef(), RemiseCheque\getNextNumRef(), Skill\getNextNumRef(), Skilldet\getNextNumRef(), StockTransfer\getNextNumRef(), StockTransferLine\getNextNumRef(), Target\getNextNumRef(), TimeSpent\getNextNumRef(), Workstation\getNextNumRef(), mod_expensereport_jade\getNextValue(), mod_facture_fournisseur_cactus\getNextValue(), mod_facture_mars\getNextValue(), mod_facture_terre\getNextValue(), mod_takepos_ref_simple\getNextValue(), getNumberInvoicesPieChart(), Stripe\getPaymentIntent(), BlockedLog\getPreviousHash(), getProductForEmailTemplate(), Project\getProjectsAuthorizedForUser(), getPurchaseInvoiceLatestEditTable(), getPurchaseInvoiceUnpaidOpenTable(), ExpenseReportIk\getRangesByCategory(), Don\getRemainToPay(), Societe\getSalesRepresentatives(), getServerTimeZoneInt(), Job\getSkillRankForJob(), getSourceDocRef(), getState(), Stripe\getStripeAccount(), CommonInvoice\getSubtypeLabel(), DiscountAbsolute\getSumCreditNotesUsed(), DiscountAbsolute\getSumDepositsUsed(), DiscountAbsolute\getSumFromThisCreditNotesNotUsed(), Task\getSummaryOfTimeSpent(), Task\getSumOfAmount(), Task\getTasksArray(), ExpenseReportIk\getTaxCategories(), Contrat\getTotalizedLines(), Holiday\getTypes(), Task\getUserRolesForProjectsOrTasks(), CommonObject\indexFile(), AccountingAccount\info(), ActionComm\info(), Adherent\info(), Asset\info(), AssetModel\info(), Availabilities\info(), BOM\info(), BOMLine\info(), Calendar\info(), ChargeSociales\info(), Commande\info(), CommandeFournisseur\info(), CompanyPaymentMode\info(), ConferenceOrBooth\info(), ConferenceOrBoothAttendee\info(), Contrat\info(), CTicketCategory\info(), Don\info(), EmailCollector\info(), EmailCollectorAction\info(), EmailCollectorFilter\info(), EmailSenderProfile\info(), Entrepot\info(), Establishment\info(), Evaluation\info(), EvaluationLine\info(), ExpenseReport\info(), Facture\info(), FactureFournisseur\info(), FactureRec\info(), Fichinter\info(), Fiscalyear\info(), Holiday\info(), Hook\info(), Inventory\info(), Job\info(), KnowledgeRecord\info(), Mo\info(), MyObject\info(), Paiement\info(), PaiementFourn\info(), Partnership\info(), PartnershipType\info(), PaymentExpenseReport\info(), PaymentVarious\info(), Position\info(), Product\info(), ProductFournisseurPrice\info(), Project\info(), Propal\info(), RecruitmentCandidature\info(), RecruitmentJobPosition\info(), Salary\info(), Skill\info(), Skilldet\info(), SkillRank\info(), Societe\info(), SocieteAccount\info(), StockTransfer\info(), StockTransferLine\info(), Subscription\info(), SupplierProposal\info(), Target\info(), TimeSpent\info(), TriggerHistory\info(), Tva\info(), User\info(), Workstation\info(), DocumentController\init(), modEmailCollector\init(), FichinterLigne\insert(), DolibarrModules\insert_permissions(), Product\is_sousproduit(), isBlockedLogUsed(), CommonObject\isObjectUsed(), Product\isVariant(), CommonObject\line_order(), Export\list_export_model(), Fournisseur\ListArray(), Commande\liste_array(), Facture\liste_array(), Propal\liste_array(), SupplierProposal\liste_array(), CommonObject\liste_contact(), Ticket\listeContact(), ExpenseReport\listOfTypes(), mod_barcode_product_standard\literalBarcodeType(), mod_barcode_thirdparty_standard\literalBarcodeType(), Translate\load(), Account\load_board(), ActionComm\load_board(), Adherent\load_board(), BonPrelevement\load_board(), Contrat\load_board(), ExpenseReport\load_board(), Facture\load_board(), FactureFournisseur\load_board(), Holiday\load_board(), Mo\load_board(), RemiseCheque\load_board(), Form\load_cache_availability(), Form\load_cache_conditions_paiements(), Form\load_cache_invoice_subtype(), Form\load_cache_transport_mode(), Form\load_cache_types_fees(), Form\load_cache_types_paiements(), Categorie\load_motherof(), EcmDirectory\load_motherof(), CommonObject\load_previous_next_ref(), Product\load_virtual_stock(), Product\loadBatchInfo(), box_activity\loadBox(), box_funnel_of_prospection\loadBox(), box_graph_nb_ticket_last_x_days\loadBox(), box_graph_nb_tickets_type\loadBox(), box_graph_new_vs_close_ticket\loadBox(), box_graph_ticket_by_severity\loadBox(), box_last_knowledgerecord\loadBox(), box_last_modified_knowledgerecord\loadBox(), box_last_modified_ticket\loadBox(), box_last_ticket\loadBox(), box_task\loadBox(), box_validated_projects\loadBox(), Ticket\loadCacheCategoriesTickets(), Dolresource\loadCacheCodeTypeResource(), Translate\loadCacheCurrencies(), Ticket\loadCacheSeveritiesTickets(), Ticket\loadCacheTypesTickets(), User\loadDefaultValues(), Translate\loadFromDatabase(), FormProduct\loadLotStock(), User\loadParentOf(), FormListWebPortal\loadRecords(), Account\loadStateBoard(), Adherent\loadStateBoard(), Client\loadStateBoard(), Commande\loadStateBoard(), CommandeFournisseur\loadStateBoard(), Contact\loadStateBoard(), Contrat\loadStateBoard(), Dolresource\loadStateBoard(), Don\loadStateBoard(), ExpenseReport\loadStateBoard(), Facture\loadStateBoard(), FactureFournisseur\loadStateBoard(), Fichinter\loadStateBoard(), Fournisseur\loadStateBoard(), Holiday\loadStateBoard(), KnowledgeRecord\loadStateBoard(), Product\loadStateBoard(), Project\loadStateBoard(), Propal\loadStateBoard(), RemiseCheque\loadStateBoard(), SupplierProposal\loadStateBoard(), Task\loadStateBoard(), Ticket\loadStateBoard(), User\loadStateBoard(), Project\loadTimeSpent(), Project\loadTimeSpentMonth(), FormProduct\loadWarehouses(), FormProduct\loadWorkstations(), localtax_pt(), CommonInvoice\makeStripeSepaRequest(), Invoices\markAsCreditAvailable(), member_prepare_head(), members_card_pdf_create(), Menubase\menuLoad(), migrate_accountingbookkeeping(), migrate_actioncomm_element(), migrate_apiresttokens(), migrate_blockedlog_add_hmac_key(), migrate_categorie_association(), migrate_commande_deliveryaddress(), migrate_commande_expedition(), migrate_commande_livraison(), migrate_contacts_socialnetworks(), migrate_contractdet_rank(), migrate_contracts_date1(), migrate_contracts_date2(), migrate_contracts_date3(), migrate_contracts_det(), migrate_contracts_open(), migrate_customerorder_shipping(), migrate_detail_livraison(), migrate_element_time(), migrate_event_assignement(), migrate_event_assignement_contact(), migrate_export_import_profiles(), migrate_invoice_export_models(), migrate_links_transfert(), migrate_members_socialnetworks(), migrate_menus(), migrate_mode_reglement(), migrate_modeles(), migrate_paiements_orphelins_1(), migrate_paiements_orphelins_2(), migrate_project_task_actors(), migrate_project_user_resp(), migrate_relationship_tables(), migrate_remise_entity(), migrate_remise_except_entity(), migrate_reset_blocked_log(), migrate_restore_missing_links(), migrate_shipping_delivery(), migrate_shipping_delivery2(), migrate_stocks(), migrate_thirdparties_socialnetworks(), migrate_user_rights_entity(), migrate_usergroup_rights_entity(), migrate_users_socialnetworks(), FormAdvTargetEmailing\multiselectCivility(), FormAdvTargetEmailing\multiselectCountry(), FormAdvTargetEmailing\multiselectProspectionStatus(), FormAdvTargetEmailing\multiselectselectSalesRepresentatives(), FormAdvTargetEmailing\multiselectState(), ExpenseReport\offsetAlreadyGiven(), ordered(), pdf_bank(), pdf_watermark(), print_left_auguria_menu(), printDropdownBookmarksList(), printing_printipp\printFile(), CommonObject\printObjectLine(), Mo\processBOM(), project_prepare_head(), pt(), rebuild_merge_pdf(), rebuildObjectClass(), recruitmentjobpositionPrepareHead(), Contrat\reopen(), Don\reopen(), security_prepare_head(), FormAccounting\select_accounting_category(), Form\select_bom(), FormCompany\select_civility(), Form\select_comptes(), FormContract\select_contract(), Form\select_dolgroups(), Form\select_dolusers(), FormProjets\select_element(), Form\select_export_model(), Form\select_incoterms(), FormIntervention\select_interventions(), FormAdmin\select_paper_format(), Form\select_product_fourn_price(), Form\select_produits_fournisseurs_list(), Form\select_produits_list(), FormProjets\select_projects_list(), FormCompany\select_region(), Form\select_remises(), FormResource\select_resource_list(), FormCompany\select_state(), FormResource\select_state(), Form\select_thirdparty_list(), FormSocialContrib\select_type_socialcontrib(), FormAdvTargetEmailing\selectAdvtargetemailingTemplate(), FormBarCode\selectBarcodeType(), FormCompany\selectCompaniesForNewContact(), Form\selectcontacts(), Form\selectEstablishments(), FormFiscalYear\selectFiscalYear(), Form\selectForFormsList(), FormTicket\selectGroupTickets(), FormOrder\selectInputMethod(), FormProjets\selectInvoiceAndLine(), FormProduct\selectMeasuringUnits(), Form\selectPhoneCode(), FormCategory\selectProductCategory(), FormProduct\selectProductNature(), FormPropal\selectProposalStatus(), Form\selectRib(), Form\selectShippingMethod(), FormProjets\selectTasks(), FormWebsite\selectWebsite(), Notify\send(), CSMSFile\sendfile(), Stripe\sepaStripe(), FichinterRec\set_auto(), Don\set_cancel(), Commande\set_reopen(), CompanyPaymentMode\setAsDefault(), FactureFournisseurRec\setAutoValidate(), FactureRec\setAutoValidate(), FichinterRec\setAutoValidate(), Expedition\setClosed(), Reception\setClosed(), CommonObject\setDocModel(), Context\setEventMessages(), FactureRec\setFrequencyAndUnit(), FichinterRec\setFrequencyAndUnit(), FactureFournisseurRec\setGeneratePdf(), FactureRec\setGeneratePdf(), FactureRec\setMailTemplate(), FactureFournisseurRec\setMaxPeriod(), FactureRec\setMaxPeriod(), FichinterRec\setMaxPeriod(), FactureFournisseurRec\setModelPdf(), FactureRec\setModelPdf(), FactureRec\setNextDate(), FichinterRec\setNextDate(), Don\setPaid(), ExpenseReport\setPaid(), FactureFournisseur\setPaid(), Adherent\setPassword(), User\setPassword(), Societe\setPriceLevel(), CommonObject\setProject(), Facture\setUnpaid(), FactureFournisseur\setUnpaid(), Fichinter\setValid(), show_actions_done(), show_array_actions_to_do(), show_array_last_actions_done(), show_contacts(), show_contacts_projects(), FormSms\show_form(), show_projects(), show_stats_for_batch(), show_stats_for_company(), FormActions\showactions(), FormFile\showdocuments(), Form\showLinkToObjectBlock(), societe_prepare_head(), CommonObject\swapContactStatus(), task_prepare_head(), tax_by_rate(), tax_by_thirdparty(), Account\update(), Categorie\update(), ExpenseReportLine\update(), Product\update(), Account\update_bban(), Localtax\update_fk_bank(), PaymentVarious\update_fk_bank(), Salary\update_fk_bank(), Tva\update_fk_bank(), ExtraFields\update_label(), Product\update_sousproduit(), ProductAttribute\updateAttributePositionDown(), ProductAttribute\updateAttributePositionUp(), FichinterRec\updateNbGenDone(), ProductAttribute\updatePositionOfAttribute(), CommonObject\updateRangOfLine(), User\user_get_property(), user_prepare_head(), Commande\valid(), CommandeFournisseur\valid(), Propal\valid(), SupplierProposal\valid(), Asset\validate(), AssetModel\validate(), Availabilities\validate(), BOM\validate(), Calendar\validate(), ConferenceOrBooth\validate(), ConferenceOrBoothAttendee\validate(), Contrat\validate(), Evaluation\validate(), Job\validate(), KnowledgeRecord\validate(), Mo\validate(), MyObject\validate(), Partnership\validate(), Position\validate(), ProductFournisseurPrice\validate(), RecruitmentCandidature\validate(), RecruitmentJobPosition\validate(), Skill\validate(), Skilldet\validate(), SkillRank\validate(), StockTransfer\validate(), StockTransferLine\validate(), Target\validate(), TimeSpent\validate(), Holiday\verifDateHolidayCP(), Holiday\verifDateHolidayForTimestamp(), ActionsTicket\viewTicketMessages(), Facture\willBeLastOfSameType(), doc_generic_asset_odt\write_file(), doc_generic_member_odt\write_file(), doc_generic_product_odt\write_file(), doc_generic_project_odt\write_file(), doc_generic_stock_odt\write_file(), doc_generic_ticket_odt\write_file(), doc_generic_user_odt\write_file(), doc_generic_usergroup_odt\write_file(), pdf_paiement\write_file(), pdf_standard_member\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_stock\write_file(), pdf_standardlabel\write_file(), and pdf_tcpdflabel\write_file().

◆ dol_print_error_email()

dol_print_error_email ( $prefixcode,
$errormessage = '',
$errormessages = array(),
$morecss = 'error',
$email = '' )

Show a public email and error code to contact if technical error.

Parameters
string$prefixcodePrefix of public error code
string$errormessageComplete error message
string[]$errormessagesArray of error messages
string$morecssMore css
string$emailEmail
Returns
void

Definition at line 7069 of file functions.lib.php.

◆ dol_print_ip()

dol_print_ip ( $ip,
$mode = 0,
$showname = 0 )

Return an IP formatted to be shown on screen.

Parameters
string$ipIP
int$mode0=return IP + country/flag, 1=return only country/flag, 2=return only IP
int$showname1=Show reverse domain name instead of IP
Returns
string Formatted IP, with country if GeoIP module is enabled

Definition at line 5151 of file functions.lib.php.

Referenced by box_lastlogin\loadBox(), IpField\printOutputField(), and ExtraFields\showOutputField().

◆ dol_print_phone()

dol_print_phone ( $phone,
$countrycode = '',
$contactid = 0,
$socid = 0,
$addlink = '',
$separ = "&nbsp;",
$withpicto = '',
$titlealt = '',
$adddivfloat = 0,
$morecss = 'paddingright' )

Format phone numbers according to country.

Parameters
string$phonePhone number to format
string$countrycodeCountry code to use for formatting
int$contactidId of contact if known
int$socidId of third party if known
string$addlink''=no link to create action, 'AC_TEL'=add link to clicktodial (if module enabled) and add link to create event (if conf->global->AGENDA_ADDACTIONFORPHONE set), 'tel'=Force "tel:..." link
string$separSeparation between numbers for a better visibility example : xx.xx.xx.xx.xx. You can also use 'hidenum' to hide the number, keep only the picto.
string$withpictoShow picto ('fax', 'phone', 'mobile')
string$titlealtText to show on alt
int$adddivfloatAdd div float around phone.
string$morecssAdd more css
Returns
string Formatted phone number

Definition at line 4808 of file functions.lib.php.

Referenced by ActionsAdherentCardCommon\assign_values(), ActionsCardCommon\assign_values(), ActionsContactCardCommon\assign_values(), Form\editfieldval(), WebPortalMember\getBannerAddressForWebPortal(), Project\getKanbanView(), Societe\getKanbanView(), Contact\getTooltipContentArray(), Societe\getTooltipContentArray(), User\getTooltipContentArray(), PhoneField\printOutputField(), show_actions_done(), and ExtraFields\showOutputField().

◆ dol_print_profids()

dol_print_profids ( $profID,
$profIDtype,
$countrycode = '',
$addcpButton = 1 )

Format professional IDs according to their country.

Parameters
string$profIDValue of profID to format
string$profIDtypeType of profID to format ('1', '2', '3', '4', '5', '6' or 'VAT')
string$countrycodeCountry code to use for formatting
int<0,2>$addcpButton Add button to copy to clipboard (1 => show only on hoover ; 2 => always display )
Returns
string Formatted profID

Definition at line 4751 of file functions.lib.php.

Referenced by top_menu_user().

◆ dol_print_size()

dol_print_size ( $size,
$shortvalue = 0,
$shortunit = 0 )

Return string with formatted size.

Parameters
int$sizeSize to print
int$shortvalueTell if we want long value to use another unit (Ex: 1.5Kb instead of 1500b)
int$shortunitUse short label of size unit (for example 'b' instead of 'bytes')
Returns
string Link

Definition at line 4333 of file functions.lib.php.

Referenced by DolMemoryCollector\collect(), AbstractDocumentController\displayDocumentTable(), FormFile\list_of_autoecmfiles(), FormFile\list_of_documents(), and FormFile\showdocuments().

◆ dol_print_socialnetworks()

dol_print_socialnetworks ( $value,
$contactid,
$socid,
$type,
$dictsocialnetworks = array() )

Show social network link.

Parameters
string$valueSocial network ID to show (only skype, without 'Name of recipient' before)
int$contactidId of contact if known
int$socidId of third party if known
string$typeType of social network: 'skype','facebook',...
array<string,array{rowid:int,label:string,url:string,icon:string,active:int}>$dictsocialnetworks List of socialnetworks available
Returns
string HTML Link

Definition at line 4649 of file functions.lib.php.

◆ dol_print_url()

dol_print_url ( $url,
$target = '_blank',
$max = 32,
$withpicto = 0,
$morecss = '' )

Show Url link.

Parameters
string$urlUrl to show
string$targetTarget for link
int$maxMax number of characters to show
int$withpictoWith picto
string$morecssMore CSS
Returns
string HTML Link

Definition at line 4372 of file functions.lib.php.

Referenced by ActionsCardCommon\assign_values(), Form\editfieldval(), WebPortalMember\getBannerAddressForWebPortal(), UrlField\printOutputField(), and ExtraFields\showOutputField().

◆ dol_sanitizeEmail()

dol_sanitizeEmail ( $stringtoclean)

Clean a string to use it as an Email.

Parameters
string$stringtocleanString to clean. Example 'abc@m.nosp@m.ycom.nosp@m.pany..nosp@m.com <My name>'
Returns
string Escaped string.

Definition at line 2034 of file functions.lib.php.

Referenced by CMailFile\__construct().

◆ dol_sanitizeFileName()

dol_sanitizeFileName ( $str,
$newstr = '_',
$unaccent = 1,
$includequotes = 0,
$allowdash = 0 )

Clean a string to use it as a file name.

Replace also '–' and ' -' strings, they are used for parameters separation (Note: ' - ' is allowed).

Parameters
string | null$strString to clean
string$newstrString to replace bad chars with.
int$unaccent1=Remove also accent (default), 0 do not remove them
int$includequotes1=Include simple quotes (double is already included by default)
int$allowdash1=Allow dash char after a space and before a string, 0 do not allow
Returns
string String cleaned
See also
dol_string_nospecial(), dol_string_unaccent(), dol_sanitizePathName()

Definition at line 1925 of file functions.lib.php.

Referenced by FileUpload\__construct(), account_statement_prepare_head(), SharedDocumentsController\action(), CommandeFournisseur\approve(), Partnership\approve(), assetPrepareHead(), bank_prepare_head(), Product\check(), clean_data_ecm_directories(), commande_prepare_head(), CommonObject\commonGenerateDocument(), conferenceorboothPrepareHead(), contact_prepare_head(), contract_prepare_head(), EcmDirectory\create(), Expedition\create(), Product\create(), ProductAttribute\create(), ProductAttributeValue\create(), Reception\create(), Project\createFromClone(), Task\createFromClone(), Website\createFromClone(), Commande\delete(), CommandeFournisseur\delete(), Contrat\delete(), Delivery\delete(), Dolresource\delete(), Expedition\delete(), ExpenseReport\delete(), Facture\delete(), FactureFournisseur\delete(), Fichinter\delete(), KnowledgeRecord\delete(), Product\delete(), Project\delete(), Propal\delete(), SupplierProposal\delete(), Task\delete(), CommonObject\deleteCommon(), delivery_prepare_head(), dol_add_file_process(), dol_delete_preview(), dol_meta_create(), dol_uncompress(), donation_prepare_head(), Utils\dumpDatabase(), evaluationPrepareHead(), expensereport_prepare_head(), AccountancyExport\exportFEC(), AccountancyExport\exportFEC2(), AccountancyExport\exportQuadratus(), facture_prepare_head(), fichinter_prepare_head(), Thirdparties\generateBankAccountDocument(), Setup\getCheckIntegrity(), FormWebsite\getContentPageTemplate(), getCustomerInvoiceLatestEditTable(), getCustomerInvoiceUnpaidOpenTable(), Asset\getNomUrl(), AssetModel\getNomUrl(), Availabilities\getNomUrl(), Calendar\getNomUrl(), ConferenceOrBooth\getNomUrl(), ConferenceOrBoothAttendee\getNomUrl(), Evaluation\getNomUrl(), EvaluationLine\getNomUrl(), IntracommReport\getNomUrl(), Job\getNomUrl(), KnowledgeRecord\getNomUrl(), MyObject\getNomUrl(), Partnership\getNomUrl(), PartnershipType\getNomUrl(), Position\getNomUrl(), ProductAttribute\getNomUrl(), ProductFournisseurPrice\getNomUrl(), RecruitmentCandidature\getNomUrl(), RecruitmentJobPosition\getNomUrl(), Skill\getNomUrl(), Skilldet\getNomUrl(), SkillRank\getNomUrl(), StockTransfer\getNomUrl(), StockTransferLine\getNomUrl(), Target\getNomUrl(), TimeSpent\getNomUrl(), TriggerHistory\getNomUrl(), WebPortalPartnership\getNomUrl(), Workstation\getNomUrl(), getPurchaseInvoiceLatestEditTable(), EcmDirectory\getRelativePath(), modMyModule\init(), modPartnership\init(), jobPrepareHead(), knowledgerecordPrepareHead(), FormFile\list_of_documents(), FicheinterListController\listPrintValueBefore(), loan_prepare_head(), memoPrepareHead(), migrate_product_photospath(), moPrepareHead(), myobjectPrepareHead(), ordersupplier_prepare_head(), partnershipPrepareHead(), positionCardPrepareHead(), Documents\post(), Tickets\postNewMessage(), product_prepare_head(), productlot_prepare_head(), project_prepare_head(), propal_prepare_head(), reception_prepare_head(), recruitmentCandidaturePrepareHead(), recruitmentjobpositionPrepareHead(), resource_prepare_head(), Notify\send(), Fichinter\setValid(), ExpenseReport\setValidate(), Conf\setValues(), shipping_prepare_head(), skilldetPrepareHead(), skillPrepareHead(), skillrankPrepareHead(), stocktransferPrepareHead(), supplier_proposal_prepare_head(), task_prepare_head(), tax_prepare_head(), FileUpload\trimFileName(), Account\update(), Dolresource\update(), Product\update(), ProductAttribute\update(), ProductAttributeValue\update(), Project\update(), Task\update(), Commande\valid(), CommandeFournisseur\valid(), Expedition\valid(), Propal\valid(), Reception\valid(), SupplierProposal\valid(), Asset\validate(), Availabilities\validate(), BOM\validate(), Calendar\validate(), ConferenceOrBoothAttendee\validate(), Contrat\validate(), Evaluation\validate(), Facture\validate(), FactureFournisseur\validate(), Holiday\validate(), Job\validate(), KnowledgeRecord\validate(), Mo\validate(), MyObject\validate(), Partnership\validate(), Position\validate(), ProductFournisseurPrice\validate(), RecruitmentCandidature\validate(), RecruitmentJobPosition\validate(), Skill\validate(), Skilldet\validate(), SkillRank\validate(), StockTransfer\validate(), StockTransferLine\validate(), Target\validate(), TimeSpent\validate(), various_payment_prepare_head(), vat_prepare_head(), workstationPrepareHead(), doc_generic_asset_odt\write_file(), doc_generic_member_odt\write_file(), doc_generic_odt\write_file(), doc_generic_product_odt\write_file(), doc_generic_project_odt\write_file(), doc_generic_stock_odt\write_file(), doc_generic_ticket_odt\write_file(), doc_generic_user_odt\write_file(), doc_generic_usergroup_odt\write_file(), html_cerfafr\write_file(), html_generic\write_file(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_balance\write_file(), pdf_baleine\write_file(), pdf_ban\write_file(), pdf_beluga\write_file(), pdf_bookkeeping\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_ledger\write_file(), pdf_merou\write_file(), pdf_muscadet\write_file(), pdf_octopus\write_file(), pdf_rouget\write_file(), pdf_sepamandate\write_file(), pdf_soleil\write_file(), pdf_sponge\write_file(), pdf_squille\write_file(), pdf_standard\write_file(), pdf_standard_asset\write_file(), pdf_standard_evaluation\write_file(), pdf_standard_expensereport\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_standard_stock\write_file(), pdf_standard_supplierpayment\write_file(), pdf_storm\write_file(), pdf_strato\write_file(), pdf_timespent\write_file(), pdf_typhon\write_file(), pdf_vinci\write_file(), pdf_zenith\write_file(), and pdf_standard_salary\writeFile().

◆ dol_sanitizeKeyCode()

dol_sanitizeKeyCode ( $str)

Clean a string to use it as a key or code.

So only char a-Z, A-Z, _ and 0-9 is kept.

Parameters
string$strString to clean
Returns
string String cleaned (a-zA-Z_)
See also
dol_string_nospecial(), dol_string_unaccent(), dol_sanitize...()

Definition at line 2052 of file functions.lib.php.

Referenced by callApiToGetObfuscationKey().

◆ dol_sanitizePathName()

dol_sanitizePathName ( $str,
$newstr = '_',
$unaccent = 0,
$allowdash = 0 )

Clean a string to use it as a path name.

Similar to dol_sanitizeFileName but accept / and \ chars. Replace also '–' and ' -' strings, they are used for parameters separation (Note: ' - ' and 'x-y' is allowed).

Parameters
string$strString to clean
string$newstrString to replace bad chars with
int$unaccent1=Remove also accent, 0 do not remove them
int$allowdash1=Allow dash char after a space and before a string, 0 do not allow
Returns
string String cleaned
See also
dol_string_nospecial(), dol_string_unaccent(), dol_sanitizeFileName()

Definition at line 1963 of file functions.lib.php.

Referenced by FileUpload\__construct(), CommonObject\commonGenerateDocument(), dol_uncompress(), dolSavePageContent(), AntiVir\getCliCommand(), EmailCollector\getpart(), FileUpload\handleFileUpload(), dolReceiptPrinter\initPrinter(), Documents\post(), vignette(), and write_conf_file().

◆ dol_sanitizeUrl()

dol_sanitizeUrl ( $stringtoclean,
$type = 1 )

Clean a string to use it as an URL (into a href or src attribute)

Parameters
string$stringtocleanString to clean
int$type0=Accept all Url, 1=Clean external Url (keep only relative Url)
Returns
string Escaped string.

Definition at line 1998 of file functions.lib.php.

◆ dol_set_focus()

dol_set_focus ( $selector)

Set focus onto field with selector (similar behaviour of 'autofocus' HTML5 tag)

Parameters
string$selectorSelector ('id' or 'input[name="ref"]') to use to find the HTML input field that must get the autofocus. You must use a CSS selector, so unique id preceding with the '#' char.
Returns
void

Definition at line 13411 of file functions.lib.php.

◆ dol_shutdown()

dol_shutdown ( )

Function called at end of web php process.

Returns
void

Definition at line 851 of file functions.lib.php.

◆ dol_size()

dol_size ( $size,
$type = '' )

Optimize a size for some browsers (phone, smarphone...)

Parameters
int$sizeSize we want
string$typeType of optimizing: '' = function used to define a size for truncation 'width' = function is used to define a width
Returns
int New size after optimizing

Definition at line 1898 of file functions.lib.php.

Referenced by box_members_by_tags\loadBox(), and box_members_by_type\loadBox().

◆ dol_sort_array()

dol_sort_array ( & $array,
$index,
$order = 'asc',
$natsort = 0,
$case_sensitive = 0,
$keepindex = 0 )

Advanced sort array by the value of a given key, which produces ascending (default) or descending output and uses optionally natural case insensitive sorting (which can be optionally case sensitive as well).

In dynamic code, this function is allowed when usort is not because it allows callable parameters.

@phpstan-template T of array<string|int,mixed> @phan-template T of array<string|int,mixed>

Parameters
array<string|int,mixed>$array Array to sort (array of array('key1'=>val1,'key2'=>val2,'key3'...) or array of objects) @phpstan-param T $array @phan-param T $array
string$indexKey in array to use for sorting criteria. We can have several keys separated by a comma but we can have only 1 sorting order.
string$orderSort order ('asc' or 'desc')
int<-1,1>$natsort If values are strings (I said value not type): 0=Use alphabetical order, 1=use "natural" sort (natsort), -1=Force alpha order If values are numeric (I said value not type): 0=Use numeric order (even if type is string) so use a "natural" sort, 1=use "natural" sort too (same than 0), -1=Force alphabetical order
int<0,1>$case_sensitive 1=sort is case sensitive, 0=not case sensitive
int<0,1>$keepindex If 0 and index key of array to sort is a numeric, then index will be rewritten. If 1 or index key is not numeric, key for index is kept after sorting.
Returns
array<string|int,mixed> Return the sorted array (the source array is not modified !) @phpstan-return T @phan-return T // Seems useful @phan-suppress PhanTypeMismatchReturn // T not understood without caller

Definition at line 11642 of file functions.lib.php.

Referenced by dol_dir_list(), Categorie\get_full_arbo(), EcmDirectory\get_full_arbo(), User\get_full_tree(), FieldsManager\getAllFieldsInfos(), Setup\getCheckIntegrity(), FormListWebPortal\init(), FormFile\list_of_autoecmfiles(), FormFile\list_of_documents(), Form\load_cache_availability(), Form\load_cache_invoice_subtype(), Form\load_cache_transport_mode(), Form\load_cache_types_paiements(), print_auguria_menu(), print_eldy_menu(), rebuildObjectClass(), show_contacts(), CommonObject\show_photos(), FormFile\showdocuments(), MenuManager\showmenu(), and showModulesExludedForExternal().

◆ dol_strftime()

dol_strftime ( $fmt,
$ts = false,
$is_gmt = false )

Format a string.

Parameters
string$fmtFormat of strftime function (http://php.net/manual/fr/function.strftime.php)
int | false$tsTimestamp (If is_gmt is true, timestamp is already includes timezone and daylight saving offset, if is_gmt is false, timestamp is a GMT timestamp and we must compensate with server PHP TZ)
bool$is_gmtSee comment of timestamp parameter
Returns
string A formatted string
See also
dol_stringtotime()

Definition at line 3853 of file functions.lib.php.

◆ dol_string_is_good_iso()

dol_string_is_good_iso ( $s,
$clean = 0 )

Check if a string is a correct iso string If not, it will not be considered as HTML encoded even if it is by FPDF.

Example, if string contains euro symbol that has ascii code 128

Parameters
string$sString to check
int$cleanClean if it is not an ISO. Warning, if file is utf8, you will get a bad formatted file.
Returns
int|string 0 if bad iso, 1 if good iso, Or the clean string if $clean is 1
Deprecated
Duplicate of ascii_check()
See also
ascii_check()

Definition at line 9968 of file functions.lib.php.

◆ dol_string_neverthesehtmltags()

dol_string_neverthesehtmltags ( $stringtoclean,
$disallowed_tags = array('textarea'),
$cleanalsosomestyles = 0 )

Clean a string from some undesirable HTML tags.

Note: You should use instead dol_string_onlythesehtmltags() that is more secured if you can.

Parameters
string$stringtocleanString to clean
string[]$disallowed_tagsArray of tags not allowed
int<0,1>$cleanalsosomestyles Clean also some tags
Returns
string String cleaned
See also
dol_escape_htmltag() strip_tags() dol_string_nohtmltag() dol_string_onlythesehtmltags() dol_string_onlythesehtmlattributes()

Definition at line 9406 of file functions.lib.php.

Referenced by Form\editfieldval().

◆ dol_string_nohtmltag()

dol_string_nohtmltag ( $stringtoclean,
$removelinefeed = 1,
$pagecodeto = 'UTF-8',
$strip_tags = 0,
$removedoublespaces = 1 )

Clean a string from all HTML tags and entities.

This function differs from strip_tags because:


  • are replaced with
    if removelinefeed=0 or 1
  • if entities are found, they are decoded BEFORE the strip
  • you can decide to convert line feed into a space
Parameters
string$stringtocleanString to clean
integer$removelinefeed1=Replace all new lines strings ('
, "\n", "\r") by 1 space, 0=The last new line endings are removed and others '
' are replaced with "\n", 2=The last new line endings are removed and others '

' are replaced with "\n" with the same nb of "\n" than the nb of
when there is both "...<br>\n..."
string$pagecodetoEncoding of input/output string
integer$strip_tags0=Use internal strip, 1=Use strip_tags() php function (bugged when text contains a < char that is not for a html tag or when tags is not closed like '<img onload=aaa')
integer$removedoublespacesReplace double space into one space
Returns
string String cleaned
See also
dol_escape_htmltag() strip_tags() dol_string_onlythesehtmltags() dol_string_neverthesehtmltags(), dolStripPhpCode()

Definition at line 9047 of file functions.lib.php.

Referenced by Adherent\_load_ldap_info(), AdherentType\_load_ldap_info(), Contact\_load_ldap_info(), User\_load_ldap_info(), UserGroup\_load_ldap_info(), pdf_standard_actions\_pages(), mailing_xinputfile\add_to_target(), ajax_dialog(), build_calfile(), build_rssfile(), DolEditor\Create(), pdf_cyan\defineColumnField(), pdf_eratosthene\defineColumnField(), pdf_octopus\defineColumnField(), pdf_sponge\defineColumnField(), dol_add_file_process(), DolGraph\draw_chart(), ExportExcel2007\excel_clean(), FormMail\get_form(), CommonDocGenerator\getExtrafieldContent(), getFullName(), Adherent\getNomUrl(), Commande\getNomUrl(), CommandeFournisseur\getNomUrl(), FactureFournisseur\getNomUrl(), FormWebPortal\getNomUrl(), Propal\getNomUrl(), SupplierProposal\getNomUrl(), User\getNomUrl(), ExternalModules\getProducts(), getStructuredData(), Societe\getTooltipContentArray(), User\getTooltipContentArray(), pdf_build_address(), print_left_auguria_menu(), Form\selectCurrency(), Form\selectPhoneCode(), ActionComm\sendSmsReminder(), Form\showCategories(), FormTicket\showMessageForm(), AccountancyExport\toAnsi(), ExportTsv\tsv_clean(), and ActionsTicket\viewTicketOriginalMessage().

◆ dol_string_nospecial()

dol_string_nospecial ( $str,
$newstr = '_',
$badcharstoreplace = '',
$badcharstoremove = '',
$keepspaces = 0 )

Clean a string from all punctuation characters to use it as a ref or login.

This is a more complete function than dol_sanitizeFileName().

Parameters
string$strString to clean
string$newstrString to replace forbidden chars with
string[] | string$badcharstoreplaceArray of forbidden characters to replace. Use '' to keep default list.
string[] | string$badcharstoremoveArray of forbidden characters to remove. Use '' to keep default list.
int<0,1>$keepspaces 1=Do not treat space as a special char to replace or remove
Returns
string Cleaned string
See also
dol_sanitizeFilename(), dol_string_unaccent(), dol_string_nounprintableascii()

Definition at line 2193 of file functions.lib.php.

Referenced by barcode_encode_genbarcode(), BonPrelevement\buildRumNumber(), check_value(), Societe\contact_get_property(), Product\create(), ProductAttribute\create(), ProductAttributeValue\create(), CommonObject\createCommon(), PartnershipUtils\doCancelStatusOfMemberPartnership(), dol_buildlogin(), PartnershipUtils\doWarningOfPartnershipIfDolibarrBacklinkNotfound(), DolGraph\draw_chart(), DolGraph\draw_jflot(), BonPrelevement\EnregDestinataireSEPA(), BonPrelevement\EnregEmetteurSEPA(), AccountancyExport\exportFEC(), AccountancyExport\exportFEC2(), BonPrelevement\generate(), get_next_value(), AntiVir\getCliCommand(), Holiday\sendPreviousMonthHRInformations(), Product\update(), ProductAttribute\update(), ProductAttributeValue\update(), CommonObject\updateCommon(), and doc_generic_odt\write_file().

◆ dol_string_nounprintableascii()

dol_string_nounprintableascii ( $str,
$removetabcrlf = 1 )

Clean a string from all non printable ASCII chars (0x00-0x1F and 0x7F).

It can also removes also Tab-CR-LF. UTF8 chars remains. This can be used to sanitize a string and view its real content. Some hacks try to obfuscate attacks by inserting non printable chars. Note, for information: UTF8 on 1 byte are: \x00-\7F 2 bytes are: byte 1 \xc0-\xdf, byte 2 = \x80-\xbf 3 bytes are: byte 1 \xe0-\xef, byte 2 = \x80-\xbf, byte 3 = \x80-\xbf 4 bytes are: byte 1 \xf0-\xf7, byte 2 = \x80-\xbf, byte 3 = \x80-\xbf, byte 4 = \x80-\xbf

Parameters
string$strString to clean
int$removetabcrlfRemove also CR-LF
Returns
string Cleaned string
See also
dol_sanitizeFilename(), dol_string_unaccent(), dol_string_nospecial()

Definition at line 2227 of file functions.lib.php.

Referenced by DolibarrApiAccess\__isAllowed(), and dolDocToText().

◆ dol_string_onlythesehtmlattributes()

dol_string_onlythesehtmlattributes ( $stringtoclean,
$allowed_attributes = null )

Clean a string from some undesirable HTML tags.

Note: Complementary to dol_string_onlythesehtmltags(). This method is used for example by dol_htmlwithnojs() when option MAIN_RESTRICTHTML_REMOVE_ALSO_BAD_ATTRIBUTES is set to 1.

Parameters
string$stringtocleanString to clean
string[]$allowed_attributesArray of tags not allowed
Returns
string String cleaned
See also
dol_htmlwithnojs() dol_escape_htmltag() strip_tags() dol_string_nohtmltag() dol_string_onlythesehtmltags() dol_string_neverthesehtmltags() @phan-suppress PhanUndeclaredProperty

Definition at line 9283 of file functions.lib.php.

◆ dol_string_onlythesehtmltags()

dol_string_onlythesehtmltags ( $stringtoclean,
$cleanalsosomestyles = 1,
$removeclassattribute = 1,
$cleanalsojavascript = 0,
$allowiframe = 0,
$allowed_tags = array(),
$allowlink = 0,
$allowscript = 0,
$allowstyle = 0,
$allowphp = 0 )

Clean a string to keep only desirable HTML tags.

Complementary of dol_string_onlythesehtmlattributes(). WARNING: This also clean HTML comments (because they can be used to obfuscate tag names).

Parameters
string$stringtocleanString to clean
int$cleanalsosomestylesRemove absolute/fixed positioning from inline styles
int$removeclassattribute1=Remove the class attribute from tags
int$cleanalsojavascriptRemove also occurrence of 'javascript:'.
int$allowiframeAllow iframe tags.
string | string[]$allowed_tagsArray of allowed tags to replace the default list or '' or 'common' or 'common,a,b,c'
int$allowlinkAllow "link" and "meta" tags (for head html section when using GETPOST with mode 'restricthtmlallowlinkscript')
int$allowscriptAllow "script" tags (for head html section when using GETPOST with mode 'restricthtmlallowlinkscript')
int$allowstyleAllow "style" tags (for head html section when using GETPOST with mode 'restricthtmlallowlinkscript')
int$allowphpAllow "php" tags (Deprecated. Should never be used. If you can add php, you can also print in the php the code to output the other non allowed tags)
Returns
string String cleaned
See also
dol_htmlwithnojs() dol_escape_htmltag() strip_tags() dol_string_nohtmltag() dol_string_neverthesehtmltags()

Definition at line 9125 of file functions.lib.php.

Referenced by Form\editfieldval().

◆ dol_string_unaccent()

dol_string_unaccent ( $str)

◆ dol_strlen()

dol_strlen ( $string,
$stringencoding = 'UTF-8' )

Make a strlen call.

Works even if mbstring module not enabled

Parameters
?string$stringString to calculate length
string$stringencodingEncoding of string
Returns
int Length of string

Definition at line 5467 of file functions.lib.php.

Referenced by Product\_get_stats(), Setup\_moduleOnOff(), ai_log_request(), ActionsAdherentCardCommon\assign_values(), ActionsCardCommon\assign_values(), ActionsContactCardCommon\assign_values(), binhex(), User\build_path_from_id_user(), calEncode(), Don\check(), Product\check(), check_value(), Productlot\checkSellOrEatByMandatoryFromProductAndDates(), chequereceipt_pdf_create(), Form\constructProductListOption(), Cronjob\create(), EcmFiles\create(), ExpeditionLineBatch\create(), Product\create(), Productbatch\create(), Productlot\create(), ReceptionLineBatch\create(), Ticket\create(), Website\create(), pdf_cyan\defineColumnField(), pdf_eratosthene\defineColumnField(), pdf_octopus\defineColumnField(), pdf_sponge\defineColumnField(), doc_label_pdf_create(), dol_ch_controle_bvrb(), dol_decode(), dol_encode(), dol_setshmop(), dol_verifyHash(), AccountancyExport\exportQuadratus(), AdherentType\fetch(), fichinter_create(), Adherent\generateDocument(), Availabilities\generateDocument(), BOM\generateDocument(), Commande\generateDocument(), CommandeFournisseur\generateDocument(), ConferenceOrBooth\generateDocument(), ConferenceOrBoothAttendee\generateDocument(), Contrat\generateDocument(), Delivery\generateDocument(), Entrepot\generateDocument(), Evaluation\generateDocument(), Expedition\generateDocument(), ExpenseReport\generateDocument(), Facture\generateDocument(), Fichinter\generateDocument(), Job\generateDocument(), KnowledgeRecord\generateDocument(), Mo\generateDocument(), MouvementStock\generateDocument(), MyObject\generateDocument(), Partnership\generateDocument(), Position\generateDocument(), Product\generateDocument(), ProductFournisseurPrice\generateDocument(), Productlot\generateDocument(), Project\generateDocument(), Propal\generateDocument(), Reception\generateDocument(), RecruitmentCandidature\generateDocument(), RecruitmentJobPosition\generateDocument(), Salary\generateDocument(), Skill\generateDocument(), Skilldet\generateDocument(), SkillRank\generateDocument(), Societe\generateDocument(), StockTransfer\generateDocument(), StockTransferLine\generateDocument(), SupplierProposal\generateDocument(), Target\generateDocument(), Task\generateDocument(), Ticket\generateDocument(), TimeSpent\generateDocument(), User\generateDocument(), UserGroup\generateDocument(), Workstation\generateDocument(), get_next_value(), DolGraph\GetCeilMaxValue(), DolGraph\GetFloorMinValue(), GoogleAPI\getGeoCoordinatesOfAddress(), Setup\getModulesList(), modGeneratePassStandard\getNewGeneratedPassword(), hexbin(), ImportCsv\import_read_record(), ImportXlsx\import_read_record(), isValidLuhn(), isValidSiren(), isValidSiret(), Ldap\littleEndian(), Form\load_tva(), box_activity\loadBox(), box_factures\loadBox(), box_factures_fourn_imp\loadBox(), box_factures_imp\loadBox(), box_graph_invoices_permonth\loadBox(), box_graph_invoices_peryear\loadBox(), box_graph_invoices_supplier_permonth\loadBox(), box_graph_nb_ticket_last_x_days\loadBox(), box_graph_nb_tickets_type\loadBox(), box_graph_new_vs_close_ticket\loadBox(), box_graph_orders_permonth\loadBox(), box_graph_orders_supplier_permonth\loadBox(), box_graph_product_distribution\loadBox(), box_graph_propales_permonth\loadBox(), box_graph_ticket_by_severity\loadBox(), box_last_modified_knowledgerecord\loadBox(), box_last_modified_ticket\loadBox(), box_last_ticket\loadBox(), box_lastlogin\loadBox(), box_project\loadBox(), box_project_opportunities\loadBox(), box_task\loadBox(), box_validated_projects\loadBox(), makesalt(), members_card_pdf_create(), pdf_bank(), removeGlobalParenthesis(), Form\select_produits_fournisseurs_list(), Notify\send(), FormSms\show_form(), CompanyBankAccount\update(), Cronjob\update(), EcmFiles\update(), FactureFournisseur\update(), Fichinter\update(), Productlot\update(), Project\update(), Ticket\update(), Website\update(), modGeneratePassPerso\validatePassword(), modGeneratePassStandard\validatePassword(), mod_barcode_product_standard\verif(), mod_barcode_thirdparty_standard\verif(), mod_codeclient_monkey\verif(), mod_codeclient_monkey\verif_syntax(), Ticket\verify(), pdf_eagle\write_file(), pdf_espadon\write_file(), pdf_rouget\write_file(), pdf_squille\write_file(), modPhpbarcode\writeBarCode(), and modTcpdfbarcode\writeBarCode().

◆ dol_strtolower()

dol_strtolower ( $string,
$encoding = "UTF-8" )

Convert a string to lower.

Never use strtolower because it does not works with UTF8 strings.

Parameters
string$stringString to encode
string$encodingCharacter set encoding
Returns
string String converted

Definition at line 2649 of file functions.lib.php.

Referenced by findobjecttosend().

◆ dol_strtoupper()

dol_strtoupper ( $string,
$encoding = "UTF-8" )

Convert a string to upper.

Never use strtolower because it does not works with UTF8 strings.

Parameters
string$stringString to encode
string$encodingCharacter set encoding
Returns
string String converted
See also
dol_ucfirst(), dol_ucwords()

Definition at line 2666 of file functions.lib.php.

Referenced by getAiChatAssistantConfig(), Adherent\getmorphylib(), and AdherentType\getmorphylib().

◆ dol_substr()

dol_substr ( $string,
$start,
$length = null,
$stringencoding = '',
$trunconbytes = 0 )

Make a substring.

Works even if mbstring module is not enabled for better compatibility.

Parameters
string$stringString to scan
int$startStart position (0 for first char)
int | null$lengthLength (in nb of characters or nb of bytes depending on trunconbytes param)
string$stringencodingPage code used for input string encoding
int$trunconbytes1=Length is max of bytes instead of max of characters
Returns
string substring

Definition at line 5490 of file functions.lib.php.

Referenced by ai_log_request(), calEncode(), Cronjob\create(), Project\create(), dolEncrypt(), get_next_value(), getAiChatAssistantConfig(), Skill\getKanbanView(), mcp_log_request(), removeGlobalParenthesis(), Cronjob\run_jobs(), AccountancyExport\toAnsi(), Cronjob\update(), and ExportExcel2007\write_record().

◆ dol_syslog()

dol_syslog ( $message,
$level = LOG_INFO,
$ident = 0,
$suffixinfilename = '',
$restricttologhandler = '',
$logcontext = null )

Write log message into outputs.

Possible outputs can be: SYSLOG_HANDLERS = ["mod_syslog_file"] file name is then defined by SYSLOG_FILE SYSLOG_HANDLERS = ["mod_syslog_syslog"] facility is then defined by SYSLOG_FACILITY Warning, syslog functions are bugged on Windows, generating memory protection faults. To solve this, use logging to files instead of syslog (see setup of module). Note: If constant 'SYSLOG_FILE_NO_ERROR' defined, we never output any error message when writing to log fails. Note: You can get log message into html sources by adding parameter &logtohtml=1 (constant MAIN_LOGTOHTML must be set) This function works only if syslog module is enabled. This must not use any call to other function calling dol_syslog (avoid infinite loop).

Parameters
string$messageLine to log. ''=Show nothing
int<0,7>$level Log level On Windows LOG_ERR=4, LOG_WARNING=5, LOG_NOTICE=LOG_INFO=6, LOG_DEBUG=6 if define_syslog_variables ou PHP 5.3+, 7 if dolibarr On Linux LOG_ERR=3, LOG_WARNING=4, LOG_NOTICE=5, LOG_INFO=6, LOG_DEBUG=7
int<-1,1>$ident 1=Increase ident of 1 (after log), -1=Decrease ident of 1 (before log)
string$suffixinfilenameWhen output is a file, append this suffix into default log filename. Example '_stripe', '_mail'
string$restricttologhandlerForce output of log only to this log handler
?array<string,mixed>$logcontext If defined, an array with extra information (can be used by some log handlers)
Returns
void @phan-suppress PhanPluginUnknownArrayFunctionParamType $logcontext is not defined in detail

Definition at line 2754 of file functions.lib.php.

Referenced by BordereauChequeBlochet\__construct(), CMailFile\__construct(), CSMSFile\__construct(), doc_generic_asset_odt\__construct(), doc_generic_bom_odt\__construct(), doc_generic_contract_odt\__construct(), doc_generic_invoice_odt\__construct(), doc_generic_member_odt\__construct(), doc_generic_mo_odt\__construct(), doc_generic_myobject_odt\__construct(), doc_generic_odt\__construct(), doc_generic_order_odt\__construct(), doc_generic_product_odt\__construct(), doc_generic_project_odt\__construct(), doc_generic_proposal_odt\__construct(), doc_generic_reception_odt\__construct(), doc_generic_recruitmentjobposition_odt\__construct(), doc_generic_shipment_odt\__construct(), doc_generic_stock_odt\__construct(), doc_generic_supplier_invoice_odt\__construct(), doc_generic_supplier_order_odt\__construct(), doc_generic_supplier_proposal_odt\__construct(), doc_generic_task_odt\__construct(), doc_generic_ticket_odt\__construct(), doc_generic_user_odt\__construct(), doc_generic_usergroup_odt\__construct(), DolEditor\__construct(), DolGeoIP\__construct(), DolibarrApi\__construct(), DoliDBMysqli\__construct(), DoliDBPgsql\__construct(), DoliDBSqlite3\__construct(), ImportCsv\__construct(), ImportXlsx\__construct(), pdf_aurore\__construct(), pdf_azur\__construct(), pdf_balance\__construct(), pdf_baleine\__construct(), pdf_ban\__construct(), pdf_beluga\__construct(), pdf_bookkeeping\__construct(), pdf_cornas\__construct(), pdf_cyan\__construct(), pdf_eagle\__construct(), pdf_eagle_proforma\__construct(), pdf_einstein\__construct(), pdf_eratosthene\__construct(), pdf_espadon\__construct(), pdf_ledger\__construct(), pdf_merou\__construct(), pdf_muscadet\__construct(), pdf_octopus\__construct(), pdf_rouget\__construct(), pdf_sepamandate\__construct(), pdf_soleil\__construct(), pdf_sponge\__construct(), pdf_squille\__construct(), pdf_standard\__construct(), pdf_standard_asset\__construct(), pdf_standard_evaluation\__construct(), pdf_standard_expensereport\__construct(), pdf_standard_movementstock\__construct(), pdf_standard_myobject\__construct(), pdf_standard_recruitmentjobposition\__construct(), pdf_standard_stock\__construct(), pdf_standard_supplierpayment\__construct(), pdf_storm\__construct(), pdf_strato\__construct(), pdf_timespent\__construct(), pdf_typhon\__construct(), pdf_vinci\__construct(), pdf_zenith\__construct(), DolibarrApiAccess\__isAllowed(), DolibarrModules\_active(), EventAttendees\_checkAccessRights(), DolibarrApi\_checkValForAPI(), EmailTemplates\_cleanObjectDatas(), MouvementStock\_create(), MouvementStock\_createSubProduct(), ExternalModules\_downloadFile(), CMailFile\_encode_file(), Stats\_getAllByProduct(), Stats\_getAllByYear(), Stats\_getAmountByMonth(), Stats\_getAverageByMonth(), Stats\_getNbByMonth(), Stats\_getNbByYear(), DolibarrModules\_init(), DolibarrModules\_load_tables(), Product\_log_price(), ObjectLink\_makeobject(), pdf_standard_actions\_pages(), DolibarrModules\_remove(), RejetPrelevement\_send_email(), DolibarrModules\_unactive(), AccountingAccount\accountActivate(), AccountingAccount\accountDeactivate(), BookKeeping\accountingLabelForOperation(), BookKeeping\accountingResult(), ContratLigne\active_line(), Ldap\add(), Societe\add_commercial(), CommonObject\add_contact(), CommonObject\add_element_resource(), Product\add_fournisseur(), CommonObject\add_object_linked(), Propal\add_product(), SupplierProposal\add_product(), Product\add_sousproduit(), MailmanSpip\add_to_mailman(), MailmanSpip\add_to_spip(), mailing_contacts1\add_to_target(), mailing_eventorganization\add_to_target(), mailing_fraise\add_to_target(), mailing_mailing_mymodule_selector1\add_to_target(), mailing_partnership\add_to_target(), mailing_pomme\add_to_target(), mailing_thirdparties\add_to_target(), mailing_thirdparties_services_expired\add_to_target(), mailing_xinputfile\add_to_target(), MailingTargets\add_to_target(), mailing_advthirdparties\add_to_target_spec(), Categorie\add_type(), Account\add_url_line(), AccountancyCategory\addAccountToCategory(), Ldap\addAttribute(), addDocumentModel(), addFileIntoDatabaseIndex(), BOM\addLine(), ProductAttribute\addLine(), Account\addline(), BonPrelevement\addline(), Commande\addline(), CommandeFournisseur\addline(), Contrat\addline(), ExpenseReport\addline(), Facture\addline(), FactureFournisseur\addline(), FactureFournisseurRec\addline(), FactureRec\addline(), Fichinter\addline(), Propal\addline(), SupplierProposal\addline(), Expedition\addline_batch(), Expedition\addlinefree(), Reception\addlinefree(), FichinterRec\addLineRec(), Holiday\addLogCP(), BonPrelevement\addNotification(), addObjectsToApiFile(), Localtax\addPayment(), Tva\addPayment(), Paiement\addPaymentToBank(), PaymentExpenseReport\addPaymentToBank(), PaymentLoan\addPaymentToBank(), PaymentSalary\addPaymentToBank(), MultiCurrency\addRateFromDolibarr(), User\addrights(), UserGroup\addrights(), MailingTargets\addTargetsToDatabase(), Task\addTimeSpent(), BonPrelevement\addWithdrawDetail(), ActionsBlockedlog\afterPDFCreation(), ActionsMyModule\afterPDFCreation(), Categorie\already_exists(), ToolProducts\analyze(), CEmailTemplate\apifetch(), CommandeFournisseur\approve(), Holiday\approve(), Partnership\approve(), Contrat\array_detail(), Ticket\assignUser(), ProductAttribute\attributeOrder(), Commande\availability(), Propal\availability(), barcode_encode(), barcode_encode_genbarcode(), barcode_print(), ActionsBlockedlog\beforePDFCreation(), ActionsMyModule\beforePDFCreation(), DoliDB\begin(), Lettering\bookkeepingLetteringAll(), build_calfile(), Import\build_example_file(), ActionComm\build_exportfile(), User\build_path_from_id_user(), build_rssfile(), modPhpbarcode\buildBarCode(), modTcpdfbarcode\buildBarCode(), Export\buildFilterQuery(), Categorie\buildPathFromId(), calcul_price_total(), CommonInvoice\calculate_date_lim_reglement(), MouvementStock\calculateBalanceForProductBefore(), callApiToGetObfuscationKey(), MailmanSpip\callMailman(), Commande\cancel(), CommandeFournisseur\cancel(), Stripe\cardStripe(), EcmDirectory\changeNbOfFiles(), Societe\check_codeclient(), Societe\check_codefournisseur(), CMailFile\check_server_port(), check_user_password_dolibarr(), check_user_password_empty(), check_user_password_forceuser(), check_user_password_googleoauth(), check_user_password_http(), check_user_password_ldap(), check_user_password_openid(), check_user_password_openid_connect(), check_value(), checkBanForAccount(), mod_syslog_file\checkConfiguration(), mod_syslog_syslog\checkConfiguration(), PartnershipUtils\checkDolibarrBacklink(), mod_codecompta_digitaria\checkIfAccountancyCodeIsAlreadyUsed(), checkLoginPassEntity(), Fiscalyear\checkOverlap(), BlockedLog\checkSignature(), AccountingAccount\checkUsage(), checkUserAccessToObject(), Commande\classifyBilled(), Propal\classifyBilled(), Commande\classifyUnBilled(), Utils\cleanUnfinishedCronjob(), MailingTargets\clear_target(), User\clearrights(), Product\clone_associations(), Product\clone_fournisseurs(), Product\clone_price(), User\cloneRights(), CashControl\close(), DoliDBMysqli\close(), DoliDBPgsql\close(), DoliDBSqlite3\close(), Ticket\close(), ModeleExports\close_file(), Contrat\closeAll(), BookKeeping\closeFiscalPeriod(), Propal\closeProposal(), Societe\codeclient_modifiable(), Societe\codefournisseur_modifiable(), CommandeFournisseur\commande(), commande_prepare_head(), DoliDB\commit(), CommonObject\commonGenerateDocument(), ModeleImports\commonImportInsert(), completeFileArrayWithDatabaseInfo(), InterfaceTicketEmail\composeAndSendAdminMessage(), InterfaceTicketEmail\composeAndSendCustomerMessage(), ExpenseReport\computeTotalKm(), conferenceorboothThirdpartyPrepareHead(), DoliDBMysqli\connect(), DoliDBSqlite3\connect(), Ldap\connectBind(), MailmanSpip\connectSpip(), Form\constructProductListOption(), contact_prepare_head(), Categorie\containsObject(), contract_prepare_head(), DoliDBSqlite3\convertSQLFromMysql(), AccountancyCategory\countAccountsInCategory(), ProductAttribute\countChildProducts(), ProductAttribute\countChildValues(), AdherentStats\countMembersByTagAndStatus(), AdherentStats\countMembersByTypeAndStatus(), Categorie\countNbOfCategories(), Account\create(), AccountancyCategory\create(), AccountancyReport\create(), AccountancySystem\create(), AccountingAccount\create(), AccountingJournal\create(), ActionComm\create(), AdherentType\create(), AdvanceTargetingMailing\create(), BankCateg\create(), BlockedLog\create(), BookKeeping\create(), Bookmark\create(), CashControl\create(), Categorie\create(), Cchargesociales\create(), Ccountry\create(), CEmailTemplate\create(), CGenericDic\create(), ChargeSociales\create(), CLeadStatus\create(), Commande\create(), CommandeFournisseur\create(), Comment\create(), Contact\create(), Cpaiement\create(), CProductNature\create(), Cregion\create(), Cronjob\create(), Cstate\create(), Ctypent\create(), Ctyperesource\create(), CUnits\create(), CurrencyRate\create(), Delivery\create(), DiscountAbsolute\create(), Dolresource\create(), EcmDirectory\create(), EcmFiles\create(), Entrepot\create(), Establishment\create(), Events\create(), Expedition\create(), ExpeditionLineBatch\create(), ExpenseReport\create(), Export\create(), Facture\create(), FactureFournisseur\create(), Fichinter\create(), Fiscalyear\create(), Holiday\create(), Import\create(), Link\create(), Loan\create(), LoanSchedule\create(), Localtax\create(), Mailing\create(), MailingTarget\create(), Menubase\create(), MultiCurrency\create(), ObjectLink\create(), Opensurveysondage\create(), Paiement\create(), PaiementFourn\create(), PaymentDonation\create(), PaymentExpenseReport\create(), PaymentLoan\create(), PaymentSalary\create(), PaymentSocialContribution\create(), PaymentTerm\create(), PaymentVarious\create(), PaymentVAT\create(), PriceExpression\create(), PriceGlobalVariable\create(), PriceGlobalVariableUpdater\create(), Product\create(), ProductAttribute\create(), ProductAttributeValue\create(), Productbatch\create(), ProductCustomerPrice\create(), Productlot\create(), ProductStockEntrepot\create(), Project\create(), Propal\create(), Propalmergepdfproduct\create(), Reception\create(), ReceptionLineBatch\create(), RejetPrelevement\create(), RemiseCheque\create(), Salary\create(), Societe\create(), SupplierProposal\create(), Task\create(), Ticket\create(), Tva\create(), User\create(), Website\create(), DolibarrModules\create_dirs(), User\create_from_contact(), Societe\create_from_member(), User\create_from_member(), Societe\create_individual(), ExtraFields\create_label(), Delivery\create_line(), createActionComm(), MouvementStock\createBatch(), Fournisseur\CreateCategory(), CommonObject\createCommon(), createContact(), Holiday\createCPusers(), Asset\createFromClone(), AssetModel\createFromClone(), Availabilities\createFromClone(), BOM\createFromClone(), BookKeeping\createFromClone(), BookkeepingTemplate\createFromClone(), Calendar\createFromClone(), CGenericDic\createFromClone(), CompanyPaymentMode\createFromClone(), ConferenceOrBoothAttendee\createFromClone(), CTicketCategory\createFromClone(), Ctyperesource\createFromClone(), DefaultValues\createFromClone(), EcmFiles\createFromClone(), EmailCollector\createFromClone(), EmailCollectorAction\createFromClone(), EmailCollectorFilter\createFromClone(), EmailSenderProfile\createFromClone(), Evaluation\createFromClone(), Hook\createFromClone(), Inventory\createFromClone(), Job\createFromClone(), KnowledgeRecord\createFromClone(), Memo\createFromClone(), Mo\createFromClone(), MyObject\createFromClone(), Partnership\createFromClone(), Position\createFromClone(), ProductFournisseurPrice\createFromClone(), Productlot\createFromClone(), ProductStockEntrepot\createFromClone(), Project\createFromClone(), Propal\createFromClone(), RecruitmentCandidature\createFromClone(), RecruitmentJobPosition\createFromClone(), Skill\createFromClone(), Skilldet\createFromClone(), SkillRank\createFromClone(), SocieteAccount\createFromClone(), StockTransfer\createFromClone(), StockTransferLine\createFromClone(), Target\createFromClone(), Task\createFromClone(), TimeSpent\createFromClone(), Website\createFromClone(), Workstation\createFromClone(), Facture\createFromCurrent(), BookKeeping\createFromValues(), createInvoice(), createInvoiceFromOrder(), createOrder(), createPayment(), Mo\createProduction(), createProductOrService(), createProject(), FactureFournisseurRec\createRecurringInvoices(), FactureRec\createRecurringInvoices(), BookKeeping\createStd(), createThirdParty(), createUserFromThirdparty(), Project\createWeeklyReport(), Stripe\customerStripe(), DoliDBPgsql\DDLAddField(), DoliDBPgsql\DDLCreateDb(), DoliDBPgsql\DDLCreateUser(), DoliDBPgsql\DDLDescTable(), DoliDBPgsql\DDLUpdateField(), Societe\del_commercial(), Product\del_sousproduit(), MailmanSpip\del_to_mailman(), MailmanSpip\del_to_spip(), Categorie\del_type(), delDocumentModel(), Account\delete(), AccountancyCategory\delete(), AccountancyReport\delete(), AccountingAccount\delete(), ActionComm\delete(), Adherent\delete(), AdvanceTargetingMailing\delete(), BankCateg\delete(), BookKeeping\delete(), BookkeepingTemplate\delete(), Categorie\delete(), Cchargesociales\delete(), Ccountry\delete(), CEmailTemplate\delete(), CGenericDic\delete(), ChargeSociales\delete(), CLeadStatus\delete(), Commande\delete(), CommandeFournisseur\delete(), CommandeFournisseurLigne\delete(), Comment\delete(), CompanyBankAccount\delete(), Contact\delete(), Contrat\delete(), Cpaiement\delete(), CProductNature\delete(), Cregion\delete(), Cronjob\delete(), Cstate\delete(), Ctypent\delete(), Ctyperesource\delete(), CUnits\delete(), CurrencyRate\delete(), DiscountAbsolute\delete(), Documents\delete(), Dolresource\delete(), Don\delete(), EcmDirectory\delete(), EcmFiles\delete(), Entrepot\delete(), Establishment\delete(), Events\delete(), Expedition\delete(), ExpeditionLigne\delete(), ExpenseReport\delete(), Export\delete(), Facture\delete(), FactureFournisseur\delete(), FactureFournisseurRec\delete(), FactureLigne\delete(), FactureRec\delete(), Fichinter\delete(), FichinterRec\delete(), Holiday\delete(), Import\delete(), KnowledgeRecord\delete(), Ldap\delete(), Link\delete(), Loan\delete(), LoanSchedule\delete(), Localtax\delete(), Mailing\delete(), MailingTarget\delete(), Menubase\delete(), MultiCurrency\delete(), Notify\delete(), ObjectLink\delete(), Opensurveysondage\delete(), OrderLine\delete(), Paiement\delete(), PaymentDonation\delete(), PaymentExpenseReport\delete(), PaymentLoan\delete(), PaymentSalary\delete(), PaymentSocialContribution\delete(), PaymentTerm\delete(), PaymentVarious\delete(), PaymentVAT\delete(), PriceExpression\delete(), PriceGlobalVariable\delete(), PriceGlobalVariableUpdater\delete(), Product\delete(), ProductAttribute\delete(), ProductAttributeValue\delete(), Productbatch\delete(), ProductCustomerPrice\delete(), Productlot\delete(), ProductStockEntrepot\delete(), Project\delete(), Propal\delete(), PropaleLigne\delete(), Propalmergepdfproduct\delete(), ReceptionLineBatch\delete(), RemiseCheque\delete(), Societe\delete(), Subscription\delete(), SupplierInvoiceLine\delete(), SupplierProposal\delete(), SupplierProposalLine\delete(), Task\delete(), Ticket\delete(), Tva\delete(), User\delete(), UserBankAccount\delete(), Website\delete(), DolibarrModules\delete_boxes(), Propalmergepdfproduct\delete_by_file(), Propalmergepdfproduct\delete_by_product(), DolibarrModules\delete_const(), CommonObject\delete_contact(), DolibarrModules\delete_cronjobs(), DolibarrModules\delete_dirs(), ExtraFields\delete_label(), CommonObject\delete_linked_contact(), DolibarrModules\delete_menus(), DolibarrModules\delete_module_parts(), DolibarrModules\delete_permissions(), CommonObject\delete_resource(), DolibarrModules\delete_tabs(), Mailing\delete_targets(), AccountancyCategory\deleteAccountFromCategory(), Ldap\deleteAttribute(), BookKeeping\deleteByImportkey(), CommonObject\deleteByParentField(), BookKeeping\deleteByYearAndJournal(), CommonObject\deleteCommon(), AccountancyCategory\deleteCptCat(), CommonObject\deleteExtraFields(), deleteFilesIntoDatabaseIndex(), ExpeditionLineBatch\deleteFromShipment(), Lettering\deleteGeneralMatching(), Lettering\deleteLettering(), BOM\deleteLine(), Contrat\deleteLine(), ExpenseReport\deleteLine(), Facture\deleteLine(), FactureFournisseur\deleteLine(), FichinterLigne\deleteLine(), ProductAttribute\deleteLine(), CommonObject\deleteLineCommon(), BookKeeping\deleteMvtNum(), CommonObject\deleteObjectLinked(), deleteProductOrService(), deleteThirdParty(), delivery_prepare_head(), AdherentType\delMultiLangs(), Categorie\delMultiLangs(), Product\delMultiLangs(), Task\delTimeSpent(), Commande\demand_reason(), Propal\demand_reason(), CommonInvoice\demande_prelevement(), Salary\demande_prelevement(), CommonInvoice\demande_prelevement_delete(), Salary\demande_prelevement_delete(), CommandeFournisseur\dispatchProduct(), AccountancyCategory\display(), Contrat\doAutoRenewContracts(), doc_label_pdf_create(), PartnershipUtils\doCancelStatusOfMemberPartnership(), EmailCollector\doCollect(), dol_add_file_process(), AntiVir\dol_avscan_file(), dol_check_secure_access_document(), dol_convert_file(), dol_copy(), dol_delete_dir(), dol_delete_dir_recursive(), dol_delete_file(), dol_dir_list(), dol_filecache(), dol_ftp_connect(), dol_ftp_delete(), dol_imageResizeOrCrop(), dol_meta_create(), dol_move(), dol_move_dir(), dol_move_uploaded_file(), dol_set_user_param(), dol_stringtotime(), dol_uncompress(), dolCheckOnFileName(), dolCopyDir(), dolDecrypt(), dolDocToText(), dolGetElementUrl(), dolibarr_del_const(), dolibarr_install_syslog(), dolibarr_set_const(), dolReplaceInFile(), dolSaveCssFile(), dolSaveHtaccessFile(), dolSaveHtmlHeader(), dolSaveIndexPage(), dolSaveJsFile(), dolSaveLicense(), dolSaveManifestJson(), dolSaveMasterFile(), dolSavePageAlias(), dolSavePageContent(), dolSaveReadme(), dolSaveRobotFile(), dolWebsiteOutput(), dolWebsiteReplacementOfLinks(), Availabilities\doScheduledJob(), ConferenceOrBooth\doScheduledJob(), KnowledgeRecord\doScheduledJob(), MyObject\doScheduledJob(), Partnership\doScheduledJob(), RecruitmentCandidature\doScheduledJob(), RecruitmentJobPosition\doScheduledJob(), StockTransferLine\doScheduledJob(), Target\doScheduledJob(), TriggerHistory\doScheduledJob(), PartnershipUtils\doWarningOfPartnershipIfDolibarrBacklinkNotfound(), DolGraph\draw(), DolGraph\draw_chart(), DolGraph\draw_jflot(), Utils\dumpDatabase(), FormCompany\effectif_array(), encodedecode_dbpassconf(), Adherent\exclude(), Utils\executeCLI(), HookManager\executeHooks(), McpHandler\executeTool(), BookKeeping\export_bookkeeping(), Website\exportWebSite(), facture_prepare_head(), facturefourn_prepare_head(), Account\fetch(), AccountancyCategory\fetch(), AccountancyReport\fetch(), AccountancySystem\fetch(), AccountingAccount\fetch(), AccountingJournal\fetch(), ActionComm\fetch(), Adherent\fetch(), AdherentType\fetch(), AdvanceTargetingMailing\fetch(), BankCateg\fetch(), BonPrelevement\fetch(), BookKeeping\fetch(), Bookmark\fetch(), CActionComm\fetch(), Categorie\fetch(), Cchargesociales\fetch(), Ccountry\fetch(), CGenericDic\fetch(), ChargeSociales\fetch(), Cincoterm\fetch(), Commande\fetch(), CommandeFournisseur\fetch(), CommandeFournisseurLigne\fetch(), Comment\fetch(), Contact\fetch(), Contrat\fetch(), ContratLigne\fetch(), Cpaiement\fetch(), Cregion\fetch(), Cstate\fetch(), Ctyperesource\fetch(), CurrencyRate\fetch(), Delivery\fetch(), DiscountAbsolute\fetch(), Dolresource\fetch(), Don\fetch(), EcmDirectory\fetch(), EcmFiles\fetch(), Entrepot\fetch(), Establishment\fetch(), Events\fetch(), Expedition\fetch(), Export\fetch(), Facture\fetch(), FactureFournisseur\fetch(), FactureFournisseurLigneRec\fetch(), FactureFournisseurRec\fetch(), FactureLigneRec\fetch(), FactureRec\fetch(), FichinterLigne\fetch(), FichinterRec\fetch(), Fiscalyear\fetch(), Holiday\fetch(), Import\fetch(), Ldap\fetch(), LignePrelevement\fetch(), Link\fetch(), Loan\fetch(), LoanSchedule\fetch(), Localtax\fetch(), Mailing\fetch(), MailingTarget\fetch(), Menubase\fetch(), ModeleBoxes\fetch(), MouvementStock\fetch(), MultiCurrency\fetch(), ObjectLink\fetch(), Opensurveysondage\fetch(), Partnership\fetch(), PaymentDonation\fetch(), PaymentExpenseReport\fetch(), PaymentLoan\fetch(), PaymentSalary\fetch(), PaymentSocialContribution\fetch(), PaymentTerm\fetch(), PaymentVarious\fetch(), PaymentVAT\fetch(), PriceExpression\fetch(), PriceGlobalVariable\fetch(), PriceGlobalVariableUpdater\fetch(), Product\fetch(), ProductAttribute\fetch(), ProductAttributeValue\fetch(), Productbatch\fetch(), ProductCustomerPrice\fetch(), Productlot\fetch(), ProductStockEntrepot\fetch(), Project\fetch(), Propal\fetch(), Propalmergepdfproduct\fetch(), Reception\fetch(), ReceptionLineBatch\fetch(), RejetPrelevement\fetch(), RemiseCheque\fetch(), Salary\fetch(), Societe\fetch(), Subscription\fetch(), SupplierProposal\fetch(), Task\fetch(), Ticket\fetch(), Tva\fetch(), User\fetch(), UserGroup\fetch(), Website\fetch(), AdvanceTargetingMailing\fetch_by_element(), AdvanceTargetingMailing\fetch_by_mailing(), Propalmergepdfproduct\fetch_by_product(), ExpenseReport\fetch_line_by_project(), Commande\fetch_lines(), CommandeFournisseur\fetch_lines(), Contrat\fetch_lines(), Delivery\fetch_lines(), Expedition\fetch_lines(), ExpenseReport\fetch_lines(), Facture\fetch_lines(), FactureFournisseur\fetch_lines(), FactureFournisseurRec\fetch_lines(), FactureRec\fetch_lines(), Fichinter\fetch_lines(), FichinterRec\fetch_lines(), ProductAttribute\fetch_lines(), Propal\fetch_lines(), Expedition\fetch_lines_free(), Reception\fetch_lines_free(), ExtraFields\fetch_name_optionals_label(), CommonObject\fetch_optionals(), Product\fetch_prod_arbo(), ProductFournisseur\fetch_product_fournisseur_price(), Adherent\fetch_subscriptions(), ExpenseReport\fetch_users_approver_expensereport(), Holiday\fetch_users_approver_holiday(), AssetAccountancyCodes\fetchAccountancyCodes(), Asset\fetchAll(), AssetModel\fetchAll(), Availabilities\fetchAll(), BOM\fetchAll(), BOMLine\fetchAll(), BookKeeping\fetchAll(), BookkeepingTemplateLine\fetchAll(), Calendar\fetchAll(), CGenericDic\fetchAll(), CLeadStatus\fetchAll(), ConferenceOrBooth\fetchAll(), ConferenceOrBoothAttendee\fetchAll(), CProductNature\fetchAll(), Cronjob\fetchAll(), CTicketCategory\fetchAll(), Ctyperesource\fetchAll(), CUnits\fetchAll(), DefaultValues\fetchAll(), Dolresource\fetchAll(), EcmFiles\fetchAll(), EmailCollector\fetchAll(), Evaluation\fetchAll(), EvaluationLine\fetchAll(), ExpeditionLineBatch\fetchAll(), Holiday\fetchAll(), Hook\fetchAll(), Job\fetchAll(), KnowledgeRecord\fetchAll(), Link\fetchAll(), LoanSchedule\fetchAll(), Mailing\fetchAll(), Memo\fetchAll(), Mo\fetchAll(), MoLine\fetchAll(), MyObject\fetchAll(), Opensurveysondage\fetchAll(), Partnership\fetchAll(), PartnershipType\fetchAll(), Position\fetchAll(), ProductAttribute\fetchAll(), ProductCustomerPrice\fetchAll(), ProductFournisseurPrice\fetchAll(), ProductStockEntrepot\fetchAll(), ReceptionLineBatch\fetchAll(), RecruitmentCandidature\fetchAll(), RecruitmentJobPosition\fetchAll(), Skill\fetchAll(), Skilldet\fetchAll(), SkillRank\fetchAll(), StockTransfer\fetchAll(), StockTransferLine\fetchAll(), Target\fetchAll(), Ticket\fetchAll(), TimeSpent\fetchAll(), TriggerHistory\fetchAll(), User\fetchAll(), Website\fetchAll(), Workstation\fetchAll(), BookKeeping\fetchAllBalance(), BookKeeping\fetchAllByAccount(), MultiCurrency\fetchAllCurrencyRate(), Comment\fetchAllFor(), ProductCustomerPrice\fetchAllLog(), BookKeeping\fetchAllPerMvt(), Product\fetchAllPriceLogs(), Task\fetchAllTimeSpent(), CommonObject\fetchBarCode(), Holiday\fetchByUser(), ObjectLink\fetchByValues(), AssetDepreciationOptions\fetchDeprecationOptions(), Dolresource\fetchElementResource(), ExpeditionLineBatch\fetchFromStock(), Holiday\fetchLog(), ExternalModules\fetchModulesFromFile(), CommonObject\fetchObjectFrom(), CommonObject\fetchObjectLinked(), CommonObject\fetchOneLike(), BookKeeping\fetchPerMvt(), Facture\fetchPreviousNextSituationInvoice(), Task\fetchTimeSpent(), Task\fetchTimeSpentOnTask(), Holiday\fetchUsers(), fichinter_prepare_head(), filterToolsProfessional(), ProductFournisseur\find_min_price_product_fournisseur(), PriceExpression\find_title(), Productbatch\findAll(), ExpeditionLigne\findAllChild(), Productbatch\findAllForProduct(), CMailFile\findHtmlImagesIsSrcData(), Societe\findNearest(), findobjecttosend(), FormFile\form_attach_new_file(), Form\form_availability(), Form\form_confirm(), form_constantes(), FormCompany\form_prospect_level(), FormCompany\formProspectContactLevel(), BonPrelevement\generate(), Ai\generateContent(), RemiseCheque\generatePdf(), Product\get_barcode(), Product\get_buyprice(), User\get_children(), mod_codecompta_aquarium\get_code(), mod_codecompta_digitaria\get_code(), ModeleAccountancyCode\get_code(), BookKeeping\get_compte_desc(), Project\get_element_list(), Categorie\get_full_arbo(), EcmDirectory\get_full_arbo(), User\get_full_tree(), get_next_value(), FactureLigne\get_prev_progress(), Facture\get_prev_sits(), doc_generic_member_odt\get_substitutionarray_object(), doc_generic_project_odt\get_substitutionarray_object(), doc_generic_task_odt\get_substitutionarray_object(), doc_generic_ticket_odt\get_substitutionarray_object(), doc_generic_user_odt\get_substitutionarray_object(), doc_generic_project_odt\get_substitutionarray_project_contacts(), Account\get_url(), AccountancyCategory\getAccountsForCategory(), AccountancyCategory\getAccountsWithNoCategory(), getActionComm(), ActionComm\getActions(), Stats\getAllByProduct(), Stats\getAllByProductEntry(), User\getAllChildIds(), getAllImages(), CommonObject\getAllItemsLinkedByObjectID(), ExpenseReports\getAllPayments(), Salaries\getAllPayments(), FactureLigne\getAllPrevProgress(), ProjectStats\getAllProjectByStatus(), ExpenseReportIk\getAllRanges(), ExpenseReportRule\getAllRule(), TaskStats\getAllTaskByStatus(), Stats\getAmountByMonthWithPrevYear(), Paiement\getAmountsArray(), CommonInvoice\getArrayOfInvoiceSubtypes(), AccountingJournal\getAssetData(), AccountancyCategory\getAvailableAccountsForCategory(), DiscountAbsolute\getAvailableDiscounts(), Lettering\getBankLinesFromFkDocAndDocType(), Paiement\getBillsArray(), PaiementFourn\getBillsArray(), AccountancyCategory\getCategoriesForAccount(), getCategory(), AccountancyCategory\getCats(), AccountancyCategory\getCatsCpts(), CommonObject\getChildrenOfLine(), Product\getChildsArbo(), Holiday\getConfCP(), getContact(), Societe\getContacts(), getContactsForThirdParty(), BookKeeping\getCountByMonthForFiscalPeriod(), Holiday\getCPforUser(), AccountancyCategory\getCptsCat(), SocieteAccount\getCustomerAccount(), CommonObject\getDefaultCreateValueFor(), PaymentTerm\getDefaultId(), AccountingJournal\getDiscountCustomer(), AccountingJournal\getDiscountSupplier(), Lettering\getDocTypeAndFkDocFromBankLines(), getDocument(), ModeleExports\getDriverDesc(), ModeleExports\getDriverExtension(), ModeleExports\getDriverLabel(), ModeleExports\getDriverVersion(), Dolresource\getElementResources(), ExpenseReportLine\getExpAmount(), getFormeJuridiqueLabel(), AssetDepreciationOptions\getGeneralDepreciationInfoForMode(), MultiCurrency\getIdAndTxFromCode(), CommonObject\getIdContact(), Tva\getIdForLabel(), MultiCurrency\getIdFromCode(), getInvoice(), MultiCurrency\getInvoiceRate(), getInvoicesForThirdParty(), Translate\getLabelFromKey(), CommonObjectLine\getLabelOfUnit(), Product\getLabelOfUnit(), DolibarrModules\getLastActivationDate(), DolibarrModules\getLastActivationInfo(), Product\getLibFinished(), ModeleExports\getLibLabel(), ModeleExports\getLibVersion(), SupplierProposal\getLinesArray(), Lettering\getLinkedDocumentByGroup(), Lettering\getLinkedLines(), getListActionCommType(), PrintingDriver\getlistAvailablePrinters(), BonPrelevement\getListInvoices(), RejetPrelevement\getListInvoices(), Contrat\getListOfContracts(), getListOfGroups(), InterfaceNotification\getListOfManagedEvents(), getListOfModels(), CommonInvoice\getListOfPayments(), getListOfProductsOrServices(), getListOfThirdParties(), ProductAttribute\getMaxAttributesPosition(), ProductAttributeValue\getMaxAttributesValuesPosition(), ExpenseReportIk\getMaxRangeNumber(), Context\getMemberAccountFromLogin(), Setup\getModules(), Setup\getModulesList(), ExternalModules\getModuleZIP(), Stats\getNbByMonthWithPrevYear(), Commande\getNbOfShipments(), BookKeeping\getNextNumMvt(), Facture\getNextNumRef(), mod_asset_standard\getNextValue(), mod_barcode_product_standard\getNextValue(), mod_bom_standard\getNextValue(), mod_chequereceipt_mint\getNextValue(), mod_codeclient_monkey\getNextValue(), mod_commande_marbre\getNextValue(), mod_contract_serpis\getNextValue(), mod_delivery_jade\getNextValue(), mod_evaluation_standard\getNextValue(), mod_expedition_safor\getNextValue(), mod_expensereport_jade\getNextValue(), mod_facture_fournisseur_cactus\getNextValue(), mod_facture_mars\getNextValue(), mod_facture_terre\getNextValue(), mod_holiday_madonna\getNextValue(), mod_knowledgerecord_standard\getNextValue(), mod_lot_standard\getNextValue(), mod_member_advanced\getNextValue(), mod_member_simple\getNextValue(), mod_mo_standard\getNextValue(), mod_myobject_standard\getNextValue(), mod_partnership_standard\getNextValue(), mod_payment_cicada\getNextValue(), mod_project_simple\getNextValue(), mod_propale_marbre\getNextValue(), mod_reception_beryl\getNextValue(), mod_recruitmentcandidature_standard\getNextValue(), mod_recruitmentjobposition_standard\getNextValue(), mod_sn_standard\getNextValue(), mod_stocktransfer_standard\getNextValue(), mod_supplier_payment_bronan\getNextValue(), mod_supplier_proposal_marbre\getNextValue(), mod_takepos_ref_simple\getNextValue(), mod_task_simple\getNextValue(), mod_ticket_simple\getNextValue(), mod_workstation_standard\getNextValue(), Notify\getNotificationsArray(), BlockedLog\getObfuscationKey(), Categories\getObjects(), CommonSellistField\getOptions(), getOrder(), getOrdersForThirdParty(), Orders\getOrderShipments(), Societe\getOutstandingBills(), Societe\getOutstandingOrders(), Societe\getOutstandingProposals(), Stripe\getPaymentIntent(), ToolProducts\getPendingCustomerOrdersQty(), ToolProducts\getPendingSupplierOrdersQty(), ProductAttribute\getPositionOfAttribute(), BlockedLog\getPreviousHash(), getProductOrService(), getProductsForCategory(), getProject(), Project\getProjectsAuthorizedForUser(), Products\getPurchasePriceLogs(), ExpenseReportIk\getRangesByCategory(), CommonObject\getRangOfLine(), MultiCurrency\getRate(), Ldap\getRecords(), Don\getRemainToPay(), BookKeeping\getRootAccount(), Form\getSelectConditionsPaiements(), Form\getSelectInvoiceSubtype(), Stripe\getSetupIntent(), ChargeSociales\getSommePaiement(), CommonInvoice\getSommePaiement(), Salary\getSommePaiement(), Tva\getSommePaiement(), getSourceDocRef(), MailingTargets\getSqlArrayForStats(), getState(), Stripe\getStripeAccount(), DiscountAbsolute\getSumCreditNotesUsed(), AccountancyCategory\getSumDebitCredit(), DiscountAbsolute\getSumDepositsUsed(), DiscountAbsolute\getSumFromThisCreditNotesNotUsed(), Task\getSummaryOfTimeSpent(), Task\getSumOfAmount(), Loan\getSumPayment(), ExpenseReport\getSumPayments(), getSupplierInvoice(), getSupplierInvoicesForThirdParty(), ToolProducts\getSupplierPrices(), Task\getTasksArray(), ExpenseReportIk\getTaxCategories(), getThirdParty(), Context\getThirdPartyAccountFromLogin(), SocieteAccount\getThirdPartyID(), Tasks\getTimeSpentByID(), CommonObject\getTotalDiscount(), ProjectStats\getTransformRateByMonthWithPrevYear(), getURLContent(), getUser(), Task\getUserRolesForProjectsOrTasks(), CommonObject\getValueFrom(), getVersions(), ProjectStats\getWeightedAmountByMonthWithPrevYear(), MCPServer\handleRequest(), Task\hasChildren(), hash_call(), CommonObject\hasProductsOrServices(), Task\hasTimeSpent(), ModeleImports\import_close_file(), ModeleImports\import_get_nb_of_lines(), ImportCsv\import_open_file(), ImportXlsx\import_open_file(), ModeleImports\import_open_file(), ModeleImports\import_read_header(), ModeleImports\import_read_record(), BankAccounts\index(), Documents\index(), Donations\index(), EmailTemplates\index(), EventAttendees\index(), Interventions\index(), Login\index(), Mailings\index(), Orders\index(), Projects\index(), Proposals\index(), Receptions\index(), Salaries\index(), Shipments\index(), Tasks\index(), Mailings\indexTargets(), AccountingAccount\info(), ActionComm\info(), Adherent\info(), ChargeSociales\info(), Cronjob\info(), Don\info(), Entrepot\info(), Establishment\info(), Fiscalyear\info(), Loan\info(), Paiement\info(), PaymentExpenseReport\info(), PaymentVarious\info(), Salary\info(), Tva\info(), DocumentController\init(), modBlockedLog\init(), ViewImageController\init(), Categorie\initAsSpecimen(), Commande\initAsSpecimen(), CommandeFournisseur\initAsSpecimen(), Expedition\initAsSpecimen(), Reception\initAsSpecimen(), HookManager\initHooks(), Target\initListOfTriggers(), dolReceiptPrinter\initPrinter(), CommandeFournisseurLigne\insert(), ContratLigne\insert(), ExpeditionLigne\insert(), ExpenseReportLine\insert(), FactureLigne\insert(), FichinterLigne\insert(), OrderLine\insert(), PropaleLigne\insert(), ReceptionLineBatch\insert(), SupplierInvoiceLine\insert(), SupplierProposalLine\insert(), DolibarrModules\insert_boxes(), DolibarrModules\insert_const(), DolibarrModules\insert_cronjobs(), DolibarrModules\insert_dirs(), DolibarrModules\insert_menus(), DolibarrModules\insert_module_parts(), DolibarrModules\insert_permissions(), DolibarrModules\insert_tabs(), BookKeeping\insertAccountingReversal(), CommonObject\insertExtraFields(), CommonObject\insertExtraLanguages(), invoice_rec_prepare_head(), Propal\InvoiceArrayList(), Facture\is_last_in_cycle(), AccountancyCategory\isAccountInCategory(), isBlockedLogUsed(), CommonObject\isExistingObject(), Target\isTriggerCodeManualTarget(), ProductAttribute\isUsed(), ProductAttributeValue\isUsed(), left_menu(), Lettering\letteringThirdparty(), CommonObject\line_max(), CommonObject\line_order(), DiscountAbsolute\link_to_invoice(), FormFile\list_of_autoecmfiles(), PriceExpression\list_price_expression(), ProductFournisseur\list_product_fournisseur_price(), Facture\list_qualified_avoir_invoices(), FactureFournisseur\list_qualified_avoir_supplier_invoices(), Facture\list_replacable_invoices(), FactureFournisseur\list_replacable_supplier_invoices(), PrintingDriver\listAvailablePrinters(), InfoBox\listBoxes(), ToolThirdParty\listContacts(), CActionComm\liste_array(), CommonObject\liste_contact(), CommonObject\listeTypeContacts(), PriceGlobalVariable\listGlobalVariables(), UserGroup\listGroupsForUser(), PrintingDriver\listJobs(), AdherentType\listMembersForMemberType(), ModeleExports\listOfAvailableExportFormat(), ModeleImports\listOfAvailableImportFormat(), listOfSessions(), ExpenseReport\listOfTypes(), PriceGlobalVariableUpdater\listPendingUpdaters(), ProductFournisseur\listProductFournisseurPriceLog(), listPublicHoliday(), Projects\listTimespent(), PriceGlobalVariableUpdater\listUpdaters(), UserGroup\listUsersForGroup(), CommandeFournisseur\Livraison(), Translate\load(), Export\load_arrays(), Import\load_arrays(), Form\load_cache_availability(), Form\load_cache_conditions_paiements(), Form\load_cache_invoice_subtype(), Form\load_cache_transport_mode(), Form\load_cache_types_fees(), Form\load_cache_types_paiements(), Form\load_cache_vatrates(), Categorie\load_motherof(), EcmDirectory\load_motherof(), Contact\load_ref_elements(), Product\load_stats_commande(), Product\load_stock(), Product\loadBatchInfo(), box_actions\loadBox(), box_actions_future\loadBox(), box_birthdays\loadBox(), box_birthdays_members\loadBox(), box_clients\loadBox(), box_comptes\loadBox(), box_customers_outstanding_bill_reached\loadBox(), box_ficheinter\loadBox(), box_goodcustomers\loadBox(), box_prospect\loadBox(), ModeleBoxes\loadBox(), Ticket\loadCacheCategoriesTickets(), Dolresource\loadCacheCodeTypeResource(), Translate\loadCacheCurrencies(), Ticket\loadCacheMsgsTicket(), Ticket\loadCacheSeveritiesTickets(), Ticket\loadCacheTypesTickets(), Commande\loadExpeditions(), McpHandler\loadExternalTools(), Translate\loadFromDatabase(), FormProduct\loadLotStock(), McpHandler\loadNativeTools(), User\loadParentOf(), CommandeFournisseur\loadReceptions(), UserGroup\loadRights(), Product\loadStockForVirtualProduct(), Project\loadTimeSpent(), Project\loadTimeSpentMonth(), FormProduct\loadWarehouses(), FormProduct\loadWorkstations(), Form\makeAddLinkToAttendee(), Form\makeAddLinkToObject(), makesalt(), CommonInvoice\makeStripeSepaRequest(), Expedition\manageStockMvtOnEvt(), Ticket\markAsRead(), member_prepare_head(), Menubase\menuLeftCharger(), Societe\mergeCompany(), Adherent\mergeMembers(), Task\mergeTask(), Task\mergeTimeSpentTask(), Ldap\modify(), FormAccounting\multi_select_journal(), FormAdvTargetEmailing\multiselectCivility(), BonPrelevement\NbFactureAPrelever(), Facture\newCycle(), Ticket\newMessage(), num_open_day(), num_public_holiday(), ExpenseReport\offsetAlreadyGiven(), ExportCsv\open_file(), ExportExcel2007\open_file(), ExportTsv\open_file(), ModeleExports\open_file(), openid_connect_create_user(), ordersupplier_prepare_head(), RssParser\parser(), pdf_getFormat(), ExpenseReport\periodExists(), Documents\post(), Projects\post(), Tasks\post(), Zapier\post(), Invoices\postContact(), Orders\postContact(), Proposals\postContact(), print_paypal_redirect(), printing_printipp\printFile(), PrintingDriver\printFile(), Mo\printOriginLine(), PriceGlobalVariableUpdater\process(), Mos\produceAndConsume(), Mos\produceAndConsumeAll(), product_prepare_head(), project_prepare_head(), propal_prepare_head(), Website\purge(), Utils\purgeFiles(), purgeSessions(), DoliDBMysqli\query(), DoliDBPgsql\query(), DoliDBSqlite3\query(), AdvanceTargetingMailing\query_contact(), AdvanceTargetingMailing\query_thirdparty(), rebuild_merge_pdf(), Categorie\rechercher(), EcmDirectory\refreshcachenboffile(), CommandeFournisseur\refuse(), McpHandler\registerTool(), Paiement\reject(), modBlockedLog\remove(), Project\remove_element(), ProductFournisseur\remove_fournisseur(), ProductFournisseur\remove_product_fournisseur_price(), AccountancyCategory\removeAllAccountsFromCategory(), RemiseCheque\removeCheck(), User\RemoveFromGroup(), removePatternFromFile(), Ldap\rename(), Expedition\reOpen(), Reception\reOpen(), Contrat\reopen(), Propal\reopen(), SupplierProposal\reopen(), Notify\replaceSpecialRecipientToken(), Societe\replaceThirdparty(), Cronjob\reprogram_jobs(), Mailing\reset_targets_status(), Mailing\resetTargetErrorStatus(), Adherent\resiliate(), ToolCategories\resolveCategoryIdFromName(), DoliDB\rollback(), Cronjob\run_jobs(), run_sql(), Interfaces\run_triggers(), InterfaceActionsAuto\runTrigger(), InterfaceContactRoles\runTrigger(), InterfaceEventOrganization\runTrigger(), InterfaceLogevents\runTrigger(), InterfaceMailmanSpipsynchro\runTrigger(), InterfaceMyModuleTriggers\runTrigger(), InterfaceNotification\runTrigger(), InterfaceStripe\runTrigger(), InterfaceWebhookTriggers\runTrigger(), InterfaceZapierTriggers\runTrigger(), InfoBox\saveboxorder(), html_generic\saveFile(), BlockedLog\saveHMACSecretKey(), Ldap\search(), ToolProducts\search(), ToolThirdParty\search(), ToolCategories\searchCategories(), Ticket\searchContactByEmail(), ToolInvoices\searchInvoices(), Ticket\searchSocidByEmail(), BookKeeping\select_account(), FormAccounting\select_account(), FormAccounting\select_accounting_category(), FormAccounting\select_auxaccount(), FormAccounting\select_bookkeeping_importkey(), FormCompany\select_civility(), Form\select_comptes(), FormContract\select_contract(), Form\select_date(), DoliDBMysqli\select_db(), DoliDBSqlite3\select_db(), Form\select_dolgroups(), Form\select_dolusers(), FormProjets\select_element(), Form\select_incoterms(), FormIntervention\select_interventions(), FormAccounting\select_journal(), Form\select_product_fourn_price(), Form\select_produits_fournisseurs_list(), Form\select_produits_list(), FormCompany\select_region(), Form\select_remises(), FormCompany\select_state(), FormResource\select_state(), Form\select_thirdparty_list(), Form\select_type_fees(), FormSocialContrib\select_type_socialcontrib(), Form\select_types_paiements(), FormResource\select_types_resource(), FormAdvTargetEmailing\selectAdvtargetemailingTemplate(), Form\selectAvailabilityDelay(), Form\selectcontacts(), Form\selectEstablishments(), FormFiscalYear\selectFiscalYear(), FormWebPortal\selectForForms(), FormTicket\selectGroupTickets(), FormOrder\selectInputMethod(), Form\selectInvoiceRec(), FormProduct\selectLotDataList(), FormProduct\selectLotStock(), FormProjets\selectOpportunityStatus(), Form\selectPhoneCode(), FormCategory\selectProductCategory(), FormPropal\selectProposalStatus(), Form\selectRib(), FormTicket\selectSeveritiesTickets(), Form\selectShippingMethod(), Form\selectSituationInvoices(), Form\selectTransportMode(), FormWebsite\selectTypeOfContainer(), FormTicket\selectTypesTickets(), FormProduct\selectWarehouses(), FormProduct\selectWorkstations(), FormAccounting\selectyear_accountancy_bookkepping(), Notify\send(), Adherent\send_an_email(), User\send_password(), Utils\sendBackup(), Adherent\sendEmail(), ActionComm\sendEmailsReminder(), Facture\sendEmailsRemindersOnInvoiceDueDate(), FactureFournisseur\sendEmailsRemindersOnSupplierInvoiceDueDate(), sendEmailToRepresentative(), CMailFile\sendfile(), CSMSFile\sendfile(), sendMail(), sendMailRepresentativeUnpaid(), Adherent\sendReminderForExpiredSubscription(), ActionComm\sendSmsReminder(), dolReceiptPrinter\sendTestToPrinter(), Ticket\sendTicketMessageByEmail(), dolReceiptPrinter\sendToPrinter(), Stripe\sepaStripe(), Societe\set_as_client(), Propal\set_availability(), ExpenseReport\set_cancel(), Facture\set_canceled(), Commande\set_date(), Propal\set_date(), RemiseCheque\set_date(), Fichinter\set_date_delivery(), Propal\set_demand_reason(), Fichinter\set_description(), Propal\set_echeance(), CommandeFournisseur\set_id_projet(), BonPrelevement\set_infocredit(), BonPrelevement\set_infotrans(), RemiseCheque\set_number(), ChargeSociales\set_paid(), ExpenseReport\set_paid(), Facture\set_paid(), FactureFournisseur\set_paid(), Salary\set_paid(), Commande\set_ref_client(), Facture\set_ref_client(), Propal\set_ref_client(), Commande\set_remise(), Facture\set_remise(), Societe\set_remise_client(), Societe\set_remise_supplier(), Commande\set_reopen(), ExpenseReport\set_save_from_refuse(), Loan\set_started(), ChargeSociales\set_unpaid(), ExpenseReport\set_unpaid(), Facture\set_unpaid(), FactureFournisseur\set_unpaid(), Product\setAccountancyCode(), Societe\setAccountancyCode(), ExpenseReport\setApproved(), CompanyBankAccount\setAsDefault(), CompanyPaymentMode\setAsDefault(), FactureFournisseurRec\setAutoValidate(), FactureRec\setAutoValidate(), FichinterRec\setAutoValidate(), CommonObject\setBankAccount(), Propal\setCancel(), Facture\setCanceled(), FactureFournisseur\setCanceled(), Societe\setCategories(), CommonObject\setCategoriesCommon(), Project\setClose(), Expedition\setClosed(), Reception\setClosed(), Ticket\setContract(), Ticket\setCustomer(), CommonObject\setDeliveryAddress(), Commande\setDeliveryDate(), CommandeFournisseur\setDeliveryDate(), Delivery\setDeliveryDate(), Expedition\setDeliveryDate(), Propal\setDeliveryDate(), Reception\setDeliveryDate(), SupplierProposal\setDeliveryDate(), ExpenseReport\setDeny(), Commande\setDiscount(), Facture\setDiscount(), CommonObject\setDocModel(), Commande\setDraft(), Facture\setDraft(), FactureFournisseur\setDraft(), Fichinter\setDraft(), Mailing\setDraft(), Propal\setDraft(), Reception\setDraft(), SupplierProposal\setDraft(), MailingTarget\setError(), CommonObject\setErrorWithLog(), Context\setEventMessages(), CommonObject\setExtraParameters(), Facture\setFinal(), User\setForcePasswordChange(), FactureFournisseurRec\setFrequencyAndUnit(), FactureRec\setFrequencyAndUnit(), FichinterRec\setFrequencyAndUnit(), FactureFournisseurRec\setGeneratePdf(), FactureRec\setGeneratePdf(), setIncoterms(), User\SetInGroup(), Facture\setInputReason(), FactureRec\setMailTemplate(), FactureFournisseurRec\setMaxPeriod(), FactureRec\setMaxPeriod(), FichinterRec\setMaxPeriod(), FactureFournisseurRec\setModelPdf(), FactureRec\setModelPdf(), CommonObject\setMulticurrencyCode(), AdherentType\setMultiLangs(), Categorie\setMultiLangs(), Product\setMultiLangs(), Societe\setMysoc(), FactureFournisseurRec\setNextDate(), FactureRec\setNextDate(), FichinterRec\setNextDate(), MailingTarget\setNotSent(), BlockedLog\setObjectData(), ExpenseReport\setPaid(), Facture\setPaid(), FactureFournisseur\setPaid(), Societe\setParent(), Adherent\setPassword(), User\setPassword(), CommonObject\setPaymentMethods(), CommonObject\setPaymentTerms(), ProductCustomerPrice\setPriceOnAffiliateThirdparty(), Ticket\setProgression(), CommonObject\setProject(), MailingTarget\setRead(), MailingTarget\setReadAndUnsubscribed(), Ticket\setReadDate(), Reception\setReceptionDate(), Fichinter\setRefClient(), Facture\setRetainedWarranty(), Facture\setRetainedWarrantyDateLimit(), CommonInvoice\setRetainedWarrantyPaymentTerms(), MailingTarget\setSent(), Expedition\setShippingDate(), CommonObject\setShippingMethod(), CommandeFournisseur\setStatus(), Contact\setstatus(), User\setstatus(), CommonObject\setStatut(), ProductFournisseur\setSupplierPriceExpression(), Adherent\setThirdPartyId(), Societe\setThirdpartyType(), CommonObject\setTransportMode(), ExpenseReport\setUnpaid(), Facture\setUnpaid(), FactureFournisseur\setUnpaid(), Adherent\setUserId(), setUserPassword(), Fichinter\setValid(), Project\setValid(), ExpenseReport\setValidate(), CommonObject\setValueFrom(), Conf\setValues(), FactureFournisseur\setVATReverseCharge(), CommonObject\setWarehouse(), shipping_prepare_head(), show_actions_done(), show_contacts(), FormSms\show_form(), ModeleBoxes\showBox(), FormFile\showdocuments(), CommonObject\showInputField(), ExtraFields\showInputField(), FormWebPortal\showInputFieldForObject(), Form\showLinkedObjectBlock(), Form\showLinkToObjectBlock(), CommonObject\showOptionals(), ExtraFields\showOutputField(), showWebsiteTemplates(), societe_prepare_head(), BonPrelevement\SommeAPrelever(), Adherent\subscriptionComplementaryActions(), pdf_octopus\sumSituation(), supplier_invoice_rec_prepare_head(), CommonObject\swapContactStatus(), MultiCurrency\syncRates(), tax_by_rate(), tax_by_thirdparty(), ticket_prepare_head(), Tasks\timespentRecordChecks(), top_htmlhead(), BookKeeping\transformTransaction(), tree_recur(), ModeleImports\triggerImportSqlOperation(), FormCompany\typent_array(), Ldap\unbind(), DiscountAbsolute\unlink_invoice(), Account\update(), AccountancyCategory\update(), AccountancyReport\update(), AccountingAccount\update(), ActionComm\update(), Adherent\update(), AdherentType\update(), AdvanceTargetingMailing\update(), BankCateg\update(), BookKeeping\update(), Bookmark\update(), Categorie\update(), Cchargesociales\update(), Ccountry\update(), CEmailTemplate\update(), CGenericDic\update(), ChargeSociales\update(), CLeadStatus\update(), Commande\update(), CommandeFournisseur\update(), CommandeFournisseurLigne\update(), Comment\update(), Contact\update(), Contrat\update(), ContratLigne\update(), Cpaiement\update(), CProductNature\update(), Cregion\update(), Cronjob\update(), Cstate\update(), Ctypent\update(), Ctyperesource\update(), CUnits\update(), CurrencyRate\update(), Dolresource\update(), Don\update(), EcmDirectory\update(), EcmFiles\update(), Entrepot\update(), Establishment\update(), Events\update(), Expedition\update(), ExpeditionLigne\update(), ExpenseReport\update(), ExpenseReportLine\update(), ExtraFields\update(), Facture\update(), FactureFournisseur\update(), FactureFournisseurLigneRec\update(), FactureFournisseurRec\update(), FactureLigne\update(), FactureLigneRec\update(), FactureRec\update(), Fichinter\update(), FichinterLigne\update(), Fiscalyear\update(), Holiday\update(), Ldap\update(), Link\update(), Loan\update(), LoanSchedule\update(), Localtax\update(), Mailing\update(), MailingTarget\update(), Menubase\update(), MultiCurrency\update(), Opensurveysondage\update(), OrderLine\update(), PaymentDonation\update(), PaymentExpenseReport\update(), PaymentLoan\update(), PaymentSalary\update(), PaymentSocialContribution\update(), PaymentTerm\update(), PaymentVarious\update(), PaymentVAT\update(), PriceExpression\update(), PriceGlobalVariable\update(), PriceGlobalVariableUpdater\update(), Product\update(), ProductAttribute\update(), ProductAttributeValue\update(), Productbatch\update(), ProductCustomerPrice\update(), Productlot\update(), ProductStockEntrepot\update(), Project\update(), Propal\update(), PropaleLigne\update(), Propalmergepdfproduct\update(), Reception\update(), ReceptionLineBatch\update(), Salary\update(), Societe\update(), Subscription\update(), SupplierInvoiceLine\update(), SupplierProposalLine\update(), Task\update(), Ticket\update(), Tva\update(), User\update(), Website\update(), Account\update_bban(), ProductFournisseur\update_buyprice(), User\update_clicktodial(), Paiement\update_date(), Project\update_element(), Adherent\update_end_date(), Paiement\update_fk_bank(), PaymentDonation\update_fk_bank(), PaymentExpenseReport\update_fk_bank(), PaymentLoan\update_fk_bank(), PaymentSalary\update_fk_bank(), PaymentSocialContribution\update_fk_bank(), PaymentVAT\update_fk_bank(), ExtraFields\update_label(), User\update_last_login_date(), User\update_ldap2dolibarr(), MailingTargets\update_nb(), PriceGlobalVariableUpdater\update_next_update(), CommonObject\update_note(), Paiement\update_num(), Contact\update_perso(), CommonObject\update_ref_ext(), Product\update_sousproduit(), PriceGlobalVariableUpdater\update_status(), Contrat\update_statut(), ContratLigne\update_total(), FactureLigne\update_total(), FichinterLigne\update_total(), OrderLine\update_total(), PropaleLigne\update_total(), SupplierInvoiceLine\update_total(), SupplierProposalLine\update_total(), AccountancyCategory\updateAccAcc(), AssetAccountancyCodes\updateAccountancyCodes(), updateActionComm(), RemiseCheque\updateAmount(), Ldap\updateAttribute(), BookKeeping\updateByMvt(), CommonObject\updateCommon(), Holiday\updateConfCP(), updateContact(), AssetDepreciationOptions\updateDeprecationOptions(), Dolresource\updateElementResource(), CommonObject\updateExtraField(), ExtraFields\updateExtraField(), Setup\updateExtrafields(), Lettering\updateGeneralMatching(), updateInvoice(), Lettering\updateLettering(), BOM\updateLine(), ProductAttribute\updateLine(), Commande\updateline(), CommandeFournisseur\updateline(), Contrat\updateline(), Facture\updateline(), FactureFournisseur\updateline(), FactureFournisseurRec\updateline(), FactureRec\updateline(), Propal\updateline(), SupplierProposal\updateline(), FichinterRec\updateNbGenDone(), CommonObject\updateObjectLinked(), SupplierProposal\updateOrCreatePriceFournisseur(), updateOrder(), PaymentSalary\updatePaymentDate(), ProductAttribute\updatePositionOfAttribute(), Product\updatePrice(), updateProductOrService(), CommonObject\updateRangOfLine(), Holiday\updateSoldeCP(), updateThirdParty(), Task\updateTimeSpent(), Societe\useNPR(), user_prepare_head(), Societe\useRevenueStamp(), CashControl\valid(), Commande\valid(), CommandeFournisseur\valid(), Expedition\valid(), Mailing\valid(), Propal\valid(), Reception\valid(), SupplierProposal\valid(), Adherent\validate(), Asset\validate(), AssetModel\validate(), Availabilities\validate(), BOM\validate(), Calendar\validate(), ConferenceOrBooth\validate(), ConferenceOrBoothAttendee\validate(), Contrat\validate(), Evaluation\validate(), Facture\validate(), FactureFournisseur\validate(), Holiday\validate(), Job\validate(), KnowledgeRecord\validate(), Mo\validate(), MyObject\validate(), Paiement\validate(), Partnership\validate(), Position\validate(), ProductFournisseurPrice\validate(), RecruitmentCandidature\validate(), RecruitmentJobPosition\validate(), RemiseCheque\validate(), Skill\validate(), Skilldet\validate(), SkillRank\validate(), StockTransfer\validate(), StockTransferLine\validate(), Target\validate(), TimeSpent\validate(), Societe\validateFamilyTree(), BookKeeping\validateMovementForFiscalPeriod(), modGeneratePassNone\validatePassword(), modGeneratePassPerso\validatePassword(), modGeneratePassStandard\validatePassword(), validateZipFile(), validOrder(), mod_barcode_product_standard\verif(), mod_barcode_thirdparty_standard\verif(), mod_codeclient_elephant\verif(), mod_codeclient_leopard\verif(), mod_codeclient_monkey\verif(), mod_codecompta_aquarium\verif(), mod_codeproduct_elephant\verif(), mod_codeproduct_leopard\verif(), mod_contract_olive\verif(), mod_codeclient_monkey\verif_dispo(), mod_barcode_product_standard\verif_syntax(), mod_barcode_thirdparty_standard\verif_syntax(), Holiday\verifNbUsers(), Ticket\verify(), ProductCustomerPrice\verifyDates(), ActionsTicket\viewTicketOriginalMessage(), vignette(), doc_generic_asset_odt\write_file(), doc_generic_member_odt\write_file(), doc_generic_odt\write_file(), doc_generic_product_odt\write_file(), doc_generic_project_odt\write_file(), doc_generic_stock_odt\write_file(), doc_generic_ticket_odt\write_file(), doc_generic_user_odt\write_file(), doc_generic_usergroup_odt\write_file(), html_cerfafr\write_file(), pdf_azur\write_file(), pdf_cyan\write_file(), pdf_eratosthene\write_file(), pdf_octopus\write_file(), pdf_paiement\write_file(), pdf_sepamandate\write_file(), pdf_sponge\write_file(), pdf_standard_asset\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_strato\write_file(), CMailFile\write_files(), ModeleExports\write_footer(), ModeleImports\write_footer_example(), ModeleExports\write_header(), ModeleImports\write_header_example(), CMailFile\write_images(), CMailFile\write_mimeheaders(), ExportCsv\write_record(), ExportExcel2007\write_record(), ExportTsv\write_record(), ModeleExports\write_record(), ModeleImports\write_record_example(), CMailFile\write_smtpheaders(), ExportCsv\write_title(), ExportExcel2007\write_title(), ExportTsv\write_title(), ModeleExports\write_title(), ModeleImports\write_title_example(), modPhpbarcode\writeBarCode(), and modTcpdfbarcode\writeBarCode().

◆ dol_textishtml()

◆ dol_trunc()

dol_trunc ( $string,
$size = 40,
$trunc = 'right',
$stringencoding = 'UTF-8',
$nodot = 0,
$display = 0 )

Truncate a string to a particular length adding '…' if string larger than length.

If length = max length+1, we do no truncate to avoid having just 1 char replaced with '…'. MAIN_DISABLE_TRUNC=1 can disable all truncings

Parameters
string$stringString to truncate
int$sizeMax string size visible (excluding …). 0 for no limit. WARNING: Final string size can have 3 more chars (if we added …, or if size was max+1 so it does not worse to replace with ...)
string$truncWhere to trunc: 'right', 'left', 'middle' (size must be a 2 power), 'wrap'
string$stringencodingTell what is source string encoding
int$nodotTruncation do not add … after truncation. So it's an exact truncation.
int$displayTrunc is used to display data and can be changed for small screen. TODO Remove this param (must be dealt with CSS)
Returns
string Truncated string. WARNING: length is never higher than $size if $nodot is set, but can be 3 chars higher otherwise.

Definition at line 5529 of file functions.lib.php.

Referenced by Product\_get_stats(), pdf_aurore\_pagehead(), pdf_cyan\_pagehead(), pdf_eratosthene\_pagehead(), pdf_octopus\_pagehead(), pdf_soleil\_pagehead(), pdf_sponge\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_standard_recruitmentjobposition\_pagehead(), pdf_standard_actions\_pages(), BookKeeping\accountingLabelForOperation(), Facture\addline(), FormAdvTargetEmailing\advMultiselectarraySelllist(), BonPrelevement\buildRumNumber(), CommonInvoice\buildSwitzerlandQRString(), vCard\buildVCardString(), check_user_password_ldap(), ModeleImports\commonImportInsert(), Form\constructProductListOption(), ActionComm\create(), BookKeeping\create(), EcmFiles\create(), Events\create(), dol_buildlogin(), pdf_octopus\drawInfoTable(), pdf_sponge\drawInfoTable(), BonPrelevement\EnregDestinataireSEPA(), BonPrelevement\EnregEmetteurSEPA(), mod_syslog_file\export(), mod_syslog_syslog\export(), AccountancyExport\exportBob50(), AccountancyExport\exportFEC(), AccountancyExport\exportFEC2(), AccountancyExport\exportGestimumV3(), AccountancyExport\exportGestimumV5(), AccountancyExport\exportLDCompta10(), AccountancyExport\exportWinfic(), mailing_advthirdparties\formFilter(), mailing_fraise\formFilter(), Ai\generateContent(), Translate\get_available_languages(), AccountingJournal\getAccountingAccountInfos(), AccountingJournal\getAssetData(), AccountingJournal\getDiscountCustomer(), AccountingJournal\getDiscountSupplier(), ConferenceOrBoothAttendee\getFullName(), getFullName(), RecruitmentCandidature\getFullName(), UserGroup\getFullName(), Job\getKanbanView(), getListOfModels(), ActionComm\getNomUrl(), Adherent\getNomUrl(), AdherentType\getNomUrl(), Asset\getNomUrl(), Categorie\getNomUrl(), Contact\getNomUrl(), EcmDirectory\getNomUrl(), ExpenseReport\getNomUrl(), Facture\getNomUrl(), FactureFournisseur\getNomUrl(), FactureRec\getNomUrl(), Loan\getNomUrl(), PaymentDonation\getNomUrl(), PaymentExpenseReport\getNomUrl(), PaymentSocialContribution\getNomUrl(), PaymentVAT\getNomUrl(), Product\getNomUrl(), ProductFournisseur\getNomUrl(), Societe\getNomUrl(), User\getNomUrl(), WebPortalInvoice\getNomUrl(), WebPortalMember\getNomUrl(), Stripe\getPaymentIntent(), getRankOrderResults(), Commande\getShippableInfos(), getSourceDocRef(), FormFile\list_of_autoecmfiles(), FormFile\list_of_documents(), box_graph_product_distribution\loadBox(), box_members_by_tags\loadBox(), FormAdvTargetEmailing\multiselectCountry(), FormAdvTargetEmailing\multiselectState(), EmailCollector\overwritePropertiesOfObject(), pdfWriteBlockedLogSignature(), Categorie\print_all_ways(), print_left_auguria_menu(), CommonObject\printOriginLine(), FormAccounting\select_account(), FormAccounting\select_accounting_category(), Form\select_all_categories(), FormContract\select_contract(), FormIntervention\select_interventions(), Form\select_produits_fournisseurs_list(), FormProjets\select_projects_list(), Form\select_remises(), Form\select_types_paiements(), FormResource\select_types_resource(), Form\selectarray(), FormWebPortal\selectarray(), FormFiscalYear\selectFiscalYear(), FormTicket\selectGroupTickets(), Form\selectInvoiceRec(), FormTicket\selectSeveritiesTickets(), FormProjets\selectTasks(), Form\selectTransportMode(), FormTicket\selectTypesTickets(), ActionComm\sendEmailsReminder(), ActionComm\sendSmsReminder(), CommonObject\setDocModel(), CommonObject\setExtraParameters(), BlockedLog\setObjectData(), show_actions_done(), ModeleBoxes\showBox(), Form\showCategories(), FormFile\showdocuments(), CommonObject\showInputField(), FormWebPortal\showInputFieldForObject(), ExtraFields\showOutputField(), Societe\thirdparty_and_contact_email_array(), Societe\thirdparty_and_contact_phone_array(), Translate\trans(), AccountancyExport\trunc(), CompanyBankAccount\update(), Contrat\update(), EcmFiles\update(), pdf_beluga\write_file(), and pdf_standard_stock\write_file().

◆ dol_ucfirst()

dol_ucfirst ( $string,
$encoding = "UTF-8" )

Convert first character of the first word of a string to upper.

Never use ucfirst because it does not works with UTF8 strings.

Parameters
string$stringString to encode
string$encodingCharacter set encodign
Returns
string String converted
See also
dol_strtoupper(), dol_ucwords()

Definition at line 2683 of file functions.lib.php.

Referenced by SocialNetworkManager\initializeHandler().

◆ dol_ucwords()

dol_ucwords ( $string,
$encoding = "UTF-8" )

Convert first character of all the words of a string to upper.

Parameters
string$stringString to encode
string$encodingCharacter set encodign
Returns
string String converted
See also
dol_strtoupper(), dol_ucfirst()

Definition at line 2700 of file functions.lib.php.

◆ dol_user_country()

dol_user_country ( )

Return country code for current user.

If software is used inside a local network, detection may fails (we need a public ip)

Returns
string Country code (fr, es, it, us, ...)

Definition at line 5273 of file functions.lib.php.

◆ dol_validElement()

dol_validElement ( $element)

Return if var element is ok.

Parameters
string$elementVariable to check
Returns
boolean Return true of variable is not empty
See also
getElementProperties()

Definition at line 12583 of file functions.lib.php.

◆ dolBuildUrl()

dolBuildUrl ( $url,
$params = [],
$addtoken = false,
$anchor = '' )

Return path of url.

Parameters
string$urlRelative path to file
array<string,int|float|string>$params params for the http query
bool$addtokendoes we need to add token
string$anchorAdd an anchor #xxx at end of URL
Returns
string path

Definition at line 1738 of file functions.lib.php.

Referenced by account_statement_prepare_head(), accounting_prepare_head(), accounting_transaction_prepare_head(), accountingTransactionTemplatePrepareHead(), actions_prepare_head(), agenda_prepare_head(), assetAdminPrepareHead(), assetModelPrepareHead(), bank_admin_prepare_head(), bank_prepare_head(), bank_report_prepare_head(), bomAdminPrepareHead(), bomPrepareHead(), bon_prelevement_prepare_head(), calendars_prepare_head(), categories_prepare_head(), categoriesadmin_prepare_head(), commande_prepare_head(), contact_prepare_head(), contract_admin_prepare_head(), contract_prepare_head(), cron_prepare_head(), cronadmin_prepare_head(), displayPositionCard(), Documentation\displaySummary(), dol_print_cron_urls(), donation_admin_prepare_head(), donation_prepare_head(), ecm_admin_prepare_head(), ecm_file_prepare_head(), ecm_prepare_dasboard_head(), ecm_prepare_head(), ecm_prepare_head_fm(), Form\editfieldkey(), establishment_prepare_head(), expedition_admin_prepare_head(), expedition_prepare_head(), expensereport_admin_prepare_head(), expensereport_prepare_head(), facture_prepare_head(), fichinter_admin_prepare_head(), fichinter_prepare_head(), fichinter_rec_prepare_head(), fiscalyear_prepare_head(), form_constantes(), get_left_menu_home(), get_left_menu_hrm(), get_left_menu_members(), get_left_menu_projects(), get_left_menu_thridparties(), get_left_menu_tools(), AccountingJournal\getNomUrl(), ActionComm\getNomUrl(), Adherent\getNomUrl(), AdherentType\getNomUrl(), BOM\getNomUrl(), BookKeeping\getNomUrl(), Commande\getNomUrl(), Contact\getNomUrl(), Contrat\getNomUrl(), ExpenseReport\getNomUrl(), Loan\getNomUrl(), Mo\getNomUrl(), MyObject\getNomUrl(), PaymentLoan\getNomUrl(), Propal\getNomUrl(), RecruitmentCandidature\getNomUrl(), RecruitmentJobPosition\getNomUrl(), Subscription\getNomUrl(), Target\getNomUrl(), TriggerHistory\getNomUrl(), User\getNomUrl(), UserGroup\getNomUrl(), Workstation\getNomUrl(), group_prepare_head(), holiday_admin_prepare_head(), holiday_prepare_head(), hrm_admin_prepare_head(), ihm_prepare_head(), doc_generic_user_odt\info(), invoice_admin_prepare_head(), invoice_rec_prepare_head(), Adherent\load_board(), ExpenseReport\load_board(), Propal\load_board(), box_members_by_tags\loadBox(), member_admin_prepare_head(), member_prepare_head(), member_stats_prepare_head(), member_type_prepare_head(), membership_stats_prepare_head(), memoPrepareHead(), modulehelp_prepare_head(), modules_prepare_head(), mymoduleAdminPrepareHead(), myobjectPrepareHead(), order_admin_prepare_head(), payment_expensereport_prepare_head(), prelevement_prepare_head(), print_eldy_menu(), product_admin_prepare_head(), product_lot_admin_prepare_head(), product_prepare_head(), productlot_prepare_head(), project_prepare_head(), propal_admin_prepare_head(), propal_prepare_head(), quickmemoAdminPrepareHead(), security_prepare_head(), showSkins(), societe_admin_prepare_head(), societe_prepare_head(), societe_prepare_head2(), subscription_prepare_head(), supplier_invoice_admin_prepare_head(), supplier_invoice_rec_prepare_head(), supplierorder_admin_prepare_head(), targetPrepareHead(), ticket_prepare_head(), ticketAdminPrepareHead(), top_menu(), top_menu_user(), translation_prepare_head(), triggerhistoryPrepareHead(), user_admin_prepare_head(), user_prepare_head(), webhookAdminPrepareHead(), and workstationPrepareHead().

◆ dolButtonToOpenExportDialog()

dolButtonToOpenExportDialog ( $name,
$label,
$buttonstring,
$exportSiteName,
$overwriteGitUrl,
$website )

Create a dialog with two buttons for export and overwrite of a website.

Parameters
string$nameUnique identifier for the dialog
string$labelTitle of the dialog
string$buttonstringText for the button that opens the dialog
string$exportSiteNameName of the "submit" input for site export
string$overwriteGitUrlURL for the link that triggers the overwrite action in GIT
Website$websiteWebsite object
Returns
string HTML and JavaScript code for the button and the dialog

Definition at line 2927 of file functions.lib.php.

◆ dolButtonToOpenUrlInDialogPopup()

dolButtonToOpenUrlInDialogPopup ( $name,
$label,
$buttonstring,
$url,
$disabled = '',
$morecss = 'classlink button bordertransp',
$jsonopen = '',
$jsonclose = '',
$accesskey = '' )

Return HTML code to output a button to open a dialog popup box.

Such buttons must be included inside a HTML form.

Parameters
string$nameA name for the html component
string$labelLabel shown in Popup title top bar
string$buttonstringbutton string (HTML text we can click on)
string$urlRelative Url to open. For example '/project/card.php'
string$disabledDisabled text
string$morecssMore CSS
string$jsonopenSome JS code to execute on click/open of popup
string$jsoncloseSome JS code to execute on close of popup Value is 'keyforpopupid:Name_of_html_component_to_set_with id,Name_of_html_component_to_set_with_label'
string$accesskeyA key to use shortcut
Returns
string HTML component with button

Definition at line 3021 of file functions.lib.php.

Referenced by Form\selectCategories(), and top_menu_user().

◆ dolChmod()

dolChmod ( $filepath,
$newmask = '' )

Change mod of a file.

Parameters
string$filepathFull file path
string$newmaskForce new mask. For example '0644'
Returns
void

Definition at line 9010 of file functions.lib.php.

Referenced by addObjectsToApiFile(), build_calfile(), ActionComm\build_exportfile(), build_rssfile(), vCard\buildVCardString(), Utils\compressSyslogs(), BlockedLog\create(), Website\create(), deletePropsAndPermsFromDoc(), dol_copy(), dol_delete_file(), dol_filecache(), dol_imageResizeOrCrop(), dol_meta_create(), dol_move(), dol_move_uploaded_file(), dol_setcache(), dolReplaceInFile(), dolSaveCssFile(), dolSaveHtaccessFile(), dolSaveHtmlHeader(), dolSaveIndexPage(), dolSaveJsFile(), dolSaveLicense(), dolSaveManifestJson(), dolSaveMasterFile(), dolSavePageAlias(), dolSavePageContent(), dolSaveReadme(), dolSaveRobotFile(), Ldap\dump(), CMailFile\dump_mail(), CSMSFile\dump_sms(), CSMSFile\dump_sms_result(), Utils\dumpDatabase(), Utils\executeCLI(), mod_syslog_file\export(), Website\exportWebSite(), DiasporaHandler\fetch(), RedditHandler\fetch(), CMailFile\findHtmlImagesIsSrcData(), BonPrelevement\generate(), Ai\generateContent(), Stats\getAllByProductEntry(), getAllImages(), Stats\getAmountByMonthWithPrevYear(), Stats\getNbByMonthWithPrevYear(), EmailCollector\getpart(), ExternalModules\getRemoteYamlFile(), ProjectStats\getTransformRateByMonthWithPrevYear(), ProjectStats\getWeightedAmountByMonthWithPrevYear(), FileUpload\handleFileUpload(), includeContainer(), migrate_blockedlog_add_end_file(), ICal\parse(), RssParser\parser(), Documents\post(), rebuild_merge_pdf(), rebuildObjectClass(), rebuildObjectSql(), removeObjectFromApiFile(), Website\replaceLineUsingNum(), CMailFile\save_dump_mail_in_err(), EmailCollector\saveAttachment(), saveAttachment(), html_generic\saveFile(), vignette(), BordereauChequeBlochet\write_file(), doc_generic_asset_odt\write_file(), doc_generic_member_odt\write_file(), doc_generic_odt\write_file(), doc_generic_product_odt\write_file(), doc_generic_project_odt\write_file(), doc_generic_stock_odt\write_file(), doc_generic_ticket_odt\write_file(), doc_generic_user_odt\write_file(), doc_generic_usergroup_odt\write_file(), html_cerfafr\write_file(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_balance\write_file(), pdf_baleine\write_file(), pdf_ban\write_file(), pdf_beluga\write_file(), pdf_bookkeeping\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_ledger\write_file(), pdf_merou\write_file(), pdf_muscadet\write_file(), pdf_octopus\write_file(), pdf_paiement\write_file(), pdf_rouget\write_file(), pdf_sepamandate\write_file(), pdf_soleil\write_file(), pdf_sponge\write_file(), pdf_squille\write_file(), pdf_standard\write_file(), pdf_standard_actions\write_file(), pdf_standard_asset\write_file(), pdf_standard_evaluation\write_file(), pdf_standard_expensereport\write_file(), pdf_standard_member\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_standard_stock\write_file(), pdf_standard_supplierpayment\write_file(), pdf_standardlabel\write_file(), pdf_storm\write_file(), pdf_strato\write_file(), pdf_tcpdflabel\write_file(), pdf_timespent\write_file(), pdf_typhon\write_file(), pdf_vinci\write_file(), pdf_zenith\write_file(), and pdf_standard_salary\writeFile().

◆ dolExplodeIntoArray()

dolExplodeIntoArray ( $string,
$delimiter = ';',
$kv = '=' )

Split a string with 2 keys into key array.

For example: "A=1;B=2;C=2" is exploded into array('A'=>'1','B'=>'2','C'=>'3')

Parameters
?string$stringString to explode
string$delimiterDelimiter between each couple of data. Example: ';' or '[
;]+' or '(
\r|\r|
|;)'
string$kvDelimiter between key and value
Returns
array<string,string> Array of data exploded

Definition at line 13320 of file functions.lib.php.

Referenced by EmailCollector\overwritePropertiesOfObject().

◆ dolExplodeKeepIfQuotes()

dolExplodeKeepIfQuotes ( $input)

Explode a search string into an array but do not explode when keys are inside quotes.

For example "a 'b c'" will be array("a", "b c").

Parameters
string$inputString to explode
Returns
array<string> Array of string values
Parameters
string$aMatched value in double quotes
string$bMatched value in single quotes
string$cUnquoted value
Returns
string

Filter out empty strings from the result array.

Parameters
string$valThe value to check.
Returns
bool True if the value is not an empty string.

Definition at line 13359 of file functions.lib.php.

◆ dolGetCountryCodeFromIp()

dolGetCountryCodeFromIp ( $ip)

Return a country code from IP.

Empty string if not found.

Parameters
string$ipIP
Returns
string Country code ('us', 'fr', ...)

Definition at line 5238 of file functions.lib.php.

◆ dolGetFirstLastname()

dolGetFirstLastname ( $firstname,
$lastname,
$nameorder = -1 )

Return firstname and lastname in correct order.

Parameters
string$firstnameFirstname
string$lastnameLastname
int$nameorder-1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname, 2=Firstname, 3=Firstname if defined else lastname, 4=Lastname, 5=Lastname if defined else firstname
Returns
string Firstname + lastname or Lastname + firstname

Definition at line 11301 of file functions.lib.php.

Referenced by pdf_standard_expensereport\_pagehead(), MailmanSpip\add_to_spip(), ActionComm\build_exportfile(), InterfaceTicketEmail\composeAndSendAssigneeMessage(), Societe\contact_array(), Societe\contact_get_property(), Societe\contact_property_array(), Notify\getAuthorEmail(), Tickets\getCommon(), ConferenceOrBoothAttendee\getFullName(), getFullName(), RecruitmentCandidature\getFullName(), UserGroup\getFullName(), mod_expensereport_jade\getNextValue(), Notify\getSupervisorEmail(), ExpenseReportRule\getUserName(), Ticket\newMessage(), FormAccounting\select_auxaccount(), Notify\send(), sendMail(), BonPrelevement\set_infotrans(), and User\user_get_property().

◆ dolGetFirstLetters()

dolGetFirstLetters ( $s,
$nbofchar = 1 )

Return first letters of a strings.

Example with nbofchar=1: 'ghi' will return 'g' but 'abc def' will return 'ad' Example with nbofchar=2: 'ghi' will return 'gh' but 'abc def' will return 'abde'

Parameters
string$sString to truncate
int$nbofcharNb of characters to keep
Returns
string Return first chars.

Definition at line 5448 of file functions.lib.php.

Referenced by Adherent\getmorphylib(), and AdherentType\getmorphylib().

◆ dolGetFirstLineOfText()

dolGetFirstLineOfText ( $text,
$nboflines = 1,
$charset = 'UTF-8' )

Return first line of text.

Cut will depends if content is HTML or not.

Parameters
string$textInput text
int$nboflinesNb of lines to get (default is 1 = first line only)
string$charsetCharset of $text string (UTF-8 by default)
Returns
string Output text
See also
dol_nboflines_bis(), dol_string_nohtmltag(), dol_escape_htmltag()

Definition at line 9431 of file functions.lib.php.

Referenced by pdf_standard_actions\_pages(), dol_add_file_process(), FormMail\get_form(), KnowledgeRecord\getKanbanView(), Skill\getNomUrl(), ActionComm\getTooltipContentArray(), Product\getTooltipContentArray(), and BlockedLog\setObjectData().

◆ dolOutputDates()

dolOutputDates ( $datep,
$datef = null,
$fullday = 0,
$addseconds = 0,
$pictotoadd = '',
$tzoutput = 'tzuserrel',
$reduceformat = 0 )

Print decorated date-hour.

Parameters
int$datepDate
int | null$datefSecond date
int$fulldaySet to 1 for full day (hours are hidden)
int$addsecondsAdd also seconds
string$pictotoaddPicto to add
string | bool$tzoutputtrue or 'gmt' => string is for Greenwich location false or 'tzserver' => output string is for local PHP server TZ usage 'tzuser' => output string is for user TZ (current browser TZ with current dst) => In a future, we should have same behaviour than 'tzuserrel' 'tzuserrel' => output string is for user TZ (current browser TZ with dst or not, depending on date position)
int$reduceformatUse 1 to use a reduce format
Returns
string Decorated date

Definition at line 4540 of file functions.lib.php.

Referenced by show_actions_done(), and FormActions\showactions().

◆ dolPrintHTML()

dolPrintHTML ( $s,
$allowiframe = 0,
$moreallowedtags = array() )

Return a string (that can be on several lines) ready to be output on a HTML page.

To output a text inside an attribute, you can use dolPrintHTMLForAttribute() or dolPrintHTMLForTextArea() inside a textarea With dolPrintHTML(), only content not already in HTML is encoded with HTML.

Parameters
int | float | string$sString to print
int$allowiframeAllow iframe tags
string[]$moreallowedtagsArray of extra allowed tags (in addition to 'common' list)
Returns
string String ready for HTML output (sanitized and escape)
See also
dolPrintHTMLForAttribute(), dolPrintHTMLFortextArea(), dolPrintText()

Definition at line 2411 of file functions.lib.php.

Referenced by Export\build_filterField(), FormSetupItem\generateOutputField(), FormSetup\generateTableOutput(), RecruitmentCandidature\getKanbanView(), ExternalModules\getProducts(), FormFile\list_of_documents(), printing_printipp\listJobs(), Form\searchComponent(), show_contacts(), Form\showCategories(), and ActionsTicket\viewTicketOriginalMessage().

◆ dolPrintHTMLForAttribute()

dolPrintHTMLForAttribute ( $s,
$escapeonlyhtmltags = 0,
$allowothertags = array() )

Return a string ready to be output into an HTML attribute (alt, title, data-html, ...) With dolPrintHTMLForAttribute(), the content is HTML encode, even if it is already HTML content.

Parameters
string$sString to print
int$escapeonlyhtmltags1=Escape only html tags, not the special chars like accents.
string[]$allowothertagsList of other tags allowed
Returns
string String ready for HTML output
See also
dolPrintHTML(), dolPrintHTMLFortextArea()

Definition at line 2437 of file functions.lib.php.

Referenced by Export\build_filterField(), ChargeSociales\getNomUrl(), Facture\getNomUrl(), Form\getSearchFilterToolInput(), Societe\getTypeUrl(), Form\inputIcon(), FormWebPortal\inputIcon(), Form\inputRadio(), FormWebPortal\inputRadio(), Form\inputStars(), FormWebPortal\inputStars(), Form\inputType(), FormWebPortal\inputType(), Form\outputIcon(), FormWebPortal\outputIcon(), Form\outputStars(), FormWebPortal\outputStars(), FormWebPortal\printFieldCell(), IconField\printInputField(), SelectField\printInputField(), SellistField\printInputField(), VarcharField\printInputField(), Form\select_comptes(), Form\select_produits(), Form\selectarray(), FormWebPortal\selectarray(), ModeleBoxes\showBox(), Form\showCategories(), CommonObject\showInputField(), and Form\showphoto().

◆ dolPrintHTMLForAttributeUrl()

dolPrintHTMLForAttributeUrl ( $s)

Return a string ready to be output on a href attribute (this one need a special because we need content is HTML with no way to detect it is HTML).

With dolPrintHTMLForAttribute(), the content is HTML encode, even if it is already HTML content.

Parameters
string$sString to print
Returns
string String ready for HTML output
See also
dolPrintHTML(), dolPrintHTMLFortextArea()

Definition at line 2460 of file functions.lib.php.

◆ dolPrintHTMLForTextArea()

dolPrintHTMLForTextArea ( $s,
$allowiframe = 0 )

Return a string ready to be output on input textarea.

Differs from dolPrintHTML because all tags are escape. With dolPrintHTML, all tags except common one are escaped.

Parameters
string$sString to print
int$allowiframeAllow iframe tags
Returns
string String ready for HTML output into a textarea
See also
dolPrintHTML(), dolPrintHTMLForAttribute()

Definition at line 2477 of file functions.lib.php.

◆ dolPrintLabel()

dolPrintLabel ( $s,
$escapeonlyhtmltags = 0 )

Return a string label (so on 1 line only and that should not contains any HTML) ready to be output on HTML page.

To use text that is not HTML content inside an attribute, you can simply use only dol_escape_htmltag(). In doubt, use dolPrintHTMLForAttribute().

Parameters
string$sString to print
int$escapeonlyhtmltags1=Escape only html tags, not the special chars like accents.
Returns
string String ready for HTML output
See also
dolPrintText()

Definition at line 2382 of file functions.lib.php.

◆ dolPrintPassword()

dolPrintPassword ( $s)

Return a string ready to be output on an HTML attribute (alt, title, ...)

Parameters
string$sString to print
Returns
string String ready for HTML output

Definition at line 2488 of file functions.lib.php.

◆ dolPrintText()

dolPrintText ( $s)

Return a string label (possible on several lines and that should not contains any HTML) ready to be output on HTML page.

To use text that is not HTML content inside an attribute, you can simply use only dol_escape_htmltag(). In doubt, use dolPrintHTMLForAttribute().

Parameters
string$sString to print
Returns
string String ready for HTML output
See also
dolPrintLabel(), dolPrintHTML()

Definition at line 2395 of file functions.lib.php.

◆ dolSetCookie()

dolSetCookie ( string $cookiename,
string $cookievalue,
int $expire = -1 )

Set a cookie.

Parameters
string$cookienameCookie name
string$cookievalueCookie value
int$expireExpire delay. If 0, expire at end of session. -1 means 1 year.
Returns
void

Return a prefix to use for this Dolibarr instance, for session/cookie names or email id. The prefix is unique for instance and avoid conflict between multi-instances, even when having two instances with same root dir or two instances in same virtual servers. This function must not use dol_hash (that is used for password hash) and need to have all context $conf loaded.

Parameters
string$mode'' (prefix for session name) or 'email' (prefix for email id)
Returns
string A calculated prefix @phan-suppress PhanRedefineFunction - Also defined in webportal.main.inc.php

Definition at line 1507 of file functions.lib.php.

◆ dolSlugify()

dolSlugify ( $stringtoslugify)

Returns text slugified (lowercase and no special char, separator is "-").

Parameters
string$stringtoslugifyString to slugify
Returns
string Slugified string

Definition at line 2242 of file functions.lib.php.

◆ fieldLabel()

fieldLabel ( $langkey,
$fieldkey,
$fieldrequired = 0 )

Show a string with the label tag dedicated to the HTML edit field.

Parameters
string$langkeyTranslation key
string$fieldkeyKey of the html select field the text refers to
int$fieldrequired1=Field is mandatory
Returns
string
Deprecated
Form\editfieldkey

Definition at line 3731 of file functions.lib.php.

◆ formatLogObject()

if(!function_exists('utf8_encode')) if(!function_exists( 'utf8_decode')) if(!function_exists('str_starts_with')) if(!function_exists( 'str_ends_with')) if(!function_exists('str_contains')) formatLogObject ( $data)

Return a string serialized to be output on log with dol_syslog() An option allow to output log in one line instead of a structured human tree.

Parameters
mixed$dataAny PHP object
Returns
string Serialized data for loh

Definition at line 134 of file functions.lib.php.

References getDolGlobalInt().

Referenced by mailing_advthirdparties\add_to_target_spec(), Stripe\cardStripe(), Stripe\getPaymentIntent(), Stripe\getSetupIntent(), CommonInvoice\makeStripeSepaRequest(), print_paypal_redirect(), Stripe\sepaStripe(), and CommonObject\setPaymentTerms().

◆ get_date_range()

get_date_range ( $date_start,
$date_end,
$format = '',
$outputlangs = null,
$withparenthesis = 1 )

Format output for start and end date.

Parameters
int$date_startStart date
int$date_endEnd date
string$formatOutput date format ('day', 'dayhour', ...)
?Translate$outputlangsOutput language
int<0,2>$withparenthesis 1=Add space and parenthesis, 0=no parenthesis, 2=Add parenthesis
Returns
string String

Definition at line 11270 of file functions.lib.php.

Referenced by box_members_last_subscriptions\loadBox(), and CommonObject\printOriginLine().

◆ get_default_localtax()

get_default_localtax ( $thirdparty_seller,
$thirdparty_buyer,
$local,
$idprod = 0 )

Function that return localtax of a product line (according to seller, buyer and product vat rate) If the seller is not subject to VAT, then default VAT=0.

Rule/Test ends. If (seller country == buyer country) default VAT=sold product VAT. Rule/Test ends. Else, default VAT=0. Rule/Test ends

Parameters
Societe$thirdparty_sellerThird party seller
Societe$thirdparty_buyerThird party buyer
int$localLocaltax to process (1 or 2)
int$idprodId product
Returns
int localtax, -1 if it can not be determined
See also
get_default_tva(), get_default_npr()

Definition at line 8741 of file functions.lib.php.

◆ get_default_npr()

get_default_npr ( Societe $thirdparty_seller,
Societe $thirdparty_buyer,
$idprod = 0,
$idprodfournprice = 0 )

Function that returns whether VAT must be recoverable collected VAT (e.g.: VAT NPR in France)

Parameters
Societe$thirdparty_sellerThirdparty seller
Societe$thirdparty_buyerThirdparty buyer
int$idprodId product
int$idprodfournpriceId supplier price for product
Returns
int<0,1> 0 or 1
See also
get_default_tva(), get_default_localtax()

Definition at line 8705 of file functions.lib.php.

Referenced by Commande\add_product(), Propal\add_product(), SupplierProposal\add_product(), Product\getSellPrice(), and Form\load_tva().

◆ get_default_tva()

get_default_tva ( Societe $thirdparty_seller,
Societe $thirdparty_buyer,
$idprod = 0,
$idprodfournprice = 0 )

Function that return vat rate of a product line (according to seller, buyer and product vat rate) VATRULE 0: If we are in mode SERVICE_ARE_ECOMMERCE_200238EC and customer is not a company with a vat id, we use default product VAT in buyer country VATRULE 1: If seller does not use VAT, default VAT is 0.

End of rule. VATRULE 2: If buyer department has a VAT rule from vat rates dictionary then it's the default VAT rate. End of rule. VATRULE 3: If the (seller country = buyer country) then the default VAT = VAT of the product sold. End of rule. VATRULE 4: If (seller and buyer in the European Community) and (property sold = new means of transport such as car, boat, plane) then VAT by default = 0 (VAT must be paid by the buyer to the tax center of his country and not to the seller). End of rule. VATRULE 5: If (seller and buyer in the European Community) and (buyer = individual) then VAT by default = VAT of the product sold. End of rule VATRULE 6: If (seller and buyer in European Community) and (buyer = company) then VAT by default=0. End of rule VATRULE 7: Otherwise the VAT proposed by default=0. End of rule.

Parameters
Societe$thirdparty_sellerObject Seller company
Societe$thirdparty_buyerObject Buyer company
int$idprodId product
int$idprodfournpriceId product_fournisseur_price (for supplier order/invoice)
Returns
float|string Vat rate to use with format 5.0 or '5.0 (XXX)', -1 if we can't guess it
See also
get_default_localtax(), get_default_npr()

Definition at line 8531 of file functions.lib.php.

Referenced by Commande\add_product(), Propal\add_product(), SupplierProposal\add_product(), Propal\createFromClone(), Product\getSellPrice(), Form\load_tva(), Adherent\subscriptionComplementaryActions(), and doc_generic_project_odt\write_file().

◆ get_exdir()

get_exdir ( $num,
$level,
$alpha,
$withoutslash,
$object,
$modulepart = '' )

Return a path to have a the directory according to object where files are stored.

This function is called by getMultidirOutput New usage: $conf->module->multidir_output[$object->entity ?? $conf->entity].'/'.get_exdir(0, 0, 0, 1, $object, '').'/' or: $conf->module->dir_output.'/'.get_exdir(0, 0, 0, 0, $object, '')

Example of output with new usage: $object is invoice -> 'INYYMM-ABCD' Example of output with old usage: '015' with level 3->"0/1/5/", '015' with level 1->"5/", 'ABC-1' with level 3 ->"0/0/1/"

Parameters
string | int$numId of object (deprecated, $object->id will be used in future)
int$levelLevel of subdirs to return (1, 2 or 3 levels). (deprecated, global setup will be used in future)
int$alpha0=Keep number only to forge path, 1=Use alpha part after the - (By default, use 0). (deprecated, global option will be used in future)
int$withoutslash0=With slash at end (except if '/', we return ''), 1=without slash at end
?CommonObject$objectObject to use to get ref to forge the path.
string$modulepartType of object ('invoice_supplier, 'donation', 'invoice', ...'). Use '' for autodetect from $object.
Returns
string Dir to use ending. Example '' or '1/' or '1/2/'
See also
getMultidirOutput()

Definition at line 8870 of file functions.lib.php.

Referenced by FileUpload\__construct(), pdf_standard_member\Add_PDF_card(), Categorie\add_photo(), FactureFournisseur\delete(), AccountancyExport\exportFEC(), AccountancyExport\exportFEC2(), AccountancyExport\exportQuadratus(), facturefourn_prepare_head(), CommonDocGenerator\get_substitutionarray_user(), getCategory(), FormFile\getDocumentsLink(), FormWebPortal\getDocumentsLink(), getMultidirOutput(), getProductOrService(), getProductsForCategory(), CommonDocGenerator\getSubstitutionarrayMember(), holiday_prepare_head(), Categorie\isAnyPhotoAvailable(), FormFile\list_of_documents(), member_prepare_head(), migrate_holiday_path(), migrate_product_photospath(), migrate_productlot_path(), migrate_user_filespath(), migrate_user_photospath(), Documents\post(), product_prepare_head(), Notify\send(), CommonObject\show_photos(), Form\showphoto(), FactureFournisseur\validate(), BordereauChequeBlochet\write_file(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle\write_file(), pdf_eagle_proforma\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_muscadet\write_file(), pdf_octopus\write_file(), pdf_rouget\write_file(), pdf_sponge\write_file(), pdf_squille\write_file(), pdf_standard\write_file(), pdf_standard_member\write_file(), pdf_storm\write_file(), and pdf_zenith\write_file().

◆ get_htmloutput_errors()

get_htmloutput_errors ( $mesgstring = '',
$mesgarray = array(),
$keepembedded = 0 )

Get formatted error messages to output (Used to show messages on html output).

Parameters
string$mesgstringError message
string[]$mesgarrayError messages array
int$keepembeddedSet to 1 in error message must be kept embedded into its html place (this disable jnotify)
Returns
string Return html output
See also
dol_print_error()
dol_htmloutput_mesg()

Definition at line 11530 of file functions.lib.php.

Referenced by ActionsCardCommon\assign_values(), ActionsCardProduct\assign_values(), and ActionsCardService\assign_values().

◆ get_htmloutput_mesg()

get_htmloutput_mesg ( $mesgstring = '',
$mesgarray = [],
$style = 'ok',
$keepembedded = 0 )

Get formatted messages to output (Used to show messages on html output).

This include also the translation of the message key.

Parameters
string$mesgstringMessage string or message key
string[]$mesgarrayArray of message strings or message keys
string$styleStyle of message output ('ok' or 'error')
int$keepembeddedSet to 1 in error message must be kept embedded into its html place (this disable jnotify)
Returns
string Return html output
See also
dol_print_error()
dol_htmloutput_errors()
setEventMessages()

Definition at line 11469 of file functions.lib.php.

Referenced by ActionsCardCommon\assign_values().

◆ get_localtax()

get_localtax ( $vatrate,
$local,
$thirdparty_buyer = null,
$thirdparty_seller = null,
$vatnpr = 0 )

Return localtax rate for a particular VAT rate, when selling a product with vat $vatrate, from a $thirdparty_buyer to a $thirdparty_seller Note: This function get information into the table llx_tva using the VAT rate as key.

Parameters
float | string$vatrateVat rate. Can be '8.5' or '8.5 (VATCODEX)' for example
int$localLocal tax to search and return (1 or 2 return only tax rate 1 or tax rate 2)
?Societe$thirdparty_buyerObject of buying third party
?Societe$thirdparty_sellerObject of selling third party ($mysoc if not defined)
int<0,1>$vatnpr If vat rate is NPR or not
Returns
int<0,0>|string 0 if not found, localtax rate if found (Can be '20', '-19:-15:-9')
See also
get_default_tva(), get_default_localtax()

Definition at line 8028 of file functions.lib.php.

Referenced by Commande\add_product(), Propal\add_product(), SupplierProposal\add_product(), Expedition\fetch_lines(), ProductFournisseur\update_buyprice(), and Product\updatePrice().

◆ get_localtax_by_third()

get_localtax_by_third ( $local)

Get values of localtaxes (1 or 2) for company country for the common vat with the highest value.

Parameters
int<1,2>$local LocalTax to get
Returns
string Values of localtax (Can be '20', '-19:-15:-9') or 'Error'

Definition at line 8181 of file functions.lib.php.

Referenced by FormCompany\select_localtax().

◆ get_product_localtax_for_country()

get_product_localtax_for_country ( $idprod,
$local,
$thirdpartytouseforcountry )

Return localtax vat rate of a product in a particular country or default country vat if product is unknown.

Parameters
int$idprodId of product
int$local1 for localtax1, 2 for localtax 2
Societe$thirdpartytouseforcountryThirdparty with a ->country_code defined (FR, US, IT, ...)
Returns
int Return integer <0 if KO, Vat rate if OK
See also
get_product_vat_for_country()

Definition at line 8457 of file functions.lib.php.

◆ get_product_vat_for_country()

get_product_vat_for_country ( $idprod,
$thirdpartytouseforcountry,
$idprodfournprice = 0 )

Return vat rate of a product in a particular country, or default country vat if product is unknown.

Function called by get_default_tva(). Do not use this function directly, prefer to use get_default_tva().

Parameters
int$idprodId of product or 0 if not a predefined product
Societe$thirdpartytouseforcountryThirdparty with a ->country_code defined (FR, US, IT, ...)
int$idprodfournpriceId product_fournisseur_price (for "supplier" proposal/order/invoice)
Returns
float|string Vat rate to use with format 5.0 or '5.0 (XXX)'
See also
get_default_tva(), get_product_localtax_for_country()

Definition at line 8361 of file functions.lib.php.

◆ getArrayOfSocialNetworks()

getArrayOfSocialNetworks ( )

Get array of social network dictionary.

Returns
array<string,array{rowid:int,label:string,url:string,icon:string,active:int}> Array of Social Networks Dictionary

Definition at line 4605 of file functions.lib.php.

Referenced by Adherent\_load_ldap_info(), User\_load_ldap_info(), show_contacts(), and User\update_ldap2dolibarr().

◆ getBrowserInfo()

getBrowserInfo ( $user_agent)

Return information about user browser.

Returns array with the following format: array( 'browsername' => Browser name (firefox|chrome|iceweasel|epiphany|safari|opera|ie|unknown) 'browserversion' => Browser version. Empty if unknown 'browseros' => Set with mobile OS (android|blackberry|ios|palm|symbian|webos|maemo|windows|unknown) 'layout' => (tablet|phone|classic) 'phone' => empty if not mobile, (android|blackberry|ios|palm|unknown) if mobile 'tablet' => true/false )

Parameters
string$user_agentContent of $_SERVER["HTTP_USER_AGENT"] variable
Returns
array{browsername:string,browserversion:string,browseros:string,browserua:string,layout:string,phone:string,tablet:bool} Check function documentation

Definition at line 737 of file functions.lib.php.

◆ getCallerInfoString()

getCallerInfoString ( )

Get caller info as a string that can be appended to a log message.

Returns
string

Definition at line 2715 of file functions.lib.php.

Referenced by BordereauChequeBlochet\__construct(), doc_generic_asset_odt\__construct(), doc_generic_bom_odt\__construct(), doc_generic_contract_odt\__construct(), doc_generic_invoice_odt\__construct(), doc_generic_member_odt\__construct(), doc_generic_mo_odt\__construct(), doc_generic_myobject_odt\__construct(), doc_generic_odt\__construct(), doc_generic_order_odt\__construct(), doc_generic_product_odt\__construct(), doc_generic_project_odt\__construct(), doc_generic_proposal_odt\__construct(), doc_generic_reception_odt\__construct(), doc_generic_recruitmentjobposition_odt\__construct(), doc_generic_shipment_odt\__construct(), doc_generic_stock_odt\__construct(), doc_generic_supplier_invoice_odt\__construct(), doc_generic_supplier_order_odt\__construct(), doc_generic_supplier_proposal_odt\__construct(), doc_generic_task_odt\__construct(), doc_generic_ticket_odt\__construct(), doc_generic_user_odt\__construct(), doc_generic_usergroup_odt\__construct(), pdf_aurore\__construct(), pdf_azur\__construct(), pdf_balance\__construct(), pdf_baleine\__construct(), pdf_ban\__construct(), pdf_beluga\__construct(), pdf_bookkeeping\__construct(), pdf_cornas\__construct(), pdf_cyan\__construct(), pdf_eagle\__construct(), pdf_eagle_proforma\__construct(), pdf_einstein\__construct(), pdf_eratosthene\__construct(), pdf_espadon\__construct(), pdf_ledger\__construct(), pdf_merou\__construct(), pdf_muscadet\__construct(), pdf_octopus\__construct(), pdf_rouget\__construct(), pdf_sepamandate\__construct(), pdf_soleil\__construct(), pdf_sponge\__construct(), pdf_squille\__construct(), pdf_standard\__construct(), pdf_standard_asset\__construct(), pdf_standard_evaluation\__construct(), pdf_standard_expensereport\__construct(), pdf_standard_movementstock\__construct(), pdf_standard_myobject\__construct(), pdf_standard_recruitmentjobposition\__construct(), pdf_standard_stock\__construct(), pdf_standard_supplierpayment\__construct(), pdf_storm\__construct(), pdf_strato\__construct(), pdf_timespent\__construct(), pdf_typhon\__construct(), pdf_vinci\__construct(), pdf_zenith\__construct(), doc_generic_project_odt\write_file(), pdf_eratosthene\write_file(), and pdf_strato\write_file().

◆ getDolCurrency()

◆ getDolDBType()

getDolDBType ( )

Return the current entity.

Returns
string Value returned

Definition at line 394 of file functions.lib.php.

References $conf.

◆ getDolDefaultContextPage()

getDolDefaultContextPage ( $s)

Return the default context page string.

Parameters
string$sPage path
Returns
string Value returned

Definition at line 406 of file functions.lib.php.

◆ getDolEntity()

getDolEntity ( )

Return the current entity.

Returns
int Value returned

Definition at line 383 of file functions.lib.php.

References $conf.

Referenced by BlockedLog\setObjectData().

◆ getDolGlobalBool()

getDolGlobalBool ( $key,
$default = false )

Return a Dolibarr global constant boolean value.

The constants $conf->global->xxx are loaded by the script master.inc.php included at begin of any PHP page.

Parameters
string$keyKey to return value, return $default if not set
bool$defaultValue to return if not defined
Returns
bool Value returned

Definition at line 350 of file functions.lib.php.

References $conf.

Referenced by DolibarrApi\__construct(), bank_prepare_head(), canDisplayLinkedObjectInPDF(), pdf_cyan\defineColumnField(), pdf_eratosthene\defineColumnField(), pdf_sponge\defineColumnField(), FormMail\get_form(), Societe\id_prof_verifiable(), show_contacts(), Commande\valid(), CommandeFournisseur\valid(), Propal\valid(), and SupplierProposal\valid().

◆ getDolGlobalFloat()

getDolGlobalFloat ( $key,
$default = 0 )

Return a Dolibarr global constant float value.

The constants $conf->global->xxx are loaded by the script master.inc.php included at begin of any PHP page.

Parameters
string$keyKey to return value, return $default if not set
float$defaultValue to return if not defined
Returns
float Value returned
See also
getDolUserInt()

Definition at line 336 of file functions.lib.php.

References $conf.

Referenced by CommandeFournisseur\approve(), calcul_price_total(), pdf_getHeightForLogo(), and pdf_pagehead().

◆ getDolGlobalInt()

getDolGlobalInt ( $key,
$default = 0 )

Return a Dolibarr global constant int value.

The constants $conf->global->xxx are loaded by the script master.inc.php included at begin of any PHP page.

Parameters
string$keyKey to return value, return $default if not set
int$defaultValue to return if not defined
Returns
int Value returned
See also
getDolUserInt()

Definition at line 321 of file functions.lib.php.

References $conf.

Referenced by AccountancyExport\__construct(), AccountingAccount\__construct(), Adherent\__construct(), AdherentType\__construct(), BookkeepingTemplate\__construct(), BookkeepingTemplateLine\__construct(), BordereauChequeBlochet\__construct(), box_activity\__construct(), box_funnel_of_prospection\__construct(), box_project_opportunities\__construct(), box_validated_projects\__construct(), Calendar\__construct(), CEmailTemplate\__construct(), Commande\__construct(), ConferenceOrBoothAttendee\__construct(), Contact\__construct(), DolEditor\__construct(), DolLogsCollector\__construct(), ExpenseReport\__construct(), Facture\__construct(), FileUpload\__construct(), FormTicket\__construct(), IntracommReport\__construct(), Ldap\__construct(), Login\__construct(), Memo\__construct(), mod_commande_fournisseur_muguet\__construct(), modCollab\__construct(), modCron\__construct(), modMyModule\__construct(), modProduct\__construct(), modQuickMemo\__construct(), modService\__construct(), modSocialNetworks\__construct(), modStock\__construct(), modTicket\__construct(), modWebsite\__construct(), MyObject\__construct(), pdf_aurore\__construct(), pdf_azur\__construct(), pdf_balance\__construct(), pdf_baleine\__construct(), pdf_ban\__construct(), pdf_beluga\__construct(), pdf_bookkeeping\__construct(), pdf_canelle\__construct(), pdf_cornas\__construct(), pdf_cyan\__construct(), pdf_eagle\__construct(), pdf_eagle_proforma\__construct(), pdf_einstein\__construct(), pdf_eratosthene\__construct(), pdf_espadon\__construct(), pdf_ledger\__construct(), pdf_merou\__construct(), pdf_muscadet\__construct(), pdf_octopus\__construct(), pdf_paiement\__construct(), pdf_rouget\__construct(), pdf_sepamandate\__construct(), pdf_soleil\__construct(), pdf_sponge\__construct(), pdf_squille\__construct(), pdf_standard\__construct(), pdf_standard_actions\__construct(), pdf_standard_asset\__construct(), pdf_standard_evaluation\__construct(), pdf_standard_expensereport\__construct(), pdf_standard_movementstock\__construct(), pdf_standard_myobject\__construct(), pdf_standard_recruitmentjobposition\__construct(), pdf_standard_salary\__construct(), pdf_standard_stock\__construct(), pdf_standard_supplierpayment\__construct(), pdf_storm\__construct(), pdf_strato\__construct(), pdf_timespent\__construct(), pdf_typhon\__construct(), pdf_vinci\__construct(), pdf_zenith\__construct(), printing_printipp\__construct(), Propal\__construct(), Salary\__construct(), Societe\__construct(), TriggerHistory\__construct(), DolibarrApiAccess\__isAllowed(), MouvementStock\_create(), BordereauChequeBlochet\_pagefoot(), pdf_aurore\_pagefoot(), pdf_azur\_pagefoot(), pdf_balance\_pagefoot(), pdf_baleine\_pagefoot(), pdf_beluga\_pagefoot(), pdf_bookkeeping\_pagefoot(), pdf_canelle\_pagefoot(), pdf_cornas\_pagefoot(), pdf_cyan\_pagefoot(), pdf_eagle\_pagefoot(), pdf_eagle_proforma\_pagefoot(), pdf_einstein\_pagefoot(), pdf_eratosthene\_pagefoot(), pdf_espadon\_pagefoot(), pdf_ledger\_pagefoot(), pdf_muscadet\_pagefoot(), pdf_octopus\_pagefoot(), pdf_rouget\_pagefoot(), pdf_sepamandate\_pagefoot(), pdf_soleil\_pagefoot(), pdf_sponge\_pagefoot(), pdf_squille\_pagefoot(), pdf_standard\_pagefoot(), pdf_standard_asset\_pagefoot(), pdf_standard_evaluation\_pagefoot(), pdf_standard_expensereport\_pagefoot(), pdf_standard_movementstock\_pagefoot(), pdf_standard_myobject\_pagefoot(), pdf_standard_salary\_pagefoot(), pdf_standard_stock\_pagefoot(), pdf_standard_supplierpayment\_pagefoot(), pdf_storm\_pagefoot(), pdf_strato\_pagefoot(), pdf_timespent\_pagefoot(), pdf_typhon\_pagefoot(), pdf_vinci\_pagefoot(), pdf_zenith\_pagefoot(), pdf_aurore\_pagehead(), pdf_azur\_pagehead(), pdf_canelle\_pagehead(), pdf_cornas\_pagehead(), pdf_cyan\_pagehead(), pdf_eagle_proforma\_pagehead(), pdf_einstein\_pagehead(), pdf_eratosthene\_pagehead(), pdf_espadon\_pagehead(), pdf_merou\_pagehead(), pdf_muscadet\_pagehead(), pdf_octopus\_pagehead(), pdf_rouget\_pagehead(), pdf_soleil\_pagehead(), pdf_sponge\_pagehead(), pdf_squille\_pagehead(), pdf_standard\_pagehead(), pdf_standard_asset\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_standard_recruitmentjobposition\_pagehead(), pdf_strato\_pagehead(), pdf_vinci\_pagehead(), pdf_zenith\_pagehead(), SMTPs\_server_authenticate(), pdf_aurore\_tableau(), pdf_azur\_tableau(), pdf_canelle\_tableau(), pdf_einstein\_tableau(), pdf_eratosthene\_tableau(), pdf_muscadet\_tableau(), pdf_octopus\_tableau(), pdf_sponge\_tableau(), pdf_squille\_tableau(), pdf_standard_myobject\_tableau(), pdf_aurore\_tableau_info(), pdf_azur\_tableau_info(), pdf_cornas\_tableau_info(), pdf_einstein\_tableau_info(), pdf_muscadet\_tableau_info(), pdf_zenith\_tableau_info(), acceptLocalLinktoMedia(), BookKeeping\accountingLabelForOperation(), BookKeeping\accountingResult(), Product\add_photo(), IntracommReport\addItemsFact(), BonPrelevement\addline(), Commande\addline(), CommandeFournisseur\addline(), Expedition\addline(), Facture\addline(), FactureFournisseur\addline(), Reception\addline(), SupplierProposal\addline(), Task\addTimeSpent(), ai_log_request(), ActionsCardCommon\assign_values(), build_calfile(), ActionComm\build_exportfile(), CommonInvoice\buildEPCQrCodeString(), Form\buttonsSaveCancel(), Asset\calculationDepreciation(), calendarPrepareHead(), Commande\cancel(), categories_prepare_head(), categoriesadmin_prepare_head(), Product\check(), check_user_password_dolibarr(), check_user_password_ldap(), check_user_password_openid_connect(), DocumentListController\checkAccess(), FicheinterListController\checkAccess(), InvoiceListController\checkAccess(), OrderListController\checkAccess(), PropalListController\checkAccess(), SharedDocumentsController\checkAccess(), TicketListController\checkAccess(), checkGeneralAccountAllowsAuxiliary(), checkUserAccessToObject(), Propal\classifyBilled(), BookKeeping\closeFiscalPeriod(), Propal\closeProposal(), RecruitmentJobPosition\cloture(), SupplierProposal\cloture(), DolLogsCollector\collect(), commande_prepare_head(), completeFileArrayWithDatabaseInfo(), InterfaceTicketEmail\composeAndSendCustomerMessage(), ExpenseReport\computeTotalKm(), conferenceorboothPrepareHead(), MailmanSpip\connectSpip(), Form\constructProductListOption(), ProductCombination\copyAll(), DolEditor\Create(), Delivery\create(), Expedition\create(), Facture\create(), FactureFournisseur\create(), FactureRec\create(), Paiement\create(), PaiementFourn\create(), Product\create(), Propalmergepdfproduct\create(), RejetPrelevement\create(), Ticket\create(), Expedition\create_delivery(), Facture\createDepositFromOrigin(), Facture\createFromClone(), FactureFournisseur\createFromClone(), Propal\createFromClone(), Commande\createFromProposal(), ProductCombination\createProductCombination(), FactureFournisseurRec\createRecurringInvoices(), FactureRec\createRecurringInvoices(), Skill\createSkills(), csvClean(), datapolicyAdminPrepareHead(), CommonObject\defineBuyPrice(), pdf_balance\defineColumnField(), pdf_bookkeeping\defineColumnField(), pdf_cornas\defineColumnField(), pdf_cyan\defineColumnField(), pdf_eratosthene\defineColumnField(), pdf_espadon\defineColumnField(), pdf_ledger\defineColumnField(), pdf_octopus\defineColumnField(), pdf_sponge\defineColumnField(), pdf_standard_asset\defineColumnField(), pdf_standard_myobject\defineColumnField(), pdf_storm\defineColumnField(), pdf_zenith\defineColumnField(), Expedition\delete(), ExpeditionLigne\delete(), Propalmergepdfproduct\delete_by_product(), delivery_prepare_head(), AccountancyCategory\display(), displayRankInfos(), Asset\dispose(), doc_getlinedesc(), PartnershipUtils\doCancelStatusOfMemberPartnership(), dol_add_file_process(), dol_get_first_day_week(), dol_getcache(), dol_move_uploaded_file(), dol_setcache(), dolSessionWrite(), dolWebsiteIncrementCounter(), PartnershipUtils\doWarningOfPartnershipIfDolibarrBacklinkNotfound(), pdf_cyan\drawInfoTable(), pdf_eagle_proforma\drawInfoTable(), pdf_eratosthene\drawInfoTable(), pdf_octopus\drawInfoTable(), pdf_sponge\drawInfoTable(), pdf_cyan\drawTotalTable(), pdf_eratosthene\drawTotalTable(), pdf_octopus\drawTotalTable(), pdf_sponge\drawTotalTable(), CMailFile\dump_mail(), BonPrelevement\EnregDestinataireSEPA(), BonPrelevement\EnregEmetteurSEPA(), HookManager\executeHooks(), expedition_admin_prepare_head(), expedition_prepare_head(), AccountancyExport\exportFEC(), AccountancyExport\exportFEC2(), Website\exportWebSite(), AccountingAccount\fetch(), AdherentType\fetch(), Categorie\fetch(), CommandeFournisseurLigne\fetch(), Facture\fetch(), FactureLigne\fetch(), Product\fetch(), Propalmergepdfproduct\fetch(), Propalmergepdfproduct\fetch_by_product(), Commande\fetch_lines(), Contrat\fetch_lines(), Expedition\fetch_lines(), Facture\fetch_lines(), Propal\fetch_lines(), fieldList(), Form\form_thirdparty(), formatLogObject(), mailing_contacts1\formFilter(), mailing_thirdparties\formFilter(), BonPrelevement\generate(), Thirdparties\generateBankAccountDocument(), Product\generateMultiprices(), BookKeeping\get_compte_desc(), FormMail\get_form(), Categorie\get_full_arbo(), FormCompany\get_input_id_prof(), get_left_menu_accountancy(), get_left_menu_commercial(), get_left_menu_home(), get_left_menu_projects(), get_left_menu_tools(), get_next_value(), FormProduct\get_parent_path(), CommonDocGenerator\get_substitutionarray_lines(), AccountancyCategory\getAccountsWithNoCategory(), FieldsManager\getAllFieldsInfos(), FieldsManager\getAllObjectFieldsInfos(), getAnonymisableFullName(), AccountingJournal\getAssetData(), AccountancyCategory\getAvailableAccountsForCategory(), Account\getBannerAddress(), getBannerAddress(), WebPortalMember\getBannerAddressForWebPortal(), html_generic\getContents(), AccountancyCategory\getCptsCat(), getCurrentPeriodOfFiscalYear(), AccountingJournal\getData(), getDefaultDatesForTransfer(), AccountingJournal\getDiscountCustomer(), AccountingJournal\getDiscountSupplier(), FormFile\getDocumentsLink(), FieldsManager\getFieldsInfos(), mod_syslog_file\getFilename(), CommonObject\getIdContact(), Categorie\getListForItem(), Setup\getListOfContactTypes(), InfoBox\getListOfPagesForBoxes(), mod_member_simple\getNextValue(), Account\getNomUrl(), ActionComm\getNomUrl(), Adherent\getNomUrl(), AdherentType\getNomUrl(), BOM\getNomUrl(), BookkeepingTemplate\getNomUrl(), Calendar\getNomUrl(), Categorie\getNomUrl(), Commande\getNomUrl(), CommandeFournisseur\getNomUrl(), Contact\getNomUrl(), Contrat\getNomUrl(), ContratLigne\getNomUrl(), Cronjob\getNomUrl(), Delivery\getNomUrl(), Dolresource\getNomUrl(), EcmFiles\getNomUrl(), Entrepot\getNomUrl(), Expedition\getNomUrl(), ExpenseReport\getNomUrl(), Facture\getNomUrl(), FactureFournisseur\getNomUrl(), Fichinter\getNomUrl(), Fiscalyear\getNomUrl(), Holiday\getNomUrl(), IntracommReport\getNomUrl(), KnowledgeRecord\getNomUrl(), Mailing\getNomUrl(), Mo\getNomUrl(), MyObject\getNomUrl(), Opensurveysondage\getNomUrl(), Partnership\getNomUrl(), PaymentSalary\getNomUrl(), Product\getNomUrl(), ProductFournisseur\getNomUrl(), Productlot\getNomUrl(), Project\getNomUrl(), Propal\getNomUrl(), Reception\getNomUrl(), RecruitmentCandidature\getNomUrl(), RecruitmentJobPosition\getNomUrl(), Salary\getNomUrl(), Societe\getNomUrl(), SocieteAccount\getNomUrl(), SupplierProposal\getNomUrl(), Task\getNomUrl(), Ticket\getNomUrl(), TimeSpent\getNomUrl(), TriggerHistory\getNomUrl(), User\getNomUrl(), UserGroup\getNomUrl(), WebPortalInvoice\getNomUrl(), WebPortalMember\getNomUrl(), WebPortalOrder\getNomUrl(), WebPortalPartnership\getNomUrl(), WebPortalPropal\getNomUrl(), Workstation\getNomUrl(), getNumberInvoicesPieChart(), CommonSellistField\getOptions(), Stripe\getPaymentIntent(), mod_bookkeeping_argon\getPrefix(), ExternalModules\getProducts(), BookKeeping\getRootAccount(), Form\getSelectConditionsPaiements(), FactureLigne\getSituationRatio(), getSoapParams(), getSourceDocRef(), Reception\getStatusDispatch(), CommonObject\getTooltipContent(), Calendar\getTooltipContentArray(), MyObject\getTooltipContentArray(), RecruitmentCandidature\getTooltipContentArray(), RecruitmentJobPosition\getTooltipContentArray(), TriggerHistory\getTooltipContentArray(), WebPortalMember\getTooltipContentArray(), WebPortalOrder\getTooltipContentArray(), WebPortalPartnership\getTooltipContentArray(), WebPortalPropal\getTooltipContentArray(), getURLContent(), hash_call(), User\hasRight(), CommonObject\indexFile(), doc_generic_proposal_odt\info(), doc_generic_supplier_proposal_odt\info(), doc_generic_user_odt\info(), doc_generic_usergroup_odt\info(), mod_codecompta_aquarium\info(), mod_facture_fournisseur_tulip\info(), DocumentController\init(), modTakePos\init(), ViewImageController\init(), WebPortalTheme\init(), Form\inputHtml(), FormWebPortal\inputHtml(), Form\inputIcon(), FormWebPortal\inputIcon(), invoice_admin_prepare_head(), CommonInvoice\is_erasable(), Product\is_photo_available(), Societe\isACompany(), MailmanSpip\isSpipEnabled(), left_menu(), length_accounta(), length_accountg(), Reception\LibStatut(), AccountingJournal\LibType(), CommonObject\line_order(), FormFile\list_of_autoecmfiles(), FormFile\list_of_documents(), Facture\list_qualified_avoir_invoices(), listPublicHoliday(), llxHeaderTicket(), Translate\load(), CommonObject\load_previous_next_ref(), box_actions\loadBox(), box_actions_future\loadBox(), box_activity\loadBox(), box_graph_invoices_permonth\loadBox(), box_graph_invoices_peryear\loadBox(), box_graph_invoices_supplier_permonth\loadBox(), box_graph_orders_permonth\loadBox(), box_graph_orders_supplier_permonth\loadBox(), box_graph_propales_permonth\loadBox(), box_members_by_tags\loadBox(), box_members_by_type\loadBox(), box_produits\loadBox(), box_produits_alerte_stock\loadBox(), Translate\loadFromDatabase(), FormProduct\loadLotStock(), FormListWebPortal\loadRecords(), ExternalModules\loadRemoteSources(), Product\loadStockForVirtualProduct(), CommonInvoice\makeStripeSepaRequest(), Expedition\manageStockMvtOnEvt(), member_type_prepare_head(), memoPrepareHead(), migrate_invoice_export_models(), migrate_paiements_orphelins_1(), migrate_paiements_orphelins_2(), modules_prepare_head(), myobjectPrepareHead(), Ticket\newMessage(), num_public_holiday(), openid_connect_create_user(), ordered(), EmailCollector\overwritePropertiesOfObject(), pdf_bank(), pdf_build_address(), pdf_getInstance(), pdf_getlinedesc(), pdf_getlineprogress(), pdf_getSizeForImage(), pdf_pagefoot(), pdfBuildThirdpartyName(), pdfWriteAlreadyPaid(), pdfWriteVATArray(), Documents\post(), price2numjs(), pricejs(), print_auguria_menu(), print_eldy_menu(), printDropdownBookmarksList(), CommonObject\printObjectLine(), CommonObject\printOriginLine(), CommonObject\printOriginLinesList(), BooleanField\printOutputField(), PricecyField\printOutputField(), product_admin_prepare_head(), product_prepare_head(), project_prepare_head(), projectLinesPerDay(), projectLinesPerWeek(), propal_prepare_head(), Contracts\putLine(), DoliDBMysqli\query(), DoliDBPgsql\query(), Reception\reOpen(), Asset\reopen(), Cronjob\run_jobs(), Interfaces\run_triggers(), BookKeeping\select_account(), FormAccounting\select_account(), FormAccounting\select_auxaccount(), Form\select_bom(), Form\select_company(), Form\select_contact(), FormContract\select_contract(), Form\select_dolgroups(), Form\select_dolusers(), FormIntervention\select_interventions(), FormAdmin\select_menu(), FormAdmin\select_menu_families(), Form\select_produits(), Form\select_produits_fournisseurs(), Form\select_produits_fournisseurs_list(), Form\select_produits_list(), FormProjets\select_projects(), FormProjets\select_projects_list(), FormCompany\select_state(), FormResource\select_state(), Form\select_thirdparty_list(), Form\selectcontacts(), Form\selectDate(), Form\selectForFormsList(), CMailFile\sendfile(), SMTPs\sendMsg(), dolReceiptPrinter\sendToPrinter(), BonPrelevement\set_infocredit(), Societe\setAsCustomer(), Reception\setClosed(), AssetDepreciationOptions\setDeprecationOptionsFromPost(), Commande\setDraft(), Reception\setDraft(), Societe\setMysoc(), FactureRec\setNextDate(), Users\setPassword(), Conf\setValues(), shipping_prepare_head(), show_actions_done(), CommonObject\show_photos(), show_skin(), box_actions\showBox(), box_actions_future\showBox(), ModeleBoxes\showBox(), showDirectPublicLink(), FormFile\showdocuments(), CommonObject\showInputField(), ExtraFields\showInputField(), Form\showLinkedObjectBlock(), FormTicket\showMessageForm(), CommonObject\showOptionals(), ExtraFields\showOutputField(), Form\showrefnav(), showSkins(), showWebsiteTemplates(), societe_prepare_head(), Adherent\subscriptionComplementaryActions(), takepos_admin_prepare_head(), ticket_prepare_head(), top_htmlhead(), top_menu(), triggerhistoryPrepareHead(), ModeleImports\triggerImportSqlOperation(), AdherentType\update(), Categorie\update(), Product\update(), Propalmergepdfproduct\update(), Facture\update_percent(), AccountancyCategory\updateAccAcc(), Lettering\updateGeneralMatching(), Lettering\updateLettering(), Commande\updateline(), Facture\updateline(), ProductCombination\updateProperties(), Holiday\updateSoldeCP(), Commande\valid(), Reception\valid(), Facture\validate(), Inventory\validate(), Account\verif(), FieldsManager\verifyFieldValue(), FieldsManager\verifyPostFieldValue(), BordereauChequeBlochet\write_file(), html_cerfafr\write_file(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_balance\write_file(), pdf_baleine\write_file(), pdf_ban\write_file(), pdf_beluga\write_file(), pdf_bookkeeping\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_ledger\write_file(), pdf_merou\write_file(), pdf_muscadet\write_file(), pdf_octopus\write_file(), pdf_rouget\write_file(), pdf_sepamandate\write_file(), pdf_soleil\write_file(), pdf_sponge\write_file(), pdf_squille\write_file(), pdf_standard\write_file(), pdf_standard_actions\write_file(), pdf_standard_asset\write_file(), pdf_standard_evaluation\write_file(), pdf_standard_expensereport\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_standard_stock\write_file(), pdf_standard_supplierpayment\write_file(), pdf_storm\write_file(), pdf_strato\write_file(), pdf_timespent\write_file(), pdf_typhon\write_file(), pdf_vinci\write_file(), and pdf_zenith\write_file().

◆ getDolGlobalLoginBadCharUnauthorized()

getDolGlobalLoginBadCharUnauthorized ( )

Return the list of unauthorized characters in user logins.

Returns
string

Definition at line 297 of file functions.lib.php.

References getDolGlobalString().

Referenced by User\create(), openid_connect_create_user(), and User\update().

◆ getDolGlobalString()

getDolGlobalString ( $key,
$default = '' )

Return a Dolibarr global constant string value.

Parameters
string$keyKey to return value, return $default if not set
string | int | float$defaultValue to return if not defined
Returns
string Value returned
See also
getDolUserString()

Definition at line 286 of file functions.lib.php.

References $conf.

Referenced by AccountancyExport\__construct(), ActionCommReminder\__construct(), Ai\__construct(), Asset\__construct(), AssetModel\__construct(), Availabilities\__construct(), BOM\__construct(), BOMLine\__construct(), box_clients\__construct(), box_comptes\__construct(), box_customers_outstanding_bill_reached\__construct(), box_goodcustomers\__construct(), box_members_by_tags\__construct(), box_members_by_type\__construct(), box_members_last_modified\__construct(), box_members_last_subscriptions\__construct(), box_members_subscriptions_by_year\__construct(), box_produits\__construct(), box_produits_alerte_stock\__construct(), box_prospect\__construct(), box_task\__construct(), CMailFile\__construct(), CompanyPaymentMode\__construct(), ConferenceOrBooth\__construct(), ConferenceOrBoothAttendee\__construct(), Contact\__construct(), Context\__construct(), CSMSFile\__construct(), CTicketCategory\__construct(), DefaultValues\__construct(), DolEditor\__construct(), DolGeoIP\__construct(), DolGraph\__construct(), DolibarrApi\__construct(), EmailCollectorAction\__construct(), EmailCollectorFilter\__construct(), EmailSenderProfile\__construct(), Entrepot\__construct(), Evaluation\__construct(), EvaluationLine\__construct(), ExportCsvIso\__construct(), ExportCsvUtf8\__construct(), ExternalModules\__construct(), FactureStats\__construct(), Hook\__construct(), ImportCsv\__construct(), Inventory\__construct(), Job\__construct(), KnowledgeRecord\__construct(), Ldap\__construct(), Mo\__construct(), mod_codecompta_aquarium\__construct(), mod_codecompta_digitaria\__construct(), mod_commande_marbre\__construct(), mod_facture_mars\__construct(), mod_facture_terre\__construct(), modAdherent\__construct(), modAgenda\__construct(), modBlockedLog\__construct(), modCategorie\__construct(), modCommande\__construct(), modExpedition\__construct(), modFacture\__construct(), modGeneratePassPerso\__construct(), modPartnership\__construct(), modPaymentByBankTransfer\__construct(), modProduct\__construct(), modProductBatch\__construct(), modProjet\__construct(), modPropale\__construct(), modReception\__construct(), modService\__construct(), modSociete\__construct(), modSupplierInvoice\__construct(), modSupplierOrder\__construct(), modSupplierProposal\__construct(), modTicket\__construct(), MoLine\__construct(), MultiCurrency\__construct(), Partnership\__construct(), PartnershipType\__construct(), pdf_azur\__construct(), pdf_eagle\__construct(), pdf_einstein\__construct(), pdf_muscadet\__construct(), pdf_octopus\__construct(), pdf_rouget\__construct(), pdf_squille\__construct(), pdf_standard_movementstock\__construct(), pdf_standard_stock\__construct(), printing_printgcp\__construct(), printing_printipp\__construct(), ProductAttribute\__construct(), ProductAttributeValue\__construct(), ProductFournisseurPrice\__construct(), Project\__construct(), RecruitmentCandidature\__construct(), RecruitmentJobPosition\__construct(), Skill\__construct(), Skilldet\__construct(), SkillRank\__construct(), Societe\__construct(), SocieteAccount\__construct(), StockTransfer\__construct(), StockTransferLine\__construct(), Target\__construct(), Thirdparties\__construct(), Ticket\__construct(), TimeSpent\__construct(), WebPortalTicket\__construct(), Workstation\__construct(), DolibarrApiAccess\__isAllowed(), MouvementStock\_create(), Thirdparties\_fetch(), Adherent\_load_ldap_dn(), AdherentType\_load_ldap_dn(), Contact\_load_ldap_dn(), User\_load_ldap_dn(), UserGroup\_load_ldap_dn(), Adherent\_load_ldap_info(), AdherentType\_load_ldap_info(), Contact\_load_ldap_info(), User\_load_ldap_info(), UserGroup\_load_ldap_info(), DolibarrModules\_load_tables(), Setup\_moduleOnOff(), BordereauChequeBlochet\_pagefoot(), pdf_ban\_pagefoot(), pdf_standard_recruitmentjobposition\_pagefoot(), pdf_aurore\_pagehead(), pdf_azur\_pagehead(), pdf_canelle\_pagehead(), pdf_cornas\_pagehead(), pdf_cyan\_pagehead(), pdf_eagle_proforma\_pagehead(), pdf_einstein\_pagehead(), pdf_eratosthene\_pagehead(), pdf_espadon\_pagehead(), pdf_merou\_pagehead(), pdf_muscadet\_pagehead(), pdf_octopus\_pagehead(), pdf_paiement\_pagehead(), pdf_rouget\_pagehead(), pdf_soleil\_pagehead(), pdf_sponge\_pagehead(), pdf_squille\_pagehead(), pdf_standard\_pagehead(), pdf_standard_asset\_pagehead(), pdf_standard_evaluation\_pagehead(), pdf_standard_expensereport\_pagehead(), pdf_standard_movementstock\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_standard_recruitmentjobposition\_pagehead(), pdf_standard_stock\_pagehead(), pdf_standard_supplierpayment\_pagehead(), pdf_storm\_pagehead(), pdf_strato\_pagehead(), pdf_typhon\_pagehead(), pdf_vinci\_pagehead(), pdf_zenith\_pagehead(), pdf_standard_actions\_pages(), SMTPs\_server_authenticate(), pdf_azur\_signature_area(), pdf_aurore\_tableau(), pdf_azur\_tableau(), pdf_balance\_tableau(), pdf_bookkeeping\_tableau(), pdf_canelle\_tableau(), pdf_cornas\_tableau(), pdf_cyan\_tableau(), pdf_eagle\_tableau(), pdf_eagle_proforma\_tableau(), pdf_einstein\_tableau(), pdf_eratosthene\_tableau(), pdf_espadon\_tableau(), pdf_ledger\_tableau(), pdf_merou\_tableau(), pdf_muscadet\_tableau(), pdf_octopus\_tableau(), pdf_rouget\_tableau(), pdf_sponge\_tableau(), pdf_squille\_tableau(), pdf_standard\_tableau(), pdf_standard_asset\_tableau(), pdf_standard_evaluation\_tableau(), pdf_standard_expensereport\_tableau(), pdf_standard_movementstock\_tableau(), pdf_standard_myobject\_tableau(), pdf_standard_recruitmentjobposition\_tableau(), pdf_standard_stock\_tableau(), pdf_storm\_tableau(), pdf_vinci\_tableau(), pdf_zenith\_tableau(), pdf_aurore\_tableau_info(), pdf_azur\_tableau_info(), pdf_einstein\_tableau_info(), pdf_sepamandate\_tableau_info(), pdf_aurore\_tableau_tot(), pdf_azur\_tableau_tot(), pdf_canelle\_tableau_tot(), pdf_cornas\_tableau_tot(), pdf_eagle\_tableau_tot(), pdf_einstein\_tableau_tot(), pdf_espadon\_tableau_tot(), pdf_muscadet\_tableau_tot(), pdf_rouget\_tableau_tot(), pdf_squille\_tableau_tot(), pdf_vinci\_tableau_tot(), pdf_zenith\_tableau_tot(), pdf_canelle\_tableau_versements(), BookKeeping\accountingResult(), MemberCardController\action(), PartnershipCardController\action(), actions_prepare_head(), pdf_standard_member\Add_PDF_card(), Commande\add_product(), Propal\add_product(), SupplierProposal\add_product(), Adherent\add_to_abo(), MailmanSpip\add_to_mailman(), Categorie\add_type(), addEventTypeSQL(), addFileIntoDatabaseIndex(), Commande\addline(), CommandeFournisseur\addline(), Delivery\addline(), Expedition\addline(), Facture\addline(), Propal\addline(), Expedition\addline_batch(), ActionsStripeconnect\addMoreActionsButtons(), MailingTargets\addTargetsToDatabase(), Task\addTimeSpent(), ModelePdfAccountancy\addTitleLine(), pdf_balance\addTotalLine(), pdf_bookkeeping\addTotalLine(), pdf_ledger\addTotalLine(), aiAdminPrepareHead(), ajax_autocompleter(), ajax_combobox(), ajax_constantonoff(), api_admin_prepare_head(), ExpenseReport\applyOffset(), CommandeFournisseur\approve(), Holiday\approve(), assetModelPrepareHead(), assetPrepareHead(), ActionsCardCommon\assign_values(), ActionsCardCompany\assign_values(), ActionsContactCardCommon\assign_values(), BookKeeping\assignAccountMass(), Ticket\assignUser(), availabilitiesPrepareHead(), bank_prepare_head(), blockedlogadmin_prepare_head(), pdf_paiement\Body(), bomPrepareHead(), build_calfile(), ActionComm\build_exportfile(), build_rssfile(), Documents\builddoc(), CommonInvoice\buildSwitzerlandQRString(), CommandeFournisseur\calcAndSetStatusDispatch(), calcul_price_total(), calendars_prepare_head(), ExternalModules\callApi(), callApiToGetObfuscationKey(), MailmanSpip\callMailman(), callSetExpressCheckout(), canApplySubtotalOn(), Account\canBeConciliated(), BookKeeping\canModifyBookkeeping(), Stripe\cardStripe(), check_authentication(), Societe\check_codeclient(), Societe\check_codefournisseur(), CMailFile\check_server_port(), check_user_password_dolibarr(), check_user_password_ldap(), check_user_password_openid_connect(), MemberCardController\checkAccess(), PartnershipCardController\checkAccess(), mod_syslog_syslog\checkConfiguration(), PartnershipUtils\checkDolibarrBacklink(), mod_codecompta_digitaria\checkIfAccountancyCodeIsAlreadyUsed(), checkPHPCode(), Productlot\checkSellOrEatByMandatory(), Productlot\checkSellOrEatByMandatoryFromProductAndDates(), Productlot\checkSellOrEatByMandatoryFromProductIdAndDates(), MailmanSpip\checkSpipConfig(), checkUserAccessToObject(), chequereceipt_pdf_create(), Propal\classifyBilled(), ProductCombinationLevel\clean(), Ticket\close(), BookKeeping\closeFiscalPeriod(), Propal\closeProposal(), Commande\cloture(), RecruitmentJobPosition\cloture(), SupplierProposal\cloture(), Societe\codeclient_modifiable(), Societe\codefournisseur_modifiable(), commande_prepare_head(), CommonObject\commonGenerateDocument(), ModeleImports\commonImportInsert(), InterfaceTicketEmail\composeAndSendAdminMessage(), InterfaceTicketEmail\composeAndSendAssigneeMessage(), InterfaceTicketEmail\composeAndSendCustomerMessage(), Utils\compressSyslogs(), conferenceorboothPrepareHead(), Notify\confirmMessage(), Ldap\connectBind(), MailmanSpip\connectSpip(), Form\constructProductListOption(), contact_prepare_head(), contract_prepare_head(), DoliDBPgsql\convertSQLFromMysql(), Account\countAccountToReconcile(), DolEditor\Create(), BlockedLog\create(), BookKeeping\create(), Categorie\create(), Commande\create(), CommandeFournisseur\create(), CompanyBankAccount\create(), Delivery\create(), EcmFiles\create(), Expedition\create(), Facture\create(), FactureFournisseur\create(), Mo\create(), Paiement\create(), PaiementFourn\create(), Product\create(), ProductCombination\create(), Project\create(), Propal\create(), RemiseCheque\create(), Societe\create(), Ticket\create(), User\create(), DolibarrModules\create_dirs(), Societe\create_from_member(), Delivery\create_from_sending(), Societe\create_individual(), CommonObject\createCommon(), Facture\createDepositFromOrigin(), Commande\createFromClone(), Facture\createFromClone(), Project\createFromClone(), Propal\createFromClone(), SupplierProposal\createFromClone(), Task\createFromClone(), Website\createFromClone(), Facture\createFromContract(), Facture\createFromCurrent(), Facture\createFromOrder(), Commande\createFromProposal(), ProductCombination\createProductCombination(), FactureRec\createRecurringInvoices(), Skill\createSkills(), BookKeeping\createStd(), Ticket\createTicketMessage(), Project\createWeeklyReport(), csvClean(), Stripe\customerStripe(), CommonObject\defineBuyPrice(), pdf_cornas\defineColumnField(), pdf_cyan\defineColumnField(), pdf_eratosthene\defineColumnField(), pdf_espadon\defineColumnField(), pdf_octopus\defineColumnField(), pdf_sponge\defineColumnField(), pdf_standard_asset\defineColumnField(), pdf_storm\defineColumnField(), pdf_zenith\defineColumnField(), Adherent\del_to_abo(), MailmanSpip\del_to_mailman(), BookKeeping\delete(), Expedition\delete(), Facture\delete(), Societe\delete(), CommonObject\deleteExtraFields(), delivery_prepare_head(), Task\delTimeSpent(), CommonInvoice\demande_prelevement(), CommandeFournisseur\dispatchProduct(), SharedDocumentsController\display(), FormMargin\displayMarginInfos(), Facture\displayRetainedWarranty(), pdf_octopus\displayRetainedWarranty(), Asset\dispose(), doc_getlinedesc(), doc_label_pdf_create(), PartnershipUtils\doCancelStatusOfMemberPartnership(), dol_add_file_process(), dol_auguria_showmenu(), dol_buildlogin(), dol_copy(), dol_ftp_close(), dol_ftp_connect(), dol_ftp_delete(), dol_ftp_get(), dol_ftp_mkdir(), dol_ftp_put(), dol_ftp_rmdir(), dol_getcache(), dol_hash(), dol_meta_create(), dol_move(), dol_move_uploaded_file(), dol_print_cron_urls(), dol_setcache(), dol_time_plus_duree(), dol_uncompress(), dol_verifyHash(), dolCheckOnFileName(), dolCheckVirus(), dolConvertToWordFrench(), dolCopyDir(), dolDispatchToDo(), dolDocToText(), dolReplaceInFile(), dolSaveIndexPage(), dolSavePageAlias(), dolSavePageContent(), dolWebsiteOutput(), PartnershipUtils\doWarningOfPartnershipIfDolibarrBacklinkNotfound(), pdf_cyan\drawInfoTable(), pdf_eagle_proforma\drawInfoTable(), pdf_eratosthene\drawInfoTable(), pdf_octopus\drawInfoTable(), pdf_sponge\drawInfoTable(), pdf_octopus\drawPaymentsTable(), pdf_sponge\drawPaymentsTable(), pdf_cyan\drawSignatureArea(), pdf_cyan\drawTotalTable(), pdf_eagle_proforma\drawTotalTable(), pdf_eratosthene\drawTotalTable(), pdf_octopus\drawTotalTable(), pdf_sponge\drawTotalTable(), Utils\dumpDatabase(), ecm_prepare_dasboard_head(), Form\editfieldkey(), Form\editfieldval(), email_admin_prepare_head(), emailing_prepare_head(), BonPrelevement\EnregDestinataireSEPA(), BonPrelevement\EnregEmetteurSEPA(), evaluationPrepareHead(), Utils\executeCLI(), expedition_admin_prepare_head(), expensereport_admin_prepare_head(), expensereport_prepare_head(), mod_syslog_file\export(), mod_syslog_syslog\export(), AccountancyExport\exportConfigurable(), AccountingJournal\exportCsv(), AccountancyExport\exportQuadratus(), Website\exportWebSite(), facture_prepare_head(), facturefourn_prepare_head(), ConferenceOrBooth\fetch(), EcmFiles\fetch(), Expedition\fetch(), Mailing\fetch(), Product\fetch(), ProductCombination\fetch(), Societe\fetch(), User\fetch(), CommandeFournisseur\fetch_lines(), ExpenseReport\fetch_lines(), ExtraLanguages\fetch_name_extralanguages(), Product\fetch_prod_arbo(), CommonObject\fetch_thirdparty(), EcmFiles\fetchAll(), User\fetchAll(), ProductCombination\fetchAllByFkProductParent(), CommonObject\fetchBarCode(), ProductCombination\fetchByFkProductChild(), ProductCombination\fetchCombinationPriceLevels(), Holiday\fetchUsers(), fichinter_create(), fichinter_prepare_head(), fieldListWebsites(), Productbatch\findAll(), User\findUserIdByEmail(), FormFile\form_attach_new_file(), Form\form_contacts(), Form\form_multicurrency_rate(), Form\form_remise_dispo(), mailing_thirdparties\formFilter(), mailing_thirdparties_services_expired\formFilter(), ActionsStripeconnect\formObjectOptions(), FormCompany\formThirdpartyType(), BonPrelevement\generate(), Ai\generateContent(), Utils\generateDoc(), Adherent\generateDocument(), Availabilities\generateDocument(), BOM\generateDocument(), Commande\generateDocument(), CommandeFournisseur\generateDocument(), ConferenceOrBooth\generateDocument(), ConferenceOrBoothAttendee\generateDocument(), Contrat\generateDocument(), Delivery\generateDocument(), Entrepot\generateDocument(), Evaluation\generateDocument(), Expedition\generateDocument(), ExpenseReport\generateDocument(), Facture\generateDocument(), FactureFournisseur\generateDocument(), Fichinter\generateDocument(), Job\generateDocument(), KnowledgeRecord\generateDocument(), Mo\generateDocument(), MouvementStock\generateDocument(), MyObject\generateDocument(), PaiementFourn\generateDocument(), Partnership\generateDocument(), Position\generateDocument(), Product\generateDocument(), ProductFournisseurPrice\generateDocument(), Productlot\generateDocument(), Project\generateDocument(), Propal\generateDocument(), Reception\generateDocument(), RecruitmentCandidature\generateDocument(), RecruitmentJobPosition\generateDocument(), Skill\generateDocument(), Skilldet\generateDocument(), SkillRank\generateDocument(), Societe\generateDocument(), StockTransfer\generateDocument(), StockTransferLine\generateDocument(), SupplierProposal\generateDocument(), Target\generateDocument(), Task\generateDocument(), Ticket\generateDocument(), TimeSpent\generateDocument(), User\generateDocument(), UserGroup\generateDocument(), Workstation\generateDocument(), FormSetupItem\generateInputFieldPassword(), Translate\get_available_languages(), Product\get_barcode(), Product\get_buyprice(), mod_codecompta_aquarium\get_code(), mod_codecompta_digitaria\get_code(), Societe\get_codecompta(), FormMail\get_form(), FormCompany\get_input_id_prof(), get_left_menu_accountancy(), get_left_menu_bank(), get_left_menu_billing(), get_left_menu_commercial(), get_left_menu_home(), get_left_menu_hrm(), get_left_menu_members(), get_left_menu_products(), get_left_menu_projects(), get_left_menu_thridparties(), get_next_value(), AccountingAccount\getAccountingCodeToBind(), getAiAssistantProviderLabel(), getAiChatAssistantConfig(), McpHandler\getAllowedToolsList(), CMailFile\getArrayAddress(), AccountingJournal\getAssetData(), getBannerAddress(), WebPortalMember\getBannerAddressForWebPortal(), SMTPs\getBodyContent(), CommonObject\getCanvas(), Setup\getCheckIntegrity(), AntiVir\getCliCommand(), Setup\getCompany(), Setup\getConf(), Setup\getConfs(), EmailCollector\getConnectStringIMAP(), html_generic\getContents(), BookKeeping\getCountByMonthForFiscalPeriod(), DolGeoIP\getCountryCodeFromIP(), DolGeoIP\getCountryCodeFromName(), getCustomerInvoiceDraftTable(), getCustomerInvoiceUnpaidOpenTable(), Products\getCustomerPricesPerCustomer(), Products\getCustomerPricesPerQuantity(), Products\getCustomerPricesPerSegment(), CommonObject\getDefaultCreateValueFor(), Ticket\getDefaultRef(), AccountingJournal\getDiscountCustomer(), AccountingJournal\getDiscountSupplier(), FormFile\getDocumentsLink(), FormWebPortal\getDocumentsLink(), getDolGlobalLoginBadCharUnauthorized(), DolibarrCollector\getDolibarrInfo(), getDraftSupplierTable(), mod_codeclient_elephant\getExample(), mod_syslog_file\getFilename(), ModelePDFFactures\getHeightForQRInvoice(), MultiCurrency\getIdAndTxFromCode(), ModeleImports\getImportTriggerMode(), DolibarrModules\getKanbanView(), Setup\getListOfExtrafields(), getListOfGroups(), getListOfModels(), getListOfPossibleImageExt(), ExtraFields\getListOfTypesLabels(), DolibarrCollector\getMailInfo(), getMaxFileSizeArray(), Setup\getModules(), Setup\getModulesList(), mailing_thirdparties_services_expired\getNbOfRecipients(), Ldap\getNextGroupGid(), ConferenceOrBoothAttendee\getNextNumRef(), ExpenseReport\getNextNumRef(), Facture\getNextNumRef(), FactureFournisseur\getNextNumRef(), Fichinter\getNextNumRef(), KnowledgeRecord\getNextNumRef(), Mo\getNextNumRef(), MyObject\getNextNumRef(), Paiement\getNextNumRef(), PaiementFourn\getNextNumRef(), Partnership\getNextNumRef(), Position\getNextNumRef(), ProductFournisseurPrice\getNextNumRef(), RecruitmentJobPosition\getNextNumRef(), RemiseCheque\getNextNumRef(), Skill\getNextNumRef(), Skilldet\getNextNumRef(), StockTransfer\getNextNumRef(), StockTransferLine\getNextNumRef(), Target\getNextNumRef(), TimeSpent\getNextNumRef(), Workstation\getNextNumRef(), mod_arctic\getNextValue(), mod_asset_advanced\getNextValue(), mod_barcode_product_standard\getNextValue(), mod_barcode_thirdparty_standard\getNextValue(), mod_bom_advanced\getNextValue(), mod_bookkeeping_helium\getNextValue(), mod_chequereceipt_thyme\getNextValue(), mod_codeclient_elephant\getNextValue(), mod_codeproduct_elephant\getNextValue(), mod_commande_fournisseur_orchidee\getNextValue(), mod_commande_saphir\getNextValue(), mod_contract_magre\getNextValue(), mod_delivery_saphir\getNextValue(), mod_evaluation_advanced\getNextValue(), mod_expedition_ribera\getNextValue(), mod_expensereport_jade\getNextValue(), mod_expensereport_sand\getNextValue(), mod_facture_fournisseur_tulip\getNextValue(), mod_facture_mercure\getNextValue(), mod_holiday_immaculate\getNextValue(), mod_knowledgerecord_advanced\getNextValue(), mod_lot_advanced\getNextValue(), mod_member_custom\getNextValue(), mod_mo_advanced\getNextValue(), mod_myobject_advanced\getNextValue(), mod_partnership_advanced\getNextValue(), mod_payment_ant\getNextValue(), mod_project_universal\getNextValue(), mod_propale_saphir\getNextValue(), mod_reception_moonstone\getNextValue(), mod_recruitmentcandidature_advanced\getNextValue(), mod_recruitmentjobposition_advanced\getNextValue(), mod_sn_advanced\getNextValue(), mod_stocktransfer_advanced\getNextValue(), mod_supplier_payment_brodator\getNextValue(), mod_supplier_proposal_saphir\getNextValue(), mod_takepos_ref_universal\getNextValue(), mod_task_universal\getNextValue(), mod_ticket_universal\getNextValue(), mod_workstation_advanced\getNextValue(), AccountingAccount\getNomUrl(), AccountingJournal\getNomUrl(), ActionComm\getNomUrl(), Adherent\getNomUrl(), Asset\getNomUrl(), AssetModel\getNomUrl(), Availabilities\getNomUrl(), BOM\getNomUrl(), BOMLine\getNomUrl(), BonPrelevement\getNomUrl(), BookKeeping\getNomUrl(), Bookmark\getNomUrl(), CashControl\getNomUrl(), ChargeSociales\getNomUrl(), Commande\getNomUrl(), CommandeFournisseur\getNomUrl(), CompanyPaymentMode\getNomUrl(), ConferenceOrBooth\getNomUrl(), ConferenceOrBoothAttendee\getNomUrl(), Contact\getNomUrl(), Contrat\getNomUrl(), Cronjob\getNomUrl(), CTicketCategory\getNomUrl(), Dolresource\getNomUrl(), EcmFiles\getNomUrl(), EmailCollector\getNomUrl(), EmailCollectorAction\getNomUrl(), EmailCollectorFilter\getNomUrl(), Entrepot\getNomUrl(), Establishment\getNomUrl(), Evaluation\getNomUrl(), EvaluationLine\getNomUrl(), Expedition\getNomUrl(), ExpenseReport\getNomUrl(), Facture\getNomUrl(), FactureFournisseur\getNomUrl(), Fichinter\getNomUrl(), Fiscalyear\getNomUrl(), Hook\getNomUrl(), IntracommReport\getNomUrl(), Inventory\getNomUrl(), Job\getNomUrl(), KnowledgeRecord\getNomUrl(), Loan\getNomUrl(), Mailing\getNomUrl(), Mo\getNomUrl(), MyObject\getNomUrl(), Opensurveysondage\getNomUrl(), Paiement\getNomUrl(), PaiementFourn\getNomUrl(), Partnership\getNomUrl(), PartnershipType\getNomUrl(), PaymentVarious\getNomUrl(), Position\getNomUrl(), Product\getNomUrl(), ProductAttribute\getNomUrl(), ProductFournisseur\getNomUrl(), ProductFournisseurPrice\getNomUrl(), Productlot\getNomUrl(), Project\getNomUrl(), Propal\getNomUrl(), RecruitmentCandidature\getNomUrl(), RecruitmentJobPosition\getNomUrl(), RemiseCheque\getNomUrl(), Salary\getNomUrl(), Skill\getNomUrl(), Skilldet\getNomUrl(), SkillRank\getNomUrl(), Societe\getNomUrl(), SocieteAccount\getNomUrl(), StockTransfer\getNomUrl(), StockTransferLine\getNomUrl(), SupplierProposal\getNomUrl(), Target\getNomUrl(), Task\getNomUrl(), Ticket\getNomUrl(), TimeSpent\getNomUrl(), TriggerHistory\getNomUrl(), Tva\getNomUrl(), User\getNomUrl(), UserGroup\getNomUrl(), WebPortalMember\getNomUrl(), WebPortalPartnership\getNomUrl(), Workstation\getNomUrl(), SimpleOpenID\GetOpenIDServer(), BlockedLog\getOrInitFirstSignature(), Stripe\getPaymentIntent(), getProductOrService(), getProductsForCategory(), getPurchaseInvoiceUnpaidOpenTable(), getRandomPassword(), Facture\getRetainedWarrantyAmount(), Context\getRootConfigUrl(), Societe\getSalesRepresentatives(), FormAI\getSectionForAIEnhancement(), Product\getSellPrice(), Stripe\getSetupIntent(), Commande\getShippableInfos(), getSoapParams(), ModelePDFFactures\getSwissQrBill(), getTaskProgressBadge(), getTaskProgressView(), ActionsAdherentCardDefault\getTitle(), ActionsContactCardDefault\getTitle(), ModeleNumRefBarCode\getToolTip(), ModeleNumRefMembers\getToolTip(), ModeleProductCode\getToolTip(), ModeleThirdPartyCode\getToolTip(), ActionComm\getTooltipContentArray(), Adherent\getTooltipContentArray(), BOM\getTooltipContentArray(), Commande\getTooltipContentArray(), Contact\getTooltipContentArray(), Contrat\getTooltipContentArray(), EcmFiles\getTooltipContentArray(), Entrepot\getTooltipContentArray(), PaymentSalary\getTooltipContentArray(), Product\getTooltipContentArray(), Productlot\getTooltipContentArray(), Propal\getTooltipContentArray(), Societe\getTooltipContentArray(), SupplierProposal\getTooltipContentArray(), TimeSpent\getTooltipContentArray(), User\getTooltipContentArray(), UserGroup\getTooltipContentArray(), AccountancyExport\getTypeConfig(), ActionComm\getTypeLabel(), ActionComm\getTypePicto(), Societe\getTypeUrl(), getURLContent(), CMailFile\getValidAddress(), DolGeoIP\getVersion(), getWeatherStatus(), IntracommReport\getXML(), group_prepare_head(), hash_call(), htmlPrintOnlineFooter(), htmlPrintOnlineHeader(), Societe\id_prof_url(), ImportCsv\import_read_record(), includeContainer(), Login\index(), Status\index(), doc_generic_asset_odt\info(), doc_generic_bom_odt\info(), doc_generic_contract_odt\info(), doc_generic_invoice_odt\info(), doc_generic_member_odt\info(), doc_generic_mo_odt\info(), doc_generic_myobject_odt\info(), doc_generic_odt\info(), doc_generic_order_odt\info(), doc_generic_product_odt\info(), doc_generic_project_odt\info(), doc_generic_proposal_odt\info(), doc_generic_reception_odt\info(), doc_generic_recruitmentjobposition_odt\info(), doc_generic_shipment_odt\info(), doc_generic_stock_odt\info(), doc_generic_supplier_invoice_odt\info(), doc_generic_supplier_order_odt\info(), doc_generic_supplier_proposal_odt\info(), doc_generic_task_odt\info(), doc_generic_ticket_odt\info(), doc_generic_user_odt\info(), doc_generic_usergroup_odt\info(), mod_arctic\info(), mod_asset_advanced\info(), mod_barcode_product_standard\info(), mod_barcode_thirdparty_standard\info(), mod_bom_advanced\info(), mod_bookkeeping_helium\info(), mod_chequereceipt_thyme\info(), mod_codeclient_elephant\info(), mod_codecompta_aquarium\info(), mod_codecompta_digitaria\info(), mod_codeproduct_elephant\info(), mod_commande_fournisseur_orchidee\info(), mod_commande_saphir\info(), mod_contract_magre\info(), mod_delivery_saphir\info(), mod_evaluation_advanced\info(), mod_expedition_ribera\info(), mod_expensereport_sand\info(), mod_facture_fournisseur_tulip\info(), mod_facture_mercure\info(), mod_holiday_immaculate\info(), mod_knowledgerecord_advanced\info(), mod_lot_advanced\info(), mod_member_custom\info(), mod_mo_advanced\info(), mod_myobject_advanced\info(), mod_partnership_advanced\info(), mod_payment_ant\info(), mod_project_universal\info(), mod_propale_saphir\info(), mod_reception_moonstone\info(), mod_recruitmentcandidature_advanced\info(), mod_recruitmentjobposition_advanced\info(), mod_sn_advanced\info(), mod_stocktransfer_advanced\info(), mod_supplier_payment_brodator\info(), mod_supplier_proposal_saphir\info(), mod_takepos_ref_universal\info(), mod_task_universal\info(), mod_ticket_universal\info(), mod_workstation_advanced\info(), Users\infoGroups(), DocumentController\init(), modBlockedLog\init(), modProductBatch\init(), modTakePos\init(), WebPortalTheme\init(), dolReceiptPrinter\initPrinter(), Form\inputGeoPoint(), FormWebPortal\inputGeoPoint(), ExpeditionLigne\insert(), Facture\insert_discount(), FactureFournisseur\insert_discount(), CommonObject\insertExtraFields(), CommonObject\insertExtraLanguages(), invoice_rec_prepare_head(), CommonInvoice\is_erasable(), Societe\isACompany(), mod_syslog_file\isActive(), mod_syslog_syslog\isActive(), CommonInvoice\isEditable(), isIPAllowed(), isRegistrationDataSaved(), isRegistrationDataSavedAndPushed(), CommonInvoice\isReplacable(), Product\isStockManaged(), isValidProfIds(), jobPrepareHead(), knowledgerecordPrepareHead(), ldap_prepare_head(), left_menu(), length_accounta(), length_accountg(), CommandeFournisseur\LibStatut(), Contrat\LibStatut(), FormFile\list_of_documents(), Facture\list_qualified_avoir_invoices(), printing_printgcp\listAvailablePrinters(), printing_printipp\listAvailablePrinters(), CActionComm\liste_array(), Users\listGroups(), listOfSessions(), TicketListController\listPrintValueBefore(), CommandeFournisseur\Livraison(), llxHeaderSubscriptionOk(), llxHeaderTicket(), llxHeaderVierge(), Translate\load(), Product\load_stats_commande(), Product\load_stats_commande_fournisseur(), Product\load_stats_contrat(), Product\load_stats_facture(), Product\load_stats_facturerec(), Product\load_stats_inproduction(), Product\load_stats_propale(), Product\load_stats_reception(), Product\load_stats_sending(), Product\load_stock(), Form\load_tva(), Product\load_virtual_stock(), box_accountancy_suspense_account\loadBox(), box_activity\loadBox(), box_boms\loadBox(), box_commandes\loadBox(), box_contacts\loadBox(), box_contracts\loadBox(), box_dolibarr_state_board\loadBox(), box_external_rss\loadBox(), box_factures\loadBox(), box_factures_fourn\loadBox(), box_factures_imp\loadBox(), box_funnel_of_prospection\loadBox(), box_graph_invoices_permonth\loadBox(), box_graph_invoices_peryear\loadBox(), box_graph_invoices_supplier_permonth\loadBox(), box_graph_orders_permonth\loadBox(), box_graph_orders_supplier_permonth\loadBox(), box_graph_propales_permonth\loadBox(), box_mos\loadBox(), box_produits\loadBox(), box_propales\loadBox(), box_shipments\loadBox(), box_supplier_orders\loadBox(), box_supplier_orders_awaiting_reception\loadBox(), User\loadDefaultValues(), Translate\loadFromDatabase(), WebPortalTheme\loadPrimaryColor(), ActionComm\loadReminders(), ExternalModules\loadRemoteSources(), User\loadRights(), User\loadStateBoard(), BlockedLog\loadTrackedEvents(), loan_prepare_head(), main_area(), CommonInvoice\makeStripeSepaRequest(), Adherent\makeSubstitution(), member_prepare_head(), member_type_prepare_head(), members_card_pdf_create(), Societe\mergeCompany(), migrate_accountingbookkeeping(), migrate_blockedlog_add_hmac_key(), migrate_invoice_export_models(), migrate_reload_menu(), Product\min_recommended_price(), modules_prepare_head(), FormAdvTargetEmailing\multiselectselectSalesRepresentatives(), Entrepot\nb_products(), BonPrelevement\NbFactureAPrelever(), BookKeeping\newClone(), BookKeeping\newCloneMass(), Ticket\newMessage(), openid_connect_create_user(), openid_connect_get_url(), ordersupplier_prepare_head(), Website\overwriteTemplate(), RssParser\parser(), partnershipPrepareHead(), pdf_bank(), pdf_build_address(), pdf_getFormat(), pdf_getInstance(), pdf_getlinedesc(), pdf_getlinetotalexcltax(), pdf_getlinetotalwithtax(), pdf_getlineupexcltax(), pdf_getlineupwithtax(), pdf_getlinevatrate(), pdf_getPDFFont(), pdf_getPDFFontSize(), pdf_pagefoot(), pdf_pagehead(), pdf_writelinedesc(), pdfGetLineTotalDiscountAmount(), pdfWriteAlreadyPaid(), pdfWriteVATArray(), positionCardPrepareHead(), Documents\post(), Products\post(), Projects\post(), Tasks\post(), prelevement_check_config(), prelevement_prepare_head(), price2fec(), price2numjs(), pricejs(), print_actions_filter(), print_auguria_menu(), print_eldy_menu(), print_left_auguria_menu(), print_paypal_redirect(), print_projecttasks_array(), print_text_menu_entry(), print_text_menu_entry_auguria(), print_text_menu_entry_empty(), printCodeForPing(), printDropdownBookmarksList(), printDropdownQuickadd(), printing_printipp\printFile(), CheckboxField\printInputField(), ChkbxlstField\printInputField(), SellistField\printInputField(), ChkbxlstField\printInputSearchField(), RadioField\printInputSearchField(), SelectField\printInputSearchField(), SellistField\printInputSearchField(), pdf_standard_expensereport\printLine(), CommonObject\printObjectLine(), Mo\printOriginLinesList(), product_admin_prepare_head(), product_prepare_head(), productlot_prepare_head(), project_admin_prepare_head(), project_prepare_head(), project_timesheet_prepare_head(), projectLinesPerAction(), projectLinesPerDay(), projectLinesPerWeek(), propal_prepare_head(), Utils\purgeFiles(), purgeSessions(), Products\put(), DoliDBPgsql\query(), DoliDBSqlite3\query(), AdvanceTargetingMailing\query_contact(), AdvanceTargetingMailing\query_thirdparty(), ICal\read_file(), rebuild_merge_pdf(), MultiCurrency\recalculRates(), reception_admin_prepare_head(), reception_prepare_head(), Expedition\reOpen(), Asset\reopen(), resolveDns(), resource_prepare_head(), restrictedArea(), Cronjob\run_jobs(), Interfaces\run_triggers(), InterfaceActionsAuto\runTrigger(), InterfaceEventOrganization\runTrigger(), InterfaceLogevents\runTrigger(), InterfaceStripe\runTrigger(), InterfaceWebhookTriggers\runTrigger(), CMailFile\save_dump_mail_in_err(), security_prepare_head(), Form\select_company(), Form\select_contact(), FormContract\select_contract(), Form\select_dolusers(), FormAdmin\select_language(), Form\select_product_fourn_price(), Form\select_produits(), Form\select_produits_fournisseurs(), Form\select_produits_fournisseurs_list(), Form\select_produits_list(), FormProjets\select_projects(), FormProjets\select_projects_list(), Form\select_remises(), FormResource\select_resource_list(), FormCompany\select_state(), FormResource\select_state(), Form\select_thirdparty_list(), FormActions\select_type_actions(), Form\select_type_of_lines(), Form\select_types_paiements(), Form\selectarray(), Form\selectArrayAjax(), Form\selectCategories(), FormCompany\selectCompaniesForNewContact(), Form\selectcontacts(), Form\selectDate(), FormCompany\selectProspectCustomerType(), FormProjets\selectTasks(), FormProduct\selectWarehouses(), FormProduct\selectWorkstations(), Notify\send(), User\send_password(), Utils\sendBackup(), Adherent\sendEmail(), ActionComm\sendEmailsReminder(), Facture\sendEmailsRemindersOnInvoiceDueDate(), FactureFournisseur\sendEmailsRemindersOnSupplierInvoiceDueDate(), sendEmailToRepresentative(), CMailFile\sendfile(), CSMSFile\sendfile(), sendMail(), sendMailRepresentativeUnpaid(), SMTPs\sendMsg(), Holiday\sendPreviousMonthHRInformations(), Adherent\sendReminderForExpiredSubscription(), ActionComm\sendSmsReminder(), Ticket\sendTicketMessageByEmail(), dolReceiptPrinter\sendToPrinter(), Stripe\sepaStripe(), FormListWebPortal\setArrayFields(), FormBarCode\setBarcodeEncoder(), Project\setClose(), Expedition\setClosed(), FieldsManager\setCommonFieldInfos(), Translate\setDefaultLang(), AssetDepreciationOptions\setDeprecationOptionsFromPost(), Commande\setDraft(), Facture\setDraft(), FactureFournisseur\setDraft(), Users\setGroup(), Product\setMultiLangs(), Societe\setMysoc(), User\setPassword(), Users\setPassword(), ProductCustomerPrice\setPriceOnAffiliateThirdparty(), Thirdparties\setThirdpartyPriceLevel(), Conf\setValues(), shipping_prepare_head(), InterfaceWorkflowManager\shouldClassify(), show_actions_done(), show_contacts(), FormSms\show_form(), show_ldap_test_button(), show_projects(), show_skin(), show_stats_for_company(), box_actions\showBox(), box_actions_future\showBox(), ModeleBoxes\showBox(), showDirectPublicLink(), FormFile\showdocuments(), CommonObject\showInputField(), ExtraFields\showInputField(), Form\showLinkToObjectBlock(), MenuManager\showmenu(), FormTicket\showMessageForm(), showModulesExludedForExternal(), CommonObject\showOptionals(), Form\showphoto(), FormFile\showPreview(), Form\showrefnav(), showSkins(), skilldetPrepareHead(), skillPrepareHead(), skillrankPrepareHead(), societe_admin_prepare_head(), societe_prepare_head(), BonPrelevement\SommeAPrelever(), stocktransferPrepareHead(), Adherent\subscriptionComplementaryActions(), supplier_invoice_rec_prepare_head(), supplier_proposal_prepare_head(), MultiCurrency\syncRates(), pdf_octopus\tableFirstPage(), pdf_strato\tabSignature(), takepos_admin_prepare_head(), task_prepare_head(), tax_by_rate(), tax_by_thirdparty(), tax_prepare_head(), testAIConnection(), ticket_prepare_head(), top_htmlhead(), top_httphead(), top_menu(), top_menu_ai(), top_menu_bookmark(), top_menu_importfile(), top_menu_quickadd(), top_menu_user(), Translate\trans(), Translate\transnoentitiesnoconv(), ExportTsv\tsv_clean(), Adherent\update(), BookKeeping\update(), Categorie\update(), ContratLigne\update(), EcmFiles\update(), ExpeditionLigne\update(), Holiday\update(), Product\update(), ProductCombination\update(), Societe\update(), Task\update(), User\update(), ProductFournisseur\update_buyprice(), User\update_ldap2dolibarr(), Delivery\update_line(), CommonObject\update_price(), CommonObject\updateCommon(), CommonObject\updateExtraField(), CommonObject\updateExtraLanguages(), Commande\updateline(), CommandeFournisseur\updateline(), Facture\updateline(), Propal\updateline(), Product\updatePrice(), ProductCombination\updateProperties(), Task\updateTimeSpent(), user_prepare_head(), userIsTaxAuditor(), Commande\valid(), CommandeFournisseur\valid(), Expedition\valid(), Propal\valid(), SupplierProposal\valid(), Contrat\validate(), Facture\validate(), FactureFournisseur\validate(), Holiday\validate(), Inventory\validate(), BookKeeping\validBookkeepingDate(), mod_barcode_product_standard\verif(), mod_barcode_thirdparty_standard\verif(), mod_codeclient_elephant\verif(), mod_codeclient_leopard\verif(), mod_codeclient_monkey\verif(), mod_codeproduct_elephant\verif(), mod_codeproduct_leopard\verif(), mod_contract_olive\verif(), mod_codeclient_elephant\verif_prefixIsUsed(), mod_codeproduct_elephant\verif_prefixIsUsed(), mod_barcode_product_standard\verif_syntax(), mod_barcode_thirdparty_standard\verif_syntax(), Societe\verify(), FieldsManager\verifyFieldValue(), PasswordField\verifyFieldValue(), FieldsManager\verifyPostFieldValue(), ActionsTicket\viewStatusActions(), ActionsTicket\viewTicketMessages(), ActionsTicket\viewTicketOriginalMessage(), vignette(), Form\widgetForTranslation(), workstationPrepareHead(), CMailFile\write_body(), BordereauChequeBlochet\write_file(), doc_generic_asset_odt\write_file(), doc_generic_member_odt\write_file(), doc_generic_odt\write_file(), doc_generic_product_odt\write_file(), doc_generic_project_odt\write_file(), doc_generic_stock_odt\write_file(), doc_generic_ticket_odt\write_file(), doc_generic_user_odt\write_file(), doc_generic_usergroup_odt\write_file(), html_cerfafr\write_file(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_balance\write_file(), pdf_baleine\write_file(), pdf_ban\write_file(), pdf_beluga\write_file(), pdf_bookkeeping\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_ledger\write_file(), pdf_merou\write_file(), pdf_muscadet\write_file(), pdf_octopus\write_file(), pdf_paiement\write_file(), pdf_rouget\write_file(), pdf_sepamandate\write_file(), pdf_soleil\write_file(), pdf_sponge\write_file(), pdf_squille\write_file(), pdf_standard\write_file(), pdf_standard_actions\write_file(), pdf_standard_asset\write_file(), pdf_standard_evaluation\write_file(), pdf_standard_expensereport\write_file(), pdf_standard_member\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_standard_stock\write_file(), pdf_standard_supplierpayment\write_file(), pdf_standardlabel\write_file(), pdf_storm\write_file(), pdf_strato\write_file(), pdf_tcpdflabel\write_file(), pdf_timespent\write_file(), pdf_typhon\write_file(), pdf_vinci\write_file(), pdf_zenith\write_file(), ExportCsv\write_record(), ExportTsv\write_record(), CMailFile\write_smtpheaders(), ExportCsv\write_title(), ExportTsv\write_title(), and pdf_standard_salary\writeFile().

◆ getDoliDBInstance()

getDoliDBInstance ( $type,
$host,
$user,
$pass,
$name,
$port )

Return a DoliDB instance (database handler).

Parameters
string$typeType of database (mysql, pgsql...)
string$hostAddress of database server
string$userAuthorized username
string$passPassword (clear)
string$nameName of database
int$portPort of database server
Returns
DoliDB A DoliDB instance

Definition at line 589 of file functions.lib.php.

Referenced by MailmanSpip\connectSpip(), dolSessionOpen(), and InterfaceWebhookTriggers\runTrigger().

◆ getDolOptimizeSmallScreen()

getDolOptimizeSmallScreen ( )

Return if render must be optimized for small screen.

Returns
string Value returned

Definition at line 372 of file functions.lib.php.

References $conf.

Referenced by ExternalModules\getProducts().

◆ getDolUserInt()

getDolUserInt ( $key,
$default = 0,
$tmpuser = null )

Return Dolibarr user constant int value.

Parameters
string$keyKey to return value, return 0 if not set
int$defaultValue to return
User$tmpuserTo get another user than current user
Returns
int

Definition at line 438 of file functions.lib.php.

Referenced by vCard\buildVCardString(), dol_check_secure_access_document(), and migrate_apiresttokens().

◆ getDolUserString()

getDolUserString ( $key,
$default = '',
$tmpuser = null )

Return Dolibarr user constant string value.

Parameters
string$keyKey to return value, return '' if not set
string | int | float$defaultValue to return
User$tmpuserTo get another user than current user
Returns
string
See also
getDolGlobalString()

Definition at line 420 of file functions.lib.php.

Referenced by InterfaceTicketEmail\composeAndSendAssigneeMessage(), get_left_menu_home(), print_eldy_menu(), Form\selectDate(), pdf_octopus\write_file(), pdf_sponge\write_file(), and pdf_standard_asset\write_file().

◆ getEntity()

getEntity ( $element,
$shared = 1,
$currentobject = null )

Get list of entity id to use.

Parameters
string$elementCurrent element 'societe', 'socpeople', 'actioncomm', 'agenda', 'resource', 'product', 'productprice', 'stock', 'bom', 'mo', 'propal', 'supplier_proposal', 'invoice', 'supplier_invoice', 'payment_various', 'categorie', 'bank_account', 'bank_account', 'adherent', 'user', 'commande', 'supplier_order', 'expedition', 'intervention', 'survey', 'contract', 'tax', 'expensereport', 'holiday', 'multicurrency', 'project', 'email_template', 'event', 'donation' 'c_paiement', 'c_payment_term', ...
int<0,1>$shared 0=Return id of current entity only, 1=Return id of current entity + shared entities (default)
?CommonObject$currentobjectCurrent object if needed
Returns
string Entity id(s) to use ( eg. entity IN ('.getEntity(elementname).')' )

Definition at line 615 of file functions.lib.php.

Referenced by CommandeStats\__construct(), ContratStats\__construct(), FichinterStats\__construct(), modAgenda\__construct(), modCommande\__construct(), modEventOrganization\__construct(), modFacture\__construct(), modHoliday\__construct(), modProduct\__construct(), modProjet\__construct(), modPropale\__construct(), modService\__construct(), modSociete\__construct(), modSupplierInvoice\__construct(), modSupplierOrder\__construct(), modTicket\__construct(), MyObjectStats\__construct(), PropaleStats\__construct(), ToolProducts\analyze(), ProductAttribute\attributeOrder(), Form\constructProductListOption(), ProductAttribute\countChildProducts(), AdherentStats\countMembersByTagAndStatus(), AdherentStats\countMembersByTypeAndStatus(), ProductCombination\countNbOfCombinationForFkProductParent(), Cpaiement\create(), PaymentTerm\create(), ToolCategories\createCategory(), Products\deleteAttributeValueByRef(), dol_check_secure_access_document(), pdf_octopus\drawInfoTable(), pdf_sponge\drawInfoTable(), AccountancyReport\fetch(), BonPrelevement\fetch(), Categorie\fetch(), PaymentTerm\fetch(), ProductAttribute\fetch(), ProductAttributeValue\fetch(), ProductCombination\fetch(), Propal\fetch(), Societe\fetch(), ProductAttribute\fetch_lines(), Position\fetchAll(), ProductAttribute\fetchAll(), User\fetchAll(), ProductCombination\fetchAllByFkProductParent(), Product\fetchAllPriceLogs(), ProductCombination\fetchByFkProductChild(), ToolInvoices\findBankAccount(), ToolInvoices\findCustomer(), ToolCrudObjects\findProduct(), ToolProducts\findProduct(), Project\get_element_list(), FormMail\get_form(), CommonInvoice\getArrayOfInvoiceSubtypes(), AccountingJournal\getAssetData(), Products\getAttributes(), Products\getAttributesByRef(), Products\getAttributesByRefExt(), Products\getAttributeValueById(), Products\getAttributeValueByRef(), BookKeeping\getCountByMonthForFiscalPeriod(), Project\getElementCount(), ToolReports\getFinancialReport(), ToolReports\getInventoryReport(), Translate\getLabelFromKey(), Lettering\getLinkedLines(), ProductAttribute\getMaxAttributesPosition(), ProductAttributeValue\getMaxAttributesValuesPosition(), Context\getMemberAccountFromLogin(), mod_commande_saphir\getNextValue(), mod_facture_mercure\getNextValue(), mod_member_custom\getNextValue(), mod_project_universal\getNextValue(), mod_propale_saphir\getNextValue(), mod_takepos_ref_universal\getNextValue(), mod_ticket_universal\getNextValue(), Contact\getNoEmail(), Societe\getNoEmail(), ToolProducts\getPendingCustomerOrdersQty(), ToolProducts\getPendingSupplierOrdersQty(), ProductAttribute\getPositionOfAttribute(), ToolReports\getPurchaseReport(), ToolReports\getSalesReport(), Societe\getSalesRepresentatives(), mailing_fraise\getSqlArrayForStats(), CdavLib\getSqlCalEvents(), ToolProducts\getSupplierPrices(), Products\getSupplierProducts(), Context\getThirdPartyAccountFromLogin(), ToolReports\getThirdpartyTransactions(), Societe\id_prof_exists(), BankAccounts\index(), Products\index(), Projects\index(), SupplierInvoices\index(), Tasks\index(), Product\isVariant(), ToolThirdParty\listContacts(), listPublicHoliday(), BonPrelevement\load_board(), Commande\load_board(), SupplierProposal\load_board(), Ticket\load_board(), Form\load_cache_conditions_paiements(), Form\load_cache_transport_mode(), Form\load_cache_types_paiements(), CommonObject\load_previous_next_ref(), box_members_subscriptions_by_year\loadBox(), FormProduct\loadLotStock(), Commande\loadStateBoard(), CommandeFournisseur\loadStateBoard(), Contact\loadStateBoard(), Facture\loadStateBoard(), Fichinter\loadStateBoard(), SupplierProposal\loadStateBoard(), Ticket\loadStateBoard(), BonPrelevement\NbFactureAPrelever(), AdvanceTargetingMailing\query_contact(), ToolCategories\resolveCategoryIdFromName(), ToolReports\resolveThirdparty(), ToolProducts\search(), ToolThirdParty\search(), ToolCategories\searchCategories(), ToolInvoices\searchInvoices(), Form\select_bom(), Form\select_comptes(), Form\select_dolusers(), FormProjets\select_element(), Form\select_product_fourn_price(), Form\select_produits_fournisseurs_list(), Form\select_produits_list(), FormProjets\select_projects_list(), Form\select_thirdparty_list(), FormCompany\selectCompaniesForNewContact(), Form\selectcontacts(), Form\selectExpenseCategories(), FormWebPortal\selectForForms(), Form\selectForFormsList(), FormProjets\selectInvoiceAndLine(), Form\selectInvoiceRec(), Form\selectMultiCurrency(), Form\selectSituationInvoices(), FormProjets\selectTasks(), Contact\setNoEmail(), Societe\setNoEmail(), FormListWebPortal\setSqlRequest(), show_actions_done(), show_contacts(), show_projects(), show_subsidiaries(), Form\showLinkToObjectBlock(), societe_prepare_head(), BonPrelevement\SommeAPrelever(), ProductAttribute\updateAttributePositionDown(), ProductAttribute\updateAttributePositionUp(), Lettering\updateGeneralMatching(), Lettering\updateLettering(), Contact\updateRoles(), and ActionsTicket\viewTicketMessages().

◆ getImgPictoConv()

getImgPictoConv ( $mode = 'fa')

Get array to convert the Dolibarr picto keys into Font awesome keys.

Parameters
string$mode'fa' to get conversion array for Font-Awesome
Returns
string[] Array of conversion
See also
img_picto()

Definition at line 6071 of file functions.lib.php.

◆ getLanguageCodeFromCountryCode()

getLanguageCodeFromCountryCode ( $countrycode)

Return default language from country code.

Return null if not found.

Parameters
string$countrycodeCountry code like 'US', 'FR', 'CA', 'ES', 'IN', 'MX', ...
Returns
?string Value of locale like 'en_US', 'fr_FR', ... or null if not found

Definition at line 12647 of file functions.lib.php.

Referenced by FormAdmin\select_language(), and Adherent\sendReminderForExpiredSubscription().

◆ getLocalTaxesFromRate()

getLocalTaxesFromRate ( $vatrate,
$local,
$buyer,
$seller,
$firstparamisid = 0 )

Get type and rate of localtaxes for a particular vat rate/country of a thirdparty.

This does not take into account the seller setup if subject to vat or not, only country.

TODO This function is ALSO called to retrieve type for building PDF. Such call of function must be removed. Instead this function must be called when adding a line to get the array of possible values for localtax and type, and then provide the selected value to the function calcul_price_total.

Parameters
float | string$vatrateVAT ID or Rate+Code. Value can be value or the string with code into parenthesis or rowid if $firstparamisid is 1. Example: '8.5' or '8.5 (8.5NPR)' or 123.
int<0,2>$local Number of localtax (1 or 2, or 0 to return 1 & 2)
?Societe$buyerCompany object
?Societe$sellerCompany object
int<0,1>$firstparamisid 1 if first param is ID into table instead of Rate+code (use this if you can)
Returns
array{}|array{0:string,1:int|string,2:string,3:string}|array{0:string,1:int|string,2:string,3:int|string,4:string,5:string} array(localtax_type1('1-6' or '0' if not found), rate localtax1, localtax_type2, rate localtax2, accountancycodecust, accountancycodesupp)
See also
getTaxesFromId()

Definition at line 8297 of file functions.lib.php.

Referenced by Commande\addline(), CommandeFournisseur\addline(), Contrat\addline(), ExpenseReport\addline(), Facture\addline(), FactureFournisseur\addline(), FactureFournisseurRec\addline(), FactureRec\addline(), Propal\addline(), SupplierProposal\addline(), ContratLigne\update(), Commande\updateline(), CommandeFournisseur\updateline(), Contrat\updateline(), ExpenseReport\updateline(), Facture\updateline(), FactureFournisseur\updateline(), FactureFournisseurRec\updateline(), FactureRec\updateline(), Propal\updateline(), SupplierProposal\updateline(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_muscadet\write_file(), pdf_octopus\write_file(), pdf_sponge\write_file(), pdf_standard_asset\write_file(), pdf_standard_myobject\write_file(), and pdf_zenith\write_file().

◆ getMultidirOutput()

getMultidirOutput ( $object,
$module = '',
$forobject = 0,
$mode = 'output' )

Return the full path of the directory where a module (or an object of a module) stores its files.

Path may depends on the entity if a multicompany module is enabled.

Parameters
CommonObject | BlockedLog | null$objectDolibarr common object.
string$moduleOverride object element, for example to use 'mycompany' instead of 'societe'
int$forobjectReturn the more complete path for the given object (including ref) instead of for the module only.
string$mode'output' (full main dir) or 'outputrel' (relative dir) or 'temp' (full dir for temporary files) or 'version' (full dir for archived files)
Returns
string|null The path of the relative directory of the module, ending with /
Since
Dolibarr V18

Definition at line 155 of file functions.lib.php.

References $conf, $object, and get_exdir().

Referenced by pdf_eratosthene\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_strato\_pagehead(), blockedlogadmin_prepare_head(), bomPrepareHead(), CommonObject\deleteCommon(), getMultidirTemp(), getMultidirVersion(), printing_printipp\printFile(), Commande\valid(), BOM\validate(), pdf_eratosthene\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), and pdf_strato\write_file().

◆ getMultidirTemp()

getMultidirTemp ( $object,
$module = '',
$forobject = 0 )

Return the full path of the directory where a module (or an object of a module) stores its temporary files.

Path may depends on the entity if a multicompany module is enabled.

Parameters
CommonObject$objectDolibarr common object
string$moduleOverride object element, for example to use 'mycompany' instead of 'societe'
int$forobjectReturn the more complete path for the given object instead of for the module only.
Returns
string|null The path of the relative temp directory of the module

Definition at line 258 of file functions.lib.php.

References $object, and getMultidirOutput().

◆ getMultidirVersion()

getMultidirVersion ( $object,
$module = '',
$forobject = 0 )

Return the full path of the directory where a module (or an object of a module) stores its versioned files.

Path may depends on the entity if a multicompany module is enabled.

Parameters
CommonObject$objectDolibarr common object
string$moduleOverride object element, for example to use 'mycompany' instead of 'societe'
int$forobjectReturn the more complete path for the given object instead of for the module only.
Returns
string|null The path of the relative version directory of the module

Definition at line 272 of file functions.lib.php.

References $object, and getMultidirOutput().

◆ getPictoForType()

getPictoForType ( $key,
$morecss = '' )

Return the picto for a data type.

Parameters
string$keyKey
string$morecssAdd more css to the object
Returns
string Pïcto for the key

Definition at line 5591 of file functions.lib.php.

Referenced by FormAdmin\selectTypeOfFields(), and CommonObject\showOptionals().

◆ GETPOST()

GETPOST ( $paramname,
$check = 'alphanohtml',
$method = 0,
$filter = null,
$options = null,
$noreplace = 0 )

Return value of a param into GET or POST supervariable.

Use the property $user->default_values[path]['createform'] and/or $user->default_values[path]['filters'] and/or $user->default_values[path]['sortorder'] Note: The property $user->default_values is loaded by main.php when loading the user.

Parameters
string$paramnameName of parameter to found
'int'|'intcomma'|'array'|'array:int'|'array:intcomma'|'array:alpha'|'array:alphanohtml'|'array:aZ09'|'array:restricthtml'|'password'|'email'|'alpha'|'alphanohtml'|'nohtml'|'restricthtml'|'alphawithlgt'|'aZ09'|'aZ'|'aZ09arobase'|'aZ09comma'|'url'|'san_alpha'|'custom'|'none'|'restricthtmlallowclass'|'restricthtmlallowunvalid'|'restricthtmlallowiframe'|'restricthtmlallowlinkscript'|''$check Type of check '' or 'none'=no check (deprecated) 'password'=allow characters for a password 'email'=allow characters for an email "email@domain.com" 'url'=allow characters for an url 'array', 'array:restricthtml' or 'array:aZ09' to check it's an array 'int'=check it's numeric (integer or float) 'intcomma'=check it's integer+comma ('1,2,3,4...') 'alphanohtml'=check there is no html content and no " and no ../ ('alpha' is an alias of 'alphanohtml') 'alphawithlgt'=alpha with lgt and no " and no ../ (Can be used for email string like "Name <email@domain.com>") 'aZ'=check it's a-Z only 'aZ09'=check it's simple alpha string (recommended for keys, it includes a-Z0-9_-.) 'aZ09arobase'=check it's a string for an element type ('myobject@mymodule') 'aZ09comma'=check it's a string for a sortfield or sortorder 'san_alpha'=Use filter_var with FILTER_SANITIZE_STRING (do not use this for free text string) 'nohtml'=check there is no html content 'restricthtml'=check html content is restricted to some tags only 'custom'= custom filter specify $filter and $options) 'restricthtmlallowclass' 'restricthtmlallowunvalid' 'restricthtmlallowiframe' 'restricthtmlallowlinkscript'
int$methodType of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get)
?int$filterFilter to apply when $check is set to 'custom'. (See http://php.net/manual/en/filter.filters.php for détails)
mixed$optionsOptions to pass to filter_var when $check is set to 'custom'
int$noreplaceForce disable of replacement of xxx strings.
Returns
string|array<mixed> Value found (string or array), or '' if check fails @phpstan-return ( $check is 'int' ? numeric-string|'' : $check is 'array:int' ? numeric-string[]|array{} : $check is 'array' | 'array:aZ09' | 'array:alpha' | 'array:intcomma' | 'array:restricthtml' ? string[] : $check is 'alpha' | 'aZ' | 'aZ09' | 'aZ09arobase' | 'aZ09comma' | 'password' | 'email' | 'url' | 'alphanohtml' |'nohtml' | 'restricthtml' | 'alphawithlgt' | 'intcomma' | 'restricthtmlallowclass' | 'restricthtmlallowunvalid' | 'restricthtmlallowiframe' | 'restricthtmlallowlinkscript' ? string : string|array<mixed> )

Definition at line 1082 of file functions.lib.php.

Referenced by Context\__construct(), ImportCsv\__construct(), mailing_contacts1\add_to_target(), mailing_fraise\add_to_target(), mailing_mailing_mymodule_selector1\add_to_target(), mailing_pomme\add_to_target(), mailing_thirdparties\add_to_target(), mailing_xinputuser\add_to_target(), ActionsAdherentCardCommon\assign_post(), ActionsCardCommon\assign_post(), ActionsContactCardCommon\assign_post(), ActionsCardCommon\assign_values(), ActionsCardIndividual\assign_values(), blockedlogadmin_prepare_head(), check_user_password_googleoauth(), check_user_password_openid(), FormTicket\checkRequiredFields(), Propal\classifyBilled(), Propal\closeProposal(), RecruitmentJobPosition\cloture(), SupplierProposal\cloture(), Facture\create(), FactureFournisseur\create(), Workstation\create(), displayPositionCard(), Asset\dispose(), FormListWebPortal\doActions(), PartnershipUtils\doCancelStatusOfMemberPartnership(), dol_add_file_process(), dol_check_secure_access_document(), PartnershipUtils\doWarningOfPartnershipIfDolibarrBacklinkNotfound(), Utils\dumpDatabase(), Form\editfieldkey(), Form\editfieldval(), fieldList(), mailing_contacts1\formFilter(), mailing_partnership\formFilter(), mailing_thirdparties\formFilter(), FormSetupItem\generateInputFieldPassword(), FormSetupItem\generateInputFieldSecureKey(), FormMail\get_form(), CommonObject\getDefaultCreateValueFor(), ExtraFields\getOptionalsFromPost(), CheckboxField\getPostFieldValue(), ChkbxlstField\getPostFieldValue(), CommonGeoField\getPostFieldValue(), DoubleField\getPostFieldValue(), EmailField\getPostFieldValue(), HtmlField\getPostFieldValue(), IconField\getPostFieldValue(), IpField\getPostFieldValue(), PasswordField\getPostFieldValue(), PhoneField\getPostFieldValue(), PricecyField\getPostFieldValue(), PriceField\getPostFieldValue(), RadioField\getPostFieldValue(), RealField\getPostFieldValue(), SelectField\getPostFieldValue(), SellistField\getPostFieldValue(), TextField\getPostFieldValue(), UrlField\getPostFieldValue(), VarcharField\getPostFieldValue(), CheckboxField\getPostSearchFieldValue(), ChkbxlstField\getPostSearchFieldValue(), DoubleField\getPostSearchFieldValue(), EmailField\getPostSearchFieldValue(), HtmlField\getPostSearchFieldValue(), IconField\getPostSearchFieldValue(), IntField\getPostSearchFieldValue(), IpField\getPostSearchFieldValue(), LinkField\getPostSearchFieldValue(), PasswordField\getPostSearchFieldValue(), PhoneField\getPostSearchFieldValue(), PricecyField\getPostSearchFieldValue(), PriceField\getPostSearchFieldValue(), RadioField\getPostSearchFieldValue(), RealField\getPostSearchFieldValue(), SelectField\getPostSearchFieldValue(), SellistField\getPostSearchFieldValue(), TextField\getPostSearchFieldValue(), UrlField\getPostSearchFieldValue(), VarcharField\getPostSearchFieldValue(), mod_codeclient_elephant\info(), DocumentController\init(), FormListWebPortal\init(), ViewImageController\init(), FormFile\list_of_documents(), Facture\list_qualified_avoir_invoices(), box_graph_invoices_permonth\loadBox(), box_graph_invoices_peryear\loadBox(), box_graph_invoices_supplier_permonth\loadBox(), box_graph_nb_ticket_last_x_days\loadBox(), box_graph_orders_permonth\loadBox(), box_graph_orders_supplier_permonth\loadBox(), box_graph_product_distribution\loadBox(), box_graph_propales_permonth\loadBox(), box_task\loadBox(), MenuManager\loadMenu(), main_area(), Ticket\newMessage(), EmailCollector\overwritePropertiesOfObject(), printingAdminPrepareHead(), LinkField\printInputField(), CommonObject\printObjectLine(), Asset\reopen(), restrictedArea(), Form\selectCategories(), FormTicket\selectGroupTickets(), AssetAccountancyCodes\setAccountancyCodesFromPost(), AssetDepreciationOptions\setDeprecationOptionsFromPost(), FormListWebPortal\setSearchValues(), FormSetupItem\setValueFromPost(), CommonObject\setValuesForExtraLanguages(), show_actions_done(), show_contacts(), FormSms\show_form(), Form\showLinkToObjectBlock(), FormTicket\showMessageForm(), CommonObject\showOptionals(), Form\showPhoneInput(), showSocialNetwork(), Adherent\subscriptionComplementaryActions(), top_htmlhead(), Workstation\update(), CheckboxField\verifyPostFieldValue(), ChkbxlstField\verifyPostFieldValue(), CommonField\verifyPostFieldValue(), DoubleField\verifyPostFieldValue(), PricecyField\verifyPostFieldValue(), PriceField\verifyPostFieldValue(), RadioField\verifyPostFieldValue(), RealField\verifyPostFieldValue(), SelectField\verifyPostFieldValue(), SellistField\verifyPostFieldValue(), StarsField\verifyPostFieldValue(), TextField\verifyPostFieldValue(), ActionsTicket\viewTicketMessages(), ActionsTicket\viewTicketOriginalMessage(), Form\widgetForTranslation(), pdf_einstein\write_file(), and pdf_standard_movementstock\write_file().

◆ GETPOSTDATE()

GETPOSTDATE ( $prefix,
$hourTime = '',
$gm = 'auto',
$saverestore = '' )

Helper function that combines values of a dolibarr DatePicker (such as Form\selectDate) for year, month, day (and optionally hour, minute, second) fields to return a timestamp.

Parameters
string$prefixPrefix used to build the date selector (for instance using Form\selectDate). Example: 'select_datec'
string$hourTime'getpost' or 'getpostend' to include hour, minute, second values from the HTTP request, or 'XX:YY:ZZ' to set hour, minute, second respectively, for example '23:59:59' or 'end' means '23:59:59' or '' means '00:00:00' (default)
int | string$gmPassed to dol_mktime. In most cases, when used with 'getpost' or 'getpostend', it should be 'tzuserrel'. Use 'auto' if you need dates related to 'tzserver' (like in accountancy).
string$saverestoreUse a string family context to save retrieved date so it will be used on the next retrieval for the same family context (if value not already defined in parameters).
Returns
int|string Date as a timestamp, '' or false if error
See also
dol_mktime()

Definition at line 990 of file functions.lib.php.

Referenced by mod_codeclient_elephant\info().

◆ GETPOSTFLOAT()

GETPOSTFLOAT ( $paramname,
$rounding = '',
$option = 2 )

Return the value of a $_GET or $_POST supervariable, converted into float.

Warning: This function assumes by default that the input is a number entered by end user in user format in local language (with possible thousands separator and decimal separator). If it is not the case, use the parameter $option = 1 instead.

Parameters
string$paramnameName of the $_GET or $_POST parameter
''|'MU'|'MT'|'MS'|'CU'|'CT'|int$rounding Type of rounding ('', 'MU', 'MT, 'MS', 'CU', 'CT', integer) {
See also
price2num()}
Parameters
int<0,2>$option Put 1 if you know that content is already universal format number (so no correction on decimal will be done) Put 2 if you know that number is a user input (so we know we have to fix decimal separator). Use 0 if unknown (never use this anymore, automatic detection is not reliable with some languages).
Returns
float Value converted into float
Since
Dolibarr V20

Definition at line 969 of file functions.lib.php.

◆ GETPOSTINT()

GETPOSTINT ( $paramname,
$method = 0 )

Return the value of a $_GET or $_POST supervariable, converted into integer.

Use the property $user->default_values[path]['creatform'] and/or $user->default_values[path]['filters'] and/or $user->default_values[path]['sortorder'] Note: The property $user->default_values is loaded by main.php when loading the user.

Parameters
string$paramnameName of the $_GET or $_POST parameter
int<0,3>$method Type of method (0 = $_GET then $_POST, 1 = only $_GET, 2 = only $_POST, 3 = $_POST then $_GET)
Returns
int Value converted into integer

Definition at line 951 of file functions.lib.php.

Referenced by mailing_eventorganization\add_to_target(), mailing_fraise\add_to_target(), mailing_partnership\add_to_target(), mailing_thirdparties\add_to_target(), mailing_thirdparties_services_expired\add_to_target(), ActionsAdherentCardCommon\assign_post(), ActionsCardCommon\assign_post(), ActionsContactCardCommon\assign_post(), check_user_password_openid(), Facture\create(), FactureFournisseur\create(), dol_add_file_process(), User\fetch(), fieldList(), fieldListAccountingCategories(), fieldListAccountingReport(), mailing_thirdparties_services_expired\formFilter(), FormMail\get_form(), get_left_menu_hrm(), get_left_menu_projects(), ExtraFields\getOptionalsFromPost(), BooleanField\getPostFieldValue(), DateField\getPostFieldValue(), DatetimeField\getPostFieldValue(), DatetimegmtField\getPostFieldValue(), DurationField\getPostFieldValue(), IntField\getPostFieldValue(), LinkField\getPostFieldValue(), StarsField\getPostFieldValue(), TimestampField\getPostFieldValue(), BooleanField\getPostSearchFieldValue(), DateField\getPostSearchFieldValue(), DatetimeField\getPostSearchFieldValue(), DatetimegmtField\getPostSearchFieldValue(), StarsField\getPostSearchFieldValue(), TimestampField\getPostSearchFieldValue(), DocumentController\init(), FormListWebPortal\init(), ViewImageController\init(), Commande\initAsSpecimen(), CommandeFournisseur\initAsSpecimen(), Contrat\initAsSpecimen(), Expedition\initAsSpecimen(), ExpenseReport\initAsSpecimen(), Facture\initAsSpecimen(), FactureFournisseur\initAsSpecimen(), FactureFournisseurRec\initAsSpecimen(), FactureRec\initAsSpecimen(), Propal\initAsSpecimen(), Reception\initAsSpecimen(), SupplierProposal\initAsSpecimen(), box_graph_invoices_permonth\loadBox(), box_graph_invoices_peryear\loadBox(), box_graph_invoices_supplier_permonth\loadBox(), box_graph_orders_permonth\loadBox(), box_graph_orders_supplier_permonth\loadBox(), box_graph_product_distribution\loadBox(), box_graph_propales_permonth\loadBox(), MenuManager\loadMenu(), Ticket\newMessage(), print_auguria_menu(), LinkField\printInputField(), AssetDepreciationOptions\setDeprecationOptionsFromPost(), FormListWebPortal\setSearchValues(), FormListWebPortal\setSqlRequest(), FormSetupItem\setValueFromPost(), CommonObject\setValuesForExtraLanguages(), show_actions_done(), show_contacts(), FormTicket\showMessageForm(), CommonObject\showOptionals(), top_htmlhead(), top_menu(), and pdf_standard_movementstock\write_file().

◆ GETPOSTISARRAY()

GETPOSTISARRAY ( $paramname,
$method = 0 )

Return true if the parameter $paramname is submit from a POST OR GET as an array.

Can be used before GETPOST to know if the $check param of GETPOST need to check an array or a string

Parameters
string$paramnameName or parameter to test
int<0,3>$method Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get)
Returns
bool True if we have just submit a POST or GET request with the parameter provided (even if param is empty)

Definition at line 923 of file functions.lib.php.

Referenced by ExtraFields\getOptionalsFromPost(), Form\selectCategories(), and Adherent\subscriptionComplementaryActions().

◆ GETPOSTISSET()

GETPOSTISSET ( $paramname)

Return true if we are in a context of submitting the parameter $paramname from a POST of a form.

Warning: For action=add, use: $var = GETPOST('var'); // No GETPOSTISSET, so GETPOST always called and default value is retrieved if not a form POST, and value of form is retrieved if it is a form POST. For action=update, use: $var = GETPOSTISSET('var') ? GETPOST('var') : $object->var;

Parameters
string$paramnameName or parameter to test
Returns
boolean True if we have just submit a POST or GET request with the parameter provided (even if param is empty)

Definition at line 872 of file functions.lib.php.

◆ getTaxesFromId()

getTaxesFromId ( $vatrate,
$buyer = null,
$seller = null,
$firstparamisid = 1 )

Get tax (VAT) main information from Id.

You can also call getLocalTaxesFromRate() after to get only localtax fields.

Parameters
float | string$vatrateVAT ID or Rate. Value can be value or the string with code into parenthesis or rowid if $firstparamisid is 1. Example: '8.5' or '8.5 (8.5NPR)' or 123.
?Societe$buyerCompany object
?Societe$sellerCompany object
int<0,1>$firstparamisid 1 if first param is id into table (use this if you can)
Returns
array{}|array{rowid:int,code:string,rate:float,localtax1:float,localtax1_type:string,localtax2:float,localtax2_type:string,npr:float,accountancy_code_sell:string,accountancy_code_buy:string} array('rowid'=> , 'code'=> ...)
See also
getLocalTaxesFromRate()

Definition at line 8218 of file functions.lib.php.

Referenced by Societe\set_remise_except().

◆ getTitleFieldOfList()

getTitleFieldOfList ( $name,
$thead = 0,
$file = "",
$field = "",
$begin = "",
$moreparam = "",
$moreattrib = "",
$sortfield = "",
$sortorder = "",
$prefix = "",
$disablesortlink = 0,
$tooltip = '',
$forcenowrapcolumntitle = 0 )

Get title line of an array.

Parameters
?string$nameTranslation key of field to show or complete HTML string to show
int<0,2>$thead 0=To use with standard table format, 1=To use inside

, 2=To use with

Parameters
string$fileUrl used when we click on sort picto
string$fieldField to use for new sorting. Empty if this field is not sortable. Example "t.abc" or "t.abc,t.def"
string$begin("" by default)
string$moreparamAdd more parameters on sort url links ("" by default)
string$moreattribAdd more attributes on th ("" by default). To add more css class, use param $prefix.
?string$sortfieldCurrent field used to sort (Ex: 'd.datep,d.id')
?string$sortorderCurrent sort order (Ex: 'asc,desc')
string$prefixPrefix for css. Use space after prefix to add your own CSS tag, for example 'mycss '.
int<0,1>$disablesortlink 1=Disable sort link
?string$tooltipText of tooltip with syntax 'Tooltip' or 'Tooltip:[keytoenabledtheonclicktooltip]:[tooltipdirection]'
int<0,1>$forcenowrapcolumntitle No need to use 'wrapcolumntitle' css style
Returns
string

Definition at line 7132 of file functions.lib.php.

Referenced by show_actions_done(), show_contacts(), and FormActions\showactions().

◆ getUserRemoteIP()

getUserRemoteIP ( $trusted = 0)

Return the real IP of remote user.

Take HTTP_X_FORWARDED_FOR (defined when using proxy) Then HTTP_CLIENT_IP if defined (rare) Then REMOTE_ADDR (the last seerver ip in proxy chain). REMOTE_ADDR can't be modified by client and may be the IP of a proxy. Note: if Apache module "remoteip" module is on, Apache may replaced the $_SERVER["REMOTE_ADDR"] by HTTP_X_FORWARDED_FOR directly. For this Apache is using the CF-Connecting-IP header (HTTP_CF_CONNECTING_IP), but only if the remote IP is in the trusted cloudflare list (Apache must enable module and conf remoteip).

Parameters
int$trusted0=Default, 1=Trusted value (the last IP that was not altered by client)
Returns
string Real IP of remote user.
See also
getBrowserInfo()

Definition at line 5206 of file functions.lib.php.

Referenced by callSetExpressCheckout(), Stripe\cardStripe(), check_user_password_dolibarr(), checkNbPostsForASpeceificIp(), Events\create(), Stripe\customerStripe(), dolSessionWrite(), mod_syslog_file\getFilename(), Stripe\getPaymentIntent(), Stripe\getSetupIntent(), User\getTooltipContentArray(), Documents\post(), InterfaceActionsAuto\runTrigger(), Stripe\sepaStripe(), and User\update_last_login_date().

◆ getWarningDelay()

getWarningDelay ( $module,
$parmlevel1,
$parmlevel2 = '' )

Return a warning delay You can use it like this: if (getWarningDelay('module', 'paramlevel1')) It replaces old syntax: if ($conf->module->user->rights->module->level1)

Parameters
string$moduleModule of permission to check (Example: 'bank', 'contrat', ...)
string$parmlevel1Parameter level1 (Example: 'rappro', 'services', ...)
string$parmlevel2Parameter level2 (Example: 'inactifs', ...)
Returns
int Return the warning delay

Definition at line 525 of file functions.lib.php.

Referenced by Adherent\hasDelay(), Facture\hasDelay(), Adherent\load_board(), Facture\load_board(), Propal\load_board(), and box_services_contracts\loadBox().

◆ img_action()

img_action ( $titlealt,
$numaction,
$picto = '',
$moreatt = '' )

Show logo action.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
string$numactionAction id or code to show
string$pictoName of image file to show ('filenew', ...) If no extension provided, we use '.png'. Image must be stored into theme/xxx/img directory. Example: picto.png if picto.png is stored into htdocs/theme/mytheme/img Example: picto.png@mymodule if picto.png is stored into htdocs/mymodule/img Example: /mydir/mysubdir/picto.png if picto.png is stored into htdocs/mydir/mysubdir (pictoisfullpath must be set to 1)
string$moreattMore attributes
Returns
string Return an img tag

Definition at line 6377 of file functions.lib.php.

Referenced by Societe\LibProspCommStatut(), Contact\libProspCommStatut(), and FormCompany\selectProspectStatus().

◆ img_allow()

img_allow ( $allow,
$titlealt = 'default' )

Show tick logo if allowed.

Parameters
string$allowAllow
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
Returns
string Return img tag

Definition at line 6734 of file functions.lib.php.

◆ img_credit_card()

img_credit_card ( $brand,
$morecss = 'fa-2x inline-block valignmiddle' )

Return image of a credit card according to its brand name.

Parameters
string$brandBrand name of credit card
string$morecssMore CSS
Returns
string Return img tag

Definition at line 6756 of file functions.lib.php.

◆ img_delete()

img_delete ( $titlealt = 'default',
$other = 'class="pictodelete"',
$morecss = '' )

Show delete logo.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
string$otherAdd more attributes on img
string$morecssMore CSS
Returns
string Retourne tag img

Definition at line 6492 of file functions.lib.php.

Referenced by Export\list_export_model(), FormFile\list_of_documents(), FormFile\listOfLinks(), show_contacts(), CommonObject\show_photos(), and FormFile\showImageToEdit().

◆ img_down()

img_down ( $titlealt = 'default',
$selected = 0,
$moreclass = '' )

Show down arrow logo.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
int$selectedSelected
string$moreclassAdd more CSS classes
Returns
string Return img tag

Definition at line 6659 of file functions.lib.php.

Referenced by form_constantes(), and FormFile\list_of_documents().

◆ img_edit()

img_edit ( $titlealt = 'default',
$float = 0,
$other = '' )

Show logo edit/modify fiche.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
integer$floatIf you have to put the style "float: right"
string$otherAdd more attributes on img
Returns
string Return tag img

Definition at line 6452 of file functions.lib.php.

Referenced by ActionsCardCommon\assign_values(), Form\editfieldkey(), AdherentType\getKanbanView(), FormFile\list_of_documents(), FormFile\listOfLinks(), show_contacts(), show_subsidiaries(), and ActionsTicket\viewTicketOriginalMessage().

◆ img_edit_add()

img_edit_add ( $titlealt = 'default',
$other = '' )

Show logo "+".

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
string$otherAdd more attributes on img
Returns
string Return tag img

Definition at line 6416 of file functions.lib.php.

◆ img_edit_remove()

img_edit_remove ( $titlealt = 'default',
$other = '' )

Show logo "-".

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
string$otherAdd more attributes on img
Returns
string Return tag img

Definition at line 6433 of file functions.lib.php.

◆ img_error()

img_error ( $titlealt = 'default')

Show error logo.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
Returns
string Return img tag

Definition at line 6602 of file functions.lib.php.

◆ img_help()

img_help ( $usehelpcursor = 1,
$usealttitle = 1 )

Show help logo with cursor "?".

Parameters
int$usehelpcursor1=Use help cursor, 2=Use click pointer cursor, 0=No specific cursor
int | string$usealttitleText to use as alt title
Returns
string Return tag img

Definition at line 6544 of file functions.lib.php.

Referenced by Form\formconfirm(), and Form\textwithpicto().

◆ img_info()

img_info ( $titlealt = 'default')

Show info logo.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
Returns
string Return img tag

Definition at line 6565 of file functions.lib.php.

◆ img_left()

img_left ( $titlealt = 'default',
$selected = 0,
$moreatt = '' )

Show left arrow logo.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
int$selectedSelected
string$moreattAdd more attribute on img tag (For example 'style="float: right"')
Returns
string Return img tag

Definition at line 6697 of file functions.lib.php.

◆ img_mime()

img_mime ( $file,
$titlealt = '',
$morecss = '' )

Show MIME img of a file.

Parameters
string$fileFilename
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
string$morecssMore css
Returns
string Return img tag

Definition at line 6789 of file functions.lib.php.

Referenced by FormMail\get_form(), FormFile\getDocumentsLink(), FormWebPortal\getDocumentsLink(), FormFile\list_of_autoecmfiles(), FormFile\list_of_documents(), FormFile\showdocuments(), FormTicket\showMessageForm(), FormFile\showPreview(), and ActionsTicket\viewTicketMessages().

◆ img_next()

img_next ( $titlealt = 'default',
$moreatt = '' )

Show next logo.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
string$moreattAdd more attribute on img tag (For example 'style="float: right"')
Returns
string Return img tag

Definition at line 6620 of file functions.lib.php.

◆ img_object()

img_object ( $titlealt,
$picto,
$moreatt = '',
$pictoisfullpath = 0,
$srconly = 0,
$notitle = 0,
$allowothertags = array() )

Show a picto called object_picto (generic function)

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
string$pictoName of image to show object_picto (example: user, group, action, bill, contract, propal, product, ...) For external modules use imagename@mymodule to search into directory "img" of module.
string$moreattAdd more attribute on img tag (ie: class="datecallink")
int$pictoisfullpathIf 1, image path is a full path
int$srconlyReturn only content of the src attribute of img.
int$notitle1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.
string[]$allowothertagsList of other tags allowed in title attribute
Returns
string Return img tag
See also
img_picto(), img_picto_common()

Definition at line 6291 of file functions.lib.php.

Referenced by Notify\confirmMessage(), MailingTargets\getEmailingSelectorsList(), DolibarrModules\getKanbanView(), User\getLoginUrl(), Account\getNomUrl(), AccountingAccount\getNomUrl(), AccountingJournal\getNomUrl(), ActionComm\getNomUrl(), Adherent\getNomUrl(), AdherentType\getNomUrl(), Asset\getNomUrl(), AssetModel\getNomUrl(), Availabilities\getNomUrl(), BOM\getNomUrl(), BOMLine\getNomUrl(), BonPrelevement\getNomUrl(), BookKeeping\getNomUrl(), BookkeepingTemplate\getNomUrl(), Bookmark\getNomUrl(), Calendar\getNomUrl(), CashControl\getNomUrl(), Categorie\getNomUrl(), ChargeSociales\getNomUrl(), Commande\getNomUrl(), CommandeFournisseur\getNomUrl(), CompanyPaymentMode\getNomUrl(), ConferenceOrBooth\getNomUrl(), ConferenceOrBoothAttendee\getNomUrl(), Contact\getNomUrl(), Contrat\getNomUrl(), Cronjob\getNomUrl(), Dolresource\getNomUrl(), Don\getNomUrl(), EcmDirectory\getNomUrl(), EmailCollector\getNomUrl(), EmailCollectorAction\getNomUrl(), EmailCollectorFilter\getNomUrl(), Entrepot\getNomUrl(), Establishment\getNomUrl(), Evaluation\getNomUrl(), EvaluationLine\getNomUrl(), Expedition\getNomUrl(), ExpenseReport\getNomUrl(), Facture\getNomUrl(), FactureFournisseur\getNomUrl(), FactureFournisseurRec\getNomUrl(), FactureRec\getNomUrl(), Fichinter\getNomUrl(), Fiscalyear\getNomUrl(), Holiday\getNomUrl(), Hook\getNomUrl(), IntracommReport\getNomUrl(), Inventory\getNomUrl(), Job\getNomUrl(), KnowledgeRecord\getNomUrl(), Loan\getNomUrl(), Mailing\getNomUrl(), Mo\getNomUrl(), MyObject\getNomUrl(), Opensurveysondage\getNomUrl(), Paiement\getNomUrl(), PaiementFourn\getNomUrl(), Partnership\getNomUrl(), PartnershipType\getNomUrl(), PaymentLoan\getNomUrl(), PaymentSalary\getNomUrl(), PaymentVarious\getNomUrl(), Position\getNomUrl(), Product\getNomUrl(), ProductAttribute\getNomUrl(), ProductFournisseur\getNomUrl(), ProductFournisseurPrice\getNomUrl(), Productlot\getNomUrl(), Project\getNomUrl(), Propal\getNomUrl(), Reception\getNomUrl(), RecruitmentCandidature\getNomUrl(), RecruitmentJobPosition\getNomUrl(), RemiseCheque\getNomUrl(), Salary\getNomUrl(), Skill\getNomUrl(), Skilldet\getNomUrl(), SkillRank\getNomUrl(), Societe\getNomUrl(), SocieteAccount\getNomUrl(), StockTransfer\getNomUrl(), StockTransferLine\getNomUrl(), Subscription\getNomUrl(), SupplierProposal\getNomUrl(), Target\getNomUrl(), Task\getNomUrl(), Ticket\getNomUrl(), TimeSpent\getNomUrl(), TriggerHistory\getNomUrl(), Tva\getNomUrl(), User\getNomUrl(), UserGroup\getNomUrl(), WebPortalInvoice\getNomUrl(), WebPortalMember\getNomUrl(), WebPortalOrder\getNomUrl(), WebPortalPartnership\getNomUrl(), WebPortalPropal\getNomUrl(), Website\getNomUrl(), Workstation\getNomUrl(), Interfaces\getTriggersList(), ModeleBoxes\getWidgetsList(), Target\initListOfTriggers(), Export\list_export_model(), TicketListController\listPrintValueBefore(), Account\load_board(), ActionComm\load_board(), Adherent\load_board(), BonPrelevement\load_board(), Commande\load_board(), CommandeFournisseur\load_board(), Contrat\load_board(), ExpenseReport\load_board(), Facture\load_board(), FactureFournisseur\load_board(), Holiday\load_board(), Mo\load_board(), Project\load_board(), Propal\load_board(), RemiseCheque\load_board(), SupplierProposal\load_board(), Task\load_board(), Ticket\load_board(), box_dolibarr_state_board\loadBox(), box_services_contracts\loadBox(), Categorie\print_all_ways(), CommonObject\printOriginLine(), ChkbxlstField\printOutputField(), SellistField\printOutputField(), Form\select_produits_fournisseurs_list(), show_actions_done(), show_contacts(), show_stats_for_batch(), show_stats_for_company(), box_actions\showBox(), box_actions_future\showBox(), ModeleBoxes\showBox(), ExtraFields\showOutputField(), mailing_contacts1\url(), mailing_eventorganization\url(), mailing_fraise\url(), mailing_mailing_mymodule_selector1\url(), mailing_partnership\url(), mailing_pomme\url(), mailing_thirdparties\url(), and mailing_thirdparties_services_expired\url().

◆ img_picto()

img_picto ( $titlealt,
$picto,
$moreatt = '',
$pictoisfullpath = 0,
$srconly = 0,
$notitle = 0,
$alt = '',
$morecss = '',
$marginleftonlyshort = 2,
$allowothertags = array() )

Show picto whatever it's its name (generic function)

Parameters
string$titlealtText on title tag for tooltip. Not used if param notitle is set to 1.
string$pictoName of image file to show ('filenew', ...). For font awesome icon (example 'user'), you can use picto_nocolor to not have the color of picto forced. If no extension provided and it is not a font awesome icon, we use '.png'. Image must be stored into theme/xxx/img directory. Example: picto.png if picto.png is stored into htdocs/theme/mytheme/img Example: picto.png@mymodule if picto.png is stored into htdocs/mymodule/img Example: /mydir/mysubdir/picto.png if picto.png is stored into htdocs/mydir/mysubdir (pictoisfullpath must be set to 1) Example: fa-value if you want to use fontaweseome icons: fa-<icon-name> Example: fa-value_fas_color_1em if you want to use fontaweseome icons: fa-<icon-name>_<style>_<color>_<size> (only icon-name is mandatory, color can be 'red' or '#FF0000')
string$moreattAdd more attribute on img tag (For example 'class="pictofixedwidth"')
int<0,1>$pictoisfullpath If true or 1, image path is a full path, 0 if not
int$srconlyReturn only content of the src attribute of img.
int$notitle1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.
string$altForce alt for blind people
string$morecssAdd more class css on img tag (For example 'myclascss').
int$marginleftonlyshort1 = Add a short left margin on picto, 2 = Add a larger left margin on picto, 0 = No margin left. Works for fontawesome picto only.
string[]$allowothertagsList of other tags allowed in title and alt attribute
Returns
string Return img tag
See also
img_object(), img_picto_common()

Definition at line 5657 of file functions.lib.php.

Referenced by modAgenda\__construct(), modApi\__construct(), modBarcode\__construct(), modBlockedLog\__construct(), modBookCal\__construct(), modCollab\__construct(), modECM\__construct(), modEventOrganization\__construct(), modFTP\__construct(), modKnowledgeManagement\__construct(), modMargin\__construct(), modModuleBuilder\__construct(), modMyModule\__construct(), modOpenSurvey\__construct(), modPartnership\__construct(), modQuickMemo\__construct(), modRecruitment\__construct(), modResource\__construct(), modStripe\__construct(), modTakePos\__construct(), modTicket\__construct(), modWebsite\__construct(), modWorkstation\__construct(), ajax_constantonoff(), ActionsCardCompany\assign_values(), Stripe\cardStripe(), FormMargin\displayMarginInfos(), dol_print_cron_urls(), dragAndDropFileUpload(), Form\editfieldval(), ExpenseReport\fetch_line_by_project(), fillArrayOfFilterFields(), fillArrayOfGroupBy(), fillArrayOfMeasures(), fillArrayOfXAxis(), form_constantes(), mailing_contacts1\formFilter(), mailing_eventorganization\formFilter(), mailing_thirdparties\formFilter(), mailing_thirdparties_services_expired\formFilter(), Form\formSelectAccount(), FormSetupItem\generateInputField(), FormSetupItem\generateInputFieldCategories(), FormSetupItem\generateInputFieldEmail(), FormSetupItem\generateInputFieldRadio(), FormSetupItem\generateInputFieldSelect(), FormSetupItem\generateInputFieldUrl(), get_left_menu_accountancy(), get_left_menu_bank(), get_left_menu_billing(), get_left_menu_commercial(), get_left_menu_home(), get_left_menu_hrm(), get_left_menu_members(), get_left_menu_mrp(), get_left_menu_products(), get_left_menu_projects(), get_left_menu_thridparties(), get_left_menu_tools(), getAiChatAssistantHtml(), modCaptchaStandard\getCaptchaCodeForForm(), DataPolicyCron\getDataPolicies(), FormFile\getDocumentsLink(), MailingTargets\getEmailingSelectorsList(), FormCategory\getFilterBox(), FormOther\getHTMLScannerForm(), Adherent\getKanbanView(), AdherentType\getKanbanView(), Availabilities\getKanbanView(), BOM\getKanbanView(), BonPrelevement\getKanbanView(), Calendar\getKanbanView(), CashControl\getKanbanView(), ChargeSociales\getKanbanView(), CommandeFournisseur\getKanbanView(), CommonOrder\getKanbanView(), ConferenceOrBooth\getKanbanView(), Contact\getKanbanView(), Contrat\getKanbanView(), DolibarrModules\getKanbanView(), Don\getKanbanView(), Entrepot\getKanbanView(), Evaluation\getKanbanView(), Expedition\getKanbanView(), ExpenseReport\getKanbanView(), Facture\getKanbanView(), FactureFournisseur\getKanbanView(), Holiday\getKanbanView(), IntracommReport\getKanbanView(), Inventory\getKanbanView(), Job\getKanbanView(), KnowledgeRecord\getKanbanView(), Loan\getKanbanView(), Localtax\getKanbanView(), Mo\getKanbanView(), MyObject\getKanbanView(), Partnership\getKanbanView(), PaymentExpenseReport\getKanbanView(), PaymentSalary\getKanbanView(), PaymentVarious\getKanbanView(), Position\getKanbanView(), Product\getKanbanView(), ProductAttribute\getKanbanView(), Project\getKanbanView(), Propal\getKanbanView(), Reception\getKanbanView(), RecruitmentCandidature\getKanbanView(), RecruitmentJobPosition\getKanbanView(), RemiseCheque\getKanbanView(), Skill\getKanbanView(), Societe\getKanbanView(), Subscription\getKanbanView(), SupplierProposal\getKanbanView(), Task\getKanbanView(), Ticket\getKanbanView(), TimeSpent\getKanbanView(), TriggerHistory\getKanbanView(), Tva\getKanbanView(), User\getKanbanView(), UserGroup\getKanbanView(), WebPortalInvoice\getKanbanView(), WebPortalOrder\getKanbanView(), WebPortalPropal\getKanbanView(), Workstation\getKanbanView(), FormSetupItem\getNameText(), Adherent\getNomUrl(), Asset\getNomUrl(), AssetModel\getNomUrl(), Availabilities\getNomUrl(), BonPrelevement\getNomUrl(), BookkeepingTemplate\getNomUrl(), ChargeSociales\getNomUrl(), Commande\getNomUrl(), CommandeFournisseur\getNomUrl(), ConferenceOrBooth\getNomUrl(), ConferenceOrBoothAttendee\getNomUrl(), Don\getNomUrl(), EcmDirectory\getNomUrl(), Establishment\getNomUrl(), Evaluation\getNomUrl(), EvaluationLine\getNomUrl(), Facture\getNomUrl(), FactureFournisseur\getNomUrl(), FactureRec\getNomUrl(), Job\getNomUrl(), MouvementStock\getNomUrl(), Paiement\getNomUrl(), PaiementFourn\getNomUrl(), PartnershipType\getNomUrl(), PaymentExpenseReport\getNomUrl(), PaymentSocialContribution\getNomUrl(), PaymentVAT\getNomUrl(), Position\getNomUrl(), ProductAttribute\getNomUrl(), ProductFournisseur\getNomUrl(), ProductFournisseurPrice\getNomUrl(), Propal\getNomUrl(), Reception\getNomUrl(), Skill\getNomUrl(), Skilldet\getNomUrl(), SkillRank\getNomUrl(), Subscription\getNomUrl(), SupplierProposal\getNomUrl(), Target\getNomUrl(), TriggerHistory\getNomUrl(), ExternalModules\getProducts(), getResultColumn(), FormAI\getSectionForAIEnhancement(), Commande\getShippableInfos(), Account\getTooltipContentArray(), ActionComm\getTooltipContentArray(), Adherent\getTooltipContentArray(), AdherentType\getTooltipContentArray(), BOM\getTooltipContentArray(), Calendar\getTooltipContentArray(), Commande\getTooltipContentArray(), Contact\getTooltipContentArray(), Contrat\getTooltipContentArray(), Cronjob\getTooltipContentArray(), Delivery\getTooltipContentArray(), Dolresource\getTooltipContentArray(), EcmFiles\getTooltipContentArray(), Entrepot\getTooltipContentArray(), Expedition\getTooltipContentArray(), ExpenseReport\getTooltipContentArray(), Facture\getTooltipContentArray(), FactureFournisseur\getTooltipContentArray(), Fichinter\getTooltipContentArray(), Fiscalyear\getTooltipContentArray(), Holiday\getTooltipContentArray(), KnowledgeRecord\getTooltipContentArray(), Mailing\getTooltipContentArray(), Mo\getTooltipContentArray(), MyObject\getTooltipContentArray(), Opensurveysondage\getTooltipContentArray(), Partnership\getTooltipContentArray(), PaymentSalary\getTooltipContentArray(), Product\getTooltipContentArray(), Productlot\getTooltipContentArray(), Project\getTooltipContentArray(), Propal\getTooltipContentArray(), RecruitmentCandidature\getTooltipContentArray(), RecruitmentJobPosition\getTooltipContentArray(), Societe\getTooltipContentArray(), SupplierProposal\getTooltipContentArray(), Task\getTooltipContentArray(), Ticket\getTooltipContentArray(), TimeSpent\getTooltipContentArray(), TriggerHistory\getTooltipContentArray(), User\getTooltipContentArray(), UserGroup\getTooltipContentArray(), WebPortalMember\getTooltipContentArray(), WebPortalOrder\getTooltipContentArray(), WebPortalPartnership\getTooltipContentArray(), WebPortalPropal\getTooltipContentArray(), Workstation\getTooltipContentArray(), Interfaces\getTriggersList(), ActionComm\getTypePicto(), ModeleBoxes\getWidgetsList(), doc_generic_asset_odt\info(), doc_generic_bom_odt\info(), doc_generic_contract_odt\info(), doc_generic_invoice_odt\info(), doc_generic_member_odt\info(), doc_generic_mo_odt\info(), doc_generic_myobject_odt\info(), doc_generic_odt\info(), doc_generic_order_odt\info(), doc_generic_product_odt\info(), doc_generic_project_odt\info(), doc_generic_proposal_odt\info(), doc_generic_reception_odt\info(), doc_generic_shipment_odt\info(), doc_generic_stock_odt\info(), doc_generic_supplier_invoice_odt\info(), doc_generic_supplier_order_odt\info(), doc_generic_supplier_proposal_odt\info(), doc_generic_task_odt\info(), doc_generic_ticket_odt\info(), doc_generic_user_odt\info(), doc_generic_usergroup_odt\info(), mod_lot_advanced\info(), mod_sn_advanced\info(), Form\inputStars(), FormWebPortal\inputStars(), Cchargesociales\LibStatut(), EmailCollectorAction\LibStatut(), EmailCollectorFilter\LibStatut(), LignePrelevement\LibStatut(), MouvementStock\LibStatut(), ProductStockEntrepot\LibStatut(), ReceptionLineBatch\LibStatut(), Task\LibStatut(), FormFile\list_of_autoecmfiles(), FormFile\list_of_documents(), printing_printgcp\listAvailablePrinters(), printing_printipp\listAvailablePrinters(), FormFile\listOfLinks(), box_external_rss\loadBox(), box_fediverse\loadBox(), box_graph_invoices_permonth\loadBox(), box_graph_invoices_peryear\loadBox(), box_graph_invoices_supplier_permonth\loadBox(), box_graph_nb_ticket_last_x_days\loadBox(), box_graph_orders_permonth\loadBox(), box_graph_orders_supplier_permonth\loadBox(), box_graph_product_distribution\loadBox(), box_graph_propales_permonth\loadBox(), BlockedLog\loadTrackedEvents(), Form\makeAddLinkToAttendee(), Form\makeAddLinkToObject(), modules_prepare_head(), Form\outputStars(), FormWebPortal\outputStars(), print_actions_filter(), print_eldy_menu(), printDropdownBookmarksList(), printDropdownQuickadd(), CommonObject\printOriginLine(), printSearchForm(), Form\searchComponent(), Form\select_all_categories(), Form\select_company(), Form\select_dolresources_forevent(), Form\select_dolusers_forevent(), Form\select_produits(), FormCron\select_typejob(), Form\selectCategories(), show_actions_done(), show_bookcal_day_events(), show_elem(), CommonObject\show_photos(), ModeleBoxes\showBox(), Form\showCategories(), showDirectPublicLink(), FormFile\showdocuments(), CommonObject\showInputField(), FormTicket\showMessageForm(), ExtraFields\showOutputField(), Form\showPhoneInput(), Form\showphoto(), FormFile\showPreview(), showSkins(), showWebsiteTemplates(), Form\textwithpicto(), top_menu(), top_menu_user(), ActionsTicket\viewTicketMessages(), and Form\widgetForTranslation().

◆ img_picto_common()

img_picto_common ( $titlealt,
$picto,
$moreatt = '',
$pictoisfullpath = 0,
$notitle = 0 )

Show picto (generic function)

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
string$pictoName of image file to show (If no extension provided, we use '.png'). Image must be stored into htdocs/theme/common directory.
string$moreattAdd more attribute on img tag
int$pictoisfullpathIf 1, image path is a full path
int$notitle1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.
Returns
string Return img tag
See also
img_object(), img_picto()

Definition at line 6339 of file functions.lib.php.

Referenced by tree_showpad().

◆ img_previous()

img_previous ( $titlealt = 'default',
$moreatt = '' )

Show previous logo.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
string$moreattAdd more attribute on img tag (For example 'style="float: right"')
Returns
string Return img tag

Definition at line 6639 of file functions.lib.php.

◆ img_printer()

img_printer ( $titlealt = "default",
$other = '' )

Show printer logo.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
string$otherAdd more attributes on img
Returns
string Retourne tag img

Definition at line 6510 of file functions.lib.php.

◆ img_right()

img_right ( $titlealt = 'default',
$selected = 0,
$moreatt = '' )

Show right arrow logo.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
int$selectedSelected
string$moreattAdd more attribute on img tag (For example 'style="float: right"')
Returns
string Return img tag

Definition at line 6716 of file functions.lib.php.

◆ img_search()

img_search ( $titlealt = 'default',
$other = '' )

Show search logo.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
string$otherAdd more attributes on img
Returns
string Retourne tag img

Definition at line 6813 of file functions.lib.php.

◆ img_searchclear()

img_searchclear ( $titlealt = 'default',
$other = '' )

Show search logo.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
string$otherAdd more attributes on img
Returns
string Retourne tag img

Definition at line 6836 of file functions.lib.php.

◆ img_split()

img_split ( $titlealt = 'default',
$other = 'class="pictosplit"' )

Show split logo.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
string$otherAdd more attributes on img
Returns
string Retourne tag img

Definition at line 6526 of file functions.lib.php.

◆ img_up()

img_up ( $titlealt = 'default',
$selected = 0,
$moreclass = '' )

Show top arrow logo.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
int$selectedSelected
string$moreclassAdd more CSS classes
Returns
string Return img tag

Definition at line 6678 of file functions.lib.php.

Referenced by FormFile\list_of_documents().

◆ img_view()

img_view ( $titlealt = 'default',
$float = 0,
$other = 'class="valignmiddle"' )

Show logo view card.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
integer$floatIf you have to put the style "float: right"
string$otherAdd more attributes on img
Returns
string Return tag img

Definition at line 6471 of file functions.lib.php.

◆ img_warning()

img_warning ( $titlealt = 'default',
$moreatt = '',
$morecss = 'pictowarning' )

Show warning logo.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
string$moreattAdd more attribute on img tag (For example 'style="float: right"'). If 1, add float: right. Can't be "class" attribute.
string$morecssAdd more CSS
Returns
string Return img tag

Definition at line 6584 of file functions.lib.php.

Referenced by get_left_menu_home(), getCustomerInvoiceUnpaidOpenTable(), Project\getKanbanView(), getResultColumn(), getTaskProgressView(), Opensurveysondage\getTooltipContentArray(), doc_generic_asset_odt\info(), doc_generic_bom_odt\info(), doc_generic_contract_odt\info(), doc_generic_invoice_odt\info(), doc_generic_member_odt\info(), doc_generic_mo_odt\info(), doc_generic_myobject_odt\info(), doc_generic_odt\info(), doc_generic_order_odt\info(), doc_generic_product_odt\info(), doc_generic_project_odt\info(), doc_generic_proposal_odt\info(), doc_generic_reception_odt\info(), doc_generic_recruitmentjobposition_odt\info(), doc_generic_shipment_odt\info(), doc_generic_stock_odt\info(), doc_generic_supplier_invoice_odt\info(), doc_generic_supplier_order_odt\info(), doc_generic_supplier_proposal_odt\info(), doc_generic_task_odt\info(), doc_generic_ticket_odt\info(), doc_generic_user_odt\info(), doc_generic_usergroup_odt\info(), box_actions\loadBox(), box_actions_future\loadBox(), box_factures\loadBox(), box_factures_fourn\loadBox(), box_factures_fourn_imp\loadBox(), box_factures_imp\loadBox(), box_produits_alerte_stock\loadBox(), box_propales\loadBox(), box_services_contracts\loadBox(), box_services_expired\loadBox(), box_supplier_orders_awaiting_reception\loadBox(), show_actions_done(), show_array_actions_to_do(), and Form\textwithpicto().

◆ img_weather()

img_weather ( $titlealt,
$picto,
$moreatt = '',
$pictoisfullpath = 0,
$morecss = '' )

Show weather picto.

Parameters
string$titlealtText on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
string | int$pictoName of image file to show (If no extension provided, we use '.png'). Image must be stored into htdocs/theme/common directory. Or level of meteo image (0-4).
string$moreattAdd more attribute on img tag
int$pictoisfullpathIf 1, image path is a full path
string$morecssMore CSS
Returns
string Return img tag
See also
img_object(), img_picto()

Definition at line 6311 of file functions.lib.php.

Referenced by showWeather().

◆ info_admin()

info_admin ( $text,
$infoonimgalt = 0,
$nodiv = 0,
$admin = '1',
$morecss = 'hideonsmartphone',
$textfordropdown = '',
$picto = '',
$textonpictotooltip = '' )

Show information in HTML for admin users or standard users.

Parameters
string$textText info
integer$infoonimgaltInfo is shown only on alt of star picto, otherwise it is shown on output after the star picto
int$nodivNo div
string | int$admin'1'=Info for admin users. '0'=Info for standard users (change only the look), 'info', 'error', 'warning', 'xxx'=Other
string$morecssMore CSS ('', 'warning', 'error')
string$textfordropdownShow a text to click to dropdown the info box.
string$picto'' or 'warning'
string$textonpictotooltipText to show in tooltip on picto
Returns
string String with info text

Definition at line 6865 of file functions.lib.php.

Referenced by ActionsAdherentCardCommon\assign_values(), ActionsCardCommon\assign_values(), ActionsContactCardCommon\assign_values(), FormFile\form_attach_new_file(), FormCompany\form_prospect_level(), FormCompany\formProspectContactLevel(), FormMail\get_form(), modBlockedLog\getDesc(), Form\getSelectConditionsPaiements(), Form\getSelectInvoiceSubtype(), main_area(), FormCompany\select_civility(), FormCompany\select_state(), FormResource\select_state(), FormActions\select_type_actions(), Form\select_type_fees(), FormSocialContrib\select_type_socialcontrib(), Form\select_types_paiements(), FormResource\select_types_resource(), Form\selectAvailabilityDelay(), Form\selectCurrency(), Form\selectExpenseCategories(), FormTicket\selectGroupTickets(), Form\selectInputReason(), FormProjets\selectOpportunityStatus(), FormTicket\selectSeveritiesTickets(), Form\selectShippingMethod(), Form\selectTransportMode(), FormWebsite\selectTypeOfContainer(), FormTicket\selectTypesTickets(), and FormTicket\showMessageForm().

◆ isASecretKey()

isASecretKey ( $keyname)

Return if string has a name dedicated to store a secret.

Parameters
string$keynameName of key to test
Returns
boolean True if key is used to store a secret

Definition at line 699 of file functions.lib.php.

Referenced by CommonDocGenerator\get_substitutionarray_other(), Setup\getConf(), and Setup\getConfs().

◆ isDolTms()

isDolTms ( $timestamp)

isDolTms check if a timestamp is valid.

Parameters
int | string | null$timestamptimestamp to check
Returns
bool

Definition at line 565 of file functions.lib.php.

Referenced by Propal\create(), Ticket\create(), Project\get_element_list(), Don\getKanbanView(), ExpenseReport\getKanbanView(), Loan\getKanbanView(), Loan\getNomUrl(), and Productlot\getTooltipContentArray().

◆ isModEnabled()

isModEnabled ( $module)

Is Dolibarr module enabled.

Parameters
string$moduleModule name to check
Returns
boolean True if module is enabled

Definition at line 489 of file functions.lib.php.

Referenced by ActionCommReminder\__construct(), AdherentType\__construct(), Asset\__construct(), AssetModel\__construct(), Availabilities\__construct(), BOM\__construct(), BOMLine\__construct(), BookkeepingTemplate\__construct(), box_actions\__construct(), box_actions_future\__construct(), box_activity\__construct(), box_graph_product_distribution\__construct(), box_members_by_tags\__construct(), box_members_by_type\__construct(), box_members_last_modified\__construct(), box_members_last_subscriptions\__construct(), box_members_subscriptions_by_year\__construct(), box_produits\__construct(), box_produits_alerte_stock\__construct(), Calendar\__construct(), CEmailTemplate\__construct(), CompanyPaymentMode\__construct(), ConferenceOrBooth\__construct(), ConferenceOrBoothAttendee\__construct(), Contact\__construct(), CTicketCategory\__construct(), DefaultValues\__construct(), DolEditor\__construct(), DolibarrDebugBar\__construct(), EmailCollector\__construct(), EmailCollectorAction\__construct(), EmailCollectorFilter\__construct(), EmailSenderProfile\__construct(), Evaluation\__construct(), EvaluationLine\__construct(), FormTicket\__construct(), Hook\__construct(), IntracommReport\__construct(), Inventory\__construct(), Job\__construct(), KnowledgeRecord\__construct(), Memo\__construct(), Mo\__construct(), modAdherent\__construct(), modAgenda\__construct(), modAsset\__construct(), modBanque\__construct(), modBlockedLog\__construct(), modCategorie\__construct(), modCommande\__construct(), modDataPolicy\__construct(), modFacture\__construct(), modMyModule\__construct(), modProduct\__construct(), modProjet\__construct(), modPropale\__construct(), modQuickMemo\__construct(), modService\__construct(), modSociete\__construct(), modStock\__construct(), modSupplierInvoice\__construct(), modSupplierOrder\__construct(), modTakePos\__construct(), modTicket\__construct(), modUser\__construct(), modWebPortal\__construct(), MoLine\__construct(), MyObject\__construct(), PartnershipType\__construct(), Position\__construct(), printing_printgcp\__construct(), ProductAttribute\__construct(), ProductAttributeValue\__construct(), ProductFournisseurPrice\__construct(), RecruitmentCandidature\__construct(), RecruitmentJobPosition\__construct(), Skill\__construct(), Skilldet\__construct(), SkillRank\__construct(), SocieteAccount\__construct(), StockTransfer\__construct(), StockTransferLine\__construct(), Target\__construct(), TimeSpent\__construct(), TriggerHistory\__construct(), Workstation\__construct(), DolibarrApiAccess\__isAllowed(), EmailTemplates\_checkAccessRights(), EventAttendees\_checkAccessRights(), Users\_cleanObjectDatas(), MouvementStock\_create(), Thirdparties\_fetch(), pdf_espadon\_pagehead(), pdf_rouget\_pagehead(), pdf_squille\_pagehead(), pdf_standard_salary\_pagehead(), pdf_eagle\_tableau(), pdf_aurore\_tableau_tot(), pdf_azur\_tableau_tot(), pdf_canelle\_tableau_tot(), pdf_cornas\_tableau_tot(), pdf_einstein\_tableau_tot(), pdf_muscadet\_tableau_tot(), pdf_vinci\_tableau_tot(), pdf_zenith\_tableau_tot(), pdf_canelle\_tableau_versements(), Salaries\_validatepayments(), MemberCardController\action(), PartnershipCardController\action(), PropalListController\action(), actions_prepare_head(), Adherent\add_to_abo(), MailmanSpip\add_to_mailman(), CommandeFournisseur\addline(), Expedition\addline(), FactureFournisseur\addline(), Reception\addline(), SupplierProposal\addline(), addMailingEventTypeSQL(), ActionsQuickMemo\addMoreActionsButtons(), ActionsStripeconnect\addMoreActionsButtons(), ExpenseReports\addPayment(), Invoices\addPayment(), Localtax\addPayment(), Salaries\addPayment(), SupplierInvoices\addPayment(), Tva\addPayment(), Invoices\addPaymentDistributed(), Paiement\addPaymentToBank(), PaymentDonation\addPaymentToBank(), PaymentExpenseReport\addPaymentToBank(), PaymentLoan\addPaymentToBank(), PaymentSalary\addPaymentToBank(), PaymentSocialContribution\addPaymentToBank(), PaymentVAT\addPaymentToBank(), CommandeFournisseur\approve(), ActionsAdherentCardCommon\assign_values(), ActionsCardCommon\assign_values(), ActionsContactCardCommon\assign_values(), pdf_eagle\atLeastOneBatch(), CommandeFournisseur\calcAndSetStatusDispatch(), BOM\calculateCosts(), Commande\cancel(), Mo\cancelConsumedAndProducedLines(), check_user_password_dolibarr(), check_user_password_ldap(), check_user_password_openid_connect(), FicheinterListController\checkAccess(), InvoiceListController\checkAccess(), MemberCardController\checkAccess(), OrderListController\checkAccess(), PartnershipCardController\checkAccess(), PropalListController\checkAccess(), TicketListController\checkAccess(), CommonObject\checkActiveProductInLines(), checkUserAccessToObject(), Ticket\close(), commande_prepare_head(), ModeleImports\commonImportInsert(), completeFileArrayWithDatabaseInfo(), Form\constructProductListOption(), contact_prepare_head(), contract_prepare_head(), DolEditor\Create(), Facture\create(), FactureFournisseur\create(), Loan\create(), PaymentVarious\create(), Societe\create_individual(), Commande\createFromProposal(), createNewDictionnary(), SupplierProposal\createPriceFournisseur(), createProductOrService(), FactureRec\createRecurringInvoices(), Adherent\del_to_abo(), MailmanSpip\del_to_mailman(), Categorie\delete(), Expedition\delete(), ExpeditionLigne\delete(), Facture\delete(), Product\delete(), Project\delete(), DolibarrModules\delete_boxes(), delivery_prepare_head(), CommandeFournisseur\dispatchProduct(), FormMargin\displayMarginInfos(), dol_check_secure_access_document(), dol_convertToWord(), dol_getcache(), dol_setcache(), dolGetElementUrl(), pdf_octopus\drawPaymentsTable(), pdf_sponge\drawPaymentsTable(), pdf_cyan\drawTotalTable(), pdf_eratosthene\drawTotalTable(), pdf_octopus\drawTotalTable(), pdf_sponge\drawTotalTable(), ecm_prepare_dasboard_head(), Form\editInPlace(), email_admin_prepare_head(), HookManager\executeHooks(), expedition_prepare_head(), facture_prepare_head(), facturefourn_prepare_head(), Expedition\fetch(), Product\fetch(), Societe\fetch(), User\fetch(), Expedition\fetch_lines(), Reception\fetch_lines(), ProductFournisseur\fetch_product_fournisseur_price(), CommonObject\fetchObjectLinked(), Holiday\fetchUsers(), fichinter_prepare_head(), ProductFournisseur\find_min_price_product_fournisseur(), form_constantes(), mailing_advthirdparties\formFilter(), mailing_partnership\formFilter(), mailing_thirdparties\formFilter(), ActionsStripeconnect\formObjectOptions(), FormSetupItem\generateInputField(), FormSetupItem\generateInputFieldHtml(), Contacts\get(), Product\get_buyprice(), FormMail\get_form(), get_left_menu_accountancy(), get_left_menu_bank(), get_left_menu_billing(), get_left_menu_commercial(), get_left_menu_home(), get_left_menu_hrm(), get_left_menu_members(), get_left_menu_mrp(), get_left_menu_products(), get_left_menu_projects(), get_left_menu_thridparties(), get_left_menu_tools(), AccountingJournal\getAssetData(), Contacts\getByEmail(), html_generic\getContents(), getCustomerInvoiceDraftTable(), getCustomerInvoiceUnpaidOpenTable(), getCustomerOrderPieChart(), getCustomerProposalPieChart(), AccountingJournal\getData(), DataPolicyCron\getDataPolicies(), FormFile\getDocumentsLink(), FormWebPortal\getDocumentsLink(), getDraftSupplierTable(), User\getKanbanView(), getListOfGroups(), InterfaceNotification\getListOfManagedEvents(), Setup\getListOfsocialNetworks(), FormSetupItem\getNameText(), ChargeSociales\getNomUrl(), Commande\getNomUrl(), ProductFournisseur\getNomUrl(), getNumberInvoicesPieChart(), User\getOnlineVirtualCardUrl(), getPublicJobPositionUrl(), getPurchaseInvoiceUnpaidOpenTable(), Societe\getSalesRepresentatives(), Commande\getShippableInfos(), getSupportedOauth2Array(), Account\getTooltipContentArray(), ActionComm\getTooltipContentArray(), Adherent\getTooltipContentArray(), Entrepot\getTooltipContentArray(), KnowledgeRecord\getTooltipContentArray(), Product\getTooltipContentArray(), Societe\getTooltipContentArray(), Ticket\getTooltipContentArray(), Interfaces\getTriggersList(), Societe\getTypeUrl(), CommonInvoice\getVentilExportCompta(), Paiement\getWay(), PaiementFourn\getWay(), group_prepare_head(), User\hasRight(), Product\hasVariants(), AgendaEvents\index(), Contacts\index(), EventAttendees\index(), MyModuleApi\index(), Thirdparties\index(), DocumentController\init(), modCategorie\init(), modProductBatch\init(), HookManager\initHooks(), Form\inputHtml(), FormWebPortal\inputHtml(), invoice_rec_prepare_head(), isALNEQualifiedVersion(), isALNERunningVersion(), isBlockedLogUsed(), Product\isVariant(), ldap_prepare_head(), Product\LibStatut(), ProductFournisseur\list_product_fournisseur_price(), InfoBox\listBoxes(), CActionComm\liste_array(), CommonObject\listeTypeContacts(), UserGroup\listGroupsForUser(), FicheinterListController\listSetArrayFields(), TicketListController\listSetArrayFields(), UserGroup\listUsersForGroup(), CommandeFournisseur\Livraison(), MouvementStock\livraison(), ActionsQuickMemo\llxFooter(), Translate\load(), Ticket\load_board(), Product\load_stats_inproduction(), Product\load_virtual_stock(), box_activity\loadBox(), box_dolibarr_state_board\loadBox(), box_graph_product_distribution\loadBox(), box_produits\loadBox(), box_produits_alerte_stock\loadBox(), Translate\loadFromDatabase(), User\loadRights(), User\loadStateBoard(), BlockedLog\loadTrackedEvents(), member_prepare_head(), member_type_prepare_head(), migrate_modeles(), migrate_reload_modules(), ordersupplier_prepare_head(), pdf_admin_prepare_head(), pdf_getlinedesc(), pdf_getlinetotalexcltax(), pdf_getlinetotalwithtax(), pdf_getlineupexcltax(), pdfWriteAlreadyPaid(), pdfWriteBlockedLogSignature(), pdfWriteVATArray(), Contacts\post(), Thirdparties\post(), print_actions_filter(), print_eldy_menu(), print_left_auguria_menu(), printDropdownQuickadd(), pdf_standard_expensereport\printLine(), CommonObject\printObjectLines(), CommonObject\printOriginLinesList(), product_prepare_head(), project_prepare_head(), propal_prepare_head(), Utils\purgeFiles(), Contacts\put(), Thirdparties\put(), MouvementStock\reception(), Expedition\reOpen(), Reception\reOpen(), resource_prepare_head(), Cronjob\run_jobs(), Interfaces\run_triggers(), InterfaceActionsAuto\runTrigger(), InterfaceEventOrganization\runTrigger(), InterfaceMyModuleTriggers\runTrigger(), InterfaceNotification\runTrigger(), InterfaceWebhookTriggers\runTrigger(), Form\select_dolgroups(), Form\select_dolusers(), Form\select_product_fourn_price(), Form\select_produits(), Form\select_produits_fournisseurs_list(), Form\select_produits_list(), Form\select_thirdparty_list(), Form\select_type_of_lines(), FormCompany\selectProspectCustomerType(), User\send_password(), ActionComm\sendEmailsReminder(), Facture\sendEmailsRemindersOnInvoiceDueDate(), FactureFournisseur\sendEmailsRemindersOnSupplierInvoiceDueDate(), Adherent\sendReminderForExpiredSubscription(), ActionComm\sendSmsReminder(), dolReceiptPrinter\sendToPrinter(), FormListWebPortal\setArrayFields(), FormBarCode\setBarcodeEncoder(), Expedition\setClosed(), Reception\setClosed(), Commande\setDraft(), Facture\setDraft(), FactureFournisseur\setDraft(), Reception\setDraft(), Users\setGroup(), Thirdparties\setThirdpartyPriceLevel(), Conf\setValues(), shipping_prepare_head(), show_actions_done(), show_contacts(), show_contacts_projects(), show_projects(), show_stats_for_batch(), show_stats_for_company(), FormActions\showactions(), FormFile\showdocuments(), CommonObject\showInputField(), ExtraFields\showInputField(), Form\showLinkedObjectBlock(), ActionsMyModule\showLinkToObjectBlock(), Form\showLinkToObjectBlock(), FormTicket\showMessageForm(), Form\showphoto(), societe_prepare_head(), Adherent\subscriptionComplementaryActions(), pdf_octopus\tableFirstPage(), pdf_standard_expensereport\tablePayments(), ticket_prepare_head(), top_htmlhead(), top_menu(), top_menu_ai(), top_menu_bookmark(), top_menu_user(), CompanyBankAccount\update(), ExpeditionLigne\update(), Product\update(), Societe\update(), ProductFournisseur\update_buyprice(), CommonObject\update_price(), SupplierProposal\updateline(), SupplierProposal\updateOrCreatePriceFournisseur(), updateProductOrService(), user_prepare_head(), Commande\valid(), Expedition\valid(), Reception\valid(), Facture\validate(), FactureFournisseur\validate(), Inventory\validate(), doc_generic_project_odt\write_file(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_beluga\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_muscadet\write_file(), pdf_octopus\write_file(), pdf_paiement\write_file(), pdf_rouget\write_file(), pdf_sponge\write_file(), pdf_squille\write_file(), pdf_standard_asset\write_file(), pdf_standard_myobject\write_file(), pdf_storm\write_file(), pdf_typhon\write_file(), and pdf_zenith\write_file().

◆ isOnlyOneLocalTax()

isOnlyOneLocalTax ( $local)

Return true if LocalTax (1 or 2) is unique.

Example: If localtax1 is 5 on line with highest common vat rate, return true Example: If localtax1 is 5:8:15 on line with highest common vat rate, return false

Parameters
int$localLocal tax to test (1 or 2)
Returns
boolean True if LocalTax have multiple values, False if not

Definition at line 8162 of file functions.lib.php.

◆ isStringVarMatching()

isStringVarMatching ( $var,
$regextext,
$matchrule = 1 )

Check if a variable with name $var start with $regextext.

Can be used to forge dol_eval() conditions.

Parameters
string$varVariable name ('mainmenu' or 'leftmenu', ...)
string$regextextText that must be a valid regex string
int<0,1>$matchrule 1=Test if start with, 0=Test if equal
Returns
boolean|string True or False, text if bad usage.

Definition at line 11883 of file functions.lib.php.

◆ isValidEmail()

isValidEmail ( $address,
$acceptsupervisorkey = 0,
$acceptuserkey = 0 )

Return true if email syntax is ok.

Parameters
string$addressemail (Ex: "toto@example.com". Long form "John Do <johndo@example.com>" will be false)
int$acceptsupervisorkeyIf 1, the special string 'SUPERVISOREMAIL' is also accepted as valid
int$acceptuserkeyIf 1, the special string 'USER_EMAIL' is also accepted as valid
Returns
boolean true if email syntax is OK, false if KO or empty string
See also
isValidMXRecord()

Definition at line 5377 of file functions.lib.php.

Referenced by mailing_xinputfile\add_to_target(), mailing_xinputuser\add_to_target(), ConferenceOrBoothAttendee\create(), User\create(), dolObfuscateEmail(), Notify\getNotificationsArray(), Holiday\sendPreviousMonthHRInformations(), Adherent\update(), User\update(), Facture\validate(), FactureFournisseur\validate(), and Societe\verify().

◆ isValidMXRecord()

isValidMXRecord ( $domain)

Return if the domain name has a valid MX record.

WARNING: This need function idn_to_ascii, checkdnsrr and getmxrr

Parameters
string$domainDomain name (Ex: "yahoo.com", "yhaoo.com", "dolibarr.fr")
Returns
int -1 if error (function not available), 0=Not valid, 1=Valid
See also
isValidEmail() @suppress PhanDeprecatedFunctionInternal Error in Phan plugins incorrectly tags some functions here

Definition at line 5401 of file functions.lib.php.

Referenced by isValidMailDomain().

◆ isValidPhone()

isValidPhone ( $phone)

Return true if phone number syntax is ok TODO Decide what to do with this.

Parameters
string$phonephone (Ex: "0601010101")
Returns
boolean true if phone syntax is OK, false if KO or empty string

Definition at line 5433 of file functions.lib.php.

◆ load_fiche_titre()

load_fiche_titre ( $title,
$morehtmlright = '',
$picto = 'generic',
$pictoisfullpath = 0,
$id = '',
$morecssontable = '',
$morehtmlcenter = '',
$morecssonpicto = 'widthpictotitle' )

Load a title with picto.

Parameters
string$titleTitle to show (HTML sanitized content). Can be a string with a
as a second string shown under the fmain title.
string$morehtmlrightAdded message to show on right
string$pictoIcon to use before title (should be a 32x32 transparent png file)
int<0,1>$pictoisfullpath 1=Icon name is a full absolute url of image
string$idTo force an id on html objects
string$morecssontableMore css on table
string$morehtmlcenterAdded message to show on center
string$morecssonpictoMore css on picto
Returns
string
See also
print_barre_liste()

Definition at line 7292 of file functions.lib.php.

Referenced by ActionsCardCompany\assign_values(), ActionsCardIndividual\assign_values(), displayPositionCard(), FormFile\form_attach_new_file(), Setup\getCheckIntegrity(), FormFile\list_of_autoecmfiles(), FormFile\list_of_documents(), FormFile\listOfLinks(), show_contacts(), show_contacts_projects(), show_projects(), show_subsidiaries(), FormActions\showactions(), FormFile\showdocuments(), and Form\showLinkedObjectBlock().

◆ make_substitutions()

make_substitutions ( $text,
$substitutionarray,
$outputlangs = null,
$converttextinhtmlifnecessary = 0 )

Make substitution into a text string, replacing keys with vals from $substitutionarray (oldval=>newval), and texts like __(TranslationKey|langfile)__, [CONSTANTKEY] or [CONSTANTKEY|urlencode] are also replaced.

Example of usage: $substitutionarray = getCommonSubstitutionArray($langs, 0, null, $thirdparty); complete_substitutions_array($substitutionarray, $langs, $thirdparty); $mesg = make_substitutions($mesg, $substitutionarray, $langs);

Parameters
string$textSource string in which we must do substitution
array<string,null|string|float|int>$substitutionarray Array with key->val to substitute. Example: array('MYKEY' => 'MyVal', ...)
?Translate$outputlangsOutput language
int<0,1>$converttextinhtmlifnecessary 0=Convert only value into HTML if text is already in HTML 1=Will also convert initial $text into HTML if we try to insert one value that is HTML
Returns
string Output string after substitutions
See also
complete_substitutions_array(), getCommonSubstitutionArray()

Definition at line 11003 of file functions.lib.php.

Referenced by BordereauChequeBlochet\_pagefoot(), Facture\create(), FactureFournisseur\create(), FactureRec\createRecurringInvoices(), PartnershipUtils\doCancelStatusOfMemberPartnership(), dolReplaceInFile(), PartnershipUtils\doWarningOfPartnershipIfDolibarrBacklinkNotfound(), FormMail\get_form(), FormWebsite\getContentPageTemplate(), getHtmlOfLayout(), Adherent\makeSubstitution(), Menubase\menuLoad(), EmailCollector\overwritePropertiesOfObject(), pdf_pagefoot(), pdf_watermark(), print_auguria_menu(), print_eldy_menu(), print_left_auguria_menu(), Notify\send(), ActionComm\sendEmailsReminder(), Facture\sendEmailsRemindersOnInvoiceDueDate(), FactureFournisseur\sendEmailsRemindersOnSupplierInvoiceDueDate(), Holiday\sendPreviousMonthHRInformations(), Adherent\sendReminderForExpiredSubscription(), ActionComm\sendSmsReminder(), FormSms\show_form(), MenuManager\showmenu(), FormTicket\showMessageForm(), pdf_octopus\tableFirstPage(), doc_generic_asset_odt\write_file(), doc_generic_product_odt\write_file(), doc_generic_stock_odt\write_file(), doc_generic_usergroup_odt\write_file(), html_cerfafr\write_file(), pdf_aurore\write_file(), pdf_azur\write_file(), pdf_baleine\write_file(), pdf_beluga\write_file(), pdf_canelle\write_file(), pdf_cornas\write_file(), pdf_cyan\write_file(), pdf_eagle_proforma\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_espadon\write_file(), pdf_soleil\write_file(), pdf_sponge\write_file(), pdf_standard\write_file(), pdf_standard_asset\write_file(), pdf_standard_expensereport\write_file(), pdf_standard_member\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_myobject\write_file(), pdf_standard_recruitmentjobposition\write_file(), pdf_standard_stock\write_file(), pdf_strato\write_file(), pdf_timespent\write_file(), pdf_vinci\write_file(), and pdf_zenith\write_file().

◆ natural_search()

natural_search ( $fields,
$value,
$mode = 0,
$nofirstand = 0,
$sqltoadd = '' )

Generate natural SQL search string for a criteria (this criteria can be tested on one or several fields)

Parameters
string | string[]$fieldsString or array of strings, filled with the name of all fields in the SQL query we must check (combined with a OR). Example: array("p.field1","p.field2")
string$valueThe value to look for. If param $mode is 0, can contains several keywords separated with a space or | like "keyword1 keyword2" = We want record field like keyword1 AND field like keyword2 or like "keyword1|keyword2" = We want record field like keyword1 OR field like keyword2 If param $mode is 1, can contains an operator <, > or = like "<10" or ">=100.5 < -1000" If param $mode is 2 or -2, can contains a list of int id separated by comma like "1,3,4" If param $mode is 3 or -3, can contains a list of string separated by comma like "a,b,c".
integer$mode0=value is list of keyword strings, 1=value is a numeric test (Example ">5.5 <10"), 2=value is a list of ID separated with comma (Example '1,3,4'), -2 is for exclude list, 3=value is list of string separated with comma (Example 'text 1,text 2'), -3 if for exclude list, 4=value is a list of ID separated with comma (Example '2,7') to be used to search inside a string '1,2,3,4'
integer$nofirstand1=Do not output the first 'AND'
string$sqltoaddAdditional SQL to append at the end of the generated SQL. Usually it is ''.
Returns
string $res The statement to append to the SQL query
See also
dolSqlDateFilter()
forgeSQLFromUniversalSearchCriteria()

Definition at line 13456 of file functions.lib.php.

Referenced by addOtherFilterSQL(), BookKeeping\fetchAll(), BookKeeping\fetchAllBalance(), BookKeeping\fetchAllByAccount(), BlockedLog\getLog(), Task\getTasksArray(), FormProjets\select_projects_list(), Form\selectForFormsList(), FormListWebPortal\setSqlRequest(), show_contacts(), DoubleField\sqlFilterSearchField(), DurationField\sqlFilterSearchField(), EmailField\sqlFilterSearchField(), HtmlField\sqlFilterSearchField(), IconField\sqlFilterSearchField(), IntField\sqlFilterSearchField(), IpField\sqlFilterSearchField(), LinkField\sqlFilterSearchField(), PasswordField\sqlFilterSearchField(), PhoneField\sqlFilterSearchField(), PricecyField\sqlFilterSearchField(), PriceField\sqlFilterSearchField(), RealField\sqlFilterSearchField(), StarsField\sqlFilterSearchField(), TextField\sqlFilterSearchField(), UrlField\sqlFilterSearchField(), VarcharField\sqlFilterSearchField(), and pdf_standard_movementstock\write_file().

◆ num2Alpha()

num2Alpha ( $n)

Return a numeric value into an Excel like column number.

So 0 return 'A', 1 returns 'B'..., 26 return 'AA'

Parameters
int | string$nNumeric value
Returns
string Column in Excel format

Definition at line 711 of file functions.lib.php.

Referenced by ModeleImports\commonImportInsert(), and show_elem().

◆ picto_from_langcode()

picto_from_langcode ( $codelang,
$moreatt = '',
$notitlealt = 0 )

Return img flag of country for a language code or country code.

Parameters
string$codelangLanguage code ('en_IN', 'fr_CA', ...) or ISO Country code on 2 characters in uppercase ('IN', 'FR')
string$moreattAdd more attribute on img tag (For example 'style="float: right"' or 'class="saturatemedium"')
int<0,1>$notitlealt No title alt
Returns
string HTML img string with flag.

Definition at line 12596 of file functions.lib.php.

Referenced by ActionsAdherentCardCommon\assign_values(), ActionsCardCommon\assign_values(), ActionsContactCardCommon\assign_values(), FormMail\get_form(), WebPortalMember\getBannerAddressForWebPortal(), KnowledgeRecord\getTooltipContentArray(), User\getTooltipContentArray(), box_last_knowledgerecord\loadBox(), box_last_modified_knowledgerecord\loadBox(), FormAdmin\select_language(), Form\selectPhoneCode(), Form\showrefnav(), top_menu_user(), and Form\widgetForTranslation().

◆ picto_required()

picto_required ( )

Return picto saying a field is required.

Returns
string String with the picto mandatory

Definition at line 9025 of file functions.lib.php.

◆ price()

price ( $amount,
$form = 0,
$outlangs = '',
$trunc = 1,
$rounding = -1,
$forcerounding = -1,
$currency_code = '' )

Function to format a value into an amount for visual output Function used into PDF and HTML pages.

Parameters
int | float | string | null$amountAmount value to format
int<0,1>$form Type of formatting: 1=HTML, 0=no formatting (no by default)
Translate | string | null$outlangsObject langs for output. '' use default lang. 'none' use international separators.
int$trunc1=Truncate if there is more decimals than MAIN_MAX_DECIMALS_SHOWN (default), 0=Does not truncate. Deprecated because amount are rounded (to unit or total amount accuracy) before being inserted into database or after a computation, so this parameter should be useless.
int<-1,max>$rounding MINIMUM number of decimal to show: 0=no change, -1=we use min(getDolGlobalString('MAIN_MAX_DECIMALS_UNIT'), getDolGlobalString('MAIN_MAX_DECIMALS_TOT'))
''|'MU'|'MT'|'MS'|'CU'|'CT'|int<-2,max>$forcerounding MAXIMUM number of decimal to forcerounding decimal: -1=no change, -2=keep non zero part, 'MU' or 'MT' or a numeric to round to MU or MT or to a given number of decimal
string$currency_codeTo add currency symbol (''=add nothing, 'auto'=Use default currency, 'XXX'=add currency symbols for XXX currency)
Returns
string String with formatted amount
See also
price2num() Revert function of price

Definition at line 7693 of file functions.lib.php.

Referenced by MouvementStock\_create(), Product\_log_price(), pdf_standard_movementstock\_pagehead(), pdf_standard_stock\_pagehead(), RejetPrelevement\_send_email(), pdf_sponge\_tableau(), pdf_standard_supplierpayment\_tableau_cheque(), pdf_aurore\_tableau_tot(), pdf_azur\_tableau_tot(), pdf_canelle\_tableau_tot(), pdf_cornas\_tableau_tot(), pdf_eagle\_tableau_tot(), pdf_einstein\_tableau_tot(), pdf_espadon\_tableau_tot(), pdf_muscadet\_tableau_tot(), pdf_rouget\_tableau_tot(), pdf_squille\_tableau_tot(), pdf_vinci\_tableau_tot(), pdf_zenith\_tableau_tot(), pdf_canelle\_tableau_versements(), pdf_balance\addTotalLine(), pdf_bookkeeping\addTotalLine(), pdf_ledger\addTotalLine(), BordereauChequeBlochet\Body(), pdf_paiement\Body(), pdf_standard_salary\body(), CommonInvoice\buildSwitzerlandQRString(), ExpenseReport\checkRules(), Form\constructProductListOption(), Product\create(), ProductCustomerPrice\create(), Facture\createDepositFromOrigin(), Propal\createFromClone(), ProductFournisseur\display_price_product_fournisseur(), FormMargin\displayMarginInfos(), pdf_octopus\drawInfoTable(), pdf_sponge\drawInfoTable(), pdf_octopus\drawPaymentsTable(), pdf_sponge\drawPaymentsTable(), pdf_cyan\drawTotalTable(), pdf_eagle_proforma\drawTotalTable(), pdf_eratosthene\drawTotalTable(), pdf_octopus\drawTotalTable(), pdf_sponge\drawTotalTable(), Form\editfieldval(), Form\editInPlace(), AccountancyExport\exportAgiris(), AccountancyExport\exportBob50(), AccountancyExport\exportCharlemagne(), AccountancyExport\exportCoala(), AccountancyExport\exportCogilog(), AccountancyExport\exportiSuiteExpert(), AccountancyExport\exportLDCompta(), AccountancyExport\exportLDCompta10(), AccountancyExport\exportOpenConcerto(), FactureLigneRec\fetch(), MouvementStock\fetch(), OrderLine\fetch(), Product\fetch(), ProductCustomerPrice\fetch(), PropaleLigne\fetch(), ExpenseReport\fetch_line_by_project(), CommonDocGenerator\fill_substitutionarray_with_extrafields(), Form\form_multicurrency_rate(), Form\form_remise_dispo(), FormProjets\formOpportunityStatus(), CommonDocGenerator\get_substitutionarray_lines(), doc_generic_project_odt\get_substitutionarray_project_reference(), doc_generic_task_odt\get_substitutionarray_project_reference(), CommonDocGenerator\get_substitutionarray_shipment(), CommonDocGenerator\get_substitutionarray_thirdparty(), ProjectStats\getAllProjectByStatus(), AccountingJournal\getAssetData(), html_generic\getContents(), getCustomerInvoiceUnpaidOpenTable(), AccountingJournal\getDiscountCustomer(), AccountingJournal\getDiscountSupplier(), ToolReports\getFinancialReport(), ToolReports\getInventoryReport(), ToolInvoices\getInvoice(), BonPrelevement\getKanbanView(), CommandeFournisseur\getKanbanView(), Facture\getKanbanView(), FactureFournisseur\getKanbanView(), Loan\getKanbanView(), Localtax\getKanbanView(), PaymentExpenseReport\getKanbanView(), PaymentSalary\getKanbanView(), PaymentVarious\getKanbanView(), Product\getKanbanView(), Propal\getKanbanView(), RemiseCheque\getKanbanView(), SupplierProposal\getKanbanView(), Tva\getKanbanView(), WebPortalOrder\getKanbanView(), BonPrelevement\getNomUrl(), Paiement\getNomUrl(), PaiementFourn\getNomUrl(), getPurchaseInvoiceUnpaidOpenTable(), ToolReports\getPurchaseReport(), AssetDepreciationOptions\getRate(), ToolReports\getSalesReport(), Product\getSellPrice(), ToolReports\getThirdpartyTransactions(), Commande\getTooltipContentArray(), CommandeFournisseur\getTooltipContentArray(), Contrat\getTooltipContentArray(), ExpenseReport\getTooltipContentArray(), Facture\getTooltipContentArray(), FactureFournisseur\getTooltipContentArray(), PaymentSalary\getTooltipContentArray(), Product\getTooltipContentArray(), Propal\getTooltipContentArray(), SupplierProposal\getTooltipContentArray(), BordereauChequeBlochet\Header(), ProductCustomerPrice\initAsSpecimen(), OrderLine\insert(), box_accountancy_last_manual_entries\loadBox(), box_activity\loadBox(), box_commandes\loadBox(), box_comptes\loadBox(), box_factures\loadBox(), box_factures_fourn\loadBox(), box_factures_fourn_imp\loadBox(), box_factures_imp\loadBox(), box_funnel_of_prospection\loadBox(), box_members_last_subscriptions\loadBox(), box_members_subscriptions_by_year\loadBox(), box_produits\loadBox(), box_produits_alerte_stock\loadBox(), box_project_opportunities\loadBox(), box_propales\loadBox(), box_supplier_orders\loadBox(), box_supplier_orders_awaiting_reception\loadBox(), loanCalcMonthlyPayment(), Form\makeAddLinkToObject(), ToolInvoices\payInvoice(), pdf_getlinetotalexcltax(), pdf_getlinetotalwithtax(), pdf_getlineupexcltax(), pdf_getlineupwithtax(), pdf_pagefoot(), pdfWriteAlreadyPaid(), pdfWriteVATArray(), print_projecttasks_array(), DoubleField\printInputField(), PricecyField\printInputField(), PriceField\printInputField(), RealField\printInputField(), FormAccounting\printJournalLine(), pdf_standard_expensereport\printLine(), CommonObject\printOriginLine(), DoubleField\printOutputField(), PricecyField\printOutputField(), PriceField\printOutputField(), RealField\printOutputField(), ToolProducts\search(), ToolInvoices\searchInvoices(), Form\select_product_fourn_price(), Form\select_produits_fournisseurs_list(), Form\select_remises(), sendEmailToRepresentative(), sendMailRepresentativeUnpaid(), dolReceiptPrinter\sendToPrinter(), BonPrelevement\set_infotrans(), FormAI\setSubstitFromObject(), show_contacts_projects(), show_projects(), show_stats_for_company(), CommonObject\showInputField(), ExtraFields\showInputField(), FormWebPortal\showInputFieldForObject(), ExtraFields\showOutputField(), pdf_octopus\tableFirstPage(), pdf_standard_expensereport\tablePayments(), FactureLigneRec\update(), OrderLine\update(), ProductCustomerPrice\update(), PropaleLigne\update(), Lettering\updateGeneralMatching(), Lettering\updateLettering(), Product\updatePrice(), html_cerfafr\write_file(), pdf_balance\write_file(), pdf_beluga\write_file(), pdf_bookkeeping\write_file(), pdf_eagle\write_file(), pdf_eagle_proforma\write_file(), pdf_espadon\write_file(), pdf_ledger\write_file(), pdf_octopus\write_file(), pdf_paiement\write_file(), pdf_rouget\write_file(), pdf_squille\write_file(), pdf_standard_expensereport\write_file(), pdf_standard_stock\write_file(), pdf_standard_supplierpayment\write_file(), and pdf_strato\write_file().

◆ price2num()

price2num ( $amount,
$rounding = '',
$option = 0 )

Function that return a number with universal decimal format (decimal separator is '.

') from an amount typed by a user. Function to use on each input amount before any numeric test or database insert. A better name for this function should be roundtext2num().

Parameters
int | float | string | null$amountAmount to convert/clean or round
''|'MU'|'MT'|'MS'|'CU'|'CT'|int<0,max>$rounding ''=No rounding 'MU'=Round to Max unit price (MAIN_MAX_DECIMALS_UNIT) 'MT'=Round to Max for totals with Tax (MAIN_MAX_DECIMALS_TOT) 'MS'=Round to Max for stock quantity (MAIN_MAX_DECIMALS_STOCK) 'CU'=Round to Max unit price of foreign currency accuracy 'CT'=Round to Max for totals with Tax of foreign currency accuracy Numeric = Nb of digits for rounding (For example 2 for a percentage)
int<0,2>$option Put 1 if you know that content is already universal format number (so no correction on decimal will be done) Put 2 if you know that number is a user input (so we know we have to fix decimal separator). Default 0 if unknown.
Returns
string Amount with universal numeric format (Example: '99.99999'), or error message. If conversion fails to return a numeric, it returns:
  • text unchanged or partial if ($rounding = ''): price2num('W9ç', '', 0) => '9ç', price2num('W9ç', '', 1) => 'W9ç', price2num('W9ç', '', 2) => '9ç'
  • '0' if ($rounding is defined): price2num('W9ç', 'MT', 0) => '9', price2num('W9ç', 'MT', 1) => '0', price2num('W9ç', 'MT', 2) => '9' Note: The best way to guarantee a numeric value is to add a cast (float) before the price2num(). If amount is null or '', it returns '' if $rounding = '', it returns '0' if $rounding is defined.
See also
price() Opposite function of price2num

Definition at line 7824 of file functions.lib.php.

Referenced by MouvementStock\_create(), Invoices\_fetch(), Thirdparties\_fetch(), Product\_log_price(), pdf_standard_movementstock\_pagehead(), pdf_standard_stock\_pagehead(), pdf_standard_supplierpayment\_tableau_cheque(), pdf_azur\_tableau_tot(), pdf_canelle\_tableau_tot(), pdf_cornas\_tableau_tot(), pdf_einstein\_tableau_tot(), pdf_muscadet\_tableau_tot(), pdf_vinci\_tableau_tot(), pdf_zenith\_tableau_tot(), Product\add_fournisseur(), Product\add_sousproduit(), BOM\addLine(), BonPrelevement\addline(), Commande\addline(), CommandeFournisseur\addline(), Contrat\addline(), ExpenseReport\addline(), Facture\addline(), FactureFournisseur\addline(), FactureFournisseurRec\addline(), FactureRec\addline(), Propal\addline(), SupplierProposal\addline(), Expedition\addlinefree(), Reception\addlinefree(), FichinterRec\addLineRec(), Holiday\addLogCP(), Invoices\addPayment(), Localtax\addPayment(), SupplierInvoices\addPayment(), Tva\addPayment(), Invoices\addPaymentDistributed(), MultiCurrency\addRate(), pdf_balance\addTotalLine(), pdf_bookkeeping\addTotalLine(), pdf_ledger\addTotalLine(), Products\addVariant(), Products\addVariantByProductRef(), CommandeFournisseur\approve(), Lettering\bookkeepingLettering(), CommonInvoice\buildEPCQrCodeString(), CommonInvoice\buildSwitzerlandQRString(), CommonInvoice\buildZATCAQRString(), calcul_price_total(), BOM\calculateCosts(), Asset\calculationDepreciation(), ChargeSociales\check(), PaymentVarious\check(), AccountancyImport\cleanAmount(), ModeleImports\commonImportInsert(), AccountancyImport\computeAmount(), AccountancyImport\computeDirection(), ExpenseReport\computeTotalKm(), Form\constructProductListOption(), Account\create(), CashControl\create(), ChargeSociales\create(), CurrencyRate\create(), DiscountAbsolute\create(), Don\create(), Facture\create(), FactureFournisseur\create(), Loan\create(), LoanSchedule\create(), Paiement\create(), PaiementFourn\create(), PaymentDonation\create(), PaymentExpenseReport\create(), PaymentLoan\create(), PaymentSalary\create(), PaymentSocialContribution\create(), PaymentVarious\create(), PaymentVAT\create(), Product\create(), ProductCustomerPrice\create(), Project\create(), RejetPrelevement\create(), Salary\create(), Tva\create(), Delivery\create_line(), SupplierProposal\createPriceFournisseur(), ProductCombination\createProductCombination(), BookKeeping\createStd(), CommonInvoice\demande_prelevement(), Salary\demande_prelevement(), pdf_cyan\drawTotalTable(), pdf_eagle_proforma\drawTotalTable(), pdf_eratosthene\drawTotalTable(), pdf_octopus\drawTotalTable(), pdf_sponge\drawTotalTable(), Form\editfieldval(), BonPrelevement\EnregDestinataireSEPA(), BonPrelevement\EnregEmetteurSEPA(), AccountancyExport\exportConfigurable(), AccountancyExport\exportEbp(), AccountancyExport\exportGestimumV3(), AccountancyExport\exportGestimumV5(), AccountancyExport\exportISTEA(), Product\fetch(), Societe\fetch(), Contrat\fetch_lines(), ProductFournisseur\fetch_product_fournisseur_price(), ProductCustomerPrice\fetchAll(), CommonDocGenerator\fill_substitutionarray_with_extrafields(), ProductFournisseur\find_min_price_product_fournisseur(), Productbatch\findAllForProduct(), Form\form_multicurrency_rate(), BonPrelevement\generate(), DiscountAbsolute\generateFromAmount(), CommonDocGenerator\get_substitutionarray_lines(), ProjectStats\getAllProjectByStatus(), Fichinter\getAmount(), MultiCurrency\getAmountConversionFromInvoiceRate(), AccountingJournal\getAssetData(), DiscountAbsolute\getAvailableDiscounts(), AccountingJournal\getDiscountCustomer(), AccountingJournal\getDiscountSupplier(), getMarginInfos(), ExtraFields\getOptionalsFromPost(), DoubleField\getPostFieldValue(), IntField\getPostFieldValue(), PricecyField\getPostFieldValue(), PriceField\getPostFieldValue(), RealField\getPostFieldValue(), ExternalModules\getProducts(), AssetDepreciationOptions\getRate(), CommonInvoice\getRemainToPay(), Facture\getRetainedWarrantyAmount(), CommonObject\getTotalDiscount(), Invoices\index(), CommandeFournisseurLigne\insert(), ContratLigne\insert(), ExpenseReportLine\insert(), OrderLine\insert(), PropaleLigne\insert(), SupplierInvoiceLine\insert(), SupplierProposalLine\insert(), CommonObject\insertExtraFields(), CommonObject\insertExtraLanguages(), ProductFournisseur\list_product_fournisseur_price(), Product\load_stats_bom(), Product\load_stats_mo(), Product\load_stock(), box_funnel_of_prospection\loadBox(), box_members_subscriptions_by_year\loadBox(), box_produits_alerte_stock\loadBox(), Productlot\loadStatsMo(), FormProduct\loadWarehouses(), loanCalcMonthlyPayment(), ProductFournisseur\logPrice(), ordersupplier_prepare_head(), pdf_getlinevatrate(), pdf_pagefoot(), pdfGetLineTotalDiscountAmount(), pdfWriteAlreadyPaid(), pdfWriteVATArray(), print_projecttasks_array(), CommonObject\printObjectLine(), Mo\processBOM(), CommonObject\quote(), RemiseCheque\rejectCheck(), Form\select_produits_fournisseurs_list(), Form\select_produits_list(), BonPrelevement\set_infocredit(), Societe\set_remise_except(), AssetDepreciationOptions\setDeprecationOptionsFromPost(), Commande\setDiscount(), Facture\setDiscount(), Societe\setMysoc(), CommonObject\setValuesForExtraLanguages(), InterfaceWorkflowManager\shouldClassify(), showMyBalance(), CommonObject\showOptionals(), Account\solde(), Thirdparties\splitdiscount(), Adherent\subscriptionComplementaryActions(), BankAccounts\transfer(), CUnits\unitConverter(), Account\update(), BookKeeping\update(), ChargeSociales\update(), CommandeFournisseurLigne\update(), ContratLigne\update(), CurrencyRate\update(), Don\update(), ExpeditionLigne\update(), ExpenseReportLine\update(), FactureFournisseurLigneRec\update(), FactureLigne\update(), Loan\update(), PaymentDonation\update(), PaymentSocialContribution\update(), PaymentVarious\update(), PaymentVAT\update(), Product\update(), ProductCustomerPrice\update(), Project\update(), PropaleLigne\update(), Reception\update(), Societe\update(), Subscription\update(), SupplierInvoiceLine\update(), SupplierProposalLine\update(), Tva\update(), ProductFournisseur\update_buyprice(), SupplierProposalLine\update_total(), CommonObject\updateExtraField(), CommandeFournisseur\updateFromCommandeClient(), Lettering\updateGeneralMatching(), Lettering\updateLettering(), BOM\updateLine(), Commande\updateline(), CommandeFournisseur\updateline(), Contrat\updateline(), ExpenseReport\updateline(), Facture\updateline(), FactureFournisseur\updateline(), FactureFournisseurRec\updateline(), FactureRec\updateline(), Propal\updateline(), SupplierProposal\updateline(), Product\updatePrice(), SupplierProposal\updatePriceFournisseur(), Mo\updateProduction(), Holiday\updateSoldeCP(), FactureFournisseur\validate(), doc_generic_project_odt\write_file(), pdf_balance\write_file(), pdf_bookkeeping\write_file(), pdf_ledger\write_file(), pdf_squille\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_stock\write_file(), and AccountingJournal\writeIntoBookkeeping().

◆ print_barre_liste()

print_barre_liste ( $title,
$page,
$file,
$options = '',
$sortfield = '',
$sortorder = '',
$morehtmlcenter = '',
$num = -1,
$totalnboflines = '',
$picto = 'generic',
$pictoisfullpath = 0,
$morehtmlright = '',
$morecss = '',
$limit = -1,
$selectlimitsuffix = 0,
$hidenavigation = 0,
$pagenavastextinput = 0,
$morehtmlrightbeforearrow = '' )

Print a title with navigation controls for pagination.

Parameters
string$titleTitle to show (required). Can be a string with a
as a substring.
int | null$pageNumero of page to show in navigation links (required)
string$fileUrl of page (required)
string$optionsMore parameters for links ('' by default, does not include sortfield neither sortorder). Value must be 'urlencoded' before calling function.
?string$sortfieldField to sort on ('' by default)
?string$sortorderOrder to sort ('' by default)
string$morehtmlcenterString in the middle ('' by default). We often find here string $massaction coming from $form->selectMassAction()
int$numNumber of records found by select with limit+1
int | string$totalnboflinesTotal number of records/lines for all pages (if known). Use a negative value of number to not show number. Use '' if unknown. Use a string to show a string.
string$pictoIcon to use before title (should be a 32x32 transparent png file)
int$pictoisfullpath1=Icon name is a full absolute url of image
string$morehtmlrightMore html to show (after arrows)
string$morecssMore css to the table
int$limitMax number of lines (-1 = use default, 0 = no limit, > 0 = limit).
int | string$selectlimitsuffixSuffix for limit ID or -1 to hide the select limit combo
int$hidenavigationForce to hide the arrows and page for navigation
int$pagenavastextinput1=Do not suggest list of pages to navigate but suggest the page number into an input field.
string$morehtmlrightbeforearrowMore html to show (before arrows)
Returns
void

Definition at line 7345 of file functions.lib.php.

Referenced by report_header().

◆ print_date_range()

print_date_range ( $date_start,
$date_end,
$format = '',
$outputlangs = null )

Format output for start and end date.

Parameters
int$date_startStart date
int$date_endEnd date
string$formatOutput format
Translate$outputlangsOutput language
Returns
void

Definition at line 11255 of file functions.lib.php.

◆ print_fiche_titre()

print_fiche_titre ( $title,
$mesg = '',
$picto = 'generic',
$pictoisfullpath = 0,
$id = '' )

Show a title with picto.

Parameters
string$titleTitle to show
string$mesgAdded message to show on right
string$pictoIcon to use before title (should be a 32x32 transparent png file)
int$pictoisfullpath1=Icon name is a full absolute url of image
string$idTo force an id on html objects by example id="name" where name is id
Returns
void
Deprecated
Use print load_fiche_titre instead

Definition at line 7273 of file functions.lib.php.

◆ print_fleche_navigation()

print_fleche_navigation ( $page,
$file,
$options = '',
$nextpage = 0,
$betweenarrows = '',
$afterarrows = '',
$limit = -1,
$totalnboflines = 0,
$selectlimitsuffix = '',
$beforearrows = '',
$hidenavigation = 0 )

Function to show navigation arrows into lists.

Parameters
int$pageNumber of page
string$filePage URL (in most cases provided with $_SERVER["PHP_SELF"])
string$optionsOther url parameters to propagate ("" by default, may include sortfield and sortorder)
integer$nextpageDo we show a next page button
string$betweenarrowsHTML content to show between arrows. MUST contains ' ' tags or ' '.
string$afterarrowsHTML content to show after arrows. Must NOT contains ' ' tags.
int$limitMax nb of record to show (-1 = no combo with limit, 0 = no limit, > 0 = limit)
int$totalnboflinesTotal number of records/lines for all pages (if known)
int | string$selectlimitsuffixA suffix for the limit ID, or -1 to hide the select of limit
string$beforearrowsHTML content to show before arrows. Must NOT contains ' ' tags.
int$hidenavigationForce to hide the switch mode view and the navigation tool (hide limit section, html in $betweenarrows and $afterarrows but not $beforearrows)
Returns
void

Definition at line 7538 of file functions.lib.php.

◆ print_liste_field_titre()

print_liste_field_titre ( $name,
$file = "",
$field = "",
$begin = "",
$param = "",
$moreattrib = "",
$sortfield = "",
$sortorder = "",
$prefix = "",
$tooltip = "",
$forcenowrapcolumntitle = 0 )

Show title line of an array.

Parameters
?string$nameLabel of field
string$fileUrl used when we click on sort picto
string$fieldField to use for new sorting
string$begin("" by default)
string$paramAdd more parameters on sort url links ("" by default)
string$moreattribOptions of attribute td ("" by default)
?string$sortfieldCurrent field used to sort
?string$sortorderCurrent sort order
string$prefixPrefix for css. Use space after prefix to add your own CSS tag, for example 'mycss '.
?string$tooltipTooltip
int$forcenowrapcolumntitleNo need to use 'wrapcolumntitle' css style
Returns
void

Definition at line 7109 of file functions.lib.php.

Referenced by FormFile\list_of_autoecmfiles(), FormFile\list_of_documents(), FormFile\listOfLinks(), and print_projecttasks_array().

◆ print_titre()

print_titre ( $title)

Show a title.

Parameters
string$titleTitle to show
Returns
void
Deprecated
Use load_fiche_titre instead
See also
load_fiche_titre()

Definition at line 7255 of file functions.lib.php.

◆ printCommonFooter()

printCommonFooter ( $zone = 'private')

Print common footer : conf->global->MAIN_HTML_FOOTER js for switch of menu hider js for conf->global->MAIN_GOOGLE_AN_ID js for conf->global->MAIN_SHOW_TUNING_INFO or $_SERVER["MAIN_SHOW_TUNING_INFO"] js for conf->logbuffer.

Parameters
string$zone'private' (for private pages) or 'public' (for public pages)
Returns
void

Definition at line 13042 of file functions.lib.php.

Referenced by llxFooterSurvey(), and llxFooterVierge().

◆ safeArrayMap()

safeArrayMap ( $callback,
array $array )

Add a function to replace array_map with allowed callback.

Parameters
string | mixed$callbackFunction
array<mixed,mixed>$array Array
Returns
array<mixed,mixed> The array after the array_map

Definition at line 10166 of file functions.lib.php.

◆ sanitizeVal()

sanitizeVal ( $out = '',
$check = 'alphanohtml',
$filter = null,
$options = null )

Return a sanitized or empty value after checking value against a rule.

Parameters
string | mixed[] | null$outValue to check/clear.
string$checkType of check/sanitizing
?int$filterFilter to apply when $check is set to 'custom' (deprecated). (See http://php.net/manual/en/filter.filters.php for détails)
?mixed$optionsOptions to pass to filter_var when $check is set to 'custom'
Returns
string|array<mixed> Value sanitized (string or array). It may be '' if format check fails.

Definition at line 1360 of file functions.lib.php.

Referenced by DolibarrApi\_checkValExtrafieldsForAPI(), DolibarrApi\_checkValForAPI(), BankAccounts\addLine(), BankAccounts\addLink(), Products\addPurchasePrice(), Export\buildFilterQuery(), Thirdparties\createCompanyBankAccount(), Thirdparties\createSocieteAccount(), Categorie\getListForItem(), RssParser\parser(), AgendaEvents\post(), BankAccounts\post(), Boms\post(), Categories\post(), Contacts\post(), Contracts\post(), Donations\post(), EmailTemplates\post(), EventAttendees\post(), ExpenseReports\post(), Holidays\post(), Interventions\post(), Invoices\post(), KnowledgeManagement\post(), Mailings\post(), Members\post(), Mos\post(), MultiCurrencies\post(), MyModuleApi\post(), Orders\post(), Partnerships\post(), Productlots\post(), Products\post(), Projects\post(), Proposals\post(), Receptions\post(), Shipments\post(), Subscriptions\post(), SupplierInvoices\post(), SupplierOrders\post(), Tasks\post(), Thirdparties\post(), Tickets\post(), Users\post(), Warehouses\post(), Zapier\post(), Recruitments\postCandidature(), Users\postGroups(), Recruitments\postJobPosition(), Contracts\postLine(), ExpenseReports\postLine(), Interventions\postLine(), Invoices\postLine(), Orders\postLine(), Proposals\postLine(), SupplierInvoices\postLine(), SupplierOrders\postLine(), Tickets\postNewMessage(), Thirdparties\postSocieteAccount(), Mailings\postTarget(), Members\postType(), Mos\produceAndConsumeAll(), AgendaEvents\put(), BankAccounts\put(), Boms\put(), Categories\put(), Contacts\put(), Contracts\put(), Donations\put(), ExpenseReports\put(), Holidays\put(), Interventions\put(), Invoices\put(), KnowledgeManagement\put(), Mailings\put(), Members\put(), Mos\put(), MultiCurrencies\put(), MyModuleApi\put(), Orders\put(), Paiements\put(), Partnerships\put(), Productlots\put(), Products\put(), Projects\put(), Proposals\put(), Receptions\put(), Shipments\put(), Subscriptions\put(), SupplierInvoices\put(), SupplierOrders\put(), Tasks\put(), Thirdparties\put(), Tickets\put(), Users\put(), Warehouses\put(), Products\putAttributes(), Products\putAttributeValue(), EmailTemplates\putById(), EventAttendees\putById(), EmailTemplates\putbyLabel(), EventAttendees\putByRef(), Recruitments\putCandidature(), Users\putGroups(), Recruitments\putJobPosition(), Contracts\putLine(), ExpenseReports\putLine(), Interventions\putLine(), Invoices\putLine(), Orders\putLine(), Proposals\putLine(), SupplierInvoices\putLine(), Thirdparties\putSocieteAccount(), Members\putType(), Products\putVariant(), BankAccounts\transfer(), Thirdparties\updateCompanyBankAccount(), BankAccounts\updateLine(), and Mailings\updateTarget().

◆ setEntity()

setEntity ( $currentobject)

Set entity id to use when to create an object.

Parameters
CommonObject$currentobjectCurrent object
Returns
int Entity id to use ( eg. entity = '.setEntity($object) )

Definition at line 682 of file functions.lib.php.

Referenced by Commande\create(), CommandeFournisseur\create(), Contact\create(), Expedition\create(), Facture\create(), FactureFournisseur\create(), Fichinter\create(), Propal\create(), Reception\create(), Societe\create(), and Ticket\create().

◆ setEventMessage()

setEventMessage ( $mesgs,
$style = 'mesgs',
$noduplicate = 0,
$attop = 0 )

Set event message in dol_events session object.

Will be output by calling dol_htmloutput_events. Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function. Note: Prefer to use setEventMessages instead.

Parameters
string | string[]$mesgsMessage string or array
string$styleWhich style to use ('mesgs' by default, 'warnings', 'errors')
int$noduplicate1 means we do not add the message if already present in session stack
int$attopAdd the message in the top of the stack (at bottom by default)
Returns
void
See also
dol_htmloutput_events()

Definition at line 11347 of file functions.lib.php.

Referenced by FileUpload\__construct(), Skill\createSkills(), Societe\getChildrenForCompany(), printing_printipp\getlistAvailablePrinters(), Societe\getParentsForCompany(), show_actions_done(), show_stats_for_company(), Commande\updateline(), CommandeFournisseur\updateline(), Facture\updateline(), Propal\updateline(), and pdf_octopus\write_file().

◆ setEventMessages()

setEventMessages ( $mesg,
$mesgs,
$style = 'mesgs',
$messagekey = '',
$noduplicate = 0,
$attop = 0 )

Set event messages in dol_events session object.

Will be output by calling dol_htmloutput_events. Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function.

Parameters
string | null$mesgMessage string
string[] | null$mesgsMessage array
string$styleWhich style to use ('mesgs' by default, 'warnings', 'errors')
string$messagekeyA key to be used to allow the feature "Never show this message during this session again"
int$noduplicate1 means we do not add the message if already present in session stack
int$attopAdd the message in the top of the stack (at bottom by default)
Returns
void
See also
dol_htmloutput_events()

Definition at line 11394 of file functions.lib.php.

Referenced by Commande\addline(), CommandeFournisseur\addline(), Facture\addline(), Propal\addline(), BookKeeping\assignAccountMass(), checkPHPCode(), FormTicket\checkRequiredFields(), completeFileArrayWithDatabaseInfo(), InterfaceTicketEmail\composeAndSendAssigneeMessage(), conferenceorboothProjectPrepareHead(), conferenceorboothThirdpartyPrepareHead(), PaiementFourn\create(), Societe\create_from_member(), Website\createFromClone(), createNewDictionnary(), Ticket\createTicketMessage(), pdf_balance\defineColumnField(), pdf_bookkeeping\defineColumnField(), pdf_cornas\defineColumnField(), pdf_cyan\defineColumnField(), pdf_eratosthene\defineColumnField(), pdf_espadon\defineColumnField(), pdf_ledger\defineColumnField(), pdf_octopus\defineColumnField(), pdf_sponge\defineColumnField(), pdf_standard_asset\defineColumnField(), pdf_standard_myobject\defineColumnField(), pdf_standard_recruitmentjobposition\defineColumnField(), pdf_storm\defineColumnField(), pdf_vinci\defineColumnField(), pdf_zenith\defineColumnField(), FormMargin\displayMarginInfos(), displayRankInfos(), dol_add_file_process(), dol_copy(), dol_delete_file(), dol_move(), dol_remove_file_process(), Website\exportWebSite(), Salary\generateDocument(), FormSetup\generateLineOutput(), FormSetup\generateOutput(), FormSetup\generateTableOutput(), FormMail\get_form(), getAllImages(), CommonDocGenerator\getExtrafieldContent(), getListOfModels(), CommonObject\indexFile(), modBlockedLog\init(), modTakePos\init(), User\loadDefaultValues(), BookKeeping\newClone(), BookKeeping\newCloneMass(), Ticket\newMessage(), BookKeeping\newReturnAccount(), Website\overwriteTemplate(), CommonDocGenerator\pdfTabTitles(), ModelePdfAccountancy\pdfTabTitles(), CommonDocGenerator\printColDescContent(), ProductAttribute\printObjectLines(), CommonDocGenerator\printStdColumnContent(), project_prepare_head(), rebuildObjectClass(), rebuildObjectSql(), redirectToContainer(), FormSetup\saveConfFromPost(), dolReceiptPrinter\sendTestToPrinter(), Ticket\sendTicketMessageByEmail(), dolReceiptPrinter\sendToPrinter(), AssetDepreciationOptions\setDeprecationOptionsFromPost(), Societe\setParent(), setSignedStatusCommon(), show_contacts(), show_stats_for_batch(), show_stats_for_company(), FormActions\showactions(), FormFile\showdocuments(), FormTicket\showMessageForm(), societe_prepare_head(), MultiCurrency\syncRates(), Link\update(), CommonObject\updateExtraField(), pdf_azur\write_file(), pdf_cyan\write_file(), pdf_einstein\write_file(), pdf_eratosthene\write_file(), pdf_octopus\write_file(), pdf_sponge\write_file(), and pdf_strato\write_file().

◆ showDimensionInBestUnit()

showDimensionInBestUnit ( $dimension,
$unit,
$type,
$outputlangs,
$round = -1,
$forceunitoutput = 'no',
$use_short_label = 0 )

Output a dimension with best unit.

Parameters
float$dimensionDimension
int$unitUnit scale of dimension (Example: 0=kg, -3=g, -6=mg, 98=ounce, 99=pound, ...)
string$type'weight', 'volume', ...
Translate$outputlangsTranslate language object
int<-1,max>$round -1 = non rounding, x = number of decimal
string$forceunitoutput'no' or numeric (-3, -6, ...) compared to $unit (In most case, this value is value defined into $conf->global->MAIN_WEIGHT_DEFAULT_UNIT)
int<0,1>$use_short_label 1=Use short label ('g' instead of 'gram'). Short labels are not translated.
Returns
string String to show dimensions

Definition at line 7978 of file functions.lib.php.

Referenced by pdf_eagle\_tableau_tot(), pdf_espadon\_tableau_tot(), pdf_rouget\_tableau_tot(), pdf_squille\_tableau_tot(), Form\constructProductListOption(), CommonDocGenerator\get_substitutionarray_shipment(), and Form\select_produits_fournisseurs_list().

◆ showSimpleOrderTable()

showSimpleOrderTable ( $outputlangs,
$object )

Returns simple order table template as string.

Parameters
Translate$outputlangsOutput language
Object$objectObject
Returns
string template

Definition at line 13683 of file functions.lib.php.

◆ utf8_check()

utf8_check ( $str)

Check if a string is in UTF8.

Seems similar to utf8_valid() but in pure PHP.

Parameters
null | string | int$strString to check
Returns
boolean True if string is UTF8 or ISO compatible with UTF8, False if not (ISO with special non utf8 char or Binary)
See also
utf8_valid()

Definition at line 11713 of file functions.lib.php.

Referenced by CMailFile\check_server_port(), dol_delete_dir_recursive(), dol_dir_list(), ImportCsv\import_read_record(), Login\index(), BOM\is_photo_available(), Product\is_photo_available(), Ticket\is_photo_available(), Categorie\isAnyPhotoAvailable(), Product\liste_photos(), box_external_rss\loadBox(), and show_elem().

◆ utf8_valid()

utf8_valid ( $str)

Check if a string is in UTF8.

Seems similar to utf8_check().

Parameters
string$strString to check
Returns
boolean True if string is valid UTF8 string, false if corrupted
See also
utf8_check()

Definition at line 11751 of file functions.lib.php.

◆ vatrate()

vatrate ( $rate,
$addpercent = false,
$info_bits = 0,
$usestarfornpr = 0,
$html = 0 )

Return a string with VAT rate label formatted for view output Used into pdf and HTML pages.

Parameters
string$rateRate value to format ('19.6', '19,6', '19.6', '19,6', '19.6 (CODEX)', ...)
boolean$addpercentAdd a percent % sign in output
int$info_bitsMiscellaneous information on vat (0=Default, 1=French NPR vat)
int$usestarfornpr-1=Never show, 0 or 1=Use '*' for NPR vat rates
int$htmlUsed for html output
Returns
string String with formatted amounts ('19,6' or '19,6' or '8.5% (NPR)' or '8.5% *' or '19,6 (CODEX)')

Definition at line 7645 of file functions.lib.php.

Referenced by pdf_aurore\_tableau_tot(), pdf_azur\_tableau_tot(), pdf_canelle\_tableau_tot(), pdf_cornas\_tableau_tot(), pdf_einstein\_tableau_tot(), pdf_muscadet\_tableau_tot(), pdf_vinci\_tableau_tot(), pdf_zenith\_tableau_tot(), Form\constructProductListOption(), dol_print_reduction(), pdf_cyan\drawTotalTable(), pdf_eratosthene\drawTotalTable(), ExpenseReportLine\fetch(), CommonDocGenerator\get_substitutionarray_lines(), ExpenseReportLine\insert(), Form\load_tva(), pdf_getlinevatrate(), pdfWriteVATArray(), CommonObject\printOriginLine(), Form\select_produits_fournisseurs_list(), and ExpenseReportLine\update().

◆ verifCond()

verifCond ( $strToEvaluate,
$onlysimplestring = '1' )

Verify if condition in string is ok or not.

Parameters
string$strToEvaluateString with condition to check
string$onlysimplestring'0' (deprecated, do not use it anymore)=Accept all chars, '1' (most common use)=Accept only simple string with char 'a-z0-9\s^$_+-.*>&|=!?():"\',/@';', '2' (used for example for the compute property of extrafields)=Accept also '[]'
Returns
boolean True or False. Note: It returns also True if $strToEvaluate is ''. False if error

Definition at line 11916 of file functions.lib.php.

Referenced by ActionsCardProduct\getFieldListCanvas(), ActionsCardService\getFieldListCanvas(), Export\load_arrays(), and Menubase\menuLoad().

◆ yn()

yn ( $yesno,
$format = 1,
$color = 0 )

Return yes or no in current language.

Parameters
boolean|int<0,1>|'yes'|'true'|'no'|'false'$yesno Value to test (true, 1, 'yes', 'true' or false, 0, 'no', 'false')
integer | string$format1=Yes/No, 0=yes/no, 2=Disabled/enabled checkbox, 3=Disabled/enabled checkbox + Yes/No, 4 or Text=Use picto
int$color0=texte only, 1=Text is formatted with a color font style ('ok' or 'error'), 2=Text is formatted with 'ok' color.
Returns
string HTML string

Definition at line 8803 of file functions.lib.php.

Referenced by ActionsCardCommon\assign_values(), AdherentType\getKanbanView(), CommandeFournisseur\getKanbanView(), getResultColumn(), ModeleNumRefBarCode\getToolTip(), ModeleNumRefMembers\getToolTip(), ModeleProductCode\getToolTip(), ModeleThirdPartyCode\getToolTip(), ActionComm\getTooltipContentArray(), AdherentType\getTooltipContentArray(), Product\getTooltipContentArray(), User\getTooltipContentArray(), mod_codecompta_aquarium\info(), mod_codecompta_digitaria\info(), Adherent\makeSubstitution(), BooleanField\printOutputField(), ExtraFields\showOutputField(), showSkins(), and top_menu_user().

Variable Documentation

◆ MODULE_MAPPING

const MODULE_MAPPING array( 'adherent' => 'member', 'member_type' => 'adherent_type', 'banque' => 'bank', 'contrat' => 'contract', 'entrepot' => 'stock', 'projet' => 'project', 'categorie' => 'category', 'commande' => 'order', 'expedition' => 'shipping', 'facture' => 'invoice', 'fichinter' => 'intervention', 'ficheinter' => 'intervention', 'propale' => 'propal', 'societe' => 'thirdparty', 'socpeople' => 'contact', 'fournisseur' => 'supplier', 'actioncomm' => 'agenda', 'product_price' => 'productprice', 'product_fournisseur_price' => 'productsupplierprice', )

This mapping defines the conversion to the current internal names from the alternative allowed names (including effectively deprecated and future new names (not yet used as internal names).

This allows to map any temporary or future name to the effective internal name.

The value is typically the name of module's root directory.

Definition at line 481 of file functions.lib.php.