|
dolibarr
x.y.z
|
A set of functions for Dolibarr This file contains all frequently used functions. More...
Go to the source code of this file.
Functions | |
| if(!function_exists('utf8_encode')) if(!function_exists('utf8_decode')) | getDolGlobalString ($key, $default='') |
| Return dolibarr global constant string value. More... | |
| getDolGlobalInt ($key, $default=0) | |
| Return dolibarr global constant int value. More... | |
| getDolUserString ($key, $default='') | |
| Return dolibarr user constant string value. More... | |
| getDolUserInt ($key, $default=0) | |
| Return dolibarr user constant int value. More... | |
| isModEnabled ($module) | |
| Is Dolibarr module enabled. More... | |
| getDoliDBInstance ($type, $host, $user, $pass, $name, $port) | |
| Return a DoliDB instance (database handler). More... | |
| getEntity ($element, $shared=1, $currentobject=null) | |
| Get list of entity id to use. More... | |
| setEntity ($currentobject) | |
| Set entity id to use when to create an object. More... | |
| isASecretKey ($keyname) | |
| Return if string has a name dedicated to store a secret. More... | |
| num2Alpha ($n) | |
| Return a numeric value into an Excel like column number. More... | |
| getBrowserInfo ($user_agent) | |
| Return information about user browser. More... | |
| dol_shutdown () | |
| Function called at end of web php process. More... | |
| GETPOSTISSET ($paramname) | |
| Return true if we are in a context of submitting the parameter $paramname from a POST of a form. More... | |
| GETPOSTISARRAY ($paramname, $method=0) | |
| Return true if the parameter $paramname is submit from a POST OR GET as an array. More... | |
| GETPOST ($paramname, $check='alphanohtml', $method=0, $filter=null, $options=null, $noreplace=0) | |
| Return value of a param into GET or POST supervariable. More... | |
| GETPOSTINT ($paramname, $method=0) | |
| Return value of a param into GET or POST supervariable. More... | |
| checkVal ($out='', $check='alphanohtml', $filter=null, $options=null) | |
| Return a sanitized or empty value after checking value against a rule. More... | |
| sanitizeVal ($out='', $check='alphanohtml', $filter=null, $options=null) | |
| Return a sanitized or empty value after checking value against a rule. More... | |
| if(!function_exists('dol_getprefix')) | dol_include_once ($relpath, $classname='') |
| Make an include_once using default root and alternate root if it fails. More... | |
| dol_buildpath ($path, $type=0, $returnemptyifnotfound=0) | |
| Return path of url or filesystem. More... | |
| dol_clone ($object, $native=0) | |
| Create a clone of instance of object (new instance with same value for each properties) With native = 0: Property that are reference are different memory area in the new object (full isolation clone). More... | |
| dol_size ($size, $type='') | |
| Optimize a size for some browsers (phone, smarphone, ...) More... | |
| dol_sanitizeFileName ($str, $newstr='_', $unaccent=1) | |
| Clean a string to use it as a file name. More... | |
| dol_sanitizePathName ($str, $newstr='_', $unaccent=1) | |
| Clean a string to use it as a path name. More... | |
| dol_sanitizeUrl ($stringtoclean, $type=1) | |
| Clean a string to use it as an URL (into a href or src attribute) More... | |
| dol_sanitizeEmail ($stringtoclean) | |
| Clean a string to use it as an Email. More... | |
| dol_string_unaccent ($str) | |
| Clean a string from all accent characters to be used as ref, login or by dol_sanitizeFileName. More... | |
| dol_string_nospecial ($str, $newstr='_', $badcharstoreplace='', $badcharstoremove='') | |
| Clean a string from all punctuation characters to use it as a ref or login. More... | |
| dol_string_nounprintableascii ($str, $removetabcrlf=1) | |
| Clean a string from all non printable ASCII chars (0x00-0x1F and 0x7F). More... | |
| dol_escape_js ($stringtoescape, $mode=0, $noescapebackslashn=0) | |
| Returns text escaped for inclusion into javascript code. More... | |
| dol_escape_json ($stringtoescape) | |
| Returns text escaped for inclusion into javascript code. More... | |
| dol_escape_htmltag ($stringtoescape, $keepb=0, $keepn=0, $noescapetags='', $escapeonlyhtmltags=0) | |
| Returns text escaped for inclusion in HTML alt or title tags, or into values of HTML input fields. More... | |
| dol_strtolower ($string, $encoding="UTF-8") | |
| Convert a string to lower. More... | |
| dol_strtoupper ($string, $encoding="UTF-8") | |
| Convert a string to upper. More... | |
| dol_ucfirst ($string, $encoding="UTF-8") | |
| Convert first character of the first word of a string to upper. More... | |
| dol_ucwords ($string, $encoding="UTF-8") | |
| Convert first character of all the words of a string to upper. More... | |
| dol_syslog ($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null) | |
| Write log message into outputs. More... | |
| dolButtonToOpenUrlInDialogPopup ($name, $label, $buttonstring, $url, $disabled='', $morecss='button bordertransp', $backtopagejsfields='') | |
| Return HTML code to output a button to open a dialog popup box. More... | |
| dol_fiche_head ($links=array(), $active='0', $title='', $notab=0, $picto='', $pictoisfullpath=0, $morehtmlright='', $morecss='', $limittoshow=0, $moretabssuffix='') | |
| Show tab header of a card. More... | |
| dol_get_fiche_head ($links=array(), $active='', $title='', $notab=0, $picto='', $pictoisfullpath=0, $morehtmlright='', $morecss='', $limittoshow=0, $moretabssuffix='') | |
| Show tabs of a record. More... | |
| dol_fiche_end ($notab=0) | |
| Show tab footer of a card. More... | |
| dol_get_fiche_end ($notab=0) | |
| Return tab footer of a card. More... | |
| dol_banner_tab ($object, $paramid, $morehtml='', $shownav=1, $fieldid='rowid', $fieldref='ref', $morehtmlref='', $moreparam='', $nodbprefix=0, $morehtmlleft='', $morehtmlstatus='', $onlybanner=0, $morehtmlright='') | |
| Show tab footer of a card. More... | |
| fieldLabel ($langkey, $fieldkey, $fieldrequired=0) | |
| Show a string with the label tag dedicated to the HTML edit field. More... | |
| dol_bc ($var, $moreclass='') | |
| Return string to add class property on html element with pair/impair. More... | |
| dol_format_address ($object, $withcountry=0, $sep="\n", $outputlangs='', $mode=0, $extralangcode='') | |
| Return a formated address (part address/zip/town/state) according to country rules. More... | |
| dol_strftime ($fmt, $ts=false, $is_gmt=false) | |
| Format a string. More... | |
| dol_print_date ($time, $format='', $tzoutput='auto', $outputlangs='', $encodetooutput=false) | |
| Output date in a string format according to outputlangs (or langs if not defined). More... | |
| dol_getdate ($timestamp, $fast=false, $forcetimezone='') | |
| Return an array with locale date info. More... | |
| dol_mktime ($hour, $minute, $second, $month, $day, $year, $gm='auto', $check=1) | |
| Return a timestamp date built from detailed informations (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. More... | |
| dol_now ($mode='auto') | |
| Return date for now. More... | |
| dol_print_size ($size, $shortvalue=0, $shortunit=0) | |
| Return string with formated size. More... | |
| dol_print_url ($url, $target='_blank', $max=32, $withpicto=0) | |
| Show Url link. More... | |
| dol_print_email ($email, $cid=0, $socid=0, $addlink=0, $max=64, $showinvalid=1, $withpicto=0) | |
| Show EMail link formatted for HTML output. More... | |
| getArrayOfSocialNetworks () | |
| Get array of social network dictionary. More... | |
| dol_print_socialnetworks ($value, $cid, $socid, $type, $dictsocialnetworks=array()) | |
| Show social network link. More... | |
| dol_print_profids ($profID, $profIDtype, $countrycode='', $addcpButton=1, $separ=' ') | |
| Format profIDs according to country. More... | |
| dol_print_phone ($phone, $countrycode='', $cid=0, $socid=0, $addlink='', $separ=" ", $withpicto='', $titlealt='', $adddivfloat=0) | |
| Format phone numbers according to country. More... | |
| dol_print_ip ($ip, $mode=0) | |
| Return an IP formated to be shown on screen. More... | |
| getUserRemoteIP () | |
| Return the IP of remote user. More... | |
| isHTTPS () | |
| Return if we are using a HTTPS connexion Check HTTPS (no way to be modified by user but may be empty or wrong if user is using a proxy) Take HTTP_X_FORWARDED_PROTO (defined when using proxy) Then HTTP_X_FORWARDED_SSL. More... | |
| dolGetCountryCodeFromIp ($ip) | |
| Return a country code from IP. More... | |
| dol_user_country () | |
| Return country code for current user. More... | |
| dol_print_address ($address, $htmlid, $element, $id, $noprint=0, $charfornl='') | |
| Format address string. More... | |
| isValidEmail ($address, $acceptsupervisorkey=0, $acceptuserkey=0) | |
| Return true if email syntax is ok. More... | |
| isValidMXRecord ($domain) | |
| Return if the domain name has a valid MX record. More... | |
| isValidPhone ($phone) | |
| Return true if phone number syntax is ok TODO Decide what to do with this. More... | |
| dolGetFirstLetters ($s, $nbofchar=1) | |
| Return first letters of a strings. More... | |
| dol_strlen ($string, $stringencoding='UTF-8') | |
| Make a strlen call. More... | |
| dol_substr ($string, $start, $length, $stringencoding='', $trunconbytes=0) | |
| Make a substring. More... | |
| 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. More... | |
| img_picto ($titlealt, $picto, $moreatt='', $pictoisfullpath=false, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2) | |
| Show picto whatever it's its name (generic function) More... | |
| img_object ($titlealt, $picto, $moreatt='', $pictoisfullpath=false, $srconly=0, $notitle=0) | |
| Show a picto called object_picto (generic function) More... | |
| img_weather ($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $morecss='') | |
| Show weather picto. More... | |
| img_picto_common ($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $notitle=0) | |
| Show picto (generic function) More... | |
| img_action ($titlealt, $numaction, $picto='') | |
| Show logo action. More... | |
| img_pdf ($titlealt='default', $size=3) | |
| Show pdf logo. More... | |
| img_edit_add ($titlealt='default', $other='') | |
| Show logo +. More... | |
| img_edit_remove ($titlealt='default', $other='') | |
| Show logo -. More... | |
| img_edit ($titlealt='default', $float=0, $other='') | |
| Show logo editer/modifier fiche. More... | |
| img_view ($titlealt='default', $float=0, $other='class="valignmiddle"') | |
| Show logo view card. More... | |
| img_delete ($titlealt='default', $other='class="pictodelete"', $morecss='') | |
| Show delete logo. More... | |
| img_printer ($titlealt="default", $other='') | |
| Show printer logo. More... | |
| img_split ($titlealt='default', $other='class="pictosplit"') | |
| Show split logo. More... | |
| img_help ($usehelpcursor=1, $usealttitle=1) | |
| Show help logo with cursor "?". More... | |
| img_info ($titlealt='default') | |
| Show info logo. More... | |
| img_warning ($titlealt='default', $moreatt='', $morecss='pictowarning') | |
| Show warning logo. More... | |
| img_error ($titlealt='default') | |
| Show error logo. More... | |
| img_next ($titlealt='default', $moreatt='') | |
| Show next logo. More... | |
| img_previous ($titlealt='default', $moreatt='') | |
| Show previous logo. More... | |
| img_down ($titlealt='default', $selected=0, $moreclass='') | |
| Show down arrow logo. More... | |
| img_up ($titlealt='default', $selected=0, $moreclass='') | |
| Show top arrow logo. More... | |
| img_left ($titlealt='default', $selected=0, $moreatt='') | |
| Show left arrow logo. More... | |
| img_right ($titlealt='default', $selected=0, $moreatt='') | |
| Show right arrow logo. More... | |
| img_allow ($allow, $titlealt='default') | |
| Show tick logo if allowed. More... | |
| img_credit_card ($brand, $morecss=null) | |
| Return image of a credit card according to its brand name. More... | |
| img_mime ($file, $titlealt='', $morecss='') | |
| Show MIME img of a file. More... | |
| img_search ($titlealt='default', $other='') | |
| Show search logo. More... | |
| img_searchclear ($titlealt='default', $other='') | |
| Show search logo. More... | |
| info_admin ($text, $infoonimgalt=0, $nodiv=0, $admin='1', $morecss='hideonsmartphone', $textfordropdown='') | |
| Show information for admin users or standard users. More... | |
| dol_print_error ($db='', $error='', $errors=null) | |
| Displays error message system with all the information to facilitate the diagnosis and the escalation of the bugs. More... | |
| dol_print_error_email ($prefixcode, $errormessage='', $errormessages=array(), $morecss='error', $email='') | |
| Show a public email and error code to contact if technical error. More... | |
| print_liste_field_titre ($name, $file="", $field="", $begin="", $moreparam="", $moreattrib="", $sortfield="", $sortorder="", $prefix="", $tooltip="", $forcenowrapcolumntitle=0) | |
| Show title line of an array. More... | |
| getTitleFieldOfList ($name, $thead=0, $file="", $field="", $begin="", $moreparam="", $moreattrib="", $sortfield="", $sortorder="", $prefix="", $disablesortlink=0, $tooltip='', $forcenowrapcolumntitle=0) | |
| Get title line of an array. More... | |
| print_titre ($title) | |
| Show a title. More... | |
| print_fiche_titre ($title, $mesg='', $picto='generic', $pictoisfullpath=0, $id='') | |
| Show a title with picto. More... | |
| load_fiche_titre ($titre, $morehtmlright='', $picto='generic', $pictoisfullpath=0, $id='', $morecssontable='', $morehtmlcenter='') | |
| Load a title with picto. More... | |
| print_barre_liste ($titre, $page, $file, $options='', $sortfield='', $sortorder='', $morehtmlcenter='', $num=-1, $totalnboflines='', $picto='generic', $pictoisfullpath=0, $morehtmlright='', $morecss='', $limit=-1, $hideselectlimit=0, $hidenavigation=0, $pagenavastextinput=0, $morehtmlrightbeforearrow='') | |
| Print a title with navigation controls for pagination. More... | |
| print_fleche_navigation ($page, $file, $options='', $nextpage=0, $betweenarrows='', $afterarrows='', $limit=-1, $totalnboflines=0, $hideselectlimit=0, $beforearrows='') | |
| Function to show navigation arrows into lists. More... | |
| vatrate ($rate, $addpercent=false, $info_bits=0, $usestarfornpr=0, $html=0) | |
| Return a string with VAT rate label formated for view output Used into pdf and HTML pages. More... | |
| 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. More... | |
| price2num ($amount, $rounding='', $option=0) | |
| Function that return a number with universal decimal format (decimal separator is '. More... | |
| showDimensionInBestUnit ($dimension, $unit, $type, $outputlangs, $round=-1, $forceunitoutput='no', $use_short_label=0) | |
| Output a dimension with best unit. More... | |
| get_localtax ($vatrate, $local, $thirdparty_buyer="", $thirdparty_seller="", $vatnpr=0) | |
| Return localtax rate for a particular vat, when selling a product with vat $vatrate, from a $thirdparty_buyer to a $thirdparty_seller Note: This function applies same rules than get_default_tva. More... | |
| isOnlyOneLocalTax ($local) | |
| Return true if LocalTax (1 or 2) is unique. More... | |
| get_localtax_by_third ($local) | |
| Get values of localtaxes (1 or 2) for company country for the common vat with the highest value. More... | |
| getTaxesFromId ($vatrate, $buyer=null, $seller=null, $firstparamisid=1) | |
| Get tax (VAT) main information from Id. More... | |
| getLocalTaxesFromRate ($vatrate, $local, $buyer, $seller, $firstparamisid=0) | |
| Get type and rate of localtaxes for a particular vat rate/country of a thirdparty. More... | |
| get_product_vat_for_country ($idprod, $thirdpartytouse, $idprodfournprice=0) | |
| Return vat rate of a product in a particular country, or default country vat if product is unknown. More... | |
| get_product_localtax_for_country ($idprod, $local, $thirdpartytouse) | |
| Return localtax vat rate of a product in a particular country or default country vat if product is unknown. More... | |
| 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 1: Si vendeur non assujeti a TVA, TVA par defaut=0. More... | |
| get_default_npr (Societe $thirdparty_seller, Societe $thirdparty_buyer, $idprod=0, $idprodfournprice=0) | |
| Fonction qui renvoie si tva doit etre tva percue recuperable. More... | |
| 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) Si vendeur non assujeti a TVA, TVA par defaut=0. More... | |
| yn ($yesno, $case=1, $color=0) | |
| Return yes or no in current language. More... | |
| get_exdir ($num, $level, $alpha, $withoutslash, $object, $modulepart='') | |
| Return a path to have a the directory according to object where files are stored. More... | |
| dol_mkdir ($dir, $dataroot='', $newmask='') | |
| Creation of a directory (this can create recursive subdir) More... | |
| picto_required () | |
| Return picto saying a field is required. More... | |
| dol_string_nohtmltag ($stringtoclean, $removelinefeed=1, $pagecodeto='UTF-8', $strip_tags=0, $removedoublespaces=1) | |
| Clean a string from all HTML tags and entities. More... | |
| dol_string_onlythesehtmltags ($stringtoclean, $cleanalsosomestyles=1, $removeclassattribute=1, $cleanalsojavascript=0, $allowiframe=0, $allowed_tags=array()) | |
| Clean a string to keep only desirable HTML tags. More... | |
| dol_string_onlythesehtmlattributes ($stringtoclean, $allowed_attributes=array("allow", "allowfullscreen", "alt", "class", "contenteditable", "data-html", "frameborder", "height", "href", "id", "name", "src", "style", "target", "title", "width")) | |
| Clean a string from some undesirable HTML tags. More... | |
| dol_string_neverthesehtmltags ($stringtoclean, $disallowed_tags=array('textarea'), $cleanalsosomestyles=0) | |
| Clean a string from some undesirable HTML tags. More... | |
| dolGetFirstLineOfText ($text, $nboflines=1, $charset='UTF-8') | |
| Return first line of text. More... | |
| dol_nl2br ($stringtoencode, $nl2brmode=0, $forxml=false) | |
| Replace CRLF in string with a HTML BR tag. More... | |
| dol_htmlwithnojs ($stringtoencode, $nouseofiframesandbox=0, $check='restricthtml') | |
| Sanitize a HTML to remove js and dangerous content. More... | |
| 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. More... | |
| dol_htmlentitiesbr_decode ($stringtodecode, $pagecodeto='UTF-8') | |
| This function is called to decode a HTML string (it decodes entities and br tags) More... | |
| dol_htmlcleanlastbr ($stringtodecode) | |
| This function remove all ending and br at end. More... | |
| dol_html_entity_decode ($a, $b, $c='UTF-8', $keepsomeentities=0) | |
| Replace html_entity_decode functions to manage errors. More... | |
| dol_htmlentities ($string, $flags=ENT_QUOTES|ENT_SUBSTITUTE, $encoding='UTF-8', $double_encode=false) | |
| Replace htmlentities functions. More... | |
| dol_string_is_good_iso ($s, $clean=0) | |
| Check if a string is a correct iso string If not, it will we considered not HTML encoded even if it is by FPDF. More... | |
| dol_nboflines ($s, $maxchar=0) | |
| Return nb of lines of a clear text. More... | |
| dol_nboflines_bis ($text, $maxlinesize=0, $charset='UTF-8') | |
| Return nb of lines of a formated text with and (WARNING: string must not have mixed and br separators) More... | |
| dol_textishtml ($msg, $option=0) | |
| Return if a text is a html content. More... | |
| 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. More... | |
| getCommonSubstitutionArray ($outputlangs, $onlykey=0, $exclude=null, $object=null) | |
| Return array of possible common substitutions. More... | |
| 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)__ and [ConstantKey] are also replaced. More... | |
| 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. More... | |
| print_date_range ($date_start, $date_end, $format='', $outputlangs='') | |
| Format output for start and end date. More... | |
| get_date_range ($date_start, $date_end, $format='', $outputlangs='', $withparenthesis=1) | |
| Format output for start and end date. More... | |
| dolGetFirstLastname ($firstname, $lastname, $nameorder=-1) | |
| Return firstname and lastname in correct order. More... | |
| setEventMessage ($mesgs, $style='mesgs') | |
| Set event message in dol_events session object. More... | |
| setEventMessages ($mesg, $mesgs, $style='mesgs', $messagekey='') | |
| Set event messages in dol_events session object. More... | |
| dol_htmloutput_events ($disabledoutputofmessages=0) | |
| Print formated messages to output (Used to show messages on html output). More... | |
| get_htmloutput_mesg ($mesgstring='', $mesgarray='', $style='ok', $keepembedded=0) | |
| Get formated messages to output (Used to show messages on html output). More... | |
| get_htmloutput_errors ($mesgstring='', $mesgarray=array(), $keepembedded=0) | |
| Get formated error messages to output (Used to show messages on html output). More... | |
| dol_htmloutput_mesg ($mesgstring='', $mesgarray=array(), $style='ok', $keepembedded=0) | |
| Print formated messages to output (Used to show messages on html output). More... | |
| dol_htmloutput_errors ($mesgstring='', $mesgarray=array(), $keepembedded=0) | |
| Print formated error messages to output (Used to show messages on html output). More... | |
| dol_sort_array (&$array, $index, $order='asc', $natsort=0, $case_sensitive=0, $keepindex=0) | |
| Advanced sort array by second index function, which produces ascending (default) or descending output and uses optionally natural case insensitive sorting (which can be optionally case sensitive as well). More... | |
| utf8_check ($str) | |
| Check if a string is in UTF8. More... | |
| ascii_check ($str) | |
| Check if a string is in ASCII. More... | |
| dol_osencode ($str) | |
| Return a string encoded into OS filesystem encoding. More... | |
| dol_getIdFromCode ($db, $key, $tablename, $fieldkey='code', $fieldid='id', $entityfilter=0, $filters='') | |
| Return an id or code from a code or id. More... | |
| verifCond ($strToEvaluate) | |
| Verify if condition in string is ok or not. More... | |
| dol_eval ($s, $returnvalue=0, $hideerrors=1, $onlysimplestring='1') | |
| Replace eval function to add more security. More... | |
| dol_validElement ($element) | |
| Return if var element is ok. More... | |
| picto_from_langcode ($codelang, $moreatt='', $notitlealt=0) | |
| Return img flag of country for a language code or country code. More... | |
| getLanguageCodeFromCountryCode ($countrycode) | |
| Return default language from country code. More... | |
| 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). More... | |
| printCommonFooter ($zone='private') | |
| Print common footer : conf->global->MAIN_HTML_FOOTER js for switch of menu hider js for conf->global->MAIN_GOOGLE_AN_ID js for conf->global->MAIN_SHOW_TUNING_INFO or $_SERVER["MAIN_SHOW_TUNING_INFO"] js for conf->logbuffer. More... | |
| dolExplodeIntoArray ($string, $delimiter=';', $kv='=') | |
| Split a string with 2 keys into key array. More... | |
| dol_set_focus ($selector) | |
| Set focus onto field with selector (similar behaviour of 'autofocus' HTML5 tag) More... | |
| 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. More... | |
| natural_search ($fields, $value, $mode=0, $nofirstand=0) | |
| Generate natural SQL search string for a criteria (this criteria can be tested on one or several fields) More... | |
| showDirectDownloadLink ($object) | |
| Return string with full Url. More... | |
| getImageFileNameForSize ($file, $extName, $extImgTarget='') | |
| Return the filename of file to get the thumbs. More... | |
| getAdvancedPreviewUrl ($modulepart, $relativepath, $alldata=0, $param='') | |
| Return URL we can use for advanced preview links. More... | |
| ajax_autoselect ($htmlname, $addlink='', $textonlink='Link') | |
| Make content of an input box selected when we click into input field. More... | |
| dolIsAllowedForPreview ($file) | |
| Return if a file is qualified for preview. More... | |
| dol_mimetype ($file, $default='application/octet-stream', $mode=0) | |
| Return MIME type of a file from its name with extension. More... | |
| getDictionaryValue ($tablename, $field, $id, $checkentity=false, $rowidfield='rowid') | |
| Return the value of a filed into a dictionary for the record $id. More... | |
| colorIsLight ($stringcolor) | |
| Return true if the color is light. More... | |
| isVisibleToUserType ($type_user, &$menuentry, &$listofmodulesforexternal) | |
| Function to test if an entry is enabled or not. More... | |
| roundUpToNextMultiple ($n, $x=5) | |
| Round to next multiple. More... | |
| dolGetBadge ($label, $html='', $type='primary', $mode='', $url='', $params=array()) | |
| Function dolGetBadge. More... | |
| dolGetStatus ($statusLabel='', $statusLabelShort='', $html='', $statusType='status0', $displayMode=0, $url='', $params=array()) | |
| Output the badge of a status. More... | |
| dolGetButtonAction ($label, $text='', $actionType='default', $url='', $id='', $userRight=1, $params=array()) | |
| Function dolGetButtonAction. More... | |
| dolGetButtonTitleSeparator ($moreClass="") | |
| Add space between dolGetButtonTitle. More... | |
| getFieldErrorIcon ($fieldValidationErrorMsg) | |
| get field error icon More... | |
| dolGetButtonTitle ($label, $helpText='', $iconClass='fa fa-file', $url='', $id='', $status=1, $params=array()) | |
| Function dolGetButtonTitle : this kind of buttons are used in title in list. More... | |
| getElementProperties ($element_type) | |
| Get an array with properties of an element. More... | |
| fetchObjectByElement ($element_id, $element_type, $element_ref='') | |
| Fetch an object from its id and element_type Inclusion of classes is automatic. More... | |
| isAFileWithExecutableContent ($filename) | |
| Return if a file can contains executable content. More... | |
| newToken () | |
| Return the value of token currently saved into session with name 'newtoken'. More... | |
| currentToken () | |
| Return the value of token currently saved into session with name 'token'. More... | |
| startSimpleTable ($header, $link="", $arguments="", $emptyRows=0, $number=-1) | |
| Start a table with headers and a optinal clickable number (don't forget to use "finishSimpleTable()" after the last table row) More... | |
| finishSimpleTable ($addLineBreak=false) | |
| Add the correct HTML close tags for "startSimpleTable(...)" (use after the last table line) More... | |
| addSummaryTableLine ($tableColumnCount, $num, $nbofloop=0, $total=0, $noneWord="None", $extraRightColumn=false) | |
| Add a summary line to the current open table ("None", "XMoreLines" or "Total xxx") More... | |
| readfileLowMemory ($fullpath_original_file_osencoded, $method=-1) | |
| Return a file on output using a low memory. More... | |
| showValueWithClipboardCPButton ($valuetocopy, $showonlyonhover=1, $texttoshow='') | |
| Create a button to copy $valuetocopy in the clipboard (for copy and paste feature). More... | |
| jsonOrUnserialize ($stringtodecode) | |
| Decode an encode string. More... | |
| dolCheckFilters ($sqlfilters, &$error='') | |
| Return if a $sqlfilters parameter is valid and will pass the preg_replace_callback() to replace Generic filter string with SQL filter string Example of usage: if ($sqlfilters) { $errormessage = ''; if (dolCheckFilters($sqlfilters, $errormessage)) { $regexstring = '(([^:\'()]+:[^:\'()]+:[^()]+))'; $sql . More... | |
| dolForgeCriteriaCallback ($matches) | |
| Function to forge a SQL criteria from a Generic filter string. More... | |
| getTimelineIcon ($actionstatic, &$histo, $key) | |
| Get timeline icon. More... | |
| getActionCommEcmList ($object) | |
| getActionCommEcmList More... | |
| show_actions_messaging ($conf, $langs, $db, $filterobj, $objcon='', $noprint=0, $actioncode='', $donetodo='done', $filters=array(), $sortfield='a.datep, a.id', $sortorder='DESC') | |
| Show html area with actions in messaging format. More... | |
A set of functions for Dolibarr This file contains all frequently used functions.
Definition in file functions.lib.php.
| addSummaryTableLine | ( | $tableColumnCount, | |
| $num, | |||
$nbofloop = 0, |
|||
$total = 0, |
|||
$noneWord = "None", |
|||
$extraRightColumn = false |
|||
| ) |
Add a summary line to the current open table ("None", "XMoreLines" or "Total xxx")
| integer | $tableColumnCount | The complete count columns of the table |
| integer | $num | The count of the rows of the table, when it is zero (0) the "$noneWord" is shown instead |
| integer | $nbofloop | (optional) The maximum count of rows thaht the table show (when it is zero (0) no summary line will show, expect "$noneWord" when $num === 0) |
| integer | $total | (optional) The total value thaht is shown after when the table has minimum of one entire |
| string | $noneWord | (optional) The word that is shown when the table has no entires ($num === 0) |
| boolean | $extraRightColumn | (optional) Add a addtional column after the summary word and total number |
Definition at line 11301 of file functions.lib.php.
| ajax_autoselect | ( | $htmlname, | |
$addlink = '', |
|||
$textonlink = 'Link' |
|||
| ) |
Make content of an input box selected when we click into input field.
| string | $htmlname | Id of html object ('#idvalue' or '.classvalue') |
| string | $addlink | Add a 'link to' after |
| string | $textonlink | Text to show on link or 'image' |
Definition at line 9985 of file functions.lib.php.
| ascii_check | ( | $str | ) |
Check if a string is in ASCII.
| string | $str | String to check |
Definition at line 8760 of file functions.lib.php.
| checkVal | ( | $out = '', |
|
$check = 'alphanohtml', |
|||
$filter = null, |
|||
$options = null |
|||
| ) |
Return a sanitized or empty value after checking value against a rule.
| string | array | $out | Value to check/clear. |
| string | $check | Type of check/sanitizing |
| int | $filter | Filter to apply when $check is set to 'custom'. (See http://php.net/manual/en/filter.filters.php for détails) |
| mixed | $options | Options to pass to filter_var when $check is set to 'custom' |
Definition at line 844 of file functions.lib.php.
| colorIsLight | ( | $stringcolor | ) |
Return true if the color is light.
| string | $stringcolor | String with hex (FFFFFF) or comma RGB ('255,255,255') |
Definition at line 10486 of file functions.lib.php.
| 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
| Conf | $conf | Object conf |
| Translate | $langs | Object langs |
| object | null | $object | Object object |
| array | $head | Object head |
| int | $h | New position to fill |
| 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 tabl 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 fundation 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 |
| string | $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. |
Definition at line 9317 of file functions.lib.php.
| 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.
| array | $substitutionarray | Array substitution old value => new value value |
| Translate | $outputlangs | Output language |
| Object | $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) |
Definition at line 8242 of file functions.lib.php.
| 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).
Definition at line 11203 of file functions.lib.php.
| dol_banner_tab | ( | $object, | |
| $paramid, | |||
$morehtml = '', |
|||
$shownav = 1, |
|||
$fieldid = 'rowid', |
|||
$fieldref = 'ref', |
|||
$morehtmlref = '', |
|||
$moreparam = '', |
|||
$nodbprefix = 0, |
|||
$morehtmlleft = '', |
|||
$morehtmlstatus = '', |
|||
$onlybanner = 0, |
|||
$morehtmlright = '' |
|||
| ) |
Show tab footer of a card.
Note: $object->next_prev_filter can be set to restrict select to find next or previous record by $form->showrefnav.
| Object | $object | Object to show |
| string | $paramid | Name of parameter to use to name the id into the URL next/previous link |
| string | $morehtml | More html content to output just before the nav bar |
| int | $shownav | Show Condition (navigation is shown if value is 1) |
| string | $fieldid | Nom du champ en base a utiliser pour select next et previous (we make the select max and min on this field). Use 'none' for no prev/next search. |
| string | $fieldref | Nom du champ objet ref (object->ref) a utiliser pour select next et previous |
| string | $morehtmlref | More html to show after the ref (see $morehtmlleft for before) |
| string | $moreparam | More param to add in nav link url. |
| int | $nodbprefix | Do not include DB prefix to forge table name |
| string | $morehtmlleft | More html code to show before the ref (see $morehtmlref for after) |
| string | $morehtmlstatus | More html code to show under navigation arrows |
| int | $onlybanner | Put this to 1, if the card will contains only a banner (this add css 'arearefnobottom' on div) |
| string | $morehtmlright | More html code to show before navigation arrows |
Definition at line 2065 of file functions.lib.php.
| dol_bc | ( | $var, | |
$moreclass = '' |
|||
| ) |
Return string to add class property on html element with pair/impair.
| string | $var | 0 or 1 |
| string | $moreclass | More class to add |
Definition at line 2391 of file functions.lib.php.
| 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.
| 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) |
| 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 |
Definition at line 1052 of file functions.lib.php.
Referenced by DolibarrCollector\getAssets().
| dol_clone | ( | $object, | |
$native = 0 |
|||
| ) |
Create a clone of instance of object (new instance with same value for each properties) With native = 0: Property that are reference are different memory area in the new object (full isolation clone).
This means $this->db of new object may not be valid. 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 $this->db of new object is not valid.
| object | $object | Object to clone |
| int | $native | 0=Full isolation method, 1=Native PHP method, 2=Full isolation method keeping only scalar and array properties (recommended) |
Definition at line 1148 of file functions.lib.php.
Referenced by Fichinter\setRefClient().
| 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.
| 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) |
Definition at line 7499 of file functions.lib.php.
| dol_escape_htmltag | ( | $stringtoescape, | |
$keepb = 0, |
|||
$keepn = 0, |
|||
$noescapetags = '', |
|||
$escapeonlyhtmltags = 0 |
|||
| ) |
Returns text escaped for inclusion in HTML alt or title tags, or into values of HTML input fields.
| string | $stringtoescape | String to escape |
| int | $keepb | 1=Keep b tags, 0=remove them completely |
| int | $keepn | 1=Preserve \r strings (otherwise, replace them with escaped value). Set to 1 when escaping for a <textarea>. |
| string | $noescapetags | '' or 'common' or list of tags to not escape. TODO Does not works yet when there is attributes into tag. |
| int | $escapeonlyhtmltags | 1=Escape only html tags, not the special chars like accents. |
Definition at line 1476 of file functions.lib.php.
| dol_escape_js | ( | $stringtoescape, | |
$mode = 0, |
|||
$noescapebackslashn = 0 |
|||
| ) |
Returns text escaped for inclusion into javascript code.
| 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 \ |
| int | $noescapebackslashn | 0=Escape also . 1=Do not escape . |
Definition at line 1431 of file functions.lib.php.
| dol_escape_json | ( | $stringtoescape | ) |
Returns text escaped for inclusion into javascript code.
| string | $stringtoescape | String to escape |
Definition at line 1460 of file functions.lib.php.
| dol_eval | ( | $s, | |
$returnvalue = 0, |
|||
$hideerrors = 1, |
|||
$onlysimplestring = '1' |
|||
| ) |
Replace eval function to add more security.
This function is called by verifCond() or trans() and transnoentitiesnoconv().
| string | $s | String to evaluate |
| int | $returnvalue | 0=No return (used to execute eval($a=something)). 1=Value of eval is returned (used to eval($something)). |
| int | $hideerrors | 1=Hide errors |
| string | $onlysimplestring | '0' (used for computed property of extrafields)=Accept all chars, '1' (most common use)=Accept only simple string with char 'a-z0-9\s^$_+-.*>&|=!?():"\',/@';', '2' (not used)=Accept also ';[]' |
Definition at line 8894 of file functions.lib.php.
| dol_fiche_end | ( | $notab = 0 | ) |
Show tab footer of a card.
| int | $notab | -1 or 0=Add tab footer, 1=no tab footer |
Definition at line 2026 of file functions.lib.php.
| dol_fiche_head | ( | $links = array(), |
|
$active = '0', |
|||
$title = '', |
|||
$notab = 0, |
|||
$picto = '', |
|||
$pictoisfullpath = 0, |
|||
$morehtmlright = '', |
|||
$morecss = '', |
|||
$limittoshow = 0, |
|||
$moretabssuffix = '' |
|||
| ) |
Show tab header of a card.
| array | $links | Array of tabs (0=>url, 1=>label, 2=>code, 3=>not used, 4=>text after link, 5=>morecssonlink). Currently initialized by calling a function xxx_admin_prepare_head. Note that label into $links[$i][1] must be already HTML escaped. |
| string | $active | Active tab name (document', 'info', 'ldap', ....) |
| string | $title | Title |
| int | $notab | -1 or 0=Add tab header, 1=no tab header (if you set this to 1, using print dol_get_fiche_end() to close tab is not required), -2=Add tab header with no sepaaration under tab (to start a tab just after), -3=Add tab header but no footer separation |
| string | $picto | Add a picto on tab title |
| int | $pictoisfullpath | If 1, image path is a full path. If you set this to 1, you can use url returned by dol_buildpath('/mymodyle/img/myimg.png',1) for $picto. |
| string | $morehtmlright | Add more html content on right of tabs title |
| string | $morecss | More Css |
| int | $limittoshow | Limit number of tabs to show. Use 0 to use automatic default value. |
| string | $moretabssuffix | A suffix to use when you have several dol_get_fiche_head() in same page |
Definition at line 1821 of file functions.lib.php.
| dol_format_address | ( | $object, | |
$withcountry = 0, |
|||
$sep = "\n", |
|||
$outputlangs = '', |
|||
$mode = 0, |
|||
$extralangcode = '' |
|||
| ) |
Return a formated address (part address/zip/town/state) according to country rules.
See https://en.wikipedia.org/wiki/Address
| Object | $object | A company or contact object |
| int | $withcountry | 1=Add country into address string |
| string | $sep | Separator to use to build 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 |
Definition at line 2414 of file functions.lib.php.
| dol_get_fiche_end | ( | $notab = 0 | ) |
Return tab footer of a card.
| int | $notab | -1 or 0=Add tab footer, 1=no tab footer |
Definition at line 2037 of file functions.lib.php.
| dol_get_fiche_head | ( | $links = array(), |
|
$active = '', |
|||
$title = '', |
|||
$notab = 0, |
|||
$picto = '', |
|||
$pictoisfullpath = 0, |
|||
$morehtmlright = '', |
|||
$morecss = '', |
|||
$limittoshow = 0, |
|||
$moretabssuffix = '' |
|||
| ) |
Show tabs of a record.
| array | $links | Array of tabs (0=>url, 1=>label, 2=>code, 3=>not used, 4=>text after link, 5=>morecssonlink). Currently initialized by calling a function xxx_admin_prepare_head. Note that label into $links[$i][1] must be already HTML escaped. |
| string | $active | Active tab name |
| string | $title | Title |
| int | $notab | -1 or 0=Add tab header, 1=no tab header (if you set this to 1, using print dol_get_fiche_end() to close tab is not required), -2=Add tab header with no seaparation under tab (to start a tab just after), -3=-2+'noborderbottom' |
| string | $picto | Add a picto on tab title |
| int | $pictoisfullpath | If 1, image path is a full path. If you set this to 1, you can use url returned by dol_buildpath('/mymodyle/img/myimg.png',1) for $picto. |
| string | $morehtmlright | Add more html content on right of tabs title |
| string | $morecss | More CSS on the link |
| int | $limittoshow | Limit number of tabs to show. Use 0 to use automatic default value. |
| string | $moretabssuffix | A suffix to use when you have several dol_get_fiche_head() in same page |
Definition at line 1841 of file functions.lib.php.
| 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 informations. Be aware to add the third parameter to "UTC" if you need to work on UTC.
| 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. |
Definition at line 2785 of file functions.lib.php.
| dol_getIdFromCode | ( | $db, | |
| $key, | |||
| $tablename, | |||
$fieldkey = 'code', |
|||
$fieldid = 'id', |
|||
$entityfilter = 0, |
|||
$filters = '' |
|||
| ) |
Return an id or code from a code or id.
Store also Code-Id into a cache to speed up next request on same key.
| DoliDB | $db | Database handler |
| string | $key | Code or Id to get Id or Code |
| string | $tablename | Table name without prefix |
| string | $fieldkey | Field to search the key into |
| string | $fieldid | Field to get |
| int | $entityfilter | Filter by entity |
| string | $filters | Filters to add. WARNING: string must be escaped for SQL and not coming from user input. |
Definition at line 8820 of file functions.lib.php.
| 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.
Definition at line 9697 of file functions.lib.php.
| dol_html_entity_decode | ( | $a, | |
| $b, | |||
$c = 'UTF-8', |
|||
$keepsomeentities = 0 |
|||
| ) |
Replace html_entity_decode functions to manage errors.
| string | $a | Operand a |
| string | $b | Operand b (ENT_QUOTES|ENT_HTML5=convert simple, double quotes, colon, e accent, ...) |
| string | $c | Operand c |
| string | $keepsomeentities | Entities but &, <, >, " are not converted. |
Definition at line 7299 of file functions.lib.php.
Referenced by dol_string_nohtmltag().
| dol_htmlcleanlastbr | ( | $stringtodecode | ) |
This function remove all ending
and br at end.
| string | $stringtodecode | String to decode |
Definition at line 7283 of file functions.lib.php.
| 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.
| 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 |
Definition at line 7322 of file functions.lib.php.
Referenced by 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 &,<,>," 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:
| 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 |
Definition at line 7234 of file functions.lib.php.
References dol_htmlentities(), dol_nl2br(), and dol_textishtml().
| dol_htmlentitiesbr_decode | ( | $stringtodecode, | |
$pagecodeto = 'UTF-8' |
|||
| ) |
This function is called to decode a HTML string (it decodes entities and br tags)
| string | $stringtodecode | String to decode |
| string | $pagecodeto | Page code for result |
Definition at line 7267 of file functions.lib.php.
Referenced by AdherentType\getMailOnExclude(), AdherentType\getMailOnResiliate(), AdherentType\getMailOnSubscription(), and AdherentType\getMailOnValid().
| dol_htmloutput_errors | ( | $mesgstring = '', |
|
$mesgarray = array(), |
|||
$keepembedded = 0 |
|||
| ) |
Print formated error messages to output (Used to show messages on html output).
| string | $mesgstring | Error message |
| array | $mesgarray | Error messages array |
| int | $keepembedded | Set to 1 in error message must be kept embedded into its html place (this disable jnotify) |
Definition at line 8648 of file functions.lib.php.
References dol_htmloutput_mesg().
| dol_htmloutput_events | ( | $disabledoutputofmessages = 0 | ) |
Print formated messages to output (Used to show messages on html output).
Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function, so there is no need to call it explicitely.
| int | $disabledoutputofmessages | Clear all messages stored into session without diplaying them |
Definition at line 8453 of file functions.lib.php.
| dol_htmloutput_mesg | ( | $mesgstring = '', |
|
$mesgarray = array(), |
|||
$style = 'ok', |
|||
$keepembedded = 0 |
|||
| ) |
Print formated messages to output (Used to show messages on html output).
| string | $mesgstring | Message string or message key |
| string[] | $mesgarray | Array of message strings or message keys |
| string | $style | Which style to use ('ok', 'warning', 'error') |
| int | $keepembedded | Set to 1 if message must be kept embedded into its html place (this disable jnotify) |
Definition at line 8580 of file functions.lib.php.
Referenced by dol_htmloutput_errors().
| dol_htmlwithnojs | ( | $stringtoencode, | |
$nouseofiframesandbox = 0, |
|||
$check = 'restricthtml' |
|||
| ) |
Sanitize a HTML to remove js and dangerous content.
| string | $stringtoencode | String to encode |
| int | $nouseofiframesandbox | Allow use of option MAIN_SECURITY_USE_SANDBOX_FOR_HTMLWITHNOJS for html sanitizing |
| string | $check | 'restricthtml' or 'restricthtmlallowunvalid' |
Definition at line 7139 of file functions.lib.php.
| 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)
| string | $relpath | Relative path to file (Ie: mydir/myfile, ../myfile, ...) |
| string | $classname | Class name (deprecated) |
Definition at line 1023 of file functions.lib.php.
| dol_mimetype | ( | $file, | |
$default = 'application/octet-stream', |
|||
$mode = 0 |
|||
| ) |
Return MIME type of a file from its name with extension.
| string | $file | Filename we looking for MIME type |
| string | $default | Default mime type if extension not found in known list |
| int | $mode | 0=Return full mime, 1=otherwise short mime string, 2=image for mime type, 3=source language, 4=css of font fa |
Definition at line 10045 of file functions.lib.php.
| dol_mkdir | ( | $dir, | |
$dataroot = '', |
|||
$newmask = '' |
|||
| ) |
Creation of a directory (this can create recursive subdir)
| 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 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' |
Definition at line 6750 of file functions.lib.php.
| dol_mktime | ( | $hour, | |
| $minute, | |||
| $second, | |||
| $month, | |||
| $day, | |||
| $year, | |||
$gm = 'auto', |
|||
$check = 1 |
|||
| ) |
Return a timestamp date built from detailed informations (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.
| 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 |
| mixed | $gm | True or 1 or 'gmt'=Input informations 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...) |
Definition at line 2828 of file functions.lib.php.
| dol_nboflines | ( | $s, | |
$maxchar = 0 |
|||
| ) |
Return nb of lines of a clear text.
| string | $s | String to check |
| int | $maxchar | Not yet used |
Definition at line 7368 of file functions.lib.php.
| dol_nboflines_bis | ( | $text, | |
$maxlinesize = 0, |
|||
$charset = 'UTF-8' |
|||
| ) |
Return nb of lines of a formated text with
and
(WARNING: string must not have mixed
and br separators)
| string | $text | Text |
| int | $maxlinesize | Largeur de ligne en caracteres (ou 0 si pas de limite - defaut) |
| string | $charset | Give the charset used to encode the $text variable in memory. |
Definition at line 7389 of file functions.lib.php.
| 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 encode the special chars of stringtoencode into HTML before.
| string | $stringtoencode | String to encode |
| int | $nl2brmode | 0=Adding br before , 1=Replacing by br |
| bool | $forxml | false=Use , true=Use |
Definition at line 7121 of file functions.lib.php.
Referenced by dol_htmlentitiesbr().
| dol_now | ( | $mode = 'auto' | ) |
Return date for now.
In most cases, we use this function without parameters (that means GMT time).
| string | $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 |
Definition at line 2916 of file functions.lib.php.
Referenced by getServerTimeZoneInt(), and ChargeSociales\initAsSpecimen().
| dol_osencode | ( | $str | ) |
Return a string encoded into OS filesystem encoding.
This function is used to define value to pass to filesystem PHP functions.
| string | $str | String to encode (UTF-8) |
Definition at line 8784 of file functions.lib.php.
Referenced by CMailFile\_encode_file(), dol_filemtime(), dol_fileperm(), dol_filesize(), dol_is_file(), and dol_is_link().
| dol_print_address | ( | $address, | |
| $htmlid, | |||
| $element, | |||
| $id, | |||
$noprint = 0, |
|||
$charfornl = '' |
|||
| ) |
Format address string.
| string | $address | Address string, already formatted with dol_format_address() |
| int | $htmlid | Html ID (for example 'gmap') |
| int | $element | 'thirdparty'|'contact'|'member'|'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. |
Definition at line 3697 of file functions.lib.php.
| dol_print_date | ( | $time, | |
$format = '', |
|||
$tzoutput = 'auto', |
|||
$outputlangs = '', |
|||
$encodetooutput = false |
|||
| ) |
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
| int | $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 | $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 | false=no convert into output pagecode |
Definition at line 2535 of file functions.lib.php.
Referenced by getServerTimeZoneInt().
| dol_print_email | ( | $email, | |
$cid = 0, |
|||
$socid = 0, |
|||
$addlink = 0, |
|||
$max = 64, |
|||
$showinvalid = 1, |
|||
$withpicto = 0 |
|||
| ) |
Show EMail link formatted for HTML output.
| string | EMail to show (only email, without 'Name of recipient' before) | |
| int | $cid | Id of contact if known |
| int | $socid | Id of third party if known |
| int | $addlink | 0=no link, 1=email has a html email link (+ link to create action if constant AGENDA_ADDACTIONFOREMAIL is on) |
| int | $max | Max number of characters to show |
| int | $showinvalid | 1=Show warning if syntax email is wrong |
| int | string | $withpicto | Show picto |
Definition at line 3031 of file functions.lib.php.
| dol_print_error | ( | $db = '', |
|
$error = '', |
|||
$errors = null |
|||
| ) |
Displays error message system with all the information to facilitate the diagnosis and the escalation of the bugs.
This function must be called when a blocking technical error is encountered. However, one must try to call it only within php pages, classes must return their error through their property "error".
| DoliDB | string | $db | Database handler |
| string | string[] | $error | String or array of errors strings to show |
| array | $errors | Array of errors |
Definition at line 4956 of file functions.lib.php.
| dol_print_error_email | ( | $prefixcode, | |
$errormessage = '', |
|||
$errormessages = array(), |
|||
$morecss = 'error', |
|||
$email = '' |
|||
| ) |
Show a public email and error code to contact if technical error.
| string | $prefixcode | Prefix of public error code |
| string | $errormessage | Complete error message |
| array | $errormessages | Array of error messages |
| string | $morecss | More css |
| string |
Definition at line 5101 of file functions.lib.php.
| dol_print_ip | ( | $ip, | |
$mode = 0 |
|||
| ) |
Return an IP formated to be shown on screen.
| string | $ip | IP |
| int | $mode | 0=return IP + country/flag, 1=return only country/flag, 2=return only IP |
Definition at line 3563 of file functions.lib.php.
| dol_print_phone | ( | $phone, | |
$countrycode = '', |
|||
$cid = 0, |
|||
$socid = 0, |
|||
$addlink = '', |
|||
$separ = " ", |
|||
$withpicto = '', |
|||
$titlealt = '', |
|||
$adddivfloat = 0 |
|||
| ) |
Format phone numbers according to country.
| string | $phone | Phone number to format |
| string | $countrycode | Country code to use for formatting |
| int | $cid | 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) |
| string | $separ | Separation between numbers for a better visibility example : xx.xx.xx.xx.xx |
| string | $withpicto | Show picto ('fax', 'phone', 'mobile') |
| string | $titlealt | Text to show on alt |
| int | $adddivfloat | Add div float around phone. |
Definition at line 3256 of file functions.lib.php.
| dol_print_profids | ( | $profID, | |
| $profIDtype, | |||
$countrycode = '', |
|||
$addcpButton = 1, |
|||
$separ = ' ' |
|||
| ) |
Format profIDs according to country.
| 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 | $addcpButton | Add button to copy to clipboard (1 => show only on hoover ; 2 => always display ) |
| string | $separ | Separation between numbers for a better visibility example : xxx xxx xxx xxxxx |
Definition at line 3220 of file functions.lib.php.
| dol_print_size | ( | $size, | |
$shortvalue = 0, |
|||
$shortunit = 0 |
|||
| ) |
Return string with formated size.
| 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') |
Definition at line 2955 of file functions.lib.php.
| dol_print_socialnetworks | ( | $value, | |
| $cid, | |||
| $socid, | |||
| $type, | |||
$dictsocialnetworks = array() |
|||
| ) |
Show social network link.
| string | $value | Skype to show (only skype, without 'Name of recipient' before) |
| int | $cid | Id of contact if known |
| int | $socid | Id of third party if known |
| string | $type | 'skype','facebook',... |
| array | $dictsocialnetworks | socialnetworks availables |
Definition at line 3139 of file functions.lib.php.
| dol_print_url | ( | $url, | |
$target = '_blank', |
|||
$max = 32, |
|||
$withpicto = 0 |
|||
| ) |
Show Url link.
| string | $url | Url to show |
| string | $target | Target for link |
| int | $max | Max number of characters to show |
| int | $withpicto | With picto |
Definition at line 2993 of file functions.lib.php.
| dol_sanitizeEmail | ( | $stringtoclean | ) |
Clean a string to use it as an Email.
| string | $stringtoclean | String to clean. Example 'abc@mycompany.com <My name>' |
Definition at line 1299 of file functions.lib.php.
| dol_sanitizeFileName | ( | $str, | |
$newstr = '_', |
|||
$unaccent = 1 |
|||
| ) |
Clean a string to use it as a file name.
Replace also '–' and ' -' strings, they are used for parameters separation (Note: ' - ' is allowed).
| string | $str | String to clean |
| string | $newstr | String to replace bad chars with. |
| int | $unaccent | 1=Remove also accent (default), 0 do not remove them |
Definition at line 1216 of file functions.lib.php.
Referenced by Product\check().
| dol_sanitizePathName | ( | $str, | |
$newstr = '_', |
|||
$unaccent = 1 |
|||
| ) |
Clean a string to use it as a path name.
Replace also '–' and ' -' strings, they are used for parameters separation (Note: ' - ' is allowed).
| string | $str | String to clean |
| string | $newstr | String to replace bad chars with |
| int | $unaccent | 1=Remove also accent (default), 0 do not remove them |
Definition at line 1242 of file functions.lib.php.
| dol_sanitizeUrl | ( | $stringtoclean, | |
$type = 1 |
|||
| ) |
Clean a string to use it as an URL (into a href or src attribute)
| string | $stringtoclean | String to clean |
| int | $type | 0=Accept all Url, 1=Clean external Url (keep only relative Url) |
Definition at line 1263 of file functions.lib.php.
| dol_set_focus | ( | $selector | ) |
Set focus onto field with selector (similar behaviour of 'autofocus' HTML5 tag)
| string | $selector | Selector ('#id' or 'input[name="ref"]') to use to find the HTML input field that must get the autofocus. You must use a CSS selector, so unique id preceding with the '#' char. |
Definition at line 9683 of file functions.lib.php.
| dol_shutdown | ( | ) |
Function called at end of web php process.
Definition at line 400 of file functions.lib.php.
| dol_size | ( | $size, | |
$type = '' |
|||
| ) |
Optimize a size for some browsers (phone, smarphone, ...)
| 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 |
Definition at line 1191 of file functions.lib.php.
| dol_sort_array | ( | & | $array, |
| $index, | |||
$order = 'asc', |
|||
$natsort = 0, |
|||
$case_sensitive = 0, |
|||
$keepindex = 0 |
|||
| ) |
Advanced sort array by second index function, which produces ascending (default) or descending output and uses optionally natural case insensitive sorting (which can be optionally case sensitive as well).
| array | $array | Array to sort (array of array('key1'=>val1,'key2'=>val2,'key3'...) or array of objects) |
| string | $index | Key in array to use for sorting criteria |
| int | $order | Sort order ('asc' or 'desc') |
| int | $natsort | If values are strings (I said value not type): 0=Use alphabetical order, 1=use "natural" sort (natsort) 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 | $case_sensitive | 1=sort is case sensitive, 0=not case sensitive |
| int | $keepindex | If 0 and index key of array to sort is a numeric, than index will be rewrote. If 1 or index key is not numeric, key for index is kept after sorting. |
Definition at line 8667 of file functions.lib.php.
| dol_strftime | ( | $fmt, | |
$ts = false, |
|||
$is_gmt = false |
|||
| ) |
Format a string.
| string | $fmt | Format of strftime function (http://php.net/manual/fr/function.strftime.php) |
| int | $ts | Timesamp (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) |
| int | $is_gmt | See comment of timestamp parameter |
Definition at line 2505 of file functions.lib.php.
| dol_string_is_good_iso | ( | $s, | |
$clean = 0 |
|||
| ) |
Check if a string is a correct iso string If not, it will we considered not HTML encoded even if it is by FPDF.
Example, if string contains euro symbol that has ascii code 128
| string | $s | String to check |
| string | $clean | Clean if it is not an ISO. Warning, if file is utf8, you will get a bad formated file. |
Definition at line 7336 of file functions.lib.php.
| dol_string_neverthesehtmltags | ( | $stringtoclean, | |
$disallowed_tags = array('textarea'), |
|||
$cleanalsosomestyles = 0 |
|||
| ) |
Clean a string from some undesirable HTML tags.
Note. Not as secured as dol_string_onlythesehtmltags().
| string | $stringtoclean | String to clean |
| array | $disallowed_tags | Array of tags not allowed |
| string | $cleanalsosomestyles | Clean also some tags |
Definition at line 7040 of file functions.lib.php.
| 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:
| string | $stringtoclean | String to clean |
| integer | $removelinefeed | 1=Replace all new lines by 1 space, 0=Only ending new lines are removed others are replaced with , 2=Ending new lines are removed but others are kept with a same number of than 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 |
Definition at line 6841 of file functions.lib.php.
References dol_html_entity_decode().
Referenced by ExportExcel2007\excel_clean(), AccountancyExport\toAnsi(), and ExportTsv\tsv_clean().
| dol_string_nospecial | ( | $str, | |
$newstr = '_', |
|||
$badcharstoreplace = '', |
|||
$badcharstoremove = '' |
|||
| ) |
Clean a string from all punctuation characters to use it as a ref or login.
This is a more complete function than dol_sanitizeFileName.
| string | $str | String to clean |
| string | $newstr | String to replace forbidden chars with |
| array | string | $badcharstoreplace | Array of forbidden characters to replace. Use '' to keep default list. |
| array | string | $badcharstoremove | Array of forbidden characters to remove. Use '' to keep default list. |
Definition at line 1384 of file functions.lib.php.
| 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
| string | $str | String to clean |
| int | $removetabcrlf | Remove also CR-LF |
Definition at line 1414 of file functions.lib.php.
Referenced by dol_string_onlythesehtmltags().
| dol_string_onlythesehtmlattributes | ( | $stringtoclean, | |
$allowed_attributes = array("allow", "allowfullscreen", "alt", "class", "contenteditable", "data-html", "frameborder", "height", "href", "id", "name", "src", "style", "target", "title", "width") |
|||
| ) |
Clean a string from some undesirable HTML tags.
Note: Complementary to dol_string_onlythesehtmltags(). This method is used for example when option MAIN_RESTRICTHTML_REMOVE_ALSO_BAD_ATTRIBUTES is set to 1.
| string | $stringtoclean | String to clean |
| array | $allowed_attributes | Array of tags not allowed |
Definition at line 6973 of file functions.lib.php.
| dol_string_onlythesehtmltags | ( | $stringtoclean, | |
$cleanalsosomestyles = 1, |
|||
$removeclassattribute = 1, |
|||
$cleanalsojavascript = 0, |
|||
$allowiframe = 0, |
|||
$allowed_tags = array() |
|||
| ) |
Clean a string to keep only desirable HTML tags.
WARNING: This also clean HTML comments (because they can be used to obfuscate tag name).
| 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 occurence of 'javascript:'. |
| int | $allowiframe | Allow iframe tags. |
| array | $allowed_tags | List of allowed tags to replace the default list |
Definition at line 6912 of file functions.lib.php.
References dol_string_nounprintableascii().
| dol_string_unaccent | ( | $str | ) |
Clean a string from all accent characters to be used as ref, login or by dol_sanitizeFileName.
| string | $str | String to clean |
Definition at line 1317 of file functions.lib.php.
| dol_strlen | ( | $string, | |
$stringencoding = 'UTF-8' |
|||
| ) |
Make a strlen call.
Works even if mbstring module not enabled
| string | $string | String to calculate length |
| string | $stringencoding | Encoding of string |
Definition at line 3852 of file functions.lib.php.
Referenced by binhex(), dol_ch_controle_bvrb(), Ldap\littleEndian(), and utf8_check().
| dol_strtolower | ( | $string, | |
$encoding = "UTF-8" |
|||
| ) |
Convert a string to lower.
Never use strtolower because it does not works with UTF8 strings.
| string | $string | String to encode |
| string | $encoding | Character set encoding |
Definition at line 1533 of file functions.lib.php.
| dol_strtoupper | ( | $string, | |
$encoding = "UTF-8" |
|||
| ) |
Convert a string to upper.
Never use strtolower because it does not works with UTF8 strings.
| string | $string | String to encode |
| string | $encoding | Character set encoding |
Definition at line 1549 of file functions.lib.php.
| dol_substr | ( | $string, | |
| $start, | |||
| $length, | |||
$stringencoding = '', |
|||
$trunconbytes = 0 |
|||
| ) |
Make a substring.
Works even if mbstring module is not enabled for better compatibility.
| string | $string | String to scan |
| string | $start | Start position |
| int | $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 |
Definition at line 3875 of file functions.lib.php.
| 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).
| string | $message | Line to log. ''=Show nothing |
| int | $level | Log level On Windows LOG_ERR=4, LOG_WARNING=5, LOG_NOTICE=LOG_INFO=6, LOG_DEBUG=6 si define_syslog_variables ou PHP 5.3+, 7 si dolibarr On Linux LOG_ERR=3, LOG_WARNING=4, LOG_NOTICE=5, LOG_INFO=6, LOG_DEBUG=7 |
| int | $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. |
| string | $restricttologhandler | Force output of log only to this log handler |
| array | null | $logcontext | If defined, an array with extra informations (can be used by some log handlers) |
Definition at line 1611 of file functions.lib.php.
Referenced by Lettering\bookkeepingLetteringAll(), Categorie\buildPathFromId(), CommonInvoice\calculate_date_lim_reglement(), User\clearrights(), DoliDBMysqli\close(), DoliDBPgsql\close(), DoliDBSqlite3\close(), MailmanSpip\connectSpip(), Categorie\countNbOfCategories(), ProductStockEntrepot\create(), BookKeeping\createFromClone(), EcmFiles\createFromClone(), Productlot\createFromClone(), ProductStockEntrepot\createFromClone(), Ldap\delete(), Link\delete(), EcmFiles\delete(), Productlot\delete(), ProductStockEntrepot\delete(), CompanyBankAccount\delete(), dol_json_decode(), dol_json_encode(), PrestaShopWebservice\executeRequest(), CurrencyRate\fetch(), MouvementStock\fetch(), MultiCurrency\fetch(), ProductStockEntrepot\fetch(), Website\fetch(), FactureRec\fetch_lines(), Lettering\getDocTypeAndFkDocFromBankLines(), Don\getRemainToPay(), Categorie\initAsSpecimen(), ModeleExports\listOfAvailableExportFormat(), ModeleImports\listOfAvailableImportFormat(), CommandeFournisseur\loadReceptions(), Societe\replaceThirdparty(), DoliDBMysqli\select_db(), DoliDBSqlite3\select_db(), Facture\set_canceled(), Don\set_paid(), ChargeSociales\set_paid(), Loan\set_paid(), Facture\set_paid(), FactureFournisseur\set_paid(), Commande\set_remise(), Facture\set_remise(), Commande\set_reopen(), Loan\set_started(), Facture\set_unpaid(), ChargeSociales\set_unpaid(), FactureFournisseur\set_unpaid(), Loan\set_unpaid(), CompanyPaymentMode\setAsDefault(), CompanyBankAccount\setAsDefault(), Facture\setCanceled(), FactureFournisseur\setCanceled(), Propal\setDraft(), Societe\setParent(), Conf\setValues(), Productlot\update(), ProductStockEntrepot\update(), Paiement\update_date(), Contrat\update_statut(), FactureLigne\update_total(), and Holiday\verifNbUsers().
| dol_textishtml | ( | $msg, | |
$option = 0 |
|||
| ) |
Return if a text is a html content.
| string | $msg | Content to check |
| int | $option | 0=Full detection, 1=Fast check |
Definition at line 7432 of file functions.lib.php.
Referenced by dol_htmlentitiesbr().
| 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
| 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) |
Definition at line 3914 of file functions.lib.php.
Referenced by WebsitePage\create(), AccountancyExport\trunc(), and WebsitePage\update().
| 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.
| string | $string | String to encode |
| string | $encoding | Character set encodign |
Definition at line 1565 of file functions.lib.php.
| dol_ucwords | ( | $string, | |
$encoding = "UTF-8" |
|||
| ) |
Convert first character of all the words of a string to upper.
Never use ucfirst because it does not works with UTF8 strings.
| string | $string | String to encode |
| string | $encoding | Character set encodign |
Definition at line 1581 of file functions.lib.php.
| 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)
Definition at line 3666 of file functions.lib.php.
| dol_validElement | ( | $element | ) |
Return if var element is ok.
| string | $element | Variable to check |
Definition at line 9007 of file functions.lib.php.
| dolButtonToOpenUrlInDialogPopup | ( | $name, | |
| $label, | |||
| $buttonstring, | |||
| $url, | |||
$disabled = '', |
|||
$morecss = 'button bordertransp', |
|||
$backtopagejsfields = '' |
|||
| ) |
Return HTML code to output a button to open a dialog popup box.
Such buttons must be included inside a HTML form.
| string | $name | A name for the html component |
| string | $label | Label shown in Popup title top bar |
| string | $buttonstring | button string |
| string | $url | Relative Url to open. For example '/project/card.php' |
| string | $disabled | Disabled text |
| string | $morecss | More CSS |
| string | $backtopagejsfields | The back to page must be managed using javascript instead of a redirect. Value is 'keyforpopupid:Name_of_html_component_to_set_with id,Name_of_html_component_to_set_with_label' |
Definition at line 1728 of file functions.lib.php.
| dolCheckFilters | ( | $sqlfilters, | |
| & | $error = '' |
||
| ) |
Return if a $sqlfilters parameter is valid and will pass the preg_replace_callback() to replace Generic filter string with SQL filter string Example of usage: if ($sqlfilters) { $errormessage = ''; if (dolCheckFilters($sqlfilters, $errormessage)) { $regexstring = '(([^:\'()]+:[^:\'()]+:[^()]+))'; $sql .
= " AND (".preg_replace_callback('/'.$regexstring.'/', 'dolForgeCriteriaCallback', $sqlfilters).")"; } }
| string | $sqlfilters | sqlfilter string |
| string | $error | Error message |
Definition at line 11455 of file functions.lib.php.
| 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)
| string | $string | String to explode |
| string | $delimiter | Delimiter between each couple of data |
| string | $kv | Delimiter between key and value |
Definition at line 9658 of file functions.lib.php.
| dolForgeCriteriaCallback | ( | $matches | ) |
Function to forge a SQL criteria from a Generic filter string.
Example of usage: if ($sqlfilters) { $errormessage = ''; if (dolCheckFilters($sqlfilters, $errormessage)) { $regexstring = '(([^:\'()]+:[^:\'()]+:[^()]+))'; $sql .= " AND (".preg_replace_callback('/'.$regexstring.'/', 'dolForgeCriteriaCallback', $sqlfilters).")"; } }
| array | $matches | Array of found string by regex search. Example: "t.ref:like:'SO-%'" or "t.date_creation:<:'20160101'" or "t.date_creation:<:'2016-01-01 12:30:00'" or "t.nature:is:NULL" |
Definition at line 11494 of file functions.lib.php.
Referenced by DolibarrApi\_forge_criteria_callback().
| dolGetBadge | ( | $label, | |
$html = '', |
|||
$type = 'primary', |
|||
$mode = '', |
|||
$url = '', |
|||
$params = array() |
|||
| ) |
Function dolGetBadge.
| string | $label | label of badge no html : use in alt attribute for accessibility |
| string | $html | optional : label of badge with html |
| string | $type | type of badge : Primary Secondary Success Danger Warning Info Light Dark status0 status1 status2 status3 status4 status5 status6 status7 status8 status9 |
| string | $mode | default '' , 'pill', 'dot' |
| string | $url | the url for link |
| array | $params | various params for future : recommended rather than adding more fuction arguments. array('attr'=>array('title'=>'abc')) |
Definition at line 10578 of file functions.lib.php.
| dolGetButtonAction | ( | $label, | |
$text = '', |
|||
$actionType = 'default', |
|||
$url = '', |
|||
$id = '', |
|||
$userRight = 1, |
|||
$params = array() |
|||
| ) |
Function dolGetButtonAction.
| string | $label | Label or tooltip of button. Also used as tooltip in title attribute. Can be escaped HTML content or full simple text. |
| string | $text | Optional : short label on button. Can be escaped HTML content or full simple text. |
| string | $actionType | 'default', 'delete', 'danger' |
| string | $url | Url for link |
| string | $id | Attribute id of button |
| int | boolean | $userRight | User action right // phpcs:disable |
| array | $params | = [ // Various params for future : recommended rather than adding more function arguments 'attr' => [ // to add or override button attributes 'xxxxx' => '', // your xxxxx attribute you want 'class' => 'reposition', // to add more css class to the button class attribute 'classOverride' => '' // to replace class attribute of the button ], 'confirm' => [ 'url' => 'http://', // Overide Url to go when user click on action btn, if empty default url is $url.?confirm=yes, for no js compatibility use $url for fallback confirm. 'title' => '', // Overide title of modal, if empty default title use "ConfirmBtnCommonTitle" lang key 'action-btn-label' => '', // Overide label of action button, if empty default label use "Confirm" lang key 'cancel-btn-label' => '', // Overide label of cancel button, if empty default label use "CloseDialog" lang key 'content' => '', // Overide text of content, if empty default content use "ConfirmBtnCommonContent" lang key 'modal' => true, // true|false to display dialog as a modal (with dark background) 'isDropDrown' => false, // true|false to display dialog as a dropdown (with dark background) ], ] // phpcs:enable |
Definition at line 10755 of file functions.lib.php.
| dolGetButtonTitle | ( | $label, | |
$helpText = '', |
|||
$iconClass = 'fa fa-file', |
|||
$url = '', |
|||
$id = '', |
|||
$status = 1, |
|||
$params = array() |
|||
| ) |
Function dolGetButtonTitle : this kind of buttons are used in title in list.
| string | $label | label of button |
| string | $helpText | optional : content for help tooltip |
| string | $iconClass | class for icon element (Example: 'fa fa-file') |
| string | $url | the url for link |
| string | $id | attribute id of button |
| int | $status | 0 no user rights, 1 active, 2 current action or selected, -1 Feature Disabled, -2 disable Other reason use param $helpText as tooltip help |
| array | $params | various params for future : recommended rather than adding more function arguments |
Definition at line 10919 of file functions.lib.php.
| dolGetButtonTitleSeparator | ( | $moreClass = "" | ) |
Add space between dolGetButtonTitle.
| string | $moreClass | more css class label |
Definition at line 10884 of file functions.lib.php.
| dolGetCountryCodeFromIp | ( | $ip | ) |
Return a country code from IP.
Empty string if not found.
| string | $ip | IP |
Definition at line 3640 of file functions.lib.php.
| dolGetFirstLastname | ( | $firstname, | |
| $lastname, | |||
$nameorder = -1 |
|||
| ) |
Return firstname and lastname in correct order.
| 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 |
Definition at line 8343 of file functions.lib.php.
| 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'
| string | $s | String to truncate |
| int | $nbofchar | Nb of characters to keep |
Definition at line 3833 of file functions.lib.php.
| dolGetFirstLineOfText | ( | $text, | |
$nboflines = 1, |
|||
$charset = 'UTF-8' |
|||
| ) |
Return first line of text.
Cut will depends if content is HTML or not.
| 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) |
Definition at line 7065 of file functions.lib.php.
| dolGetStatus | ( | $statusLabel = '', |
|
$statusLabelShort = '', |
|||
$html = '', |
|||
$statusType = 'status0', |
|||
$displayMode = 0, |
|||
$url = '', |
|||
$params = array() |
|||
| ) |
Output the badge of a status.
| string | $statusLabel | Label of badge no html : use in alt attribute for accessibility |
| string | $statusLabelShort | Short label of badge no html |
| string | $html | Optional : label of badge with html |
| string | $statusType | status0 status1 status2 status3 status4 status5 status6 status7 status8 status9 : image name or badge name |
| int | $displayMode | 0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto, 6=Long label + Picto |
| string | $url | The url for link |
| array | $params | Various params. Example: array('tooltip'=>'no|...', 'badgeParams'=>...) |
Definition at line 10642 of file functions.lib.php.
| dolIsAllowedForPreview | ( | $file | ) |
Return if a file is qualified for preview.
| string | $file | Filename we looking for information |
Definition at line 10010 of file functions.lib.php.
| fetchObjectByElement | ( | $element_id, | |
| $element_type, | |||
$element_ref = '' |
|||
| ) |
Fetch an object from its id and element_type Inclusion of classes is automatic.
| int | $element_id | Element id |
| string | $element_type | Element type |
| string | $element_ref | Element ref (Use this or element_id but not both) |
Definition at line 11154 of file functions.lib.php.
| fieldLabel | ( | $langkey, | |
| $fieldkey, | |||
$fieldrequired = 0 |
|||
| ) |
Show a string with the label tag dedicated to the HTML edit field.
| string | $langkey | Translation key |
| string | $fieldkey | Key of the html select field the text refers to |
| int | $fieldrequired | 1=Field is mandatory |
Definition at line 2368 of file functions.lib.php.
| finishSimpleTable | ( | $addLineBreak = false | ) |
Add the correct HTML close tags for "startSimpleTable(...)" (use after the last table line)
| bool | $addLineBreak | (optional) Add a extra line break after the complete table (<br>) |
Definition at line 11280 of file functions.lib.php.
| get_date_range | ( | $date_start, | |
| $date_end, | |||
$format = '', |
|||
$outputlangs = '', |
|||
$withparenthesis = 1 |
|||
| ) |
Format output for start and end date.
| int | $date_start | Start date |
| int | $date_end | End date |
| string | $format | Output date format ('day', 'dayhour', ...) |
| Translate | $outputlangs | Output language |
| integer | $withparenthesis | 1=Add parenthesis, 0=no parenthesis |
Definition at line 8312 of file functions.lib.php.
| 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) Si vendeur non assujeti a TVA, TVA par defaut=0.
Fin de regle. Si le (pays vendeur = pays acheteur) alors TVA par defaut=TVA du produit vendu. Fin de regle. Sinon TVA proposee par defaut=0. Fin de regle.
| Societe | $thirdparty_seller | Thirdparty seller |
| Societe | $thirdparty_buyer | Thirdparty buyer |
| int | $local | Localtax to process (1 or 2) |
| int | $idprod | Id product |
Definition at line 6588 of file functions.lib.php.
| get_default_npr | ( | Societe | $thirdparty_seller, |
| Societe | $thirdparty_buyer, | ||
$idprod = 0, |
|||
$idprodfournprice = 0 |
|||
| ) |
Fonction qui renvoie si tva doit etre tva percue recuperable.
| Societe | $thirdparty_seller | Thirdparty seller |
| Societe | $thirdparty_buyer | Thirdparty buyer |
| int | $idprod | Id product |
| int | $idprodfournprice | Id supplier price for product |
Definition at line 6552 of file functions.lib.php.
| 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 1: Si vendeur non assujeti a TVA, TVA par defaut=0.
Fin de regle. VATRULE 2: Si le (pays vendeur = pays acheteur) alors TVA par defaut=TVA du produit vendu. Fin de regle. VATRULE 3: Si (vendeur et acheteur dans Communaute europeenne) et (bien vendu = moyen de transports neuf comme auto, bateau, avion) alors TVA par defaut=0 (La TVA doit etre paye par acheteur au centre d'impots de son pays et non au vendeur). Fin de regle. VATRULE 4: Si (vendeur et acheteur dans Communaute europeenne) et (acheteur = particulier) alors TVA par defaut=TVA du produit vendu. Fin de regle VATRULE 5: Si (vendeur et acheteur dans Communaute europeenne) et (acheteur = entreprise) alors TVA par defaut=0. Fin de regle VATRULE 6: Sinon TVA proposee par defaut=0. Fin de regle.
| Societe | $thirdparty_seller | Objet societe vendeuse |
| Societe | $thirdparty_buyer | Objet societe acheteuse |
| int | $idprod | Id product |
| int | $idprodfournprice | Id product_fournisseur_price (for supplier order/invoice) |
Definition at line 6451 of file functions.lib.php.
| get_exdir | ( | $num, | |
| $level, | |||
| $alpha, | |||
| $withoutslash, | |||
| $object, | |||
$modulepart = '' |
|||
| ) |
Return a path to have a the directory according to object where files are stored.
New usage: $conf->module->multidir_output[$object->entity].'/'.get_exdir(0, 0, 0, 1, $object, '').'/' or: $conf->module->dir_output.'/'.get_exdir(0, 0, 0, 0, $object, '') if multidir_output not defined. Example out with new usage: $object is invoice -> 'INYYMM-ABCD' Example out with old usage: '015' with level 3->"0/1/5/", '015' with level 1->"5/", 'ABC-1' with level 3 ->"0/0/1/"
| string | int | $num | Id of object (deprecated, $object will be used in future) |
| int | $level | Level of subdirs to return (1, 2 or 3 levels). (deprecated, global option will be used in future) |
| int | $alpha | 0=Keep number only to forge path, 1=Use alpha part afer 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 |
| Object | $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. |
Definition at line 6696 of file functions.lib.php.
| get_htmloutput_errors | ( | $mesgstring = '', |
|
$mesgarray = array(), |
|||
$keepembedded = 0 |
|||
| ) |
Get formated error messages to output (Used to show messages on html output).
| string | $mesgstring | Error message |
| array | $mesgarray | Error messages array |
| int | $keepembedded | Set to 1 in error message must be kept embedded into its html place (this disable jnotify) |
Definition at line 8562 of file functions.lib.php.
References get_htmloutput_mesg().
| get_htmloutput_mesg | ( | $mesgstring = '', |
|
$mesgarray = '', |
|||
$style = 'ok', |
|||
$keepembedded = 0 |
|||
| ) |
Get formated messages to output (Used to show messages on html output).
This include also the translation of the message key.
| string | $mesgstring | Message string or message key |
| string[] | $mesgarray | Array of message strings or message keys |
| string | $style | Style of message output ('ok' or 'error') |
| int | $keepembedded | Set to 1 in error message must be kept embedded into its html place (this disable jnotify) |
Definition at line 8493 of file functions.lib.php.
Referenced by get_htmloutput_errors().
| get_localtax | ( | $vatrate, | |
| $local, | |||
$thirdparty_buyer = "", |
|||
$thirdparty_seller = "", |
|||
$vatnpr = 0 |
|||
| ) |
Return localtax rate for a particular vat, when selling a product with vat $vatrate, from a $thirdparty_buyer to a $thirdparty_seller Note: This function applies same rules than get_default_tva.
| float | $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 | $vatnpr | If vat rate is NPR or not |
Definition at line 5967 of file functions.lib.php.
| get_localtax_by_third | ( | $local | ) |
Get values of localtaxes (1 or 2) for company country for the common vat with the highest value.
| int | $local | LocalTax to get |
Definition at line 6119 of file functions.lib.php.
| get_product_localtax_for_country | ( | $idprod, | |
| $local, | |||
| $thirdpartytouse | |||
| ) |
Return localtax vat rate of a product in a particular country or default country vat if product is unknown.
| int | $idprod | Id of product |
| int | $local | 1 for localtax1, 2 for localtax 2 |
| Societe | $thirdpartytouse | Thirdparty with a ->country_code defined (FR, US, IT, ...) |
Definition at line 6380 of file functions.lib.php.
| get_product_vat_for_country | ( | $idprod, | |
| $thirdpartytouse, | |||
$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().
| int | $idprod | Id of product or 0 if not a predefined product |
| Societe | $thirdpartytouse | Thirdparty with a ->country_code defined (FR, US, IT, ...) |
| int | $idprodfournprice | Id product_fournisseur_price (for "supplier" proposal/order/invoice) |
Definition at line 6289 of file functions.lib.php.
| getActionCommEcmList | ( | $object | ) |
getActionCommEcmList
| ActionComm | $object | Object ActionComm |
Definition at line 11600 of file functions.lib.php.
| getAdvancedPreviewUrl | ( | $modulepart, | |
| $relativepath, | |||
$alldata = 0, |
|||
$param = '' |
|||
| ) |
Return URL we can use for advanced preview links.
| string | $modulepart | propal, facture, facture_fourn, ... |
| string | $relativepath | Relative path of docs. |
| int | $alldata | Return array with all components (1 is recommended, then use a simple a href link with the class, target and mime attribute added. 'documentpreview' css class is handled by jquery code into main.inc.php) |
| string | $param | More param on http links |
Definition at line 9950 of file functions.lib.php.
| getArrayOfSocialNetworks | ( | ) |
Get array of social network dictionary.
Definition at line 3097 of file functions.lib.php.
| getBrowserInfo | ( | $user_agent | ) |
Return information about user browser.
Returns array with the following format: array( 'browsername' => Browser name (firefox|chrome|iceweasel|epiphany|safari|opera|ie|unknown) 'browserversion' => Browser version. Empty if unknown 'browseros' => Set with mobile OS (android|blackberry|ios|palm|symbian|webos|maemo|windows|unknown) 'layout' => (tablet|phone|classic) 'phone' => empty if not mobile, (android|blackberry|ios|palm|unknown) if mobile 'tablet' => true/false )
| string | $user_agent | Content of $_SERVER["HTTP_USER_AGENT"] variable |
Definition at line 292 of file functions.lib.php.
| getCommonSubstitutionArray | ( | $outputlangs, | |
$onlykey = 0, |
|||
$exclude = null, |
|||
$object = null |
|||
| ) |
Return array of possible common substitutions.
This includes several families like: 'system', 'mycompany', 'object', 'objectamount', 'date', 'user'
| Translate | $outputlangs | Output language |
| int | $onlykey | 1=Do not calculate some heavy values of keys (performance enhancement when we need only the keys), 2=Values are trunc and html sanitized (to use for help tooltip) |
| array | $exclude | Array of family keys we want to exclude. For example array('system', 'mycompany', 'object', 'objectamount', 'date', 'user', ...) |
| Object | $object | Object for keys on object |
Definition at line 7526 of file functions.lib.php.
| 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.
| 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) |
Definition at line 10442 of file functions.lib.php.
| getDolGlobalInt | ( | $key, | |
$default = 0 |
|||
| ) |
Return dolibarr global constant int value.
| string | $key | key to return value, return 0 if not set |
| int | $default | value to return |
Definition at line 96 of file functions.lib.php.
Referenced by Reception\__construct(), and MailmanSpip\isSpipEnabled().
| if (!function_exists( 'utf8_encode')) if (!function_exists( 'utf8_decode')) getDolGlobalString | ( | $key, | |
$default = '' |
|||
| ) |
Return dolibarr global constant string value.
| string | $key | key to return value, return '' if not set |
| string | $default | value to return |
Definition at line 82 of file functions.lib.php.
Referenced by MailmanSpip\checkSpipConfig(), and MailmanSpip\connectSpip().
| getDoliDBInstance | ( | $type, | |
| $host, | |||
| $user, | |||
| $pass, | |||
| $name, | |||
| $port | |||
| ) |
Return a DoliDB instance (database handler).
| string | $type | Type of database (mysql, pgsql...) |
| string | $host | Address of database server |
| string | $user | Authorized username |
| string | $pass | Password |
| string | $name | Name of database |
| int | $port | Port of database server |
Definition at line 154 of file functions.lib.php.
Referenced by MailmanSpip\connectSpip().
| getDolUserInt | ( | $key, | |
$default = 0 |
|||
| ) |
Return dolibarr user constant int value.
| string | $key | key to return value, return 0 if not set |
| int | $default | value to return |
Definition at line 124 of file functions.lib.php.
| getDolUserString | ( | $key, | |
$default = '' |
|||
| ) |
Return dolibarr user constant string value.
| string | $key | key to return value, return '' if not set |
| string | $default | value to return |
Definition at line 110 of file functions.lib.php.
| getElementProperties | ( | $element_type | ) |
Get an array with properties of an element.
Called by fetchObjectByElement.
| string | $element_type | Element type (Value of $object->element). Example: 'action', 'facture', 'project_task' or 'object@mymodule'... |
Definition at line 11020 of file functions.lib.php.
| getEntity | ( | $element, | |
$shared = 1, |
|||
$currentobject = null |
|||
| ) |
Get list of entity id to use.
| 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 | $shared | 0=Return id of current entity only, 1=Return id of current entity + shared entities (default) |
| object | $currentobject | Current object if needed |
Definition at line 180 of file functions.lib.php.
| getFieldErrorIcon | ( | $fieldValidationErrorMsg | ) |
get field error icon
| string | $fieldValidationErrorMsg | message to add in tooltip |
Definition at line 10895 of file functions.lib.php.
| getImageFileNameForSize | ( | $file, | |
| $extName, | |||
$extImgTarget = '' |
|||
| ) |
Return the filename of file to get the thumbs.
| string | $file | Original filename (full or relative path) |
| string | $extName | Extension to differenciate thumb file name ('', '_small', '_mini') |
| string | $extImgTarget | Force image extension for thumbs. Use '' to keep same extension than original image (default). |
Definition at line 9899 of file functions.lib.php.
| getLanguageCodeFromCountryCode | ( | $countrycode | ) |
Return default language from country code.
Return null if not found.
| string | $countrycode | Country code like 'US', 'FR', 'CA', 'ES', 'IN', 'MX', ... |
Definition at line 9063 of file functions.lib.php.
| 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.
| int | 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 | $local | Number of localtax (1 or 2, or 0 to return 1 & 2) |
| Societe | $buyer | Company object |
| Societe | $seller | Company object |
| int | $firstparamisid | 1 if first param is ID into table instead of Rate+code (use this if you can) |
Definition at line 6227 of file functions.lib.php.
| GETPOST | ( | $paramname, | |
$check = 'alphanohtml', |
|||
$method = 0, |
|||
$filter = null, |
|||
$options = null, |
|||
$noreplace = 0 |
|||
| ) |
Return value of a param into GET or POST supervariable.
Use the property $user->default_values[path]['createform'] and/or $user->default_values[path]['filters'] and/or $user->default_values[path]['sortorder'] Note: The property $user->default_values is loaded by main.php when loading the user.
| string | $paramname | Name of parameter to found |
| string | $check | Type of check ''=no check (deprecated) 'none'=no check (only for param that should have very rich content like passwords) '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...') 'alpha'=Same than alphanohtml since v13 'alphawithlgt'=alpha with lgt 'alphanohtml'=check there is no html content and no " and no ../ 'aZ'=check it's a-z only 'aZ09'=check it's simple alpha string (recommended for keys) '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 and no " and no ../ 'restricthtml'=check html content is restricted to some tags only 'custom'= custom filter specify $filter and $options) |
| 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 détails) |
| mixed | $options | Options to pass to filter_var when $check is set to 'custom' |
| string | $noreplace | Force disable of replacement of xxx strings. |
Definition at line 517 of file functions.lib.php.
Referenced by StockTransfer\create(), and FormSetupItem\setValueFromPost().
| GETPOSTINT | ( | $paramname, | |
$method = 0 |
|||
| ) |
Return value of a param into GET or POST supervariable.
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.
| string | $paramname | Name of parameter to found |
| int | $method | Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get) |
Definition at line 828 of file functions.lib.php.
| 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
| string | $paramname | Name or parameter to test |
| int | $method | Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get) |
Definition at line 471 of file functions.lib.php.
| GETPOSTISSET | ( | $paramname | ) |
Return true if we are in a context of submitting the parameter $paramname from a POST of a form.
| string | $paramname | Name or parameter to test |
Definition at line 418 of file functions.lib.php.
| 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.
| int | 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 | $firstparamisid | 1 if first param is id into table (use this if you can) |
Definition at line 6154 of file functions.lib.php.
| getTimelineIcon | ( | $actionstatic, | |
| & | $histo, | ||
| $key | |||
| ) |
Get timeline icon.
| ActionComm | $actionstatic | actioncomm |
| array | $histo | histo |
| int | $key | key |
Definition at line 11537 of file functions.lib.php.
| getTitleFieldOfList | ( | $name, | |
$thead = 0, |
|||
$file = "", |
|||
$field = "", |
|||
$begin = "", |
|||
$moreparam = "", |
|||
$moreattrib = "", |
|||
$sortfield = "", |
|||
$sortorder = "", |
|||
$prefix = "", |
|||
$disablesortlink = 0, |
|||
$tooltip = '', |
|||
$forcenowrapcolumntitle = 0 |
|||
| ) |
Get title line of an array.
| string | $name | Translation key of field to show or complete HTML string to show |
| int | $thead | 0=To use with standard table format, 1=To use inside <thead> |
, 2=To use with
| string | $file | Url used when we click on sort picto |
| string | $field | Field to use for new sorting. Empty if this field is not sortable. Example "t.abc" or "t.abc,t.def" |
| string | $begin | ("" by defaut) |
| string | $moreparam | Add more parameters on sort url links ("" by default) |
| string | $moreattrib | Add more attributes on th ("" by defaut). To add more css class, use param $prefix. |
| string | $sortfield | Current field used to sort (Ex: 'd.datep,d.id') |
| string | $sortorder | Current sort order (Ex: 'asc,desc') |
| string | $prefix | Prefix for css. Use space after prefix to add your own CSS tag, for example 'mycss '. |
| string | $disablesortlink | 1=Disable sort link |
| string | $tooltip | Tooltip |
| string | $forcenowrapcolumntitle | No need for use 'wrapcolumntitle' css style |
Definition at line 5164 of file functions.lib.php.
| getUserRemoteIP | ( | ) |
Return the IP of remote user.
Take HTTP_X_FORWARDED_FOR (defined when using proxy) Then HTTP_CLIENT_IP if defined (rare) Then REMOTE_ADDR (no way to be modified by user but may be wrong if user is using a proxy)
Definition at line 3597 of file functions.lib.php.
| img_action | ( | $titlealt, | |
| $numaction, | |||
$picto = '' |
|||
| ) |
Show logo action.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| string | $numaction | Action id or code to show |
| string | $picto | Name of image file to show ('filenew', ...) If no extension provided, we use '.png'. Image must be stored into theme/xxx/img directory. Example: picto.png if picto.png is stored into htdocs/theme/mytheme/img Example: picto.png@mymodule if picto.png is stored into htdocs/mymodule/img Example: /mydir/mysubdir/picto.png if picto.png is stored into htdocs/mydir/mysubdir (pictoisfullpath must be set to 1) |
Definition at line 4408 of file functions.lib.php.
| img_allow | ( | $allow, | |
$titlealt = 'default' |
|||
| ) |
Show tick logo if allowed.
| string | $allow | Allow |
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
Definition at line 4783 of file functions.lib.php.
| img_credit_card | ( | $brand, | |
$morecss = null |
|||
| ) |
Return image of a credit card according to its brand name.
| string | $brand | Brand name of credit card |
| string | $morecss | More CSS |
Definition at line 4805 of file functions.lib.php.
| img_delete | ( | $titlealt = 'default', |
|
$other = 'class="pictodelete"', |
|||
$morecss = '' |
|||
| ) |
Show delete logo.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| string | $other | Add more attributes on img |
| string | $morecss | More CSS |
Definition at line 4541 of file functions.lib.php.
| img_down | ( | $titlealt = 'default', |
|
$selected = 0, |
|||
$moreclass = '' |
|||
| ) |
Show down arrow logo.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| int | $selected | Selected |
| string | $moreclass | Add more CSS classes |
Definition at line 4708 of file functions.lib.php.
| img_edit | ( | $titlealt = 'default', |
|
$float = 0, |
|||
$other = '' |
|||
| ) |
Show logo editer/modifier fiche.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| integer | $float | If you have to put the style "float: right" |
| string | $other | Add more attributes on img |
Definition at line 4501 of file functions.lib.php.
| img_edit_add | ( | $titlealt = 'default', |
|
$other = '' |
|||
| ) |
Show logo +.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| string | $other | Add more attributes on img |
Definition at line 4465 of file functions.lib.php.
| img_edit_remove | ( | $titlealt = 'default', |
|
$other = '' |
|||
| ) |
Show logo -.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| string | $other | Add more attributes on img |
Definition at line 4482 of file functions.lib.php.
| img_error | ( | $titlealt = 'default' | ) |
Show error logo.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
Definition at line 4651 of file functions.lib.php.
| img_help | ( | $usehelpcursor = 1, |
|
$usealttitle = 1 |
|||
| ) |
Show help logo with cursor "?".
| int | $usehelpcursor | 1=Use help cursor, 2=Use click pointer cursor, 0=No specific cursor |
| int | string | $usealttitle | Text to use as alt title |
Definition at line 4593 of file functions.lib.php.
| img_info | ( | $titlealt = 'default' | ) |
Show info logo.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
Definition at line 4614 of file functions.lib.php.
| img_left | ( | $titlealt = 'default', |
|
$selected = 0, |
|||
$moreatt = '' |
|||
| ) |
Show left arrow logo.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| int | $selected | Selected |
| string | $moreatt | Add more attribute on img tag (For example 'style="float: right"') |
Definition at line 4746 of file functions.lib.php.
| img_mime | ( | $file, | |
$titlealt = '', |
|||
$morecss = '' |
|||
| ) |
Show MIME img of a file.
| string | $file | Filename |
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| string | $morecss | More css |
Definition at line 4838 of file functions.lib.php.
| img_next | ( | $titlealt = 'default', |
|
$moreatt = '' |
|||
| ) |
Show next logo.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| string | $moreatt | Add more attribute on img tag (For example 'style="float: right"') |
Definition at line 4669 of file functions.lib.php.
| img_object | ( | $titlealt, | |
| $picto, | |||
$moreatt = '', |
|||
$pictoisfullpath = false, |
|||
$srconly = 0, |
|||
$notitle = 0 |
|||
| ) |
Show a picto called object_picto (generic function)
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| string | $picto | Name of image to show object_picto (example: user, group, action, bill, contract, propal, product, ...) For external modules use imagename@mymodule to search into directory "img" of module. |
| string | $moreatt | Add more attribute on img tag (ie: class="datecallink") |
| int | $pictoisfullpath | If 1, image path is a full path |
| int | $srconly | Return only content of the src attribute of img. |
| int | $notitle | 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip. |
Definition at line 4323 of file functions.lib.php.
| img_pdf | ( | $titlealt = 'default', |
|
$size = 3 |
|||
| ) |
Show pdf logo.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| int | $size | Taille de l'icone : 3 = 16x16px , 2 = 14x14px |
Definition at line 4447 of file functions.lib.php.
| img_picto | ( | $titlealt, | |
| $picto, | |||
$moreatt = '', |
|||
$pictoisfullpath = false, |
|||
$srconly = 0, |
|||
$notitle = 0, |
|||
$alt = '', |
|||
$morecss = '', |
|||
$marginleftonlyshort = 2 |
|||
| ) |
Show picto whatever it's its name (generic function)
| string | $titlealt | Text on title tag for tooltip. Not used if param notitle is set to 1. |
| string | $picto | Name of image file to show ('filenew', ...) If no extension provided, we use '.png'. Image must be stored into theme/xxx/img directory. Example: picto.png if picto.png is stored into htdocs/theme/mytheme/img Example: picto.png@mymodule if picto.png is stored into htdocs/mymodule/img Example: /mydir/mysubdir/picto.png if picto.png is stored into htdocs/mydir/mysubdir (pictoisfullpath must be set to 1) Example: fontawesome_envelope-open-text_fas_red_1em if you want to use fontaweseome icons: fontawesome_<icon-name>_<style>_<color>_<size> (only icon-name is mandatory) |
| string | $moreatt | Add more attribute on img tag (For example 'class="pictofixedwidth"') |
| boolean | int | $pictoisfullpath | If true or 1, image path is a full path |
| int | $srconly | Return only content of the src attribute of img. |
| int | $notitle | 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip. |
| string | $alt | Force alt for bind people |
| string | $morecss | Add more class css on img tag (For example 'myclascss'). |
| string | $marginleftonlyshort | 1 = Add a short left margin on picto, 2 = Add a larger left margin on picto, 0 = No margin left. Works for fontawesome picto only. |
Definition at line 3989 of file functions.lib.php.
| img_picto_common | ( | $titlealt, | |
| $picto, | |||
$moreatt = '', |
|||
$pictoisfullpath = 0, |
|||
$notitle = 0 |
|||
| ) |
Show picto (generic function)
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| string | $picto | Name of image file to show (If no extension provided, we use '.png'). Image must be stored into htdocs/theme/common directory. |
| string | $moreatt | Add more attribute on img tag |
| int | $pictoisfullpath | If 1, image path is a full path |
| int | $notitle | 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip. |
Definition at line 4371 of file functions.lib.php.
| img_previous | ( | $titlealt = 'default', |
|
$moreatt = '' |
|||
| ) |
Show previous logo.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| string | $moreatt | Add more attribute on img tag (For example 'style="float: right"') |
Definition at line 4688 of file functions.lib.php.
| img_printer | ( | $titlealt = "default", |
|
$other = '' |
|||
| ) |
Show printer logo.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| string | $other | Add more attributes on img |
Definition at line 4559 of file functions.lib.php.
| img_right | ( | $titlealt = 'default', |
|
$selected = 0, |
|||
$moreatt = '' |
|||
| ) |
Show right arrow logo.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| int | $selected | Selected |
| string | $moreatt | Add more attribute on img tag (For example 'style="float: right"') |
Definition at line 4765 of file functions.lib.php.
| img_search | ( | $titlealt = 'default', |
|
$other = '' |
|||
| ) |
Show search logo.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| string | $other | Add more attributes on img |
Definition at line 4862 of file functions.lib.php.
| img_searchclear | ( | $titlealt = 'default', |
|
$other = '' |
|||
| ) |
Show search logo.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| string | $other | Add more attributes on img |
Definition at line 4885 of file functions.lib.php.
| img_split | ( | $titlealt = 'default', |
|
$other = 'class="pictosplit"' |
|||
| ) |
Show split logo.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| string | $other | Add more attributes on img |
Definition at line 4575 of file functions.lib.php.
| img_up | ( | $titlealt = 'default', |
|
$selected = 0, |
|||
$moreclass = '' |
|||
| ) |
Show top arrow logo.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| int | $selected | Selected |
| string | $moreclass | Add more CSS classes |
Definition at line 4727 of file functions.lib.php.
| img_view | ( | $titlealt = 'default', |
|
$float = 0, |
|||
$other = 'class="valignmiddle"' |
|||
| ) |
Show logo view card.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| integer | $float | If you have to put the style "float: right" |
| string | $other | Add more attributes on img |
Definition at line 4520 of file functions.lib.php.
| img_warning | ( | $titlealt = 'default', |
|
$moreatt = '', |
|||
$morecss = 'pictowarning' |
|||
| ) |
Show warning logo.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| string | $moreatt | Add more attribute on img tag (For example 'style="float: right"'). If 1, add float: right. Can't be "class" attribute. |
| string | $morecss | Add more CSS |
Definition at line 4633 of file functions.lib.php.
| img_weather | ( | $titlealt, | |
| $picto, | |||
$moreatt = '', |
|||
$pictoisfullpath = 0, |
|||
$morecss = '' |
|||
| ) |
Show weather picto.
| string | $titlealt | Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title. |
| string | int | $picto | Name of image file to show (If no extension provided, we use '.png'). Image must be stored into htdocs/theme/common directory. Or level of meteo image (0-4). |
| string | $moreatt | Add more attribute on img tag |
| int | $pictoisfullpath | If 1, image path is a full path |
| string | $morecss | More CSS |
Definition at line 4343 of file functions.lib.php.
| info_admin | ( | $text, | |
$infoonimgalt = 0, |
|||
$nodiv = 0, |
|||
$admin = '1', |
|||
$morecss = 'hideonsmartphone', |
|||
$textfordropdown = '' |
|||
| ) |
Show information for admin users or standard users.
| string | $text | Text info |
| integer | $infoonimgalt | Info is shown only on alt of star picto, otherwise it is show on output after the star picto |
| int | $nodiv | No div |
| string | $admin | '1'=Info for admin users. '0'=Info for standard users (change only the look), 'error', 'warning', 'xxx'=Other |
| string | $morecss | More CSS ('', 'warning', 'error') |
| string | $textfordropdown | Show a text to click to dropdown the info box. |
Definition at line 4912 of file functions.lib.php.
| isAFileWithExecutableContent | ( | $filename | ) |
Return if a file can contains executable content.
| string | $filename | File name to test |
Definition at line 11177 of file functions.lib.php.
| isASecretKey | ( | $keyname | ) |
Return if string has a name dedicated to store a secret.
| string | $keyname | Name of key to test |
Definition at line 256 of file functions.lib.php.
| isHTTPS | ( | ) |
Return if we are using a HTTPS connexion Check HTTPS (no way to be modified by user but may be empty or wrong if user is using a proxy) Take HTTP_X_FORWARDED_PROTO (defined when using proxy) Then HTTP_X_FORWARDED_SSL.
Definition at line 3623 of file functions.lib.php.
| isModEnabled | ( | $module | ) |
Is Dolibarr module enabled.
| string | $module | module name to check |
Definition at line 137 of file functions.lib.php.
| 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
| int | $local | Local tax to test (1 or 2) |
Definition at line 6100 of file functions.lib.php.
| isValidEmail | ( | $address, | |
$acceptsupervisorkey = 0, |
|||
$acceptuserkey = 0 |
|||
| ) |
Return true if email syntax is ok.
| string | $address | email (Ex: "toto@examle.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 |
Definition at line 3763 of file functions.lib.php.
Referenced by dolObfuscateEmail().
| isValidMXRecord | ( | $domain | ) |
Return if the domain name has a valid MX record.
WARNING: This need function idn_to_ascii, checkdnsrr and getmxrr
| string | $domain | Domain name (Ex: "yahoo.com", "yhaoo.com", "dolibarr.fr") |
Definition at line 3786 of file functions.lib.php.
| isValidPhone | ( | $phone | ) |
Return true if phone number syntax is ok TODO Decide what to do with this.
| string | $phone | phone (Ex: "0601010101") |
Definition at line 3818 of file functions.lib.php.
| isVisibleToUserType | ( | $type_user, | |
| & | $menuentry, | ||
| & | $listofmodulesforexternal | ||
| ) |
Function to test if an entry is enabled or not.
| string | $type_user | 0=We test for internal user, 1=We test for external user |
| array | $menuentry | Array for feature entry to test |
| array | $listofmodulesforexternal | Array with list of modules allowed to external users |
Definition at line 10521 of file functions.lib.php.
| jsonOrUnserialize | ( | $stringtodecode | ) |
Decode an encode string.
The string can be encoded in json format (recommended) or with serialize (avoid this)
| string | $stringtodecode | String to decode (json or serialize coded) |
Definition at line 11429 of file functions.lib.php.
| load_fiche_titre | ( | $titre, | |
$morehtmlright = '', |
|||
$picto = 'generic', |
|||
$pictoisfullpath = 0, |
|||
$id = '', |
|||
$morecssontable = '', |
|||
$morehtmlcenter = '' |
|||
| ) |
Load a title with picto.
| string | $titre | Title to show |
| string | $morehtmlright | Added message to show on right |
| string | $picto | Icon to use before title (should be a 32x32 transparent png file) |
| int | $pictoisfullpath | 1=Icon name is a full absolute url of image |
| string | $id | To force an id on html objects |
| string | $morecssontable | More css on table |
| string | $morehtmlcenter | Added message to show on center |
Definition at line 5323 of file functions.lib.php.
| 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)__ and [ConstantKey] are also replaced.
Example of usage: $substitutionarray = getCommonSubstitutionArray($langs, 0, null, $thirdparty); complete_substitutions_array($substitutionarray, $langs, $thirdparty); $mesg = make_substitutions($mesg, $substitutionarray, $langs);
| string | $text | Source string in which we must do substitution |
| array | $substitutionarray | Array with key->val to substitute. Example: array('MYKEY' => 'MyVal', ...) |
| Translate | $outputlangs | Output language |
| int | $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 |
Definition at line 8119 of file functions.lib.php.
| natural_search | ( | $fields, | |
| $value, | |||
$mode = 0, |
|||
$nofirstand = 0 |
|||
| ) |
Generate natural SQL search string for a criteria (this criteria can be tested on one or several fields)
| 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, can contains a list of int id separated by comma like "1,3,4" If param $mode is 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') 3=value is list of string separated with comma (Example 'text 1,text 2'), 4=value is a list of ID separated with comma (Example '2,7') to be used to search into a multiselect string '1,2,3,4' |
| integer | $nofirstand | 1=Do not output the first 'AND' |
Definition at line 9724 of file functions.lib.php.
| 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.
Definition at line 11192 of file functions.lib.php.
| num2Alpha | ( | $n | ) |
Return a numeric value into an Excel like column number.
So 0 return 'A', 1 returns 'B'..., 26 return 'AA'
| int | string | $n | Numeric value |
Definition at line 268 of file functions.lib.php.
| picto_from_langcode | ( | $codelang, | |
$moreatt = '', |
|||
$notitlealt = 0 |
|||
| ) |
Return img flag of country for a language code or country code.
| string | $codelang | Language code ('en_IN', 'fr_CA', ...) or ISO Country code on 2 characters in uppercase ('IN', 'FR') |
| string | $moreatt | Add more attribute on img tag (For example 'style="float: right"' or 'class="saturatemedium"') |
| int | $notitlealt | No title alt |
Definition at line 9020 of file functions.lib.php.
| picto_required | ( | ) |
Return picto saying a field is required.
Definition at line 6819 of file functions.lib.php.
| 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.
| float | $amount | Amount to format |
| integer | $form | Type of format, HTML or not (not by default) |
| Translate | string | $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 accurancy) before beeing inserted into database or after a computation, so this parameter should be useless. |
| int | $rounding | MINIMUM number of decimal to show. 0=no change, -1=we use min($conf->global->MAIN_MAX_DECIMALS_UNIT,$conf->global->MAIN_MAX_DECIMALS_TOT) |
| int | string | $forcerounding | Force the MAXIMUM of decimal to forcerounding decimal (-1=no change, 'MU' or 'MT' or 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) |
Definition at line 5660 of file functions.lib.php.
| 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().
| string | float | $amount | Amount to convert/clean or round |
| string | int | $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 | $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). |
Definition at line 5786 of file functions.lib.php.
Referenced by PaymentVarious\check(), ChargeSociales\check(), CommonInvoice\getRemainToPay(), SupplierProposal\set_remise_absolue(), Propal\set_remise_absolue(), Commande\set_remise_absolue(), Facture\set_remise_absolue(), SupplierProposal\set_remise_percent(), Propal\set_remise_percent(), Commande\setDiscount(), and Facture\setDiscount().
| print_barre_liste | ( | $titre, | |
| $page, | |||
| $file, | |||
$options = '', |
|||
$sortfield = '', |
|||
$sortorder = '', |
|||
$morehtmlcenter = '', |
|||
$num = -1, |
|||
$totalnboflines = '', |
|||
$picto = 'generic', |
|||
$pictoisfullpath = 0, |
|||
$morehtmlright = '', |
|||
$morecss = '', |
|||
$limit = -1, |
|||
$hideselectlimit = 0, |
|||
$hidenavigation = 0, |
|||
$pagenavastextinput = 0, |
|||
$morehtmlrightbeforearrow = '' |
|||
| ) |
Print a title with navigation controls for pagination.
| string | $titre | Title to show (required) |
| int | $page | Numero of page to show in navigation links (required) |
| string | $file | Url of page (required) |
| string | $options | More parameters for links ('' by default, does not include sortfield neither sortorder). Value must be 'urlencoded' before calling function. |
| string | $sortfield | Field to sort on ('' by default) |
| string | $sortorder | Order to sort ('' by default) |
| string | $morehtmlcenter | String in the middle ('' by default). We often find here string $massaction comming from $form->selectMassAction() |
| int | $num | Number of records found by select with limit+1 |
| int | string | $totalnboflines | Total number of records/lines for all pages (if known). Use a negative value of number to not show number. Use '' if unknown. |
| string | $picto | Icon to use before title (should be a 32x32 transparent png file) |
| int | $pictoisfullpath | 1=Icon name is a full absolute url of image |
| string | $morehtmlright | More html to show (after arrows) |
| string | $morecss | More css to the table |
| int | $limit | Max number of lines (-1 = use default, 0 = no limit, > 0 = limit). |
| int | $hideselectlimit | Force to hide select limit |
| int | $hidenavigation | Force to hide all navigation tools |
| int | $pagenavastextinput | 1=Do not suggest list of pages to navigate but suggest the page number into an input field. |
| string | $morehtmlrightbeforearrow | More html to show (before arrows) |
Definition at line 5376 of file functions.lib.php.
| print_date_range | ( | $date_start, | |
| $date_end, | |||
$format = '', |
|||
$outputlangs = '' |
|||
| ) |
Format output for start and end date.
| int | $date_start | Start date |
| int | $date_end | End date |
| string | $format | Output format |
| Translate | $outputlangs | Output language |
Definition at line 8297 of file functions.lib.php.
| print_fiche_titre | ( | $title, | |
$mesg = '', |
|||
$picto = 'generic', |
|||
$pictoisfullpath = 0, |
|||
$id = '' |
|||
| ) |
Show a title with picto.
| string | $title | Title to show |
| string | $mesg | Added message to show on right |
| string | $picto | Icon to use before title (should be a 32x32 transparent png file) |
| int | $pictoisfullpath | 1=Icon name is a full absolute url of image |
| int | $id | To force an id on html objects |
Definition at line 5305 of file functions.lib.php.
| print_fleche_navigation | ( | $page, | |
| $file, | |||
$options = '', |
|||
$nextpage = 0, |
|||
$betweenarrows = '', |
|||
$afterarrows = '', |
|||
$limit = -1, |
|||
$totalnboflines = 0, |
|||
$hideselectlimit = 0, |
|||
$beforearrows = '' |
|||
| ) |
Function to show navigation arrows into lists.
| int | $page | Number of page |
| string | $file | Page URL (in most cases provided with $_SERVER["PHP_SELF"]) |
| string | $options | Other url parameters to propagate ("" by default, may include sortfield and sortorder) |
| integer | $nextpage | Do we show a next page button |
| string | $betweenarrows | HTML content to show between arrows. MUST contains ' ' tags or ' '. |
| string | $afterarrows | HTML content to show after arrows. Must NOT contains ' ' tags. |
| int | $limit | Max nb of record to show (-1 = no combo with limit, 0 = no limit, > 0 = limit) |
| int | $totalnboflines | Total number of records/lines for all pages (if known) |
| int | $hideselectlimit | Force to hide select limit |
| string | $beforearrows | HTML content to show before arrows. Must NOT contains ' ' tags. |
Definition at line 5522 of file functions.lib.php.
| print_liste_field_titre | ( | $name, | |
$file = "", |
|||
$field = "", |
|||
$begin = "", |
|||
$moreparam = "", |
|||
$moreattrib = "", |
|||
$sortfield = "", |
|||
$sortorder = "", |
|||
$prefix = "", |
|||
$tooltip = "", |
|||
$forcenowrapcolumntitle = 0 |
|||
| ) |
Show title line of an array.
| string | $name | Label of field |
| string | $file | Url used when we click on sort picto |
| string | $field | Field to use for new sorting |
| string | $begin | ("" by defaut) |
| string | $moreparam | Add more parameters on sort url links ("" by default) |
| string | $moreattrib | Options of attribute td ("" by defaut) |
| string | $sortfield | Current field used to sort |
| string | $sortorder | Current sort order |
| string | $prefix | Prefix for css. Use space after prefix to add your own CSS tag. |
| string | $tooltip | Tooltip |
| string | $forcenowrapcolumntitle | No need for use 'wrapcolumntitle' css style |
Definition at line 5141 of file functions.lib.php.
| print_titre | ( | $title | ) |
Show a title.
| string | $title | Title to show |
Definition at line 5287 of file functions.lib.php.
| printCommonFooter | ( | $zone = 'private' | ) |
Print common footer : conf->global->MAIN_HTML_FOOTER js for switch of menu hider js for conf->global->MAIN_GOOGLE_AN_ID js for conf->global->MAIN_SHOW_TUNING_INFO or $_SERVER["MAIN_SHOW_TUNING_INFO"] js for conf->logbuffer.
| string | $zone | 'private' (for private pages) or 'public' (for public pages) |
Definition at line 9453 of file functions.lib.php.
Referenced by llxFooterVierge().
| 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.
| string | $fullpath_original_file_osencoded | Full path of file to return. |
| int | $method | -1 automatic, 0=readfile, 1=fread, 2=stream_copy_to_stream |
Definition at line 11353 of file functions.lib.php.
| roundUpToNextMultiple | ( | $n, | |
$x = 5 |
|||
| ) |
Round to next multiple.
| double | $n | Number to round up |
| integer | $x | Multiple. For example 60 to round up to nearest exact minute for a date with seconds. |
Definition at line 10562 of file functions.lib.php.
| sanitizeVal | ( | $out = '', |
|
$check = 'alphanohtml', |
|||
$filter = null, |
|||
$options = null |
|||
| ) |
Return a sanitized or empty value after checking value against a rule.
| string | array | $out | Value to check/clear. |
| string | $check | Type of check/sanitizing |
| int | $filter | Filter to apply when $check is set to 'custom'. (See http://php.net/manual/en/filter.filters.php for détails) |
| mixed | $options | Options to pass to filter_var when $check is set to 'custom' |
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.
| string | $mode | '' (prefix for session name) or 'email' (prefix for email id) |
Definition at line 858 of file functions.lib.php.
Referenced by Export\build_filterQuery().
| setEntity | ( | $currentobject | ) |
Set entity id to use when to create an object.
| object | $currentobject | Current object |
Definition at line 239 of file functions.lib.php.
| setEventMessage | ( | $mesgs, | |
$style = 'mesgs' |
|||
| ) |
Set event message in dol_events session object.
Will be output by calling dol_htmloutput_events. Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function. Note: Prefer to use setEventMessages instead.
| string | string[] | $mesgs | Message string or array |
| string | $style | Which style to use ('mesgs' by default, 'warnings', 'errors') |
Definition at line 8389 of file functions.lib.php.
| setEventMessages | ( | $mesg, | |
| $mesgs, | |||
$style = 'mesgs', |
|||
$messagekey = '' |
|||
| ) |
Set event messages in dol_events session object.
Will be output by calling dol_htmloutput_events. Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function.
| string | $mesg | Message string |
| array | null | $mesgs | Message array |
| string | $style | Which style to use ('mesgs' by default, 'warnings', 'errors') |
| string | $messagekey | A key to be used to allow the feature "Never show this message again" |
Definition at line 8418 of file functions.lib.php.
Referenced by Societe\setParent().
| show_actions_messaging | ( | $conf, | |
| $langs, | |||
| $db, | |||
| $filterobj, | |||
$objcon = '', |
|||
$noprint = 0, |
|||
$actioncode = '', |
|||
$donetodo = 'done', |
|||
$filters = array(), |
|||
$sortfield = 'a.datep, |
|||
| a.id' | , | ||
$sortorder = 'DESC' |
|||
| ) |
Show html area with actions in messaging format.
Note: Global parameter $param must be defined.
| Conf | $conf | Object conf |
| Translate | $langs | Object langs |
| DoliDB | $db | Object db |
| mixed | $filterobj | Filter on object Adherent|Societe|Project|Product|CommandeFournisseur|Dolresource|Ticket|... to list events linked to an object |
| Contact | $objcon | Filter on object contact to filter events on a contact |
| int | $noprint | Return string but does not output it |
| string | $actioncode | Filter on actioncode |
| string | $donetodo | Filter on event 'done' or 'todo' or ''=nofilter (all). |
| array | $filters | Filter on other fields |
| string | $sortfield | Sort field |
| string | $sortorder | Sort order |
Definition at line 11643 of file functions.lib.php.
| showDimensionInBestUnit | ( | $dimension, | |
| $unit, | |||
| $type, | |||
| $outputlangs, | |||
$round = -1, |
|||
$forceunitoutput = 'no', |
|||
$use_short_label = 0 |
|||
| ) |
Output a dimension with best unit.
| float | $dimension | Dimension |
| int | $unit | Unit scale of dimension (Example: 0=kg, -3=g, -6=mg, 98=ounce, 99=pound, ...) |
| string | $type | 'weight', 'volume', ... |
| Translate | $outputlangs | Translate language object |
| int | $round | -1 = non rounding, x = number of decimal |
| string | $forceunitoutput | 'no' or numeric (-3, -6, ...) compared to $unit (In most case, this value is value defined into $conf->global->MAIN_WEIGHT_DEFAULT_UNIT) |
| int | $use_short_label | 1=Use short label ('g' instead of 'gram'). Short labels are not translated. |
Definition at line 5918 of file functions.lib.php.
| showDirectDownloadLink | ( | $object | ) |
Return string with full Url.
The file qualified is the one defined by relative path in $object->last_main_doc
| Object | $object | Object |
Definition at line 9873 of file functions.lib.php.
| showValueWithClipboardCPButton | ( | $valuetocopy, | |
$showonlyonhover = 1, |
|||
$texttoshow = '' |
|||
| ) |
Create a button to copy $valuetocopy in the clipboard (for copy and paste feature).
Code that handle the click is inside core/js/lib_foot.js.php.
| string | $valuetocopy | The value to print |
| int | $showonlyonhover | Show the copy-paste button only on hover |
| string | $texttoshow | Replace the value to show with this text. Use 'none' to show no text (only the copy-paste picto) |
Definition at line 11401 of file functions.lib.php.
| startSimpleTable | ( | $header, | |
$link = "", |
|||
$arguments = "", |
|||
$emptyRows = 0, |
|||
$number = -1 |
|||
| ) |
Start a table with headers and a optinal clickable number (don't forget to use "finishSimpleTable()" after the last table row)
| string | $header | The first left header of the table (automatic translated) |
| string | $link | (optional) The link to a internal dolibarr page, when click on the number (without the first "/") |
| string | $arguments | (optional) Additional arguments for the link (e.g. "search_status=0") |
| integer | $emptyRows | (optional) The count of empty rows after the first header |
| integer | $number | (optional) The number that is shown right after the first header, when not set the link is shown on the right side of the header as "FullList" |
Definition at line 11220 of file functions.lib.php.
| utf8_check | ( | $str | ) |
Check if a string is in UTF8.
| string | $str | String to check |
Definition at line 8723 of file functions.lib.php.
References dol_strlen().
| vatrate | ( | $rate, | |
$addpercent = false, |
|||
$info_bits = 0, |
|||
$usestarfornpr = 0, |
|||
$html = 0 |
|||
| ) |
Return a string with VAT rate label formated for view output Used into pdf and HTML pages.
| 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 |
Definition at line 5611 of file functions.lib.php.
| verifCond | ( | $strToEvaluate | ) |
Verify if condition in string is ok or not.
| string | $strToEvaluate | String with condition to check |
Definition at line 8867 of file functions.lib.php.
| yn | ( | $yesno, | |
$case = 1, |
|||
$color = 0 |
|||
| ) |
Return yes or no in current language.
| string | int | $yesno | Value to test (1, 'yes', 'true' or 0, 'no', 'false') |
| integer | $case | 1=Yes/No, 0=yes/no, 2=Disabled checkbox, 3=Disabled checkbox + Yes/No |
| int | $color | 0=texte only, 1=Text is formated with a color font style ('ok' or 'error'), 2=Text is formated with 'ok' color. |
Definition at line 6638 of file functions.lib.php.
