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

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, $nodefault=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, $nodefault=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 value of 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.

	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.

	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=2, $withpicto=0, $morecss='paddingrightonly')
	Show EMail link formatted for HTML output.

	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=" ", $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.

	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 '.

	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.

	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, $ishtml=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.

	dolCloseUnclosedHtmlTags ($text)
	Close the HTML tags left open in a truncated HTML string.

	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.

	dolSort ($arraytosort)
	Sort an array using a user defined function.

	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.

	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).

	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_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)

	getImageFileNameForSize ($file, $extName, $extImgTarget='')
	Return the filename of file to get the thumbs.

	getLabelSpecialCode ($idcode)
	Make content of an input box selected when we click into input field.

	dolIsAllowedForPreview ($file)
	Return if a file is qualified for preview.

	dol_mimetype ($file, $default='application/octet-stream', $mode=0)
	Return MIME type of a file from its name with extension.

	getDictionaryValue ($tablename, $field, $id, $checkentity=false, $rowidfield='rowid')
	Return the value of a filed into a dictionary for the record $id.

	colorIsLight ($stringcolor)
	Return true if the color is light.

	isVisibleToUserType ($type_user, &$menuentry, &$listofmodulesforexternal)
	Function to test if an entry is enabled or not.

	roundUpToNextMultiple ($n, $x=5)
	Round to next multiple.

	getElementProperties ($elementType)
	Get an array with properties of an element.

	getExecutableContent ()
	Return array of extension for executable files of text files that can contains executable code.

	isAFileWithExecutableContent ($filename)
	Return if a file can contains executable content.

	newToken ()
	Return the value of token currently saved into session with name 'newtoken'.

	currentToken ()
	Return the value of token currently saved into session with name 'token'.

	getNonce ()
	Return a random string to be used as a nonce value for js.

	readfileLowMemory ($fullpath_original_file_osencoded, $method=-1)
	Return a file on output using a low memory.

	jsonOrUnserialize ($stringtodecode, $assoc=true)
	Decode an encoded string.

	forgeSQLFromUniversalSearchCriteria ($filter, &$errorstr='', $noand=0, $nopar=0, $noerror=0, $forbiddenfields=array())
	forgeSQLFromUniversalSearchCriteria

	dolForgeExplodeAnd ($sqlfilters)
	Explode an universal search string with AND parts.

	dolCheckFilters ($sqlfilters, &$error='', &$parenthesislevel=0)
	Return if a $sqlfilters parameter has a valid balance of parenthesis.

	dolForgeDummyCriteriaCallback ($matches)
	Function to forge a SQL criteria from a Dolibarr filter syntax string.

	dolForgeSQLCriteriaCallback ($matches)
	Function to forge a SQL criteria from a USF (Universal Filter Syntax) string.

	getTimelineIcon ($actionstatic, &$histo, $key)
	Get timeline icon.

	getActionCommEcmList ($object)
	getActionCommEcmList

	buildParamDate ($prefix, $timestamp=null, $hourTime='', $gm='auto')
	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 portion of URL reproducing the values from the current HTTP request.

	recordNotFound ($message='', $printheader=1, $printfooter=1, $showonlymessage=0, $params=null)
	Displays an error page when a record is not found.

	array_merge_recursive_distinct (array $array1, array $array2)
	Recursively merges two arrays while preserving keys and replacing existing values.

	getObjectSocId ($obj)
	Get the socid of an object, supporting legacy attribute names.

	getListLimitFromScreenHeight ()
	Get the limit of list to show according to the screen height.

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

◆ array_merge_recursive_distinct()

array_merge_recursive_distinct	(	array	$array1,
		array	$array2 )

Recursively merges two arrays while preserving keys and replacing existing values.

Unlike PHP's native array_merge_recursive(), this function does not combine values into an array when duplicate keys are found. Instead, values from the second array will override values from the first array, unless both values are arrays, in which case the function will merge them recursively.

Note : function name is not in camelCase because of name of native php function named array_merge_recursive this approach will help developers to find this function

Example: $a = ['color' => 'blue', 'style' => ['font' => 'Arial', 'size' => 10]]; $b = ['color' => 'red', 'style' => ['size' => 12]]; Result: [ 'color' => 'red', 'style' => [ 'font' => 'Arial', 'size' => 12 ] ]

@template T of mixed

Parameters

array<string,T>	$array1 The base array (default parameters).
array<string,T>	$array2 The array with values to override or extend the base array.

Returns: array<string, T> The merged array with recursive replacement.

TODO Move it out of functions.lib.php

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

Referenced by Form\radio().

◆ ascii_check()

ascii_check ( $str )

Check if a string is in ASCII.

Parameters

string $str String to check

Returns: boolean True if string is ASCII, False if not (byte value > 0x7F)

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

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

◆ buildParamDate()

buildParamDate	(	$prefix,
		$timestamp = null,
		$hourTime = '',
		$gm = 'auto' )

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 portion of URL reproducing the values from the current HTTP request.

Parameters

string	$prefix	Prefix used to build the date selector (for instance using Form\selectDate)
?int	$timestamp	If null, the timestamp will be created from request data
string	$hourTime	If timestamp is null, will be passed to GETPOSTDATE to construct the timestamp
string	$gm	If timestamp is null, will be passed to GETPOSTDATE to construct the timestamp

Returns: string Portion of URL with query parameters for the specified date

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

◆ colorIsLight()

colorIsLight ( $stringcolor )

Return true if the color is light.

Parameters

string $stringcolor String with hex (FFFFFF) or comma RGB ('255,255,255')

Returns: int<-1,1> -1 : Error with argument passed | 0 : color is dark | 1 : color is light

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

Referenced by Categorie\getNomUrl(), pdf_render_subtotals(), Categorie\print_all_ways(), Form\showCategories(), ExtraFields\showOutputField(), and pdf_soleil\write_file().

◆ 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	$conf	Object conf
Translate	$langs	Object langs
?Object	$object	Object object
	array<array{0:string,1:string,2:string}>	$head List of head tabs (updated by this function)
int	$h	New position to fill (updated by this function)
string	$type	Value 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	$filterorigmodule	Filter on module origin: 'external' will show only external modules. 'core' only core modules. No filter (default) will add both.

Returns: void

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

◆ 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	$outputlangs	Output language
?CommonObject	$object	Source object
?mixed	$parameters	Add more parameters (useful to pass product lines)
string	$callfunc	What is the name of the custom function that will be called? (default: completesubstitutionarray)

Returns: void

See also: make_substitutions()

Definition at line 7953 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(), Contrat\sendReminderForExpiredServices(), 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_helios\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().

◆ currentToken()

currentToken ( )

Return the value of token currently saved into session with name 'token'.

For ajax call, you must use this token as a parameter of the call into the js calling script (the called ajax php page must also set constant NOTOKENRENEWAL).

Since: Dolibarr v10.0.7

Returns: string

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

Referenced by dragAndDropFileUpload(), FormAI\getAjaxAICallFunction(), Form\getPhoneInputSharedJs(), Form\selectExpenseCategories(), and FormCompany\selectProspectStatus().

◆ 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	$path	Relative path to file (if mode=0) or relative url (if mode=1). Ie: mydir/myfile, ../myfile
int	$type	0=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	$returnemptyifnotfound	0: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 1684 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(), Inventory\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(), ModeleGenPassword\loadAndInstantiate(), 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_actions_messaging(), 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	$srcobject	Object to clone
int	$native	0=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 1867 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	$srcobject	Object to clone
int	$startlevel	Start level to track recursive depth

Returns: array<string,mixed> Array

Definition at line 1912 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	$text1	Text 1
string	$text2	Text 2

Returns: string Text 1 + new line + Text2

See also: dol_textishtml()

Definition at line 6892 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	$text1	Text 1
string	$text2	Text 2
bool	$forxml	true=Use instead of if we have to add a br tag
bool	$invert	invert 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 6869 of file functions.lib.php.

Referenced by Propal\classifyBilled(), Propal\closeProposal(), RecruitmentJobPosition\cloture(), CommandeFournisseur\commande(), constructGanttLine(), Facture\create(), FactureFournisseur\create(), doc_getlinedesc(), Societe\mergeCompany(), Contact\mergeContact(), 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_helios\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 $stringtoescape String to escape

Returns: string Escaped string for XML content.

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

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

◆ dol_escape_js()

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

Returns text escaped for inclusion into JavaScript code.

Parameters

int \| string	$stringtoescape	String to escape
int	$mode	0=Escape also \' and " into \', 1=Escape \' but not " for usage into 'string', 2=Escape " but not \' for usage into "string", 3=Escape \' and " with \\. @param int $noescapebackslashn 0=Escape also \n. 1=Do not escape \n. @return string Escaped string. Both \' and " are escaped into \' if they are escaped.

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

Referenced by ajax_combobox(), ajax_constantonoff(), ActionsCardCompany\assign_values(), Form\buttonsSaveCancel(), constructGanttLine(), FormWebPortal\convertAllLink(), DolEditor\Create(), dolButtonToOpenExportDialog(), dolButtonToOpenUrlInDialogPopup(), dolJSToSetRandomPassword(), dragAndDropFileUpload(), DolGraph\draw_chart(), DolGraph\draw_jflot(), FormFile\form_attach_new_file(), FormActions\form_select_status_action(), Form\formconfirm(), get_htmloutput_mesg(), modCaptchaStandard\getCaptchaCodeForForm(), FormOther\getHTMLScannerForm(), DolibarrModules\getKanbanView(), Form\getPhoneInputFieldJs(), ExternalModules\getProducts(), FormAI\getSectionForAIEnhancement(), FormWebPortal\inputSelectAjax(), printCodeForPing(), rebuildObjectClass(), Form\searchComponent(), FormAccounting\select_auxaccount(), Form\selectArrayAjax(), Form\selectArrayFilter(), FormCompany\selectCompaniesForNewContact(), Form\selectDate(), FormTicket\selectGroupTickets(), FormFile\showdocuments(), ExtraFields\showOutputField(), showSocialNetwork(), top_menu_ai(), and top_menu_quickadd().

◆ dol_escape_json()

dol_escape_json ( $stringtoescape )

Returns text escaped for inclusion into javascript code.

Parameters

string $stringtoescape String to escape

Returns: string Escaped string for JSON content.

Definition at line 2324 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	$stringtoescape	String 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 2336 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 $stringtoescape String to escape

Returns: string Escaped string.

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

◆ dol_escape_xml()

dol_escape_xml ( $stringtoescape )

Returns text escaped for inclusion into a XML string.

Parameters

string $stringtoescape String to escape

Returns: string Escaped string for XML content.

Definition at line 2374 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. To test non-regression on this, run "phpunit test/phpunit/SecurityTest.php"

Parameters

string	$s	String 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 8428 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 $s String 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 8452 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	$s	String 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 8727 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	$object	A company or contact object
int	$withcountry	1=Add country into address string
string	$sep	Separator to use to separate info when building string
?Translate	$outputlangs	Object lang that contains language for text translation.
int	$mode	0=Standard output, 1=Remove address
string	$extralangcode	User extralanguage $langcode as values for address, town

Returns: string Formatted string

See also: dol_print_address()

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

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

◆ dol_get_object_properties()

dol_get_object_properties	(		$obj,
			$properties = [] )

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

By default, returns all public properties. If a list of properties is provided, only returns the ones that exist.

Parameters

object	$obj	Object to get properties from
string[]	$properties	Optional list of properties to get. When empty, only gets public properties.

Returns: array<string,mixed> Hash for retrieved values (key=name)

Definition at line 1825 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	$timestamp	Timestamp
boolean	$fast	Fast 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 3070 of file functions.lib.php.

Referenced by modAdherent\__construct(), modContrat\__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(), dolOutputDates(), dolWebsiteIncrementCounter(), Accountancy\exportData(), getCurrentPeriodOfFiscalYear(), MultiCurrency\getIdAndTxFromCode(), FactureRec\getNextDate(), ActionComm\getTooltipContentArray(), Paiement\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(), Contrat\sendReminderForExpiredServices(), Adherent\sendReminderForExpiredSubscription(), and show_actions_messaging().

◆ 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	$db	Database handler
string \| int	$key	Code (string) or Id (int) to get Id or Code
string	$tablename	Table name without prefix. Example 'c_input_method'
string	$fieldkey	Field to search the key into
string	$fieldid	Field to get
int	$entityfilter	1=Filter by entity
string	$filters	Filters to add. WARNING: string must be escaped for SQL and not coming from user input.
bool	$useCache	If 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 8306 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(), Form\load_tva(), 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 9571 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	$a	Operand a
int	$b	Operand b (ENT_QUOTES\|ENT_HTML5=convert simple, double quotes, colon, e accent, ...)
string	$c	Operand c
int	$keepsomeentities	Entities but &, <, >, " are not converted.

Returns: string String decoded

Definition at line 6666 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 $stringtodecode String to decode

Returns: string String decoded

Definition at line 6650 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	$string	The input string to encode
int	$flags	Flags (see PHP doc above)
string	$encoding	Encoding page code
bool	$double_encode	When double_encode is turned off, PHP will not encode existing html entities

Returns: string $ret Encoded string

See also: dol_htmlentitiesbr()

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

Referenced by commonHtmlAttributeBuilder(), SharedDocumentsController\display(), dol_print_error(), dolGetButtonAction(), FormSetupItem\generateInputFieldTextarea(), FormMail\get_form(), getHtmlOfLayout(), Form\getSearchFilterToolInput(), getTaskProgressView(), ActionComm\getTooltipContentArray(), box_task\loadBox(), run_sql(), FormTicket\showMessageForm(), 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	$stringtoencode	String to encode
int	$nl2brmode	0=Adding br before , 1=Replacing by br (for use with FPDF writeHTMLCell function for example)
string	$pagecodefrom	Pagecode stringtoencode is encoded
int	$removelasteolbr	1=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 6600 of file functions.lib.php.

◆ 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	$stringtodecode	String to decode
string	$pagecodeto	Page code for result

Returns: string String decoded

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

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

◆ 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	$stringtoencode	String to encode
int	$nouseofiframesandbox	0=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 6265 of file functions.lib.php.

Referenced by dolPrintHTML(), dolPrintHTMLForTextArea(), and 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	$relpath	Relative path to file (Ie: mydir/myfile, ./myfile, ...)
string	$classname	Class name (deprecated)

Returns: bool True if load is a success, False if it fails

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

Referenced by 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_mimetype()

dol_mimetype	(	$file,
		$default = 'application/octet-stream',
		$mode = 0 )

Return MIME type of a file from its name with extension.

Parameters

string	$file	Filename we looking for MIME type
string	$default	Default mime type if extension not found in known list
	int<0,4>	$mode 0=Return full mime, 1=otherwise short mime string, 2=image for mime type, 3=source language, 4=css of font fa

Returns: string Return a mime type family (text/xxx, application/xxx, image/xxx, audio, video, archive)

See also: dolIsAllowedForPreview(), image_format_supported() from images.lib.php

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

Referenced by FormMail\add_attached_files(), Documents\builddoc(), vCard\buildVCardString(), FactureRec\createRecurringInvoices(), doc_label_pdf_create(), dol_check_secure_access_document(), dol_init_file_process(), getDocument(), FormFile\getDocumentsLink(), FormWebPortal\getDocumentsLink(), Documents\getDocumentsListByElement(), FileUpload\getFileObject(), FileUpload\handleFileUpload(), img_mime(), Documents\index(), DocumentController\init(), ViewImageController\init(), Facture\sendEmailsRemindersOnInvoiceDueDate(), show_actions_messaging(), FormFile\showdocuments(), FormTicket\showMessageForm(), ActionsTicket\viewTicketMessages(), and pdf_standard_member\write_file().

◆ dol_mkdir()

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

Creation of a directory (this can create recursive subdir)

Parameters

string	$dir	Directory to create (Separator must be '/'. Example: '/mydir/mysubdir')
string	$dataroot	Data 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	$newmask	Mask 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 5625 of file functions.lib.php.

◆ 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	$hour	Hour (can be -1 for undefined)
int	$minute	Minute (can be -1 for undefined)
int	$second	Second (can be -1 for undefined)
int	$month	Month (1 to 12)
int	$day	Day (1 to 31)
int	$year	Year
bool \| int \| string	$gm	True 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	$check	0=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 3117 of file functions.lib.php.

Referenced by modAdherent\__construct(), modContrat\__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(), Contrat\sendReminderForExpiredServices(), 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	$s	String to check
int	$maxchar	Not yet used

Returns: int Number of lines

See also: dol_nboflines_bis(), dolGetFirstLineOfText()

Definition at line 6738 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	$text	Text
int	$maxlinesize	Linewidth in character count (default = 0 == nolimit)
string	$charset	Give the charset used to encode the $text variable in memory.

Returns: int Number of lines

See also: dol_nboflines(), dolGetFirstLineOfText()

Definition at line 6759 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	$stringtoencode	String to encode
int	$nl2brmode	0=Adding br before , 1=Replacing by br
bool	$forxml	false=Use , true=Use

Returns: string String encoded

See also: dol_htmlentitiesbr(), dol_nboflines(), dolGetFirstLineOfText()

Definition at line 6242 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(), FormTicket\showMessageForm(), and html_cerfafr\write_file().

◆ 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 3203 of file functions.lib.php.

◆ 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 $str String to encode (UTF-8)

Returns: string Encoded string (UTF-8, ISO-8859-1)

Definition at line 8271 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(), DolibarrModules\getModuleInfoByRightsClass(), 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	$address	Address string, already formatted with dol_format_address()
string	$htmlid	Html ID (for example 'gmap')
string	$element	'thirdparty'\|'contact'\|'member'\|'user'\|'other'
int	$id	Id of object
int	$noprint	No output. Result is the function return
string	$charfornl	Char 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 4134 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	$time	GM Timestamps date
string	$format	Output 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	$tzoutput	true 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	$outputlangs	Object lang that contains language for text translation.
boolean	$encodetooutput	Use true to convert/encode string into the HTML rendering pagecode (false=keep UTF8 by default)
int \| string	$decorate	Use 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 2792 of file functions.lib.php.

◆ dol_print_email()

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

Show EMail link formatted for HTML output.

Parameters

string	$email	EMail to show (can be 'email' or 'Name of recipient <email>')
int	$contactid	Id of contact if known
int	$socid	Id of third party if known
int \| string	$addlink	0=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	$max	Max number of characters to show. Use -1 to hide the mail text and show only the picto.
int	$showinvalid	0=no check on email, 1=Show warning if syntax email is wrong (fast), 2=Check also DNS domain (slow)
int \| string	$withpicto	0=Show email, 1=Show picto of email + email, 2=Show only picto
string	$morecss	More CSS

Returns: string HTML Link

Definition at line 3328 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_ip()

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

Return an IP formatted to be shown on screen.

Parameters

string	$ip	IP
int	$mode	0=return IP + country/flag, 1=return only country/flag, 2=return only IP
int	$showname	1=Show reverse domain name instead of IP

Returns: string Formatted IP, with country if GeoIP module is enabled

Definition at line 3983 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 = " ",
		$withpicto = '',
		$titlealt = '',
		$adddivfloat = 0,
		$morecss = 'paddingright' )

Format phone numbers according to country.

Parameters

string	$phone	Phone number to format
string	$countrycode	Country code to use for formatting
int	$contactid	Id of contact if known
int	$socid	Id 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	$separ	Separation 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	$withpicto	Show picto ('fax', 'phone', 'mobile')
string	$titlealt	Text to show on alt
int	$adddivfloat	Add div float around phone.
string	$morecss	Add more css

Returns: string Formatted phone number

Definition at line 3641 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(), show_actions_messaging(), and ExtraFields\showOutputField().

◆ dol_print_profids()

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

Format professional IDs according to their country.

Parameters

string	$profID	Value of profID to format
string	$profIDtype	Type of profID to format ('1', '2', '3', '4', '5', '6' or 'VAT')
string	$countrycode	Country 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 3584 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	$size	Size to print
int	$shortvalue	Tell if we want long value to use another unit (Ex: 1.5Kb instead of 1500b)
int	$shortunit	Use short label of size unit (for example 'b' instead of 'bytes')

Returns: string Link

Definition at line 3241 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	$value	Social network ID to show (only skype, without 'Name of recipient' before)
int	$contactid	Id of contact if known
int	$socid	Id of third party if known
string	$type	Type 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 3482 of file functions.lib.php.

◆ dol_print_url()

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

Show Url link.

Parameters

string	$url	Url to show
string	$target	Target for link
int	$max	Max number of characters to show
int	$withpicto	With picto
string	$morecss	More CSS

Returns: string HTML Link

Definition at line 3280 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 $stringtoclean String to clean. Example 'abc@m.nosp@m.ycom.nosp@m.pany..nosp@m.com <My name>'

Returns: string Escaped string.

Definition at line 2078 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	$str	String to clean
string	$newstr	String to replace bad chars with.
int	$unaccent	1=Remove also accent (default), 0 do not remove them
int	$includequotes	1=Include simple quotes (double is already included by default)
int	$allowdash	1=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 1969 of file functions.lib.php.

◆ 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 $str String to clean

Returns: string String cleaned (a-zA-Z_)

See also: dol_string_nospecial(), dol_string_unaccent(), dol_sanitize...()

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

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

◆ 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	$str	String to clean
string	$newstr	String to replace bad chars with
int	$unaccent	1=Remove also accent, 0 do not remove them
int	$allowdash	1=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 2007 of file functions.lib.php.

Referenced by FileUpload\__construct(), CommonObject\commonGenerateDocument(), dol_uncompress(), dolSavePageContent(), Utils\dumpDatabase(), AntiVir\getCliCommand(), getMultidirOutput(), EmailCollector\getpart(), FileUpload\handleFileUpload(), dolReceiptPrinter\initPrinter(), Documents\post(), EmailCollector\saveAttachment(), 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	$stringtoclean	String to clean
int	$type	0=Accept all Url, 1=Clean external Url (keep only relative Url)

Returns: string Escaped string.

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

◆ dol_shutdown()

dol_shutdown ( )

Function called at end of web php process.

Returns: void

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

◆ dol_size()

dol_size	(		$size,
			$type = '' )

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

Parameters

int	$size	Size we want
string	$type	Type 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 1942 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	$index	Key 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	$order	Sort 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 8122 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	$fmt	Format of strftime function (http://php.net/manual/fr/function.strftime.php)
int \| false	$ts	Timestamp (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_gmt	See comment of timestamp parameter

Returns: string A formatted string

See also: dol_stringtotime()

Definition at line 2761 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	$s	String to check
int	$clean	Clean 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 6706 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	$stringtoclean	String to clean
string[]	$disallowed_tags	Array 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 6098 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	$stringtoclean	String to clean
integer	$removelinefeed	1=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	$pagecodeto	Encoding of input/output string
integer	$strip_tags	0=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	$removedoublespaces	Replace 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 5734 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(), dolPrintLabel(), dolPrintText(), 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\select_produits_fournisseurs_list(), Form\selectCurrency(), Form\selectPhoneCode(), ActionComm\sendSmsReminder(), Form\showCategories(), FormTicket\showMessageForm(), AccountancyExport\toAnsi(), ExportTsv\tsv_clean(), ActionsTicket\viewTicketOriginalMessage(), and ExportCsv\write_title().

◆ 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	$str	String to clean
string	$newstr	String to replace forbidden chars with
string[] \| string	$badcharstoreplace	Array of forbidden characters to replace. Use '' to keep default list.
string[] \| string	$badcharstoremove	Array 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 2199 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(), Utils\dumpDatabase(), 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	$str	String to clean
int	$removetabcrlf	Remove also CR-LF

Returns: string Cleaned string

See also: dol_sanitizeFilename(), dol_string_unaccent(), dol_string_nospecial()

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

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

◆ dol_string_onlythesehtmlattributes()

dol_string_onlythesehtmlattributes	(	$stringtoclean,
		$allowed_attributes = null,
		$ishtml = 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	$stringtoclean	String to clean
string[] \| null	$allowed_attributes	Array of attributes to keep (null = default list)
int \| null	$ishtml	Use 1 if string is not an HTML content. 0 if it is, null if unknown.

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 5971 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	$stringtoclean	String to clean
int	$cleanalsosomestyles	Remove absolute/fixed positioning from inline styles
int	$removeclassattribute	1=Remove the class attribute from tags
int	$cleanalsojavascript	Remove also occurrence of 'javascript:'.
int	$allowiframe	Allow iframe tags.
string \| string[]	$allowed_tags	Array of allowed tags to replace the default list or '' or 'common' or 'common,a,b,c'
int	$allowlink	Allow "link" and "meta" tags (for head html section when using GETPOST with mode 'restricthtmlallowlinkscript')
int	$allowscript	Allow "script" tags (for head html section when using GETPOST with mode 'restricthtmlallowlinkscript')
int	$allowstyle	Allow "style" tags (for head html section when using GETPOST with mode 'restricthtmlallowlinkscript')
int	$allowphp	Allow "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 5812 of file functions.lib.php.

Referenced by dol_escape_htmltag(), dolPrintHTML(), dolPrintHTMLForAttribute(), dolPrintHTMLForAttributeUrl(), dolPrintHTMLForTextArea(), and Form\editfieldval().

◆ dol_string_unaccent()

dol_string_unaccent ( $str )

Clean a string from all accent characters to be used as ref, login or by dol_sanitizeFileName.

Parameters

string $str String to clean. Must be an ascii or utf8 string without any htmlentities.

Returns: string Cleaned string

See also: dol_sanitizeFilename(), dol_string_nospecial()

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

Referenced by CMailFile\__construct(), BonPrelevement\buildRumNumber(), classifyIntentUniversal(), dol_buildlogin(), DolGraph\draw_chart(), DolGraph\draw_jflot(), BonPrelevement\EnregDestinataireSEPA(), BonPrelevement\EnregEmetteurSEPA(), AccountancyExport\exportCegid(), AccountancyExport\exportCiel(), AccountancyExport\exportFEC(), AccountancyExport\exportFEC2(), AccountancyExport\exportQuadratus(), AccountancyExport\exportWinfic(), BonPrelevement\generate(), get_next_value(), mod_codeproduct_elephant\getNextValue(), and Form\selectPhoneCode().

◆ dol_strlen()

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

Make a strlen call.

Works even if mbstring module not enabled

Parameters

?string	$string	String to calculate length
string	$stringencoding	Encoding of string

Returns: int Length of string

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

◆ 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	$string	String to encode
string	$encoding	Character set encoding

Returns: string String converted

Definition at line 2387 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	$string	String to encode
string	$encoding	Character set encoding

Returns: string String converted

See also: dol_ucfirst(), dol_ucwords()

Definition at line 2404 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	$string	String to scan
int	$start	Start position (0 for first char)
int \| null	$length	Length (in nb of characters or nb of bytes depending on trunconbytes param)
string	$stringencoding	Page code used for input string encoding
int	$trunconbytes	1=Length is max of bytes instead of max of characters

Returns: string substring

Definition at line 4320 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	$message	Line 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	$suffixinfilename	When output is a file, append this suffix into default log filename. Example '_stripe', '_mail'
string	$restricttologhandler	Force 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 2492 of file functions.lib.php.

◆ dol_textishtml()

dol_textishtml	(		$msg,
			$option = 0 )

Return if a text is a html content.

Parameters

string	$msg	Content to check
int	$option	0=Full detection, 1=Fast check

Returns: boolean true/false

See also: dol_concatdesc()

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

Referenced by CMailFile\__construct(), DolEditor\__construct(), ajax_dialog(), InterfaceTicketEmail\composeAndSendAdminMessage(), InterfaceTicketEmail\composeAndSendCustomerMessage(), dolGetButtonAction(), Mailing\fetch(), Ai\generateContent(), FormMail\get_form(), getTitleFieldOfList(), ActionComm\getTooltipContentArray(), Adherent\makeSubstitution(), Ticket\newMessage(), pdf_getlinedesc(), Adherent\sendEmail(), sendEmailToRepresentative(), sendMailRepresentativeUnpaid(), and FormTicket\showMessageForm().

◆ 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	$string	String to truncate
int	$size	Max 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	$trunc	Where to trunc: 'right', 'left', 'middle' (size must be a 2 power), 'wrap'
string	$stringencoding	Tell what is source string encoding
int	$nodot	Truncation do not add '...' after truncation. So it's an exact truncation.
int	$display	Trunc 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 4359 of file functions.lib.php.

Referenced by Product\_get_stats(), pdf_aurore\_pagehead(), pdf_cyan\_pagehead(), pdf_eratosthene\_pagehead(), pdf_helios\_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(), show_actions_messaging(), 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(), Propal\updateline(), pdf_beluga\write_file(), pdf_standard_inventory\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	$string	String to encode
string	$encoding	Character set encodign

Returns: string String converted

See also: dol_strtoupper(), dol_ucwords()

Definition at line 2421 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	$string	String to encode
string	$encoding	Character set encodign

Returns: string String converted

See also: dol_strtoupper(), dol_ucfirst()

Definition at line 2438 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 4105 of file functions.lib.php.

◆ dol_validElement()

dol_validElement ( $element )

Return if var element is ok.

Parameters

string $element Variable to check

Returns: boolean Return true of variable is not empty

See also: getElementProperties()

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

◆ dolBuildUrl()

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

Return path of url.

Parameters

string	$url	Relative path to file
	array<string,int\|float\|string>	$params params for the http query
bool	$addtoken	does we need to add token
string	$anchor	Add an anchor #xxx at end of URL

Returns: string path

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

◆ dolCheckFilters()

dolCheckFilters	(		$sqlfilters,
		&	$error = '',
		&	$parenthesislevel = 0 )

Return if a $sqlfilters parameter has a valid balance of parenthesis.

Parameters

string	$sqlfilters	Universal SQL filter string. Must have been trimmed before.
string	$error	Returned error message
int	$parenthesislevel	Returned level of global parenthesis that we can remove/simplify, 0 if error or we can't simplify.

Returns: boolean True if valid, False if not valid ($error returned parameter is filled with the reason in such a case)

See also: forgeSQLFromUniversalSearchCriteria()

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

Referenced by DolibarrApi\_checkFilters().

◆ dolChmod()

dolChmod	(		$filepath,
			$newmask = '' )

Change mod of a file.

Parameters

string	$filepath	Full file path
string	$newmask	Force new mask. For example '0644'

Returns: void

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

◆ dolCloseUnclosedHtmlTags()

dolCloseUnclosedHtmlTags ( $text )

Close the HTML tags left open in a truncated HTML string.

Truncating HTML on a separator can cut inside a block, and an unclosed tag makes the browser nest everything that follows inside it. Only tags really left open are closed, in reverse order.

Parameters

string $text HTML string, possibly with unclosed tags

Returns: string Same string with the missing closing tags appended

See also: dolGetFirstLineOfText()

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

Referenced by show_actions_messaging().

◆ 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	$string	String to explode
string	$delimiter	Delimiter between each couple of data. Example: ';' or '[ ;]+' or '( \r\|\r\| \|;)'
string	$kv	Delimiter between key and value

Returns: array<string,string> Array of data exploded

Definition at line 9479 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 $input String to explode

Returns: array<string> Array of string values

Parameters

string	$a	Matched value in double quotes
string	$b	Matched value in single quotes
string	$c	Unquoted value

Returns: string

Filter out empty strings from the result array.

Parameters

string $val The value to check.

Returns: bool True if the value is not an empty string.

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

◆ dolForgeDummyCriteriaCallback()

dolForgeDummyCriteriaCallback ( $matches )

Function to forge a SQL criteria from a Dolibarr filter syntax string.

This method is called by forgeSQLFromUniversalSearchCriteria()

Parameters

string[] $matches Array of found string by regex search. Example: "t.ref:like:'SO-%'" or "t.date_creation:>:'20160101'" or "t.nature:is:NULL"

Returns: string Forged criteria. Example: "" or "()"

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

◆ dolForgeExplodeAnd()

dolForgeExplodeAnd ( $sqlfilters )

Explode an universal search string with AND parts.

This is used to output the search criteria in an UFS (Universal Filter Syntax) input component.

Parameters

string $sqlfilters Universal SQL filter string. Must have been trimmed before.

Returns: string[] Array of AND

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

Referenced by Form\searchComponent().

◆ dolForgeSQLCriteriaCallback()

dolForgeSQLCriteriaCallback ( $matches )

Function to forge a SQL criteria from a USF (Universal Filter Syntax) string.

This method is called by forgeSQLFromUniversalSearchCriteria()

Parameters

string[] $matches Array of found strings by regex search. Example: $matches[1] = "t.ref:like:'SO-%'" or "t.date_creation:>:'20160101'" or "t.date_creation:<:'2016-01-01 12:30:00'" or "t.nature:is:NULL"

Returns: string Forged criteria. Example: "t.field LIKE 'abc%'"

See also: forgeSQLFromUniversalSearchCriteria()

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

Referenced by DolibarrApi\_forge_criteria_callback().

◆ dolGetCountryCodeFromIp()

dolGetCountryCodeFromIp ( $ip )

Return a country code from IP.

Empty string if not found.

Parameters

string $ip IP

Returns: string Country code ('us', 'fr', ...)

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

◆ dolGetFirstLastname()

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

Return firstname and lastname in correct order.

Parameters

string	$firstname	Firstname
string	$lastname	Lastname
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 8054 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	$s	String to truncate
int	$nbofchar	Nb of characters to keep

Returns: string Return first chars.

Definition at line 4278 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	$text	Input text
int	$nboflines	Nb of lines to get (default is 1 = first line only)
string	$charset	Charset 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 6167 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(), BlockedLog\setObjectData(), and show_actions_messaging().

◆ dolIsAllowedForPreview()

dolIsAllowedForPreview ( $file )

Return if a file is qualified for preview.

Parameters

string $file Filename we looking for information

Returns: int<0,1> 1 If allowed, 0 otherwise

See also: dol_mimetype(), image_format_supported() from images.lib.php

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

Referenced by DocumentController\init(), ViewImageController\init(), and Form\showphoto().

◆ dolSetCookie()

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

Set a cookie.

Parameters

string	$cookiename	Cookie name
string	$cookievalue	Cookie value
int	$expire	Expire 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 1551 of file functions.lib.php.

◆ dolSlugify()

dolSlugify ( $stringtoslugify )

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

Parameters

string $stringtoslugify String to slugify

Returns: string Slugified string

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

◆ dolSort()

dolSort ( $arraytosort )

Sort an array using a user defined function.

This function is a wrapper to usort without the callable parameter so we can use it into dol_eval(). This function is not used in Dolibarr code.

Parameters

array<string|int,mixed> $arraytosort Array to sort

Returns: array<string|int,mixed> Return the sorted array (the source array is not modified)

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

◆ forgeSQLFromUniversalSearchCriteria()

forgeSQLFromUniversalSearchCriteria	(		$filter,
		&	$errorstr = '',
			$noand = 0,
			$nopar = 0,
			$noerror = 0,
			$forbiddenfields = array() )

forgeSQLFromUniversalSearchCriteria

Parameters

?string	$filter	String with universal search string. Must be '(aaa:bbb:ccc) OR (ddd:eeee:fff) ...' with aaa is a field name (with alias or not) and bbb is one of this operator '=', '<', '>', '<=', '>=', '!=', 'in', 'notin', 'like', 'notlike', 'is', 'isnot'. ccc must not contains ( or ) Example: '((client:=:1) OR ((client:>=:2) AND (client:<=:3))) AND (client:!=:8) AND (nom:like:'a')'
string	$errorstr	Error message string
	int<0,1>	$noand 1=Do not add the AND before the condition string.
	int<0,1>	$nopar 1=Do not add the parenthesis around the final condition string.
	int<0,1>	$noerror 1=If search criteria is not valid, does not return an error string but invalidate the SQL
string[]	$forbiddenfields	List of fields that we can't use in the filter

Returns: string Return forged SQL string

See also: dolSqlDateFilter(); natural_search()

Definition at line 11222 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 $data Any 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(), CommonObject\setPaymentTerms(), and Societe\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_start	Start date
int	$date_end	End date
string	$format	Output date format ('day', 'dayhour', ...)
?Translate	$outputlangs	Output language
	int<0,2>	$withparenthesis 1=Add space and parenthesis, 0=no parenthesis, 2=Add parenthesis

Returns: string String

Definition at line 8023 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_seller	Third party seller
Societe	$thirdparty_buyer	Third party buyer
int	$local	Localtax to process (1 or 2)
int	$idprod	Id product

Returns: int localtax, -1 if it can not be determined

See also: get_default_tva(), get_default_npr()

Definition at line 5484 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_seller	Thirdparty seller
Societe	$thirdparty_buyer	Thirdparty buyer
int	$idprod	Id product
int	$idprodfournprice	Id supplier price for product

Returns: int<0,1> 0 or 1

See also: get_default_tva(), get_default_localtax()

Definition at line 5448 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_seller	Object Seller company
Societe	$thirdparty_buyer	Object Buyer company
int	$idprod	Id product
int	$idprodfournprice	Id 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 5268 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->"5/1/0/", '015' with level 1->"5/", 'ABC-1' with level 3 ->"1/0/0/"

Parameters

string \| int	$num	Id of object (deprecated, $object->id will be used in future)
int	$level	Level of subdirs to return (1, 2 or 3 levels). (deprecated, global setup will be used in future)
int	$alpha	0=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	$withoutslash	0=With slash at end (except if '/', we return ''), 1=without slash at end
?CommonObject	$object	Object to use to get ref to forge the path.
string	$modulepart	Type of object ('invoice_supplier, 'donation', 'invoice', ...'). Use '' for autodetect from $object.

Returns: string Sanitized Dir to use ending. Example '' or '1/' or '1/2/'

See also: getMultidirOutput()

Definition at line 5557 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_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	$vatrate	Vat rate. Can be '8.5' or '8.5 (VATCODEX)' for example
int	$local	Local tax to search and return (1 or 2 return only tax rate 1 or tax rate 2)
?Societe	$thirdparty_buyer	Object of buying third party
?Societe	$thirdparty_seller	Object 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 4760 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 4918 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	$idprod	Id of product
int	$local	1 for localtax1, 2 for localtax 2
Societe	$thirdpartytouseforcountry	Thirdparty 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 5194 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	$idprod	Id of product or 0 if not a predefined product
Societe	$thirdpartytouseforcountry	Thirdparty with a ->country_code defined (FR, US, IT, ...)
int	$idprodfournprice	Id 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 5098 of file functions.lib.php.

◆ getActionCommEcmList()

getActionCommEcmList ( $object )

getActionCommEcmList

Parameters

ActionComm $object Object ActionComm

Returns: array<int,stdClass> Array of documents in index table

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

Referenced by show_actions_messaging().

◆ 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 3438 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.

Parameters

string $user_agent Content 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 774 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 2453 of file functions.lib.php.

◆ getDictionaryValue()

getDictionaryValue	(	$tablename,
		$field,
		$id,
		$checkentity = false,
		$rowidfield = 'rowid' )

Return the value of a filed into a dictionary for the record $id.

This also set all the values into a cache for a next search.

Parameters

string	$tablename	Name of table dictionary (without the MAIN_DB_PREFIX, example: 'c_holiday_types')
string	$field	The name of field where to find the value to return
int	$id	Id of line record
bool	$checkentity	Add filter on entity
string	$rowidfield	Name of the column rowid (to use for the filter on $id)

Returns: string The value of field $field. This also set $dictvalues cache.

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

Referenced by Holiday\approve(), Facture\createDepositFromOrigin(), CommonObject\setPaymentTerms(), Societe\setPaymentTerms(), Holiday\update(), and Holiday\validate().

◆ getDolCurrency()

getDolCurrency ( )

Return the main currency ('EUR', 'USD', ...)

Returns: string Value returned

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

References $conf.

Referenced by pdf_einstein\_tableau(), pdf_eratosthene\_tableau(), pdf_sponge\_tableau(), pdf_standard_asset\_tableau(), pdf_standard_recruitmentjobposition\_tableau(), Propal\create(), SupplierProposal\create(), modMultiCurrency\createFirstCurrency(), AccountancyExport\exportQuadratus(), Translate\getCurrencySymbol(), DolibarrCollector\getDolibarrInfo(), Don\getKanbanView(), Expedition\getKanbanView(), WebPortalOrder\getKanbanView(), getStructuredData(), SupplierProposal\getTooltipContentArray(), htmlPrintOnlineFooter(), Propal\initAsSpecimen(), SupplierProposal\initAsSpecimen(), pdf_pagefoot(), pricejs(), MultiCurrency\recalculRates(), sendEmailToRepresentative(), sendMailRepresentativeUnpaid(), top_menu_user(), and pdf_eratosthene\write_file().

◆ getDolDBType()

getDolDBType ( )

Return the current entity.

Returns: string Value returned

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

References $conf.

◆ getDolDefaultContextPage()

getDolDefaultContextPage ( $s )

Return the default context page string.

Parameters

string $s Page path

Returns: string Value returned

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

◆ getDolEntity()

getDolEntity ( )

Return the current entity.

Returns: int Value returned

Definition at line 421 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	$key	Key to return value, return $default if not set
bool	$default	Value to return if not defined

Returns: bool Value returned

Definition at line 388 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	$key	Key to return value, return $default if not set
float	$default	Value to return if not defined

Returns: float Value returned

See also: getDolUserInt()

Definition at line 374 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	$key	Key to return value, return $default if not set
int	$default	Value to return if not defined

Returns: int Value returned

See also: getDolUserInt()

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

References $conf.

◆ getDolGlobalLoginBadCharUnauthorized()

getDolGlobalLoginBadCharUnauthorized ( )

Return the list of unauthorized characters in user logins.

Returns: string

Definition at line 335 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	$key	Key to return value, return $default if not set
string \| int \| float	$default	Value to return if not defined

Returns: string Value returned

See also: getDolUserString()

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

References $conf.

◆ getDoliDBInstance()

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

Return a DoliDB instance (database handler).

Parameters

string	$type	Type of database (mysql, pgsql...)
string	$host	Address of database server
string	$user	Authorized username
string	$pass	Password (clear)
string	$name	Name of database
int	$port	Port of database server

Returns: DoliDB A DoliDB instance

Definition at line 626 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 410 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	$key	Key to return value, return 0 if not set
int	$default	Value to return
User	$tmpuser	To get another user than current user

Returns: int

Definition at line 476 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	$key	Key to return value, return '' if not set
string \| int \| float	$default	Value to return
User	$tmpuser	To get another user than current user

Returns: string

See also: getDolGlobalString()

Definition at line 458 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().

◆ getElementProperties()

getElementProperties ( $elementType )

Get an array with properties of an element.

We must not have database access in this method.

Parameters

string $elementType Element type (Value of $object->element or value of $object->element$object->module). Example: 'action', 'facture', 'project', 'project_task' or 'myobject@mymodule' (or old syntax 'mymodule_myobject' like 'project_task')

Returns: array{module:string,element:string,table_element:string,subelement:string,classpath:string,classfile:string,classname:string,dir_output:string,dir_temp:string,parent_element:string} array('module'=>, 'classpath'=>, 'element'=>, 'subelement'=>, 'classfile'=>, 'classname'=>, 'dir_output'=>, 'dir_temp'=>)

See also: fetchObjectByElement(), getMultidirOutput()

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

Referenced by FileUpload\__construct(), modCategorie\exportTagLinks(), CommonObject\fetchObjectLinked(), LinkField\getObject(), modCategorie\importTagLinks(), DocumentController\init(), Validate\isFetchableElement(), InterfaceActionsAuto\runTrigger(), and Form\selectForFormsList().

◆ getEntity()

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

Get list of entity id to use.

Parameters

string	$element	Current 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	$currentobject	Current object if needed

Returns: string Entity id(s) to use ( eg. entity IN ('.getEntity(elementname).')' )

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

◆ getExecutableContent()

getExecutableContent ( )

Return array of extension for executable files of text files that can contains executable code.

Returns: string[] Array of extensions

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

Referenced by dol_add_file_process().

◆ getImageFileNameForSize()

getImageFileNameForSize	(	$file,
		$extName,
		$extImgTarget = '' )

Return the filename of file to get the thumbs.

Parameters

string	$file	Original filename (full or relative path)
string	$extName	Extension to differentiate thumb file name ('', '_small', '_mini')
string	$extImgTarget	Force image extension for thumbs. Use '' to keep same extension than original image (default).

Returns: string New file name (full or relative path, including the thumbs/). May be the original path if no thumb can exists.

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

Referenced by CommonObject\delThumbs(), CommonDocGenerator\get_substitutionarray_user(), FormFile\list_of_documents(), CommonObject\show_photos(), FormFile\showImageToEdit(), Form\showphoto(), and vignette().

◆ getLabelSpecialCode()

getLabelSpecialCode ( $idcode )

Make content of an input box selected when we click into input field.

Parameters

int $idcode Id of special code

Returns: string

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

◆ getLanguageCodeFromCountryCode()

getLanguageCodeFromCountryCode ( $countrycode )

Return default language from country code.

Return null if not found.

Parameters

string $countrycode Country 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 9085 of file functions.lib.php.

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

◆ getListLimitFromScreenHeight()

getListLimitFromScreenHeight ( )

Get the limit of list to show according to the screen height.

Returns: int The limit of list to show

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

Referenced by Conf\setValues().

◆ 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	$vatrate	VAT 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	$buyer	Company object
?Societe	$seller	Company 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 5034 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	$object	Dolibarr common object.
string	$module	Override object element, for example to use 'mycompany' instead of 'societe'
int	$forobject	Return 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, dol_sanitizePathName(), and get_exdir().

Referenced by FileUpload\__construct(), pdf_eratosthene\_pagehead(), pdf_standard_myobject\_pagehead(), pdf_strato\_pagehead(), blockedlogadmin_prepare_head(), bomPrepareHead(), CommonObject\deleteCommon(), Documents\getDocumentsListByElement(), 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	$object	Dolibarr common object
string	$module	Override object element, for example to use 'mycompany' instead of 'societe'
int	$forobject	Return 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 296 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	$object	Dolibarr common object
string	$module	Override object element, for example to use 'mycompany' instead of 'societe'
int	$forobject	Return 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 310 of file functions.lib.php.

References $object, and getMultidirOutput().

◆ getNonce()

getNonce ( )

Return a random string to be used as a nonce value for js.

Returns: string

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

Referenced by Form\buttonsSaveCancel(), dol_get_fiche_head(), dolButtonToOpenExportDialog(), dragAndDropFileUpload(), Form\formconfirm(), get_htmloutput_mesg(), Form\getSelectConditionsPaiements(), info_admin(), Form\select_dolresources_forevent(), Form\select_dolusers_forevent(), Form\select_produits(), Form\selectArrayAjax(), FormCompany\selectCompaniesForNewContact(), Form\selectDate(), Form\selectExpenseCategories(), Form\selectMassAction(), FormBarCode\setBarcodeEncoder(), Form\showCheckAddButtons(), showEyeForField(), Form\showLinkToObjectBlock(), top_htmlhead(), and Form\widgetForTranslation().

◆ getObjectSocId()

getObjectSocId ( $obj )

Get the socid of an object, supporting legacy attribute names.

Parameters

object $obj The Dolibarr object

Returns: int|null Returns the socid if found, null otherwise

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

Referenced by canDisplayLinkedObjectInPDF().

◆ GETPOST()

GETPOST	(	$paramname,
		$check = 'alphanohtml',
		$method = 0,
		$filter = null,
		$options = null,
		$noreplace = 0,
		$nodefault = 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	$paramname	Name 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	$method	Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get)
?int	$filter	Filter to apply when $check is set to 'custom'. (See http://php.net/manual/en/filter.filters.php for details)
mixed	$options	Options to pass to filter_var when $check is set to 'custom'
int	$noreplace	Force disable of replacement of xxx strings.
int	$nodefault	Force disable of default values set from the admin setup page

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 1121 of file functions.lib.php.

◆ 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	$prefix	Prefix 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	$gm	Passed 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	$saverestore	Use 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 1028 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	$paramname	Name 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 1007 of file functions.lib.php.

◆ GETPOSTINT()

GETPOSTINT	(	$paramname,
		$method = 0,
		$nodefault = 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	$paramname	Name 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)
int	$nodefault	Force disable of default values set from the admin setup page

Returns: int Value converted into integer

Definition at line 989 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	$paramname	Name 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 960 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 $paramname Name 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 909 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	$vatrate	VAT 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	$buyer	Company object
?Societe	$seller	Company 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 4955 of file functions.lib.php.

Referenced by Societe\set_remise_except().

◆ getTimelineIcon()

getTimelineIcon	(		$actionstatic,
		&	$histo,
			$key )

Get timeline icon.

Parameters

ActionComm	$actionstatic	actioncomm
	array<int,array{percent:int}>	$histo histo
int	$key	key

Returns: string String with timeline icon

Deprecated: Use actioncomm->getPictoType() instead

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

◆ 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 $trusted 0=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 4038 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	$module	Module of permission to check (Example: 'bank', 'contrat', ...)
string	$parmlevel1	Parameter level1 (Example: 'rappro', 'services', ...)
string	$parmlevel2	Parameter level2 (Example: 'inactifs', ...)

Returns: int Return the warning delay

Definition at line 562 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().

◆ isAFileWithExecutableContent()

isAFileWithExecutableContent ( $filename )

Return if a file can contains executable content.

Parameters

string $filename File name to test

Returns: boolean True if yes, False if no

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

Referenced by dol_move_uploaded_file(), and Documents\post().

◆ isASecretKey()

isASecretKey ( $keyname )

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

Parameters

string $keyname Name of key to test

Returns: boolean True if key is used to store a secret

Definition at line 736 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 $timestamp timestamp to check

Returns: bool

Definition at line 602 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 $module Module name to check

Returns: boolean True if module is enabled

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

◆ 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 $local Local tax to test (1 or 2)

Returns: boolean True if LocalTax have multiple values, False if not

Definition at line 4899 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	$var	Variable name ('mainmenu' or 'leftmenu', ...)
string	$regextext	Text 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 8363 of file functions.lib.php.

◆ isValidEmail()

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

Return true if email syntax is ok.

Parameters

string	$address	email (Ex: "toto@example.com". Long form "John Do <johndo@example.com>" will be false)
int	$acceptsupervisorkey	If 1, the special string 'SUPERVISOREMAIL' is also accepted as valid
int	$acceptuserkey	If 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 4207 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 $domain Domain 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 4231 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 $phone phone (Ex: "0601010101")

Returns: boolean true if phone syntax is OK, false if KO or empty string

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

◆ isVisibleToUserType()

isVisibleToUserType	(		$type_user,
		&	$menuentry,
		&	$listofmodulesforexternal )

Function to test if an entry is enabled or not.

Parameters

	int<0,1>	$type_user 0=We test for internal user, 1=We test for external user
	array{enabled:int<0,1>,module?:string,perms:string}	$menuentry Array for feature entry to test
string[]	$listofmodulesforexternal	Array with list of modules allowed to external users

Returns: int<0,2> 0=Hide, 1=Show, 2=Show gray

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

Referenced by box_produits\__construct(), box_produits_alerte_stock\__construct(), get_left_menu_projects(), and print_eldy_menu().

◆ jsonOrUnserialize()

jsonOrUnserialize	(		$stringtodecode,
			$assoc = true )

Decode an encoded string.

The string can be encoded in json format (recommended) or with serialize (avoid this)

Parameters

string	$stringtodecode	String to decode (json or serialize coded)
boolean	$assoc	true=Return is converted into associative array

Returns: mixed The decoded object.

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

Referenced by BlockedLog\dolDecodeBlockedData(), ExtraFields\fetch_name_optionals_label(), Setup\getExtrafields(), Setup\getListOfExtrafields(), ExportCsv\write_record(), ExportExcel2007\write_record(), and ExportTsv\write_record().

◆ 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	$text	Source 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	$outputlangs	Output 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 7756 of file functions.lib.php.

◆ 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[]	$fields	String 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	$value	The 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	$mode	0=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	$nofirstand	1=Do not output the first 'AND'
string	$sqltoadd	Additional 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 9602 of file functions.lib.php.

◆ newToken()

newToken ( )

Return the value of token currently saved into session with name 'newtoken'.

This token must be send by any POST as it will be used by next page for comparison with value in session.

Since: Dolibarr v10.0.7

Returns: string

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

◆ 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 $n Numeric value

Returns: string Column in Excel format

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

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

◆ picto_required()

picto_required ( )

Return picto saying a field is required.

Returns: string String with the picto mandatory

Definition at line 5712 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	$amount	Amount value to format
	int<0,1>	$form Type of formatting: 1=HTML, 0=no formatting (no by default)
Translate \| string \| null	$outlangs	Object langs for output. '' use default lang. 'none' use international separators.
int	$trunc	1=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_code	To 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 4474 of file functions.lib.php.

◆ 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	$amount	Amount 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('W9c', '', 0) => '9c', price2num('W9c', '', 1) => 'W9c', price2num('W9c', '', 2) => '9c'
'0' if ($rounding is defined): price2num('W9c', 'MT', 0) => '9', price2num('W9c', 'MT', 1) => '0', price2num('W9c', '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 4605 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(), 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_inventory\write_file(), pdf_standard_movementstock\write_file(), pdf_standard_stock\write_file(), and AccountingJournal\writeIntoBookkeeping().

◆ print_date_range()

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

Format output for start and end date.

Parameters

int	$date_start	Start date
int	$date_end	End date
string	$format	Output format
Translate	$outputlangs	Output language

Returns: void

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

◆ readfileLowMemory()

readfileLowMemory	(		$fullpath_original_file_osencoded,
			$method = -1 )

Return a file on output using a low memory.

It can return very large files with no need of memory. WARNING: This close output buffers.

Parameters

string	$fullpath_original_file_osencoded	Full path of file to return.
	int<-1,2>	$method -1 automatic, 0=readfile, 1=fread, 2=stream_copy_to_stream

Returns: void

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

Referenced by DocumentController\display(), and AccountancyExport\export().

◆ recordNotFound()

recordNotFound	(	$message = '',
		$printheader = 1,
		$printfooter = 1,
		$showonlymessage = 0,
		$params = null )

Displays an error page when a record is not found.

It allows customization of the message, whether to include the header and footer, and if only the message should be shown without additional details. The function also supports executing additional hooks for customized handling of error pages.

Parameters

string	$message	Custom error message to display. If empty, a default "Record Not Found" message is shown.
	int<0,1>	$printheader Determines if the page header should be printed (1 = yes, 0 = no).
	int<0,1>	$printfooter Determines if the page footer should be printed (1 = yes, 0 = no).
	int<0,1>	$showonlymessage If set to 1, only the error message is displayed without any additional information or hooks.
mixed	$params	Optional parameters to pass to hooks for further processing or customization. @global Conf $conf Dolibarr configuration object (global) @global DoliDB $db Database connection object (global) @global Translate $langs Language translation object, initialized within the function if not already. @global HookManager $hookmanager Hook manager object, initialized within the function if not already for executing hooks. @global string $action Current action, can be modified by hooks. @global object $object Current object, can be modified by hooks.

Returns: void This function terminates script execution after outputting the error page.

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

◆ roundUpToNextMultiple()

roundUpToNextMultiple	(		$n,
			$x = 5 )

Round to next multiple.

Parameters

float	$n	Number to round up
int	$x	Multiple. For example 60 to round up to nearest exact minute for a date with seconds.

Returns: int Value rounded.

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

◆ safeArrayMap()

safeArrayMap	(		$callback,
		array	$array )

Add a function to replace array_map with allowed callback.

Parameters

string \| mixed	$callback	Function
	array<mixed,mixed>	$array Array

Returns: array<mixed,mixed> The array after the array_map

Definition at line 6904 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	$out	Value to check/clear.
string	$check	Type of check/sanitizing
?int	$filter	Filter to apply when $check is set to 'custom' (deprecated). (See http://php.net/manual/en/filter.filters.php for details)
?mixed	$options	Options 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 1404 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 $currentobject Current object

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

Definition at line 719 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().

◆ 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 $str String 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 8193 of file functions.lib.php.

Referenced by CMailFile\check_server_port(), dol_delete_dir_recursive(), dol_dir_list(), dol_print_error(), dolDecrypt(), 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 $str String to check

Returns: boolean True if string is valid UTF8 string, false if corrupted

See also: utf8_check()

Definition at line 8231 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	$rate	Rate value to format ('19.6', '19,6', '19.6', '19,6', '19.6 (CODEX)', ...)
boolean	$addpercent	Add a percent % sign in output
int	$info_bits	Miscellaneous information on vat (0=Default, 1=French NPR vat)
int	$usestarfornpr	-1=Never show, 0 or 1=Use '*' for NPR vat rates
int	$html	Used 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 4426 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	$strToEvaluate	String 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 8396 of file functions.lib.php.

Referenced by ActionsCardProduct\getFieldListCanvas(), ActionsCardService\getFieldListCanvas(), Export\load_arrays(), and Menubase\menuLoad().

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 518 of file functions.lib.php.

Functions

Variables

Detailed Description

Function Documentation

◆ array_merge_recursive_distinct()

◆ ascii_check()

◆ buildParamDate()

◆ colorIsLight()

◆ complete_head_from_modules()

◆ complete_substitutions_array()

◆ currentToken()

◆ dol_buildpath()

◆ dol_clone()

◆ dol_clone_in_array()

◆ dol_concat()

◆ dol_concatdesc()

◆ dol_escape_all()

◆ dol_escape_js()

◆ dol_escape_json()

◆ dol_escape_php()

◆ dol_escape_uri()

◆ dol_escape_xml()

◆ dol_eval()

◆ dol_eval_new()

◆ dol_eval_standard()

◆ dol_format_address()

◆ dol_get_object_properties()

◆ dol_getdate()

◆ dol_getIdFromCode()

◆ dol_getmypid()

◆ dol_html_entity_decode()

◆ dol_htmlcleanlastbr()

◆ dol_htmlentities()

◆ dol_htmlentitiesbr()

◆ dol_htmlentitiesbr_decode()

◆ dol_htmlwithnojs()

◆ dol_include_once()

◆ dol_mimetype()

◆ dol_mkdir()

◆ dol_mktime()

◆ dol_nboflines()

◆ dol_nboflines_bis()

◆ dol_nl2br()

◆ dol_now()

◆ dol_osencode()

◆ dol_print_address()

◆ dol_print_date()

◆ dol_print_email()

◆ dol_print_ip()

◆ dol_print_phone()

◆ dol_print_profids()

◆ dol_print_size()

◆ dol_print_socialnetworks()

◆ dol_print_url()

◆ dol_sanitizeEmail()

◆ dol_sanitizeFileName()

◆ dol_sanitizeKeyCode()

◆ dol_sanitizePathName()

◆ dol_sanitizeUrl()

◆ dol_shutdown()

◆ dol_size()

◆ dol_sort_array()

◆ dol_strftime()

◆ dol_string_is_good_iso()

◆ dol_string_neverthesehtmltags()

◆ dol_string_nohtmltag()

◆ dol_string_nospecial()

◆ dol_string_nounprintableascii()

◆ dol_string_onlythesehtmlattributes()

◆ dol_string_onlythesehtmltags()

◆ dol_string_unaccent()

◆ dol_strlen()

◆ dol_strtolower()

◆ dol_strtoupper()

◆ dol_substr()

◆ dol_syslog()

◆ dol_textishtml()

◆ dol_trunc()

◆ dol_ucfirst()

◆ dol_ucwords()