admin.lib.php File Reference

Library of admin functions. More...

Go to the source code of this file.

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=0, $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 informations.
	email_admin_prepare_head ()
	Return array head with list of tabs to view object informations.

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 array('nbmodules'=>nb modules activated with success, 'errors=>array of error messages, 'nbperms'=>Nb permission added);

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

References 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 1494 of file admin.lib.php.

References 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 1919 of file admin.lib.php.

References dol_print_error(), and dol_syslog().

company_admin_prepare_head()

company_admin_prepare_head

(

)

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

Returns

array head array with tabs

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

References 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

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

Returns

int 1

Definition at line 1325 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

$elementList

elementList

Returns

int 1

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

References 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 of tabs to show

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

References 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 1950 of file admin.lib.php.

References dol_print_error(), and dol_syslog().

dolibarr_del_const()

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

Delete a constant.

Parameters

DoliDB	$db	Database handler
string | int	$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 563 of file admin.lib.php.

References 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 603 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
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 639 of file admin.lib.php.

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

Referenced by modGeneratePassPerso\__construct(), BlockedLog\getSignature(), 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 informations.

Returns

array head array with tabs

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

References complete_head_from_modules().

form_constantes()

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

Show array with constants to edit.

Parameters

array	$tableau	Array of constants array('key'=>array('type'=>type, 'label'=>label) where type can be 'string', 'text', 'textarea', 'html', 'yesno', 'emailtemplate:xxx', ...
int	$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)
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 1663 of file admin.lib.php.

References 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 of tabs to show

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

References complete_head_from_modules().

listOfSessions()

listOfSessions

(

)

Return list of session.

Returns

array Array list of sessions

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

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

modulehelp_prepare_head()

modulehelp_prepare_head

(

$object

)

Prepare array with list of tabs.

Parameters

object

$object

Descriptor class

Returns

array Array of tabs to show

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

References 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 of tabs to show

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

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

phpinfo_array()

phpinfo_array

(

)

Return the php_info into an array.

Returns

array Array with PHP infos

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

purgeSessions()

purgeSessions

(

$mysessionid

)

Purge existing sessions.

Parameters

int

$mysessionid

To avoid to try to delete my own session

Returns

int >0 if OK, <0 if KO

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

References 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 resquests 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 169 of file admin.lib.php.

References dol_htmlentities(), dol_syslog(), and versioncompare().

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

security_prepare_head()

security_prepare_head

(

)

Prepare array with list of tabs.

Returns

array Array of tabs to show

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

References dol_print_error(), and getDolGlobalString().

showModulesExludedForExternal()

showModulesExludedForExternal

(

$modules

)

Show array with constants to edit.

Parameters

array

$modules

Array of all modules

Returns

string HTML string with warning

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

References dol_sort_array(), and getDolGlobalString().

translation_prepare_head()

translation_prepare_head

(

)

Prepare array with list of tabs.

Returns

array Array of tabs to show

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

References 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 1249 of file admin.lib.php.

References 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	$versionarray1	Array of version (vermajor,verminor,patch)
array	$versionarray2	Array of version (vermajor,verminor,patch)

Returns

int -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 67 of file admin.lib.php.

Referenced by activateModule(), migrate_restore_missing_links(), and run_sql().

versiondolibarrarray()

versiondolibarrarray

(

)

Return version Dolibarr.

Returns

array Tableau de version (vermajeur,vermineur,autre)

See also

versioncompare()

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

Referenced by activateModule().

versionphparray()

versionphparray

(

)

Return version PHP.

Returns

array Tableau de version (vermajeur,vermineur,autre)

See also

versioncompare()

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

Referenced by activateModule().

versiontostring()

versiontostring

(

$versionarray

)

Renvoi une version en chaine depuis une version en tableau.

Parameters

array

$versionarray

Tableau de version (vermajeur,vermineur,autre)

Returns

string Chaine version

See also

versioncompare()

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

Referenced by activateModule().