Library of admin functions. More...

Functions
	versiontostring ($versionarray)
	Renvoi une version en chaine depuis une version en tableau.

	versioncompare ($versionarray1, $versionarray2)
	Compare 2 versions (stored into 2 arrays).

	versionphparray ()
	Return version PHP.

	versiondolibarrarray ()
	Return version Dolibarr.

	run_sql ($sqlfile, $silent=1, $entity=0, $usesavepoint=1, $handler='', $okerror='default', $linelengthlimit=32768, $nocommentremoval=0, $offsetforchartofaccount=0, $colspan=0, $onlysqltoimportwebsite=0, $database='')
	Launch a sql file.

	dolibarr_del_const ($db, $name, $entity=1)
	Delete a constant.

	dolibarr_get_const ($db, $name, $entity=1)
	Get the value of a setup constant from database.

	dolibarr_set_const ($db, $name, $value, $type='chaine', $visible=0, $note='', $entity=1)
	Insert a parameter (key,value) into database (delete old key then insert it again).

	modules_prepare_head ($nbofactivatedmodules, $nboftotalmodules, $nbmodulesnotautoenabled)
	Prepare array with list of tabs.

	ihm_prepare_head ()
	Prepare array with list of tabs.

	security_prepare_head ()
	Prepare array with list of tabs.

	modulehelp_prepare_head ($object)
	Prepare array with list of tabs.

	translation_prepare_head ()
	Prepare array with list of tabs.

	defaultvalues_prepare_head ()
	Prepare array with list of tabs.

	listOfSessions ()
	Return list of session.

	purgeSessions ($mysessionid)
	Purge existing sessions.

	activateModule ($value, $withdeps=1, $noconfverification=0)
	Enable a module.

	unActivateModule ($value, $requiredby=1)
	Disable a module.

	complete_dictionary_with_modules (&$taborder, &$tabname, &$tablib, &$tabsql, &$tabsqlsort, &$tabfield, &$tabfieldvalue, &$tabfieldinsert, &$tabrowid, &$tabcond, &$tabhelp, &$tabcomplete)
	Add external modules to list of dictionaries.

	activateModulesRequiredByCountry ($country_code)
	Activate external modules mandatory when country is country_code.

	complete_elementList_with_modules (&$elementList)
	Search external modules to complete the list of contact element.

	form_constantes ($tableau, $strictw3c=2, $helptext='', $text='Value')
	Show array with constants to edit.

	showModulesExludedForExternal ($modules)
	Show array with constants to edit.

	addDocumentModel ($name, $type, $label='', $description='')
	Add document model used by doc generator.

	delDocumentModel ($name, $type)
	Delete document model used by doc generator.

	phpinfo_array ()
	Return the php_info into an array.

	company_admin_prepare_head ()
	Return array head with list of tabs to view object information.

	email_admin_prepare_head ()
	Return array head with list of tabs to view object information.

Detailed Description

Library of admin functions.

Definition in file admin.lib.php.

Function Documentation

◆ activateModule()

activateModule	(	$value,
		$withdeps = 1,
		$noconfverification = 0 )

Enable a module.

Parameters

string	$value	Name of module to activate
int	$withdeps	Activate/Disable also all dependencies
int	$noconfverification	Remove verification of $conf variable for module

Returns: array{nbmodules?:int,errors:string[],nbperms?:int} array('nbmodules'=>nb modules activated with success, 'errors=>array of error messages, 'nbperms'=>Nb permission added);

Definition at line 1165 of file admin.lib.php.

References $conf, activateModule(), dol_syslog(), dolGetModulesDirs(), getDolGlobalString(), unActivateModule(), versioncompare(), versiondolibarrarray(), versionphparray(), and versiontostring().

Referenced by activateModule(), and activateModulesRequiredByCountry().

◆ activateModulesRequiredByCountry()

activateModulesRequiredByCountry ( $country_code )

Activate external modules mandatory when country is country_code.

Parameters

string $country_code CountryCode

Returns: int 1

Definition at line 1560 of file admin.lib.php.

References $conf, activateModule(), dol_osencode(), dol_strlen(), dol_syslog(), dolGetModulesDirs(), getDolGlobalInt(), getDolGlobalString(), and setEventMessages().

◆ addDocumentModel()

addDocumentModel	(	$name,
		$type,
		$label = '',
		$description = '' )

Add document model used by doc generator.

Parameters

string	$name	Model name
string	$type	Model type
string	$label	Model label
string	$description	Model description

Returns: int Return integer <0 if KO, >0 if OK

Definition at line 1992 of file admin.lib.php.

References $conf, dol_print_error(), and dol_syslog().

◆ company_admin_prepare_head()

company_admin_prepare_head ( )

Return array head with list of tabs to view object information.

Returns: array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 2081 of file admin.lib.php.

References $conf, and complete_head_from_modules().

◆ complete_dictionary_with_modules()

complete_dictionary_with_modules	(	&	$taborder,
		&	$tabname,
		&	$tablib,
		&	$tabsql,
		&	$tabsqlsort,
		&	$tabfield,
		&	$tabfieldvalue,
		&	$tabfieldinsert,
		&	$tabrowid,
		&	$tabcond,
		&	$tabhelp,
		&	$tabcomplete )

Add external modules to list of dictionaries.

Addition is done into var $taborder, $tabname, etc... that are passed with pointers.

Parameters

int[]	$taborder	Taborder
string[]	$tabname	Tabname
string[]	$tablib	Tablib
string[]	$tabsql	Tabsql
string[]	$tabsqlsort	Tabsqlsort
string[]	$tabfield	Tabfield
string[]	$tabfieldvalue	Tabfieldvalue
string[]	$tabfieldinsert	Tabfieldinsert
string[]	$tabrowid	Tabrowid
bool[]	$tabcond	Tabcond
	array<array<string,string>>	$tabhelp Tabhelp
	array<string,array<string,array<string,string>>>	$tabcomplete Tab complete (will replace all other in future). Key is table name.

Returns: int 1

Definition at line 1386 of file admin.lib.php.

References dol_osencode(), dol_strlen(), dol_syslog(), dolGetModulesDirs(), getDolGlobalInt(), and getDolGlobalString().

◆ complete_elementList_with_modules()

complete_elementList_with_modules ( & $elementList )

Search external modules to complete the list of contact element.

Parameters

array<string,string> $elementList elementList

Returns: int 1

Definition at line 1623 of file admin.lib.php.

References $conf, dol_osencode(), dol_strlen(), dol_syslog(), dolGetModulesDirs(), getDolGlobalInt(), and getDolGlobalString().

◆ defaultvalues_prepare_head()

defaultvalues_prepare_head ( )

Prepare array with list of tabs.

Returns: array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 1004 of file admin.lib.php.

References $conf, and complete_head_from_modules().

◆ delDocumentModel()

delDocumentModel	(		$name,
			$type )

Delete document model used by doc generator.

Parameters

string	$name	Model name
string	$type	Model type

Returns: int Return integer <0 if KO, >0 if OK

Definition at line 2023 of file admin.lib.php.

References $conf, dol_print_error(), and dol_syslog().

◆ dolibarr_del_const()

dolibarr_del_const	(	$db,
		$name,
		$entity = 1 )

Delete a constant.

Parameters

DoliDB	$db	Database handler
int \| string	$name	Name of constant or rowid of line
int	$entity	Multi company id, -1 for all entities

Returns: int Return integer <0 if KO, >0 if OK

See also: dolibarr_get_const(), dolibarr_set_const(), dol_set_user_param()

Definition at line 581 of file admin.lib.php.

References $conf, dol_print_error(), and dol_syslog().

◆ dolibarr_get_const()

dolibarr_get_const	(	$db,
		$name,
		$entity = 1 )

Get the value of a setup constant from database.

Parameters

DoliDB	$db	Database handler
string	$name	Name of constant
int	$entity	Multi company id

Returns: string Value of constant

See also: dolibarr_del_const(), dolibarr_set_const(), dol_set_user_param()

Definition at line 635 of file admin.lib.php.

References dol_syslog(), and dolDecrypt().

◆ dolibarr_set_const()

dolibarr_set_const	(	$db,
		$name,
		$value,
		$type = 'chaine',
		$visible = 0,
		$note = '',
		$entity = 1 )

Insert a parameter (key,value) into database (delete old key then insert it again).

Parameters

DoliDB	$db	Database handler
string	$name	Name of constant
int \| string	$value	Value of constant
string	$type	Type of constant. Deprecated, only strings are allowed for $value. Caller must json encode/decode to store other type of data.
int	$visible	Is constant visible in Setup->Other page (0 by default)
string	$note	Note on parameter
int	$entity	Multi company id (0 means all entities)

Returns: int -1 if KO, 1 if OK

See also: dolibarr_del_const(), dolibarr_get_const(), dol_set_user_param()

Definition at line 671 of file admin.lib.php.

References $conf, dol_print_error(), dol_syslog(), and dolEncrypt().

Referenced by modGeneratePassPerso\__construct(), BlockedLog\getSignature(), mod_codeclient_elephant\info(), modEventOrganization\init(), modProductBatch\init(), modTakePos\init(), FormSetupItem\saveConfValue(), and top_htmlhead().

◆ email_admin_prepare_head()

email_admin_prepare_head ( )

Return array head with list of tabs to view object information.

Returns: array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 2120 of file admin.lib.php.

References $conf, complete_head_from_modules(), and getDolGlobalString().

◆ form_constantes()

form_constantes	(	$tableau,
		$strictw3c = 2,
		$helptext = '',
		$text = 'Value' )

Show array with constants to edit.

Parameters

	array<string,array{type:string,label:string}>\|array<int,string>	$tableau Array of constants array('key'=>array('type'=>type, 'label'=>label) where type can be 'string', 'text', 'textarea', 'html', 'yesno', 'emailtemplate:xxx', ...
	int<2,3>	$strictw3c 0=Include form into table (deprecated), 1=Form is outside table to respect W3C (deprecated), 2=No form nor button at all, 3=No form nor button at all and each field has a unique name (form is output by caller, recommended) (typed as int<2,3> to highlight the deprecated values)
string	$helptext	Tooltip help to use for the column name of values
string	$text	Text to use for the column name of values

Returns: void

Definition at line 1730 of file admin.lib.php.

References $conf, dol_escape_htmltag(), dol_syslog(), img_down(), and img_picto().

◆ ihm_prepare_head()

ihm_prepare_head ( )

Prepare array with list of tabs.

Returns: array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 808 of file admin.lib.php.

References $conf, and complete_head_from_modules().

◆ listOfSessions()

listOfSessions ( )

Return list of session.

Returns: array<string,array{login:string,age:int,creation:int,modification:int,raw:string}> Array list of sessions

Definition at line 1056 of file admin.lib.php.

References $conf, dol_osencode(), dol_syslog(), and getDolGlobalString().

◆ modulehelp_prepare_head()

modulehelp_prepare_head ( $object )

Prepare array with list of tabs.

Parameters

DolibarrModules $object Descriptor class

Returns: array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 936 of file admin.lib.php.

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

◆ modules_prepare_head()

modules_prepare_head	(	$nbofactivatedmodules,
		$nboftotalmodules,
		$nbmodulesnotautoenabled )

Prepare array with list of tabs.

Parameters

int	$nbofactivatedmodules	Number if activated modules
int	$nboftotalmodules	Nb of total modules
int	$nbmodulesnotautoenabled	Nb of modules not auto enabled that are activated

Returns: array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 763 of file admin.lib.php.

References getDolGlobalInt(), getDolGlobalString(), and img_picto().

◆ phpinfo_array()

phpinfo_array ( )

Return the php_info into an array.

Returns: array<string,array<string,string|array{local:string,master:string}>> Array with PHP info

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

◆ purgeSessions()

purgeSessions ( $mysessionid )

Purge existing sessions.

Parameters

string $mysessionid To avoid to try to delete my own session

Returns: int >0 if OK, <0 if KO

Definition at line 1112 of file admin.lib.php.

References $conf, dol_osencode(), dol_syslog(), and getDolGlobalString().

◆ run_sql()

run_sql	(	$sqlfile,
		$silent = 1,
		$entity = 0,
		$usesavepoint = 1,
		$handler = '',
		$okerror = 'default',
		$linelengthlimit = 32768,
		$nocommentremoval = 0,
		$offsetforchartofaccount = 0,
		$colspan = 0,
		$onlysqltoimportwebsite = 0,
		$database = '' )

Launch a sql file.

Function is used by:

Migrate process (dolibarr-xyz-abc.sql)
Loading sql menus (auguria)
Running specific Sql by a module init
Loading sql file of website import package Install process however does not use it. Note that Sql files must have all comments at start of line. Also this function take ';' as the char to detect end of sql request

Parameters

string	$sqlfile	Full path to sql file
int	$silent	1=Do not output anything, 0=Output line for update page
int	$entity	Entity targeted for multicompany module
int	$usesavepoint	1=Run a savepoint before each request and a rollback to savepoint if error (this allow to have some request with errors inside global transactions).
string	$handler	Handler targeted for menu (replace HANDLER with this value between quotes)
string	$okerror	Family of errors we accept ('default', 'none')
int	$linelengthlimit	Limit for length of each line (Use 0 if unknown, may be faster if defined)
int	$nocommentremoval	Do no try to remove comments (in such a case, we consider that each line is a request, so use also $linelengthlimit=0)
int	$offsetforchartofaccount	Offset to use to load chart of account table to update sql on the fly to add offset to rowid and account_parent value
int	$colspan	2=Add a colspan=2 on td
int	$onlysqltoimportwebsite	Only sql requests used to import a website template are allowed
string	$database	Database (replace DATABASE with this value)

Returns: int Return integer <=0 if KO, >0 if OK

Definition at line 171 of file admin.lib.php.

References $conf, checkPHPCode(), dol_htmlentities(), dol_syslog(), dolKeepOnlyPhpCode(), and versioncompare().

Referenced by DolibarrModules\_load_tables(), and migrate_reload_menu().

◆ security_prepare_head()

security_prepare_head ( )

Prepare array with list of tabs.

Returns: array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 853 of file admin.lib.php.

References $conf, dol_print_error(), and getDolGlobalString().

◆ showModulesExludedForExternal()

showModulesExludedForExternal ( $modules )

Show array with constants to edit.

Parameters

DolibarrModules[] $modules Array of all modules

Returns: string HTML string with warning

Definition at line 1942 of file admin.lib.php.

References $conf, dol_sort_array(), and getDolGlobalString().

◆ translation_prepare_head()

translation_prepare_head ( )

Prepare array with list of tabs.

Returns: array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 974 of file admin.lib.php.

References $conf, and complete_head_from_modules().

◆ unActivateModule()

unActivateModule	(		$value,
			$requiredby = 1 )

Disable a module.

Parameters

string	$value	Nom du module a desactiver
int	$requiredby	1=Desactive aussi modules dependants

Returns: string Error message or '';

Definition at line 1309 of file admin.lib.php.

References $conf, dol_syslog(), dolGetModulesDirs(), and unActivateModule().

Referenced by activateModule(), and unActivateModule().

◆ versioncompare()

versioncompare	(		$versionarray1,
			$versionarray2 )

Compare 2 versions (stored into 2 arrays).

To check if Dolibarr version is lower than (x,y,z), do "if versioncompare(versiondolibarrarray(), array(x.y.z)) <= 0" For example: if (versioncompare(versiondolibarrarray(),array(4,0,-5)) >= 0) is true if version is 4.0 alpha or higher. For example: if (versioncompare(versiondolibarrarray(),array(4,0,0)) >= 0) is true if version is 4.0 final or higher. For example: if (versioncompare(versiondolibarrarray(),array(4,0,1)) >= 0) is true if version is 4.0.1 or higher. Alternative way to compare: if ((float) DOL_VERSION >= 4.0) is true if version is 4.0 alpha or higher (works only to compare first and second level)

Parameters

array<int\|string>	$versionarray1 Array of version (vermajor,verminor,patch)
array<int\|string>	$versionarray2 Array of version (vermajor,verminor,patch)

Returns: int<-4,4> -4,-3,-2,-1 if versionarray1<versionarray2 (value depends on level of difference) 0 if same 1,2,3,4 if versionarray1>versionarray2 (value depends on level of difference)

See also: versiontostring()

Definition at line 69 of file admin.lib.php.

Referenced by ImportCsv\__construct(), ImportXlsx\__construct(), activateModule(), migrate_restore_missing_links(), and run_sql().

◆ versiondolibarrarray()

versiondolibarrarray ( )

Return version Dolibarr.

Returns: array<int<0,2>,string> Tableau de version (vermajeur,vermineur,autre)

See also: versioncompare()

Definition at line 142 of file admin.lib.php.

Referenced by activateModule().

◆ versionphparray()

versionphparray ( )

Return version PHP.

Returns: array<int<0,2>,string> Tableau de version (vermajeur,vermineur,autre)

See also: versioncompare()

Definition at line 131 of file admin.lib.php.

Referenced by ImportCsv\__construct(), ImportXlsx\__construct(), and activateModule().

◆ versiontostring()

versiontostring ( $versionarray )

Renvoi une version en chaine depuis une version en tableau.

Parameters

array<int<0,2>,int|string> $versionarray Tableau de version (vermajeur,vermineur,autre)

Returns: string Chaine version

See also: versioncompare()

Definition at line 39 of file admin.lib.php.

Referenced by activateModule().

Functions

Detailed Description

Function Documentation

◆ activateModule()

◆ activateModulesRequiredByCountry()

◆ addDocumentModel()

◆ company_admin_prepare_head()

◆ complete_dictionary_with_modules()

◆ complete_elementList_with_modules()

◆ defaultvalues_prepare_head()

◆ delDocumentModel()

◆ dolibarr_del_const()

◆ dolibarr_get_const()

◆ dolibarr_set_const()

◆ email_admin_prepare_head()

◆ form_constantes()

◆ ihm_prepare_head()

◆ listOfSessions()

◆ modulehelp_prepare_head()

◆ modules_prepare_head()

◆ phpinfo_array()

◆ purgeSessions()

◆ run_sql()

◆ security_prepare_head()

◆ showModulesExludedForExternal()

◆ translation_prepare_head()

◆ unActivateModule()

◆ versioncompare()

◆ versiondolibarrarray()

◆ versionphparray()

◆ versiontostring()