HTML rendering functions for Dolibarr This file contains all HTML output, formatting and display functions. More...

Functions
	dolPrintLabel ($s, $escapeonlyhtmltags=0)
	Return a string label (so on 1 line only and that should not contains any HTML) ready to be output on HTML page.

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

	dolPrintHTML ($s, $allowiframe=0, $moreallowedtags=array())
	Return a string (that can be on several lines) ready to be output on a HTML page.

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

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

	dolPrintHTMLForTextArea ($s, $allowiframe=0)
	Return a string ready to be output on input textarea.

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

	dol_escape_htmltag ($stringtoescape, $keepb=0, $keepn=0, $noescapetags='', $escapeonlyhtmltags=0, $cleanalsojavascript=0)
	Returns text escaped for inclusion in HTML alt or title or value tags, or into values of HTML input fields.

	dolButtonToOpenExportDialog ($name, $label, $buttonstring, $exportSiteName, $overwriteGitUrl, $website)
	Create a dialog with two buttons for export and overwrite of a website.

	dolButtonToOpenUrlInDialogPopup ($name, $label, $buttonstring, $url, $disabled='', $morecss='classlink button bordertransp', $jsonopen='', $jsonclose='', $accesskey='')
	Return HTML code to output a button to open a dialog popup box.

	dol_fiche_head ($links=array(), $active='0', $title='', $notab=0, $picto='', $pictoisfullpath=0, $morehtmlright='', $morecss='', $limittoshow=0, $moretabssuffix='')
	Show tab header of a card.

	dol_get_fiche_head ($links=array(), $active='', $title='', $notab=0, $picto='', $pictoisfullpath=0, $morehtmlright='', $morecss='', $limittoshow=0, $moretabssuffix='', $dragdropfile=0, $morecssdiv='')
	Show tabs of a record.

	dol_fiche_end ($notab=0)
	Show tab footer of a card.

	dol_get_fiche_end ($notab=0)
	Return tab footer of a card.

	fieldLabel ($langkey, $fieldkey, $fieldrequired=0)
	Show a string with the label tag dedicated to the HTML edit field.

	dolOutputDates ($datep, $datef=null, $fullday=0, $addseconds=0, $pictotoadd='', $tzoutput='tzuserrel', $reduceformat=0)
	Print decorated date-hour.

	getPictoForType ($key, $morecss='')
	Return the picto for a data type.

	img_picto ($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2, $allowothertags=array())
	Show picto whatever it's its name (generic function)

	getImgPictoConv ($mode='fa')
	Get array to convert the Dolibarr picto keys into Font awesome keys.

	img_object ($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $allowothertags=array())
	Show a picto called object_picto (generic function)

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

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

	img_action ($titlealt, $numaction, $picto='', $moreatt='')
	Show logo action.

	img_edit_add ($titlealt='default', $other='')
	Show logo "+".

	img_edit_remove ($titlealt='default', $other='')
	Show logo "-".

	img_edit ($titlealt='default', $float=0, $other='')
	Show logo edit/modify fiche.

	img_view ($titlealt='default', $float=0, $other='class="valignmiddle"')
	Show logo view card.

	img_delete ($titlealt='default', $other='class="pictodelete"', $morecss='')
	Show delete logo.

	img_printer ($titlealt="default", $other='')
	Show printer logo.

	img_split ($titlealt='default', $other='class="pictosplit"')
	Show split logo.

	img_help ($usehelpcursor=1, $usealttitle=1)
	Show help logo with cursor "?".

	img_info ($titlealt='default')
	Show info logo.

	img_warning ($titlealt='default', $moreatt='', $morecss='pictowarning')
	Show warning logo.

	img_error ($titlealt='default')
	Show error logo.

	img_next ($titlealt='default', $moreatt='')
	Show next logo.

	img_previous ($titlealt='default', $moreatt='')
	Show previous logo.

	img_down ($titlealt='default', $selected=0, $moreclass='')
	Show down arrow logo.

	img_up ($titlealt='default', $selected=0, $moreclass='')
	Show top arrow logo.

	img_left ($titlealt='default', $selected=0, $moreatt='')
	Show left arrow logo.

	img_right ($titlealt='default', $selected=0, $moreatt='')
	Show right arrow logo.

	img_allow ($allow, $titlealt='default')
	Show tick logo if allowed.

	img_credit_card ($brand, $morecss='fa-2x inline-block valignmiddle')
	Return image of a credit card according to its brand name.

	img_mime ($file, $titlealt='', $morecss='')
	Show MIME img of a file.

	img_search ($titlealt='default', $other='')
	Show search logo.

	img_searchclear ($titlealt='default', $other='')
	Show search logo.

	info_admin ($text, $infoonimgalt=0, $nodiv=0, $admin='1', $morecss='hideonsmartphone', $textfordropdown='', $picto='', $textonpictotooltip='', $cssfordropdown='info_admin')
	Show information in HTML for admin users or standard users.

	dol_print_error ($db=null, $error='', $errors=null)
	Displays error message system with all the information to facilitate the diagnosis and the escalation of the bugs.

	dol_print_error_email ($prefixcode, $errormessage='', $errormessages=array(), $morecss='error', $email='')
	Show a public email and error code to contact if technical error.

	print_liste_field_titre ($name, $file="", $field="", $begin="", $param="", $moreattrib="", $sortfield="", $sortorder="", $prefix="", $tooltip="", $forcenowrapcolumntitle=0)
	Show title line of an array.

	getTitleFieldOfList ($name, $thead=0, $file="", $field="", $begin="", $moreparam="", $moreattrib="", $sortfield="", $sortorder="", $prefix="", $disablesortlink=0, $tooltip='', $forcenowrapcolumntitle=0)
	Get title line of an array.

	print_titre ($title)
	Show a title.

	print_fiche_titre ($title, $mesg='', $picto='generic', $pictoisfullpath=0, $id='')
	Show a title with picto.

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

	print_barre_liste ($title, $page, $file, $options='', $sortfield='', $sortorder='', $morehtmlcenter='', $num=-1, $totalnboflines='', $picto='generic', $pictoisfullpath=0, $morehtmlright='', $morecss='', $limit=-1, $selectlimitsuffix=0, $hidenavigation=0, $pagenavastextinput=0, $morehtmlrightbeforearrow='')
	Print a title with navigation controls for pagination.

	print_fleche_navigation ($page, $file, $options='', $nextpage=0, $betweenarrows='', $afterarrows='', $limit=-1, $totalnboflines=0, $selectlimitsuffix='', $beforearrows='', $hidenavigation=0)
	Function to show navigation arrows into lists.

	showTotalAmount ($amount)
	Style total amount of an object.

	showDimensionInBestUnit ($dimension, $unit, $type, $outputlangs, $round=-1, $forceunitoutput='no', $use_short_label=0)
	Output a dimension with best unit.

	yn ($yesno, $format=1, $color=0)
	Return yes or no in current language.

	setEventMessage ($mesgs, $style='mesgs', $noduplicate=0, $attop=0)
	Set event message in dol_events session object.

	setEventMessages ($mesg, $mesgs, $style='mesgs', $messagekey='', $noduplicate=0, $attop=0)
	Set event messages in dol_events session object.

	dol_htmloutput_events ($disabledoutputofmessages=0)
	Print formatted messages to output (Used to show messages on html output).

	get_htmloutput_mesg ($mesgstring='', $mesgarray=[], $style='ok', $keepembedded=0)
	Get formatted messages to output (Used to show messages on html output).

	get_htmloutput_errors ($mesgstring='', $mesgarray=array(), $keepembedded=0)
	Get formatted error messages to output (Used to show messages on html output).

	dol_htmloutput_mesg ($mesgstring='', $mesgarray=array(), $style='ok', $keepembedded=0)
	Print formatted messages to output (Used to show messages on html output).

	dol_htmloutput_errors ($mesgstring='', $mesgarray=array(), $keepembedded=0)
	Print formatted error messages to output (Used to show messages on html output).

	picto_from_langcode ($codelang, $moreatt='', $notitlealt=0)
	Return img flag of country for a language code or country code.

	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.

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

	showSimpleHTMLTable ($outputlangs, $object)
	Returns simple order table template as string.

	showDirectDownloadLink ($object)
	Return string with full Url.

	getAdvancedPreviewUrl ($modulepart, $relativepath, $alldata=0, $param='')
	Return URL we can use for advanced preview links.

	ajax_autoselect ($htmlname, $addlink='', $textonlink='Link')
	Make content of an input box selected when we click into input field.

	dolGetBadge ($label, $html='', $type='primary', $mode='', $url='', $params=array())
	Function dolGetBadge.

	dolGetStatus ($statusLabel='', $statusLabelShort='', $html='', $statusType='status0', $displayMode=0, $url='', $params=array())
	Output the badge of a status.

	dolGetButtonAction ($label, $text='', $actionType='default', $url='', $id='', $userRight=1, $params=array())
	Function dolGetButtonAction.

	commonHtmlAttributeBuilder ($attr, array $unescapedAttr=[])
	Builds an array of safe and properly escaped HTML attributes from a key-value pair list.

	getListOfHtmlBooleanAttributes ()
	Returns a list of HTML boolean attributes.

	dolCompletUrlForDropdownButton (string $url, array $params, bool $addDolUrlRoot=true)
	An function to complete dropdown url in dolGetButtonAction.

	dolGetButtonTitleSeparator ($moreClass="")
	Add space between dolGetButtonTitle.

	getFieldErrorIcon ($fieldValidationErrorMsg)
	get field error icon

	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.

	startSimpleTable ($header, $link="", $arguments="", $emptyColumns=0, $number=-1, $pictofulllist='')
	Start a table with headers and a optional clickable number (don't forget to use "finishSimpleTable()" after the last table row)

	finishSimpleTable ($addLineBreak=false)
	Add the correct HTML close tags for "startSimpleTable(...)" (use after the last table line)

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

	showValueWithClipboardCPButton ($valuetocopy, $showonlyonhover=1, $texttoshow='')
	Create a button to copy $valuetocopy in the clipboard (for copy and paste feature).

	show_actions_messaging ($conf, $langs, $db, $filterobj, $objcon=null, $noprint=0, $actioncode='', $donetodo='done', $filters=array(), $sortfield='a.datep, a.id', $sortorder='DESC')
	Show html area with actions in messaging format.

Detailed Description

HTML rendering functions for Dolibarr This file contains all HTML output, formatting and display functions.

It was extracted from functions.lib.php to reduce file size and improve maintainability.

Functions included:

Icon and image rendering (img_*, picto_*)
HTML output functions (dolPrint*, dol_print_*)
Form and list rendering (fiche, barre_liste, etc.)
Button and badge rendering
Formatted output (price, vatrate, dates, etc.)
Error and message display

Definition in file html.lib.php.

Function Documentation

◆ addSummaryTableLine()

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

Parameters

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 entries ($num === 0)
bool	$extraRightColumn	(optional) Add a additional column after the summary word and total number

Returns: void

Definition at line 5035 of file html.lib.php.

References price().

◆ ajax_autoselect()

ajax_autoselect	(	$htmlname,
		$addlink = '',
		$textonlink = 'Link' )

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

Parameters

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'

Returns: string

See also: showValueWithClipboardCPButton()

Definition at line 4212 of file html.lib.php.

Referenced by dol_print_cron_urls(), ExternalModules\getPagination(), FormFile\list_of_documents(), print_barre_liste(), showDirectPublicLink(), and FormFile\showdocuments().

◆ commonHtmlAttributeBuilder()

commonHtmlAttributeBuilder	(		$attr,
		array	$unescapedAttr = [] )

Builds an array of safe and properly escaped HTML attributes from a key-value pair list.

This function ensures that HTML attributes are correctly encoded for safe output. Special handling is applied for attributes such as href, which are processed using dolPrintHTMLForAttributeUrl(). All other attributes are escaped using dolPrintHTMLForAttribute().

Example:

$attr = [
    'href' => 'https://example.com?a=1&b=2',
    'class' => 'btn btn-primary',
    'title' => 'View details'
];
$result = commonHtmlAttributeBuilder($attr);
 
// Output:
// [
//   'href' => 'href="https://example.com?a=1&amp;b=2"',
//   'class' => 'class="btn btn-primary"',
//   'title' => 'title="View details"'
// ]

Parameters

	array<string,string\|int\|float\|null\|bool>	$attr Associative array of attribute names and their values.
string[]	$unescapedAttr	Optional list of attribute names that should not be escaped.

Returns: array<string, string> An array where each key corresponds to the attribute name and each value is a full key="escaped_value" string ready for HTML output.

Definition at line 4692 of file html.lib.php.

References dol_htmlentities(), dolPrintHTMLForAttribute(), dolPrintHTMLForAttributeUrl(), and getListOfHtmlBooleanAttributes().

Referenced by FormSetup\generateLineOutput(), and Form\radio().

◆ dol_escape_htmltag()

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

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

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

dolPrintLabel...
dolPrintHTML... that is dol_escape_htmltag(dol_htmlwithnojs(dol_string_onlythesehtmltags(dol_htmlentitiesbr(...), 1, 1, 1, 0)), 1, 1, 'common', 0, 1) for notes or descriptions into textarea, add 'common' if into a html content
dolPrintPassword that is a simple htmlspecialchars(... , ENT_COMPAT, 'UTF-8') for passwords.

Parameters

string	$stringtoescape	String to escape
int	$keepb	1=Replace b tags with escaped value (except if in $noescapetags), 0=Remove them completely
int	$keepn	1=Preserve \r strings, 0=Replace them with escaped value, -1=Remove them. Set to 1 when escaping for a <textarea>.
string	$noescapetags	'' (escape all html tags) or 'common' (do not escape some common tags) or 'common,a,b,c' or list of tags to not escape.
int	$escapeonlyhtmltags	1=Escape only html tags and double quotes, not the special chars like accents.
int	$cleanalsojavascript	Clean also javascript. @TODO switch this option to 1 by default.

Returns: string Escaped string

See also: dol_string_nohtmltag(), dol_string_onlythesehtmltags(), dol_string_nospecial(), dol_string_unaccent(), dol_htmlentitiesbr()

Parameters

string[] $reg

Returns: string

Definition at line 172 of file html.lib.php.

References dol_string_onlythesehtmltags(), and string.

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

◆ dol_fiche_end()

dol_fiche_end ( $notab = 0 )

Show tab footer of a card.

Parameters

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

Returns: void

Deprecated: Use print dol_get_fiche_end() instead

Definition at line 706 of file html.lib.php.

References dol_get_fiche_end().

◆ dol_fiche_head()

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

Show tab header of a card.

Parameters

	array<int,array<int<0,5>,string>>	$links Array of tabs (0=>url, 1=>label, 2=>code, 3=>not used, 4=>text after link, 5=>morecssonlink). Currently initialized by calling a function xxx_admin_prepare_head. Note that label into $links[$i][1] must be already HTML escaped.
string	$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('/mymodule/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

Returns: void

Deprecated: Use print dol_get_fiche_head() instead

Definition at line 497 of file html.lib.php.

References dol_get_fiche_head().

◆ dol_get_fiche_end()

dol_get_fiche_end ( $notab = 0 )

Return tab footer of a card.

Parameters

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

Returns: string

Definition at line 717 of file html.lib.php.

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

◆ dol_get_fiche_head()

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

Show tabs of a record.

Parameters

	array<int,array<int<0,5>,string>>	$links Array of tabs (0=>url, 1=>label, 2=>code, 3=>not used, 4=>text after link, 5=>morecssonlink). Currently initialized by calling a function xxx_admin_prepare_head. Note that label into $links[$i][1] must be already HTML escaped.
string	$active	Active tab name (using the old numeric int is deprecated)
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 separation 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('/mymodule/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
int	$dragdropfile	0 (default) or 1. 1 enable a drop zone for file to be upload, 0 disable it
string	$morecssdiv	More CSS on the div

Returns: string

Definition at line 519 of file html.lib.php.

References $conf, dol_escape_htmltag(), dragAndDropFileUpload(), getDolGlobalInt(), getDolGlobalString(), getNonce(), and img_picto().

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

◆ dol_htmloutput_errors()

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

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

Parameters

string	$mesgstring	Error message
string[]	$mesgarray	Error messages array
	int<0,1>	$keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)

Returns: void

See also: dol_print_error(); dol_htmloutput_mesg()

Definition at line 3700 of file html.lib.php.

◆ dol_htmloutput_events()

dol_htmloutput_events ( $disabledoutputofmessages = 0 )

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

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

Parameters

int $disabledoutputofmessages Clear all messages stored into session without displaying them

Returns: void

See also: dol_htmloutput_mesg()

Definition at line 3483 of file html.lib.php.

References dol_htmloutput_mesg().

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

◆ dol_htmloutput_mesg()

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

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

Parameters

string	$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)

Returns: void

See also: dol_print_error(); dol_htmloutput_errors(); setEventMessages()

Definition at line 3632 of file html.lib.php.

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

◆ dol_print_error()

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

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

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

Parameters

DoliDB \| null	$db	Database handler
string \| string[]	$error	String or array of errors strings to show
string[] \| null	$errors	Array of errors

Returns: void

See also: dol_htmloutput_errors()

Definition at line 2552 of file html.lib.php.

References $conf, $db, dol_escape_htmltag(), dol_htmlentities(), dol_now(), dol_print_date(), dol_syslog(), getDolGlobalInt(), top_httphead(), and utf8_check().

◆ dol_print_error_email()

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

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

Parameters

string	$prefixcode	Prefix of public error code
string	$errormessage	Complete error message
string[]	$errormessages	Array of error messages
string	$morecss	More css
string	$email	Email

Returns: void

Definition at line 2704 of file html.lib.php.

References dol_now(), dol_print_date(), and getDolGlobalString().

◆ dol_set_focus()

dol_set_focus ( $selector )

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

Parameters

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.

Returns: void

Definition at line 4047 of file html.lib.php.

◆ dolButtonToOpenExportDialog()

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

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

Parameters

string	$name	Unique identifier for the dialog
string	$label	Title of the dialog
string	$buttonstring	Text for the button that opens the dialog
string	$exportSiteName	Name of the "submit" input for site export
string	$overwriteGitUrl	URL for the link that triggers the overwrite action in GIT
Website	$website	Website object

Returns: string HTML and JavaScript code for the button and the dialog

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

References $db, dol_escape_htmltag(), dol_escape_js(), getNonce(), and newToken().

◆ dolButtonToOpenUrlInDialogPopup()

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

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

Such buttons must be included inside a HTML form.

Parameters

string	$name	A name for the html component
string	$label	Label shown in Popup title top bar
string	$buttonstring	button string (HTML text we can click on)
string	$url	Relative Url to open. For example '/project/card.php'
string	$disabled	Disabled text
string	$morecss	More CSS
string	$jsonopen	Some JS code to execute on click/open of popup
string	$jsonclose	Some JS code to execute on close of popup Value is 'keyforpopupid:Name_of_html_component_to_set_with id,Name_of_html_component_to_set_with_label'
string	$accesskey	A key to use shortcut

Returns: string HTML component with button

Definition at line 415 of file html.lib.php.

References dol_escape_js().

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

◆ dolCompletUrlForDropdownButton()

dolCompletUrlForDropdownButton	(	string	$url,
		array	$params,
		bool	$addDolUrlRoot = true )

An function to complete dropdown url in dolGetButtonAction.

Parameters

string	$url	the Url to complete
	array<string,mixed>	$params params of dolGetButtonAction function
bool	$addDolUrlRoot	to add root url

Returns: string

Definition at line 4786 of file html.lib.php.

Referenced by dolGetButtonAction().

◆ dolGetBadge()

dolGetBadge	(	$label,
		$html = '',
		$type = 'primary',
		$mode = '',
		$url = '',
		$params = array() )

Function dolGetBadge.

Parameters

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
	''\|'pill'\|'dot'	$mode Default '' , 'pill', 'dot'
string	$url	the url for link
	array{attr?:array{class:string,title:string},css?:string}	$params Various params for future : recommended rather than adding more function arguments. array('attr'=>array('title'=>'abc'))

Returns: string Html badge

Definition at line 4243 of file html.lib.php.

Referenced by FormSetupItem\generateOutputFieldMultiSelect().

◆ dolGetButtonAction()

dolGetButtonAction	(	$label,
		$text = '',
		$actionType = 'default',
		$url = '',
		$id = '',
		$userRight = 1,
		$params = array() )

Function dolGetButtonAction.

Parameters

string	$label	Long label (or tooltip of button if param $text is provided). Also used as tooltip in title attribute. Can be escaped HTML content or full simple text. Used only if $url not defined.
string	$text	Optional : Short label on button. Can be escaped HTML content or full simple text.
string	$actionType	'default', 'edit', 'danger', 'email', 'clone', 'cancel', 'delete', ...
	string\|array<int,array{lang:string,enabled:bool,perm:bool\|int,label:string,text?:string,url:string,urlroot?:string,isDropDown?:int<0,1>}>	$url Url for link or array of subbutton description Example when an array is used: $arrayforbutaction = array( 10 => array('attr' => array('class'=>''), 'lang'=>'propal', 'enabled'=>isModEnabled("propal"), 'perm'=>$user->hasRight('propal', 'creer'), 'label' => 'AddProp', 'url'=>'/comm/propal/card.php?action=create&projectid='.$object->id.'&socid='.$object->socid), 20 => array('attr' => array('class'=>''), 'lang'=>'mymodule', 'enabled'=>isModEnabled("mymodule"), 'perm'=>$user->hasRight('mymodule', 'write'), 'label' => 'MyModuleAction', 'urlroot'=>dol_build_patch('/mymodule/mypage.php?action=create')), 30 => array('attr' => array('class'=>''), 'lang'=>'mymodule', 'enabled'=>isModEnabled("mymodule"), 'perm'=>$user->hasRight('mymodule', 'write'), 'label' => 'MyModuleOtherAction', 'urlraw' => '# \|\| external Url \|\| javascript: \|\| tel: \|\| mailto:' ), ); );
string	$id	Attribute id of action button. Example 'action-delete'. This can be used for full ajax confirm if this code is reused into the ->formconfirm() method.
bool \| int	$userRight	User action right. True or 1 of ok. Use 0 if user has no permission, it will add the message "No permission" on tooltip (if no other message explicitly provided). Use -1 to have button not allowed without adding the message (because an explicit label is already set). // phpcs:disable
	array{confirm?:array{url?:string,title?:string,content?:string,use_unsecured_unescapedattr?:bool\|string[],action-btn-label?:string,cancel-btn-label?:string,modal?:bool},attr?:array<string,mixed>,areDropdownButtons?:bool,backtopage?:string,lang?:string,enabled?:bool,perm?:int<0,1>,label?:string,url?:string,isDropdown?:int<0,1>,isDropDown?:int<0,1>}	$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://', // Override 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' => '', // Override title of modal, if empty default title use "ConfirmBtnCommonTitle" lang key 'action-btn-label' => '', // Override label of action button, if empty default label use "Confirm" lang key 'cancel-btn-label' => '', // Override label of cancel button, if empty default label use "CloseDialog" lang key 'content' => '', // Override text of content, if empty default content use "ConfirmBtnCommonContent" lang key 'modal' => true, // true\|false to display dialog as a modal (with dark background) 'isDropDown' => false, // true\|false to display dialog as a dropdown list (css dropdown-item with dark background) ], ] // phpcs:enable

Returns: string html button

Definition at line 4437 of file html.lib.php.

References $id, $object, dol_escape_htmltag(), dol_htmlentities(), dol_textishtml(), dolCompletUrlForDropdownButton(), dolGetButtonAction(), dolPrintHTMLForAttribute(), dolPrintHTMLForAttributeUrl(), newToken(), and setEventMessages().

Referenced by displayPositionCard(), and dolGetButtonAction().

◆ dolGetButtonTitle()

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.

Parameters

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<-2,2>	$status 0 no user rights, 1 active, 2 current action or selected, -1 Feature Disabled (deprecated, use -2 instead), -2 disable Other reason use param $helpText as tooltip help
	array<string,mixed>	$params various parameters for future : recommended rather than adding more function arguments

Returns: string html button

Definition at line 4855 of file html.lib.php.

References $id, dol_escape_htmltag(), and getDolGlobalString().

Referenced by FormFile\list_of_documents(), FormFile\listOfLinks(), show_contacts(), show_contacts_projects(), show_projects(), and FormActions\showactions().

◆ dolGetButtonTitleSeparator()

dolGetButtonTitleSeparator ( $moreClass = "" )

Add space between dolGetButtonTitle.

Parameters

string $moreClass more css class label

Returns: string html of title separator

Definition at line 4820 of file html.lib.php.

◆ dolGetStatus()

dolGetStatus	(	$statusLabel = '',
		$statusLabelShort = '',
		$html = '',
		$statusType = 'status0',
		$displayMode = 0,
		$url = '',
		$params = array() )

Output the badge of a status.

Parameters

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<0,6>	$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<string,mixed>	$params Various params. Example: array('tooltip'=>'no\|...', 'badgeParams'=>...)

Returns: string Html status string

Definition at line 4312 of file html.lib.php.

Referenced by getLibSignedStatus(), ExternalModules\libStatus(), Account\LibStatut(), AccountingAccount\LibStatut(), ActionComm\LibStatut(), ActionCommReminder\LibStatut(), Adherent\LibStatut(), AdherentType\LibStatut(), Asset\LibStatut(), AssetModel\LibStatut(), Availabilities\LibStatut(), BOM\LibStatut(), BonPrelevement\LibStatut(), Calendar\LibStatut(), CashControl\LibStatut(), ChargeSociales\LibStatut(), Commande\LibStatut(), CommandeFournisseur\LibStatut(), CommonInvoice\LibStatut(), CompanyPaymentMode\LibStatut(), ConferenceOrBoothAttendee\LibStatut(), Contact\LibStatut(), Contrat\LibStatut(), ContratLigne\LibStatut(), Cronjob\LibStatut(), CTicketCategory\LibStatut(), Delivery\LibStatut(), Don\LibStatut(), EmailCollector\LibStatut(), EmailSenderProfile\LibStatut(), Entrepot\LibStatut(), Establishment\LibStatut(), Evaluation\LibStatut(), Expedition\LibStatut(), ExpenseReport\LibStatut(), FactureFournisseurRec\LibStatut(), FactureRec\LibStatut(), Fichinter\LibStatut(), Fiscalyear\LibStatut(), Holiday\LibStatut(), Hook\LibStatut(), Inventory\LibStatut(), KnowledgeRecord\LibStatut(), Loan\LibStatut(), Mailing\LibStatut(), Mo\LibStatut(), MyObject\LibStatut(), Opensurveysondage\LibStatut(), Partnership\LibStatut(), Position\LibStatut(), Product\LibStatut(), ProductFournisseurPrice\LibStatut(), Project\LibStatut(), Propal\LibStatut(), Reception\LibStatut(), RecruitmentCandidature\LibStatut(), RecruitmentJobPosition\LibStatut(), RemiseCheque\LibStatut(), Salary\LibStatut(), Skilldet\LibStatut(), SkillRank\LibStatut(), Societe\LibStatut(), SocieteAccount\LibStatut(), StockTransfer\LibStatut(), StockTransferLine\LibStatut(), SupplierProposal\LibStatut(), Target\LibStatut(), Task\LibStatut(), Ticket\LibStatut(), TimeSpent\LibStatut(), TriggerHistory\LibStatut(), Tva\LibStatut(), User\LibStatut(), Website\LibStatut(), Workstation\LibStatut(), Mailing\libStatutDest(), and ConferenceOrBooth\LibStatutEvent().

◆ dolOutputDates()

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

Print decorated date-hour.

Parameters

int	$datep	Date
int \| null	$datef	Second date
int	$fullday	Set to 1 for full day (hours are hidden)
int	$addseconds	Add also seconds
string	$pictotoadd	Picto to add
string \| bool	$tzoutput	true or 'gmt' => string is for Greenwich location false or 'tzserver' => output string is for local PHP server TZ usage 'tzuser' => output string is for user TZ (current browser TZ with current dst) => In a future, we should have same behaviour than 'tzuserrel' 'tzuserrel' => output string is for user TZ (current browser TZ with dst or not, depending on date position)
int	$reduceformat	Use 1 to use a reduce format

Returns: string Decorated date

Definition at line 1158 of file html.lib.php.

References dol_getdate(), and dol_print_date().

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

◆ dolPrintHTML()

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

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

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

Parameters

int \| float \| string	$s	String to print
int	$allowiframe	Allow iframe tags
string[]	$moreallowedtags	Array of extra allowed tags (in addition to 'common' list)

Returns: string String ready for HTML output (sanitized and escape)

See also: dolPrintHTMLForAttribute(), dolPrintHTMLFortextArea(), dolPrintText()

Definition at line 73 of file html.lib.php.

References dol_escape_htmltag(), dol_htmlentitiesbr(), dol_htmlwithnojs(), and dol_string_onlythesehtmltags().

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

◆ dolPrintHTMLForAttribute()

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

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

Parameters

string	$s	String to print
int	$escapeonlyhtmltags	1=Escape only html tags, not the special chars like accents.
string[]	$allowothertags	List of other tags allowed

Returns: string String ready for HTML output

See also: dolPrintHTML(), dolPrintHTMLFortextArea()

Definition at line 99 of file html.lib.php.

References dol_escape_htmltag(), dol_htmlentitiesbr(), and dol_string_onlythesehtmltags().

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

◆ dolPrintHTMLForAttributeUrl()

dolPrintHTMLForAttributeUrl ( $s )

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

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

Parameters

string $s String to print

Returns: string String ready for HTML output

See also: dolPrintHTML(), dolPrintHTMLFortextArea()

Definition at line 122 of file html.lib.php.

References dol_escape_htmltag(), and dol_string_onlythesehtmltags().

Referenced by commonHtmlAttributeBuilder(), and dolGetButtonAction().

◆ dolPrintHTMLForTextArea()

dolPrintHTMLForTextArea	(		$s,
			$allowiframe = 0 )

Return a string ready to be output on input textarea.

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

Parameters

string	$s	String to print
int	$allowiframe	Allow iframe tags

Returns: string String ready for HTML output into a textarea

See also: dolPrintHTML(), dolPrintHTMLForAttribute()

Definition at line 139 of file html.lib.php.

References dol_escape_htmltag(), dol_htmlentitiesbr(), dol_htmlwithnojs(), and dol_string_onlythesehtmltags().

◆ dolPrintLabel()

dolPrintLabel	(		$s,
			$escapeonlyhtmltags = 0 )

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

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

Parameters

string	$s	String to print
int	$escapeonlyhtmltags	1=Escape only html tags, not the special chars like accents.

Returns: string String ready for HTML output

See also: dolPrintText()

Definition at line 44 of file html.lib.php.

References dol_escape_htmltag(), and dol_string_nohtmltag().

◆ dolPrintPassword()

dolPrintPassword ( $s )

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

Parameters

string $s String to print

Returns: string String ready for HTML output

Definition at line 150 of file html.lib.php.

◆ dolPrintText()

dolPrintText ( $s )

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

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

Parameters

string $s String to print

Returns: string String ready for HTML output

See also: dolPrintLabel(), dolPrintHTML()

Definition at line 57 of file html.lib.php.

References dol_escape_htmltag(), and dol_string_nohtmltag().

◆ fieldLabel()

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

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

Parameters

string	$langkey	Translation key
string	$fieldkey	Key of the html select field the text refers to
int	$fieldrequired	1=Field is mandatory

Returns: string

Deprecated: Form\editfieldkey

Definition at line 1126 of file html.lib.php.

◆ finishSimpleTable()

finishSimpleTable ( $addLineBreak = false )

Add the correct HTML close tags for "startSimpleTable(...)" (use after the last table line)

Parameters

bool $addLineBreak (optional) Add a extra line break after the complete table (<br>)

Returns: void

See also: startSimpleTable()

Definition at line 5014 of file html.lib.php.

◆ get_htmloutput_errors()

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

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

Parameters

string	$mesgstring	Error message
string[]	$mesgarray	Error messages array
int	$keepembedded	Set to 1 in error message must be kept embedded into its html place (this disable jnotify)

Returns: string Return html output

See also: dol_print_error(); dol_htmloutput_mesg()

Definition at line 3614 of file html.lib.php.

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

◆ get_htmloutput_mesg()

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

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

This include also the translation of the message key.

Parameters

string	$mesgstring	Message string or message key
string[]	$mesgarray	Array of message strings or message keys
string	$style	Style of message output ('ok', 'warning' or 'error')
int	$keepembedded	Set to 1 in error message must be kept embedded into its html place (this disable jnotify)

Returns: string Return html output

See also: dol_print_error(); dol_htmloutput_errors(); setEventMessages()

Definition at line 3523 of file html.lib.php.

References $conf, dol_escape_js(), getDolGlobalString(), getNonce(), and type.

Referenced by ActionsCardCommon\assign_values().

◆ getAdvancedPreviewUrl()

getAdvancedPreviewUrl	(	$modulepart,
		$relativepath,
		$alldata = 0,
		$param = '' )

Return URL we can use for advanced preview links.

Parameters

string	$modulepart	propal, facture, facture_fourn, ...
string	$relativepath	Relative path of docs.
	int<0,1>	$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

Returns: string|array{}|array{target:string,css:string,url:string,mime:string} Output string with href link or array with all components of link

Definition at line 4168 of file html.lib.php.

Referenced by FormFile\getDocumentsLink(), FormFile\list_of_documents(), CommonObject\show_photos(), Form\showphoto(), FormFile\showPreview(), and showWebsiteTemplates().

◆ getFieldErrorIcon()

getFieldErrorIcon ( $fieldValidationErrorMsg )

get field error icon

Parameters

string $fieldValidationErrorMsg Message to add in tooltip

Returns: string html output

Definition at line 4831 of file html.lib.php.

References dol_escape_htmltag().

◆ getImgPictoConv()

getImgPictoConv ( $mode = 'fa' )

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

Parameters

string $mode 'fa' to get conversion array for Font-Awesome

Returns: string[] Array of conversion

See also: img_picto()

Definition at line 1705 of file html.lib.php.

References $conf.

Referenced by img_picto().

◆ getListOfHtmlBooleanAttributes()

getListOfHtmlBooleanAttributes ( )

Returns a list of HTML boolean attributes.

Boolean attributes are attributes whose presence on an HTML element represents a true value, and absence represents false. They do not require a value like name="value"; simply including the attribute enables its behavior.

Examples of usage: <input type="checkbox" checked> <input type="text" readonly>

Returns: string[] An array of HTML boolean attribute names.

Definition at line 4737 of file html.lib.php.

Referenced by commonHtmlAttributeBuilder().

◆ getPictoForType()

getPictoForType	(		$key,
			$morecss = '' )

Return the picto for a data type.

Parameters

string	$key	Key
string	$morecss	Add more css to the object

Returns: string Picto for the key

Definition at line 1225 of file html.lib.php.

References img_picto().

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

◆ getTitleFieldOfList()

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

Get title line of an array.

Parameters

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

, 2=To use with

Parameters

string	$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 default)
string	$moreparam	Add more parameters on sort url links ("" by default)
string	$moreattrib	Add more attributes on th ("" by default). 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 '.
	int<0,1>	$disablesortlink 1=Disable sort link
?string	$tooltip	Text of tooltip with syntax 'Tooltip' or 'Tooltip:[keytoenabledtheonclicktooltip]:[tooltipdirection]'
	int<0,1>	$forcenowrapcolumntitle No need to use 'wrapcolumntitle' css style

Returns: string

Definition at line 2767 of file html.lib.php.

References dol_textishtml(), dolBuildUrl(), dolPrintHTMLForAttribute(), getDolGlobalString(), img_down(), img_up(), and string.

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

◆ img_action()

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

Show logo action.

Parameters

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)
string	$moreatt	More attributes

Returns: string Return an img tag

Definition at line 2011 of file html.lib.php.

References img_picto().

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

◆ img_allow()

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

Show tick logo if allowed.

Parameters

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.

Returns: string Return img tag

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

References img_picto().

◆ img_credit_card()

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

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

Parameters

string	$brand	Brand name of credit card
string	$morecss	More CSS

Returns: string Return img tag

Definition at line 2390 of file html.lib.php.

◆ img_delete()

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

Show delete logo.

Parameters

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

Returns: string Retourne tag img

Definition at line 2126 of file html.lib.php.

References img_picto().

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

◆ img_down()

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

Show down arrow logo.

Parameters

string	$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

Returns: string Return img tag

Definition at line 2293 of file html.lib.php.

References img_picto().

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

◆ img_edit()

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

Show logo edit/modify fiche.

Parameters

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

Returns: string Return tag img

Definition at line 2086 of file html.lib.php.

References img_picto().

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

◆ img_edit_add()

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

Show logo "+".

Parameters

string	$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

Returns: string Return tag img

Definition at line 2050 of file html.lib.php.

References img_picto().

◆ img_edit_remove()

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

Show logo "-".

Parameters

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

Returns: string Return tag img

Definition at line 2067 of file html.lib.php.

References img_picto().

◆ img_error()

img_error ( $titlealt = 'default' )

Show error logo.

Parameters

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.

Returns: string Return img tag

Definition at line 2236 of file html.lib.php.

References img_picto().

◆ img_help()

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

Show help logo with cursor "?".

Parameters

int	$usehelpcursor	1=Use help cursor, 2=Use click pointer cursor, 0=No specific cursor
int \| string	$usealttitle	Text to use as alt title

Returns: string Return tag img

Definition at line 2178 of file html.lib.php.

References dol_escape_htmltag(), and img_picto().

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

◆ img_info()

img_info ( $titlealt = 'default' )

Show info logo.

Parameters

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.

Returns: string Return img tag

Definition at line 2199 of file html.lib.php.

References img_picto().

◆ img_left()

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

Show left arrow logo.

Parameters

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"')

Returns: string Return img tag

Definition at line 2331 of file html.lib.php.

References img_picto().

◆ img_mime()

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

Show MIME img of a file.

Parameters

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

Returns: string Return img tag

Definition at line 2423 of file html.lib.php.

References dol_mimetype(), and dolPrintHTMLForAttribute().

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

◆ img_next()

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

Show next logo.

Parameters

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"')

Returns: string Return img tag

Definition at line 2254 of file html.lib.php.

References dol_escape_htmltag().

◆ img_object()

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

Show a picto called object_picto (generic function)

Parameters

string	$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.
string[]	$allowothertags	List of other tags allowed in title attribute

Returns: string Return img tag

See also: img_picto(), img_picto_common()

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

References img_picto().

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

◆ img_picto()

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

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

Parameters

string	$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', ...). For font awesome icon (example 'user'), you can use picto_nocolor to not have the color of picto forced. If no extension provided and it is not a font awesome icon, we use '.png'. Image must be stored into theme/xxx/img directory. Example: picto.png if picto.png is stored into htdocs/theme/mytheme/img Example: picto.png@mymodule if picto.png is stored into htdocs/mymodule/img Example: /mydir/mysubdir/picto.png if picto.png is stored into htdocs/mydir/mysubdir (pictoisfullpath must be set to 1) Example: fa-value if you want to use fontaweseome icons: fa-<icon-name> Example: fa-value_fas_color_1em if you want to use fontaweseome icons: fa-<icon-name>_<style>_<color>_<size> (only icon-name is mandatory, color can be 'red' or '#FF0000')
string	$moreatt	Add more attribute on img tag (For example 'class="pictofixedwidth"')
	int<0,1>	$pictoisfullpath If true or 1, image path is a full path, 0 if not
int	$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 blind people
string	$morecss	Add more class css on img tag (For example 'myclascss').
int	$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.
string[]	$allowothertags	List of other tags allowed in title and alt attribute

Returns: string Return img tag

See also: img_object(), img_picto_common()

Definition at line 1291 of file html.lib.php.

References $conf, dol_escape_htmltag(), dolPrintHTMLForAttribute(), getDolGlobalString(), and getImgPictoConv().

◆ img_picto_common()

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

Show picto (generic function)

Parameters

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.

Returns: string Return img tag

See also: img_object(), img_picto()

Definition at line 1973 of file html.lib.php.

References $conf, getDolGlobalInt(), and img_picto().

Referenced by tree_showpad().

◆ img_previous()

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

Show previous logo.

Parameters

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"')

Returns: string Return img tag

Definition at line 2273 of file html.lib.php.

References dol_escape_htmltag().

◆ img_printer()

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

Show printer logo.

Parameters

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

Returns: string Retourne tag img

Definition at line 2144 of file html.lib.php.

References img_picto().

◆ img_right()

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

Show right arrow logo.

Parameters

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"')

Returns: string Return img tag

Definition at line 2350 of file html.lib.php.

References img_picto().

◆ img_search()

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

Show search logo.

Parameters

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

Returns: string Retourne tag img

Definition at line 2447 of file html.lib.php.

References dol_escape_htmltag(), and img_picto().

◆ img_searchclear()

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

Show search logo.

Parameters

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

Returns: string Retourne tag img

Definition at line 2470 of file html.lib.php.

References dol_escape_htmltag(), and img_picto().

◆ img_split()

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

Show split logo.

Parameters

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

Returns: string Retourne tag img

Definition at line 2160 of file html.lib.php.

References img_picto().

◆ img_up()

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

Show top arrow logo.

Parameters

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

Returns: string Return img tag

Definition at line 2312 of file html.lib.php.

References img_picto().

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

◆ img_view()

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

Show logo view card.

Parameters

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

Returns: string Return tag img

Definition at line 2105 of file html.lib.php.

References img_picto().

◆ img_warning()

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

Show warning logo.

Parameters

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

Returns: string Return img tag

Definition at line 2218 of file html.lib.php.

References img_picto().

◆ img_weather()

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

Show weather picto.

Parameters

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

Returns: string Return img tag

See also: img_object(), img_picto()

Definition at line 1945 of file html.lib.php.

References $conf, and img_picto().

Referenced by showWeather().

◆ info_admin()

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

Show information in HTML for admin users or standard users.

Parameters

string	$text	Text info
integer	$infoonimgalt	Info is shown only on alt of star picto, otherwise it is shown on output after the star picto
int	$nodiv	No div
string \| int	$admin	'1'=Info for admin users. '0'=Info for standard users (change only the look), 'info', 'error', 'warning', 'xxx'=Other
string	$morecss	More CSS ('', 'warning', 'error')
string	$textfordropdown	Show a text to click to dropdown the info box.
string	$picto	'' or 'warning'
string	$textonpictotooltip	Text to show in tooltip on picto
string	$cssfordropdown	An additional css to avoid conflict to manage the dropdown if $textfordropdown is set

Returns: string String with info text

Definition at line 2500 of file html.lib.php.

References $conf, dol_escape_htmltag(), getNonce(), img_picto(), and string.

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

◆ load_fiche_titre()

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

Load a title with picto.

Parameters

string	$title	Title to show (HTML sanitized content). Can be a string with a as a second string shown under the fmain title.
string	$morehtmlright	Added message to show on right
string	$picto	Icon to use before title (should be a 32x32 transparent png file)
	int<0,1>	$pictoisfullpath 1=Icon name is a full absolute url of image
string	$id	To force an id on html objects
string	$morecssontable	More css on table
string	$morehtmlcenter	Added message to show on center
string	$morecssonpicto	More css on picto

Returns: string

See also: print_barre_liste()

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

References $id, dol_strlen(), and img_picto().

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

◆ picto_from_langcode()

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

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

Parameters

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<0,1>	$notitlealt No title alt

Returns: string HTML img string with flag.

Definition at line 3715 of file html.lib.php.

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

◆ print_barre_liste()

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

Print a title with navigation controls for pagination.

Parameters

string	$title	Title to show (required). Can be a string with a as a substring.
int \| null	$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 coming 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. Use a string to show a string.
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 \| string	$selectlimitsuffix	Suffix for limit ID or -1 to hide the select limit combo
int	$hidenavigation	Force to hide the arrows and page for navigation
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)

Returns: void

Definition at line 2980 of file html.lib.php.

References $conf, ajax_autoselect(), dolBuildUrl(), img_picto(), and print_fleche_navigation().

Referenced by report_header().

◆ print_fiche_titre()

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

Show a title with picto.

Parameters

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
string	$id	To force an id on html objects by example id="name" where name is id

Returns: void

Deprecated: Use print load_fiche_titre instead

Definition at line 2908 of file html.lib.php.

References $id, and load_fiche_titre().

◆ print_fleche_navigation()

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

Function to show navigation arrows into lists.

Parameters

int	$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 \| string	$selectlimitsuffix	A suffix for the limit ID, or -1 to hide the select of limit
string	$beforearrows	HTML content to show before arrows. Must NOT contains ' ' tags.
int	$hidenavigation	Force to hide the switch mode view and the navigation tool (hide limit section, html in $betweenarrows and $afterarrows but not $beforearrows)

Returns: void

Definition at line 3173 of file html.lib.php.

References $conf, ajax_combobox(), dol_escape_htmltag(), and getDolGlobalString().

Referenced by print_barre_liste().

◆ print_liste_field_titre()

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

Show title line of an array.

Parameters

?string	$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 default)
string	$param	Add more parameters on sort url links ("" by default)
string	$moreattrib	Options of attribute td ("" by default)
?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, for example 'mycss '.
?string	$tooltip	Tooltip
int	$forcenowrapcolumntitle	No need to use 'wrapcolumntitle' css style

Returns: void

Definition at line 2744 of file html.lib.php.

References getTitleFieldOfList().

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

◆ print_titre()

print_titre ( $title )

Show a title.

Parameters

string $title Title to show

Returns: void

Deprecated: Use load_fiche_titre instead

See also: load_fiche_titre()

Definition at line 2890 of file html.lib.php.

References dol_syslog().

◆ printCommonFooter()

printCommonFooter ( $zone = 'private' )

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

Parameters

string $zone 'private' (for private pages) or 'public' (for public pages)

Returns: void

Definition at line 3771 of file html.lib.php.

Referenced by llxFooterSurvey(), and llxFooterVierge().

◆ setEventMessage()

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

Set event message in dol_events session object.

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

Parameters

string \| string[]	$mesgs	Message string or array
	''\|'mesgs'\|'warnings'\|'errors'	$style Which style to use ('mesgs' by default, 'warnings', 'errors')
int	$noduplicate	1 means we do not add the message if already present in session stack
int	$attop	Add the message in the top of the stack (at bottom by default)

Returns: void

See also: dol_htmloutput_events()

Definition at line 3401 of file html.lib.php.

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

◆ setEventMessages()

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

Set event messages in dol_events session object.

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

Parameters

string \| null	$mesg	Message string
string[] \| null	$mesgs	Message array
	''\|'mesgs'\|'warnings'\|'errors'	$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 during this session again"
int	$noduplicate	1 means we do not add the message if already present in session stack
int	$attop	Add the message in the top of the stack (at bottom by default)

Returns: void

See also: dol_htmloutput_events()

Definition at line 3448 of file html.lib.php.

References dol_print_error(), dol_syslog(), getCallerInfoString(), and setEventMessage().

◆ show_actions_messaging()

show_actions_messaging	(		$conf,
			$langs,
			$db,
			$filterobj,
			$objcon = null,
			$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.

Parameters

Conf	$conf	Object conf
Translate	$langs	Object langs
DoliDB	$db	Object db
?CommonObject	$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<string,string>	$filters Filter on other fields
string	$sortfield	Sort field
string	$sortorder	Sort order

Returns: ?string Return html part or void if noprint is 1

Definition at line 5136 of file html.lib.php.

References $conf, $db, dol_buildpath(), dol_escape_htmltag(), dol_getdate(), dol_mimetype(), dol_now(), dol_print_date(), dol_print_error(), dol_print_phone(), dol_syslog(), dol_trunc(), dolCloseUnclosedHtmlTags(), dolGetElementUrl(), dolGetFirstLineOfText(), dolPrintHTML(), getActionCommEcmList(), getDolGlobalInt(), getDolGlobalString(), getEntity(), getTitleFieldOfList(), img_mime(), img_object(), img_picto(), img_warning(), info_admin(), isModEnabled(), natural_search(), newToken(), and setEventMessage().

◆ showDimensionInBestUnit()

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

Output a dimension with best unit.

Parameters

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<-1,max>	$round -1 = non rounding, x = number of decimal
string	$forceunitoutput	'no' or numeric (-3, -6, ...) compared to $unit (In most case, this value is value defined into $conf->global->MAIN_WEIGHT_DEFAULT_UNIT)
	int<0,1>	$use_short_label 1=Use short label ('g' instead of 'gram'). Short labels are not translated.

Returns: string String to show dimensions

Definition at line 3292 of file html.lib.php.

References measuringUnitString(), and price().

Referenced by pdf_eagle\_tableau_tot(), pdf_espadon\_tableau_tot(), pdf_rouget\_tableau_tot(), pdf_squille\_tableau_tot(), Form\constructProductListOption(), CommonDocGenerator\get_substitutionarray_shipment(), and Form\select_produits_fournisseurs_list().

◆ showDirectDownloadLink()

showDirectDownloadLink ( $object )

Return string with full Url.

The file qualified is the one defined by relative path in $object->last_main_doc

Parameters

CommonObject $object Object

Returns: string Url string

Definition at line 4139 of file html.lib.php.

◆ showSimpleHTMLTable()

showSimpleHTMLTable	(		$outputlangs,
			$object )

Returns simple order table template as string.

Parameters

Translate	$outputlangs	Output language
Object	$object	Object

Returns: string template

Definition at line 4062 of file html.lib.php.

◆ showTotalAmount()

showTotalAmount ( $amount )

Style total amount of an object.

Parameters

string | float $amount Amount value to format

Returns: string String to show amount with style of total

Definition at line 3275 of file html.lib.php.

◆ showValueWithClipboardCPButton()

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.

Parameters

string	$valuetocopy	The value to print
	int<0,1>	$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)

Returns: string The string to print for the button

Definition at line 5093 of file html.lib.php.

References dol_escape_htmltag(), dolPrintHTML(), and img_picto().

◆ startSimpleTable()

startSimpleTable	(	$header,
		$link = "",
		$arguments = "",
		$emptyColumns = 0,
		$number = -1,
		$pictofulllist = '' )

Start a table with headers and a optional clickable number (don't forget to use "finishSimpleTable()" after the last table row)

Parameters

string	$header	The first left header of the table (automatic translated)
string	$link	(optional) The link to a internal dolibarr page, where to go on clicking on the number or the ... (without the first "/")
string	$arguments	(optional) Additional arguments for the link (e.g. "search_status=0")
integer	$emptyColumns	(optional) Number of empty columns to add after the first column
integer	$number	(optional) The number that is shown right after the first header, when -1 the link is shown as '...'
string	$pictofulllist	(optional) The picto to use for the full list link

Returns: void

See also: finishSimpleTable()

Definition at line 4966 of file html.lib.php.

◆ yn()

yn	(	$yesno,
		$format = 1,
		$color = 0 )

Return yes or no in current language.

Parameters

	boolean\|int<0,1>\|'yes'\|'true'\|'no'\|'false'	$yesno Value to test (true, 1, 'yes', 'true' or false, 0, 'no', 'false')
integer \| string	$format	1=Yes/No, 0=yes/no, 2=Disabled/enabled checkbox, 3=Disabled/enabled checkbox + Yes/No, 4 or Text=Use picto
int	$color	0=texte only, 1=Text is formatted with a color font style ('ok' or 'error'), 2=Text is formatted with 'ok' color.

Returns: string HTML string

Definition at line 3339 of file html.lib.php.

References img_picto().

Referenced by ActionsCardCommon\assign_values(), AdherentType\getKanbanView(), CommandeFournisseur\getKanbanView(), getResultColumn(), ModeleNumRefBarCode\getToolTip(), ModeleNumRefMembers\getToolTip(), ModeleProductCode\getToolTip(), ModeleThirdPartyCode\getToolTip(), ActionComm\getTooltipContentArray(), AdherentType\getTooltipContentArray(), Product\getTooltipContentArray(), User\getTooltipContentArray(), mod_codecompta_aquarium\info(), mod_codecompta_digitaria\info(), Adherent\makeSubstitution(), BooleanField\printOutputField(), ExtraFields\showOutputField(), showSkins(), and top_menu_user().