inc.php File Reference

File that define environment for support pages. More...

Go to the source code of this file.

Functions
	conf ($dolibarr_main_document_root)
	Load conf file (file must exists) More...
	pHeader ($subtitle, $next, $action= 'set', $param= '', $forcejqueryurl= '', $csstable= 'main-inside')
	Show HTML header of install pages. More...
	pFooter ($nonext=0, $setuplang= '', $jscheckfunction= '', $withpleasewait=0, $morehtml= '')
	Print HTML footer of install pages. More...
	dolibarr_install_syslog ($message, $level=LOG_DEBUG)
	Log function for install pages. More...
	detect_dolibarr_main_document_root ()
	Automatically detect Dolibarr's main document root. More...
	detect_dolibarr_main_data_root ($dolibarr_main_document_root)
	Automatically detect Dolibarr's main data root. More...
	detect_dolibarr_main_url_root ()
	Automatically detect Dolibarr's main URL root. More...
	parse_database_login ($force_install_databaserootlogin)
	Replaces automatic database login by actual value. More...
	parse_database_pass ($force_install_databaserootpass)
	Replaces automatic database password by actual value. More...

Detailed Description

File that define environment for support pages.

Definition in file inc.php.

Function Documentation

conf

(

$dolibarr_main_document_root

)

Load conf file (file must exists)

Parameters

string

$dolibarr_main_document_root

Root directory of Dolibarr bin files

Returns

int <0 if KO, >0 if OK

Definition at line 300 of file inc.php.

Referenced by modGeneratePassNone\__construct(), modGeneratePassStandard\__construct(), modGeneratePassPerso\__construct(), printing_printgcp\__construct(), printing_printipp\__construct(), User\__construct(), encodedecode_dbpassconf(), User\fetch(), printing_printgcp\getlistAvailablePrinters(), printing_printgcp\listJobs(), User\send_password(), and printing_printgcp\sendPrintToPrinter().

detect_dolibarr_main_data_root

(

$dolibarr_main_document_root

)

Automatically detect Dolibarr's main data root.

Parameters

string

$dolibarr_main_document_root

Current main document root

Returns

string

Definition at line 596 of file inc.php.

detect_dolibarr_main_document_root

(

)

Automatically detect Dolibarr's main document root.

Returns

string

Definition at line 572 of file inc.php.

detect_dolibarr_main_url_root

(

)

Automatically detect Dolibarr's main URL root.

Returns

string

Definition at line 608 of file inc.php.

dolibarr_install_syslog	(		$message,
			$level = LOG_DEBUG
	)

Log function for install pages.

Parameters

string	$message	Message
int	$level	Level of log

Returns

void

Definition at line 559 of file inc.php.

References dol_syslog().

Referenced by migrate_actioncomm_element(), migrate_categorie_association(), migrate_clean_association(), migrate_commande_deliveryaddress(), migrate_commande_expedition(), migrate_commande_livraison(), migrate_contracts_date1(), migrate_contracts_date2(), migrate_contracts_date3(), migrate_contracts_det(), migrate_contracts_open(), migrate_customerorder_shipping(), migrate_delete_old_dir(), migrate_delete_old_files(), migrate_detail_livraison(), migrate_event_assignement(), migrate_event_assignement_contact(), migrate_links_transfert(), migrate_menus(), migrate_mode_reglement(), migrate_modeles(), migrate_paiementfourn_facturefourn(), migrate_paiements(), migrate_paiements_orphelins_1(), migrate_paiements_orphelins_2(), migrate_price_commande(), migrate_price_commande_fournisseur(), migrate_price_contrat(), migrate_price_facture(), migrate_price_propal(), migrate_project_task_actors(), migrate_project_task_time(), migrate_project_user_resp(), migrate_relationship_tables(), migrate_reload_menu(), migrate_reload_modules(), migrate_remise_entity(), migrate_remise_except_entity(), migrate_rename_directories(), migrate_reset_blocked_log(), migrate_restore_missing_links(), migrate_shipping_delivery(), migrate_shipping_delivery2(), migrate_stocks(), migrate_user_rights_entity(), and migrate_usergroup_rights_entity().

parse_database_login

(

$force_install_databaserootlogin

)

Replaces automatic database login by actual value.

Parameters

string

$force_install_databaserootlogin

Login

Returns

string

Definition at line 641 of file inc.php.

parse_database_pass

(

$force_install_databaserootpass

)

Replaces automatic database password by actual value.

Parameters

string

$force_install_databaserootpass

Password

Returns

string

Definition at line 652 of file inc.php.

pFooter	(		$nonext = 0,
			$setuplang = '',
			$jscheckfunction = '',
			$withpleasewait = 0,
			$morehtml = ''
	)

Print HTML footer of install pages.

Parameters

integer	$nonext	1=No button "Next step", 2=Show button but disabled with a link to enable
string	$setuplang	Language code
string	$jscheckfunction	Add a javascript check function
integer	$withpleasewait	Add also please wait tags
string	$morehtml	Add more HTML content

Returns

void

Definition at line 498 of file inc.php.

pHeader	(		$subtitle,
			$next,
			$action = 'set',
			$param = '',
			$forcejqueryurl = '',
			$csstable = 'main-inside'
	)

Show HTML header of install pages.

Parameters

string	$subtitle	Title
string	$next	Next
string	$action	Action code ('set' or 'upgrade')
string	$param	Param
string	$forcejqueryurl	Set jquery relative URL (must end with / if defined)
string	$csstable	Css for table

Returns

void

Definition at line 409 of file inc.php.