User Class Reference

Class to manage Dolibarr users. More...

Inheritance diagram for User:

Collaboration diagram for User:

Public Member Functions
	__construct ($db)
	Constructor of the class.
	fetch ($id=0, $login='', $sid='', $loadpersonalconf=0, $entity=-1, $email='', $fk_socpeople=0, $use_email_oauth2=0)
	Load a user from database with its id or ref (login).
	loadPersonalConf ()
	Load const values from database table user_param and set it into user->conf->XXX.
	loadDefaultValues ()
	Load default values from database table into property ->default_values.
	hasRight ($module, $permlevel1, $permlevel2='')
	Return if a user has a permission.
	addrights ($rid, $allmodule='', $allperms='', $entity=0, $notrigger=0)
	Add a right to the user.
	delrights ($rid, $allmodule='', $allperms='', $entity=0, $notrigger=0)
	Remove a right to the user.
	clearrights ()
	Clear all permissions array of user.
	loadRights ($moduletag='', $forcereload=0)
	Load permissions granted to a user->id into object user->rights.
	getrights ($moduletag='', $forcereload=0)
	Load permissions granted to a user->id into object user->rights TODO Remove this method.
	setstatus ($status)
	Change status of a user.
	setCategories ($categories)
	Sets object to supplied categories.
	delete (User $user)
	Delete the user.
	create ($user, $notrigger=0)
	Create a user into database.
	create_from_contact ($contact, $login='', $password='')
	Create a user from a contact object.
	create_from_member ($member, $login='')
	Create a user into database from a member object.
	set_default_rights ()
	Assign rights by default.
	update ($user, $notrigger=0, $nosyncmember=0, $nosyncmemberpass=0, $nosynccontact=0)
	Update a user into database (and also password if this->pass is defined)
	update_last_login_date ()
	Update the user's last login date in the database.
	setPassword ($user, $password='', $changelater=0, $notrigger=0, $nosyncmember=0, $passwordalreadycrypted=0, $flagdelsessionsbefore=1)
	Change password of a user.
	send_password ($user, $password='', $changelater=0)
	Send a new password (or instructions to reset it) by email.
	error ()
	Renvoie la derniere erreur fonctionnelle de manipulation de l'objet.
	fetch_clicktodial ()
	Read clicktodial information for user.
	update_clicktodial ()
	Update clicktodial info.
	SetInGroup ($group, $entity, $notrigger=0)
	Add user into a group.
	RemoveFromGroup ($group, $entity, $notrigger=0)
	Remove a user from a group.
	isNotIntoValidityDateRange ()
	Return a link with photo Use this->id,this->photo.
	getPhotoUrl ($width, $height, $cssclass='', $imagesize='')
	Return a link with photo Use this->id,this->photo.
	getTooltipContentArray ($params)
	getTooltipContentArray
	getNomUrl ($withpictoimg=0, $option='', $infologin=0, $notooltip=0, $maxlen=24, $hidethirdpartylogo=0, $mode='', $morecss='', $save_lastsearch_value=-1)
	Return a HTML link to the user card (with optionally the picto) Use this->id,this->lastname, this->firstname.
	getLoginUrl ($withpictoimg=0, $option='', $notooltip=0, $morecss='')
	Return clickable link of login (optionally with picto)
	getLibStatut ($mode=0)
	Return the label of the status of user (active, inactive)
	LibStatut ($status, $mode=0)
	Return the label of a status of user (active, inactive)
	getKanbanView ($option='', $arraydata=null)
	Return clickable link of object (optionally with picto)
	_load_ldap_dn ($info, $mode=0)
	Retourne chaine DN complete dans l'annuaire LDAP pour l'objet.
	_load_ldap_info ()
	Initialize the info array (array of LDAP values) that will be used to call LDAP functions.
	initAsSpecimen ()
	Initialise an instance with random values.
	info ($id)
	Load info of user object.
	getNbOfEMailings ()
	Return number of mass Emailing received by this contacts with its email.
	getNbOfUsers ($limitTo, $option='', $admin=-1)
	Return number of existing users.
	update_ldap2dolibarr (&$ldapuser)
	Update user using data from the LDAP.
	get_children ()
	Return and array with all instantiated first level children users of current user.
	get_full_tree ($deleteafterid=0, $filter='')
	Build the hierarchy/tree of users into an array.
	getAllChildIds ($addcurrentuser=0)
	Return list of all child user ids in hierarchy (all sublevels).
	build_path_from_id_user ($id_user, $protection=0)
	For user id_user and its children available in this->users, define property fullpath and fullname.
	loadStateBoard ()
	Load metrics this->nb for dashboard.
	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
	Create a document onto disk according to template module.
	user_get_property ($rowid, $mode)
	Return property of user from its id.
	getOnlineVirtualCardUrl ($mode='', $typeofurl='external')
	Return string with full Url to virtual card.
	fetchAll ($sortorder='', $sortfield='', $limit=0, $offset=0, $filter='', $filtermode='AND', $entityfilter=false)
	Load all objects into $this->users.
	findUserIdByEmail ($email)
	Find a user by the given e-mail and return it's user id when found.
	cloneRights ($fromId, $toId)
	Clone permissions of user.
	cloneCategories ($fromId, $toId, $type='user')
	Copy related categories to another object.
Public Member Functions inherited from CommonObject
	isEmpty ()
	isEmpty We consider CommonObject isEmpty if this->id is empty
	setErrorsFromObject ($object)
	setErrorsFromObject
	getTooltipContent ($params)
	getTooltipContent
	errorsToString ()
	Method to output saved errors.
	getFormatedCustomerRef ($objref)
	Return customer ref for screen output.
	getFormatedSupplierRef ($objref)
	Return supplier ref for screen output.
	getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
	Return full address of contact.
	getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
	Return the link of last main doc file for direct public download.
	add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
	Add a link between element $this->element and a contact.
	copy_linked_contact ($objFrom, $source='internal')
	Copy contact from one element to current.
	update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
	Update a link to contact line.
	delete_contact ($rowid, $notrigger=0)
	Delete a link to contact line.
	delete_linked_contact ($source='', $code='')
	Delete all links between an object $this and all its contacts in llx_element_contact.
	liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
	Get array of all contacts for an object.
	swapContactStatus ($rowid)
	Update status of a contact linked to object.
	liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
	Return array with list of possible values for type of contacts.
	listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
	Return array with list of possible values for type of contacts.
	getIdContact ($source, $code, $status=0)
	Return id of contacts for a source and a contact code.
	fetch_contact ($contactid=null)
	Load object contact with id=$this->contact_id into $this->contact.
	fetch_thirdparty ($force_thirdparty_id=0)
	Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty.
	fetchOneLike ($ref)
	Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set.
	fetch_barcode ()
	Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.
	fetchBarCode ()
	Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.
	fetchProject ()
	Load the project with id $this->fk_project into this->project.
	fetch_project ()
	Load the project with id $this->fk_project into this->project.
	fetch_projet ()
	Load the project with id $this->fk_project into this->project.
	fetch_product ()
	Load the product with id $this->fk_product into this->product.
	fetch_user ($userid)
	Load the user with id $userid into this->user.
	fetch_origin ()
	Read linked origin object.
	fetchObjectFrom ($table, $field, $key, $element=null)
	Load object from specific field.
	getValueFrom ($table, $id, $field)
	Getter generic.
	setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
	Setter generic.
	load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
	Load properties id_previous and id_next by comparing $fieldid with $this->ref.
	getListContactId ($source='external')
	Return list of id of contacts of object.
	setProject ($projectid, $notrigger=0)
	Link element with a project.
	setPaymentMethods ($id)
	Change the payments methods.
	setMulticurrencyCode ($code)
	Change the multicurrency code.
	setPaymentTerms ($id, $deposit_percent=null)
	Change the payments terms.
	setTransportMode ($id)
	Change the transport mode methods.
	setRetainedWarrantyPaymentTerms ($id)
	Change the retained warranty payments terms.
	setDeliveryAddress ($id)
	Define delivery address.
	setShippingMethod ($shipping_method_id, $notrigger=0, $userused=null)
	Change the shipping method.
	setWarehouse ($warehouse_id)
	Change the warehouse.
	setDocModel ($user, $modelpdf)
	Set last model used by doc generator.
	setBankAccount ($fk_account, $notrigger=0, $userused=null)
	Change the bank account.
	line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
	Save a new position (field rang) for details lines.
	getChildrenOfLine ($id, $includealltree=0)
	Get children of line.
	line_up ($rowid, $fk_parent_line=true)
	Update a line to have a lower rank.
	line_down ($rowid, $fk_parent_line=true)
	Update a line to have a higher rank.
	updateRangOfLine ($rowid, $rang)
	Update position of line (rang)
	line_ajaxorder ($rows)
	Update position of line with ajax (rang)
	updateLineUp ($rowid, $rang)
	Update position of line up (rang)
	updateLineDown ($rowid, $rang, $max)
	Update position of line down (rang)
	getRangOfLine ($rowid)
	Get position of line (rang)
	getIdOfLine ($rang)
	Get rowid of the line relative to its position.
	line_max ($fk_parent_line=0)
	Get max value used for position of line (rang)
	update_ref_ext ($ref_ext)
	Update external ref of element.
	update_note ($note, $suffix='', $notrigger=0)
	Update note of element.
	update_note_public ($note)
	Update public note (kept for backward compatibility)
	update_price ($exclspec=0, $roundingadjust='auto', $nodatabaseupdate=0, $seller=null)
	Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines).
	add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
	Add an object link into llx_element_element.
	getElementType ()
	Return an element type string formatted like element_element target_type and source_type.
	fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1)
	Fetch array of objects linked to current object (object of enabled modules only).
	clearObjectLinkedCache ()
	Clear the cache saying that all linked object were already loaded.
	updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
	Update object linked of a current object.
	deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
	Delete all links between an object $this.
	setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
	Set status of an object.
	getCanvas ($id=0, $ref='')
	Load type of canvas of an object if it exists.
	getSpecialCode ($lineid)
	Get special code of a line.
	isObjectUsed ($id=0, $entity=0)
	Function to check if an object is used by others (by children).
	hasProductsOrServices ($predefined=-1)
	Function to say how many lines object contains.
	getTotalDiscount ()
	Function that returns the total amount HT of discounts applied for all lines.
	getTotalWeightVolume ()
	Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line.
	setExtraParameters ()
	Set extra parameters.
	formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
	Show add free and predefined products/services form.
	printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir='/core/tpl')
	Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects.
	printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir='/core/tpl')
	Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php)
	printOriginLinesList ($restrictlist='', $selectedLines=array())
	Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
	printOriginLine ($line, $var, $restrictlist='', $defaulttpldir='/core/tpl', $selectedLines=array())
	Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
	add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
	Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id.
	delete_resource ($rowid, $element, $notrigger=0)
	Delete a link to resource line.
	__clone ()
	Overwrite magic function to solve problem of cloning object that are kept as references.
	indexFile ($destfull, $update_main_doc_field)
	Index a file into the ECM database.
	addThumbs ($file)
	Build thumb.
	delThumbs ($file)
	Delete thumbs.
	getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
	Return the default value to use for a field when showing the create form of object.
	call_trigger ($triggerName, $user)
	Call trigger based on this instance.
	fetchValuesForExtraLanguages ()
	Function to get alternative languages of a data into $this->array_languages This method is NOT called by method fetch of objects but must be called separately.
	setValuesForExtraLanguages ($onlykey='')
	Fill array_options property of object by extrafields value (using for data sent by forms)
	fetchNoCompute ($id)
	Function to make a fetch but set environment to avoid to load computed values before.
	fetch_optionals ($rowid=null, $optionsArray=null)
	Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately.
	deleteExtraFields ()
	Delete all extra fields values for the current object.
	insertExtraFields ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	insertExtraLanguages ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	updateExtraField ($key, $trigger=null, $userused=null)
	Update 1 extra field value for the current object.
	getExtraField ($key)
	Convenience method for retrieving the value of an extrafield without actually fetching it from the database.
	setExtraField ($key, $value)
	Convenience method for setting the value of an extrafield without actually updating it in the database.
	updateExtraLanguages ($key, $trigger=null, $userused=null)
	Update an extra language value for the current object.
	showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0, $nonewbutton=0)
	Return HTML string to put an input field into a page Code very similar with showInputField of extra fields.
	clearFieldError ($fieldKey)
	clear validation message result for a field
	setFieldError ($fieldKey, $msg='')
	set validation error message a field
	getFieldError ($fieldKey)
	get field error message
	validateField ($fields, $fieldKey, $fieldValue)
	Return validation test result for a field.
	showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
	Function to show lines of extrafields with output data.
	getJSListDependancies ($type='_extra')
	getRights ()
	Returns the rights used for this class.
	defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
	Get buy price to use for margin calculation.
	getDataToShowPhoto ($modulepart, $imagesize)
	Function used to get the logos or photos of an object.
	show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0, $cache='', $addphotorefcss='photoref')
	Show photos of an object (nbmax maximum), into several columns.
	isDate ($info)
	Function test if type is date.
	isDuration ($info)
	Function test if type is duration.
	isInt ($info)
	Function test if type is integer.
	isFloat ($info)
	Function test if type is float.
	isText ($info)
	Function test if type is text.
	setVarsFromFetchObj (&$obj)
	Function to load data from a SQL pointer into properties of current object $this.
	emtpyObjectVars ()
	Sets all object fields to null.
	getFieldList ($alias='', $excludefields=array())
	Function to concat keys of fields.
	createCommon (User $user, $notrigger=0)
	Create object in the database.
	fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
	Load object in memory from the database.
	fetchLinesCommon ($morewhere='', $noextrafields=0)
	Load object in memory from the database.
	updateCommon (User $user, $notrigger=0)
	Update object into database.
	deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0)
	Delete object in database.
	deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND")
	Delete all child object from a parent ID.
	deleteLineCommon (User $user, $idline, $notrigger=0)
	Delete a line of object in database.
	setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
	Set to a status.
	initAsSpecimenCommon ()
	Initialise object with example values Id must be 0 if object instance is a specimen.
	fetchComments ()
	Load comments linked with current task.
	getNbComments ()
	Return nb comments already posted.
	trimParameters ($parameters)
	Trim object parameters.
	getCategoriesCommon ($type_categ)
	Sets object to given categories.
	setCategoriesCommon ($categories, $type_categ='', $remove_existing=true)
	Sets object to given categories.
	deleteEcmFiles ($mode=0)
	Delete related files of object in database.

Static Public Member Functions
static	replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id)
	Function used to replace a thirdparty id with another one.
Static Public Member Functions inherited from CommonObject
static	isExistingObject ($element, $id, $ref='', $ref_ext='')
	Check if an object id or ref exists If you don't need or want to instantiate the object and just need to know if the object exists, use this method instead of fetch.
static	getAllItemsLinkedByObjectID ($fk_object_where, $field_select, $field_where, $table_element)
	Function used to get an array with all items linked to an object id in association table.
static	getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Count items linked to an object id in association table.
static	deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Function used to remove all items linked to an object id in association table.
static	commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a thirdparty id with another one.
static	commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a product id with another one.

Private Member Functions
	loadParentOf ()
	Load this->parentof that is array(id_son=>id_parent, ...)

Additional Inherited Members
Public Attributes inherited from CommonObject
	$origin_object
Protected Member Functions inherited from CommonObject
	deprecatedProperties ()
	Provide list of deprecated properties and replacements.
	commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
	Common function for all objects extending CommonObject for generating documents.
	isArray ($info)
	Function test if type is array.
	canBeNull ($info)
	Function test if field can be null.
	isForcedToNullIfZero ($info)
	Function test if field is forced to null if zero or empty.
	isIndex ($info)
	Function test if is indexed.
	setSaveQuery ()
	Function to return the array of data key-value from the ->fields and all the ->properties of an object.
	quote ($value, $fieldsentry)
	Add quote to field value if necessary.

Detailed Description

Class to manage Dolibarr users.

Definition at line 49 of file user.class.php.

Constructor & Destructor Documentation

__construct()

User::__construct

(

$db

)

Constructor of the class.

Parameters

DoliDB

$db

Database handler

Definition at line 497 of file user.class.php.

References conf().

Member Function Documentation

_load_ldap_dn()

User::_load_ldap_dn	(		$info,
			$mode = 0 )

Retourne chaine DN complete dans l'annuaire LDAP pour l'objet.

Parameters

array<string,mixed>	$info Info array loaded by _load_ldap_info
int<0,2>	$mode 0=Return full DN (uid=qqq,ou=xxx,dc=aaa,dc=bbb) 1=Return parent (ou=xxx,dc=aaa,dc=bbb) 2=Return key only (RDN) (uid=qqq)

Returns

string DN

Definition at line 3405 of file user.class.php.

References getDolGlobalString().

_load_ldap_info()

User::_load_ldap_info

(

)

Initialize the info array (array of LDAP values) that will be used to call LDAP functions.

Returns

array<string,mixed> Table with attribute information

Definition at line 3427 of file user.class.php.

References $conf, address, dol_hash(), dol_string_nohtmltag(), dolGetLdapPasswordHash(), email, getArrayOfSocialNetworks(), getDolGlobalString(), and getFullName().

addrights()

User::addrights	(		$rid,
			$allmodule = '',
			$allperms = '',
			$entity = 0,
			$notrigger = 0 )

Add a right to the user.

Parameters

int	$rid	Id of permission to add or 0 to add several permissions
string	$allmodule	Add all permissions of module $allmodule or 'allmodules' to include all modules.
string	$allperms	Add all permissions of module $allmodule, subperms $allperms only or '' to include all permissions.
int	$entity	Entity to use
int	$notrigger	1=Does not execute triggers, 0=Execute triggers

Returns

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

See also

clearrights(), delrights(), loadRights(), hasRight()

Definition at line 1021 of file user.class.php.

References $conf, CommonObject\call_trigger(), dol_print_error(), dol_syslog(), and error().

build_path_from_id_user()

User::build_path_from_id_user	(		$id_user,
			$protection = 0 )

For user id_user and its children available in this->users, define property fullpath and fullname.

Function called by get_full_tree().

Parameters

int	$id_user	id_user entry to update
int	$protection	Deep counter to avoid infinite loop (no more required, a protection is added with array useridfound)

Returns

int<-1,1> Return integer < 0 if KO (infinite loop), >= 0 if OK

Definition at line 4001 of file user.class.php.

References dol_strlen(), and dol_syslog().

Referenced by get_full_tree().

clearrights()

User::clearrights

(

)

Clear all permissions array of user.

Returns

void

See also

loadRights(), hasRight()

Definition at line 1282 of file user.class.php.

References dol_syslog().

cloneCategories()

User::cloneCategories	(		$fromId,
			$toId,
			$type = 'user' )

Copy related categories to another object.

Parameters

int	$fromId	Id user source
int	$toId	Id user cible
string	$type	Type of category ('user', ...)

Returns

int Return integer < 0 if error, > 0 if ok

Reimplemented from CommonObject.

Definition at line 4380 of file user.class.php.

References error().

cloneRights()

User::cloneRights	(		$fromId,
			$toId )

Clone permissions of user.

Parameters

int	$fromId	User ID from whom to clone rights
int	$toId	User ID

Returns

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

Definition at line 4328 of file user.class.php.

References dol_syslog().

create()

User::create	(		$user,
			$notrigger = 0 )

Create a user into database.

Parameters

User	$user	Object user doing creation
int	$notrigger	1=do not execute triggers, 0 otherwise

Returns

int Return integer <0 if KO, id of created user if OK

Definition at line 1727 of file user.class.php.

References $conf, CommonObject\call_trigger(), dol_now(), dol_syslog(), email, error(), getDolGlobalString(), getFullName(), isValidEmail(), set_default_rights(), setUpperOrLowerCase(), and update().

Referenced by create_from_contact(), and create_from_member().

create_from_contact()

User::create_from_contact	(		$contact,
			$login = '',
			$password = '' )

Create a user from a contact object.

User will be internal but if contact is linked to a third party, user will be external

Parameters

Contact	$contact	Object for source contact
string	$login	Login to force
string	$password	Password to force

Returns

int Return integer <0 if error, if OK returns id of created user

Definition at line 1871 of file user.class.php.

References address, CommonObject\call_trigger(), create(), dol_buildlogin(), dol_syslog(), email, error(), and setUpperOrLowerCase().

create_from_member()

User::create_from_member	(		$member,
			$login = '' )

Create a user into database from a member object.

If $member->fk_soc is set, it will be an external user.

Parameters

Adherent	$member	Object member source
string	$login	Login to force

Returns

int Return integer <0 if KO, if OK, return id of created account

Definition at line 1957 of file user.class.php.

References address, create(), dol_buildlogin(), dol_syslog(), email, error(), setPassword(), and setUpperOrLowerCase().

delete()

User::delete

(

User

$user

)

Delete the user.

Parameters

User

$user

User than delete

Returns

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

Definition at line 1640 of file user.class.php.

References CommonObject\call_trigger(), CommonObject\deleteExtraFields(), dol_syslog(), error(), and fetch().

delrights()

User::delrights	(		$rid,
			$allmodule = '',
			$allperms = '',
			$entity = 0,
			$notrigger = 0 )

Remove a right to the user.

Parameters

int	$rid	Id of permission to remove (or 0 when using the other filters)
string	$allmodule	Retirer tous les droits du module allmodule
string	$allperms	Retirer tous les droits du module allmodule, perms allperms
int | string	$entity	Entity to use. Example: '1', or '0,1', or '2,3'
int	$notrigger	1=Does not execute triggers, 0=Execute triggers

Returns

int Return integer > 0 if OK, < 0 if OK

See also

clearrights(), addrights(), loadRights(), hasRight()

Definition at line 1164 of file user.class.php.

References $conf, CommonObject\call_trigger(), and dol_print_error().

error()

User::error

(

)

Renvoie la derniere erreur fonctionnelle de manipulation de l'objet.

Returns

string chaine erreur

Definition at line 2753 of file user.class.php.

Referenced by addrights(), cloneCategories(), create(), create_from_contact(), create_from_member(), delete(), fetch(), fetch_clicktodial(), get_full_tree(), getNbOfEMailings(), getNbOfUsers(), loadPersonalConf(), loadStateBoard(), RemoveFromGroup(), send_password(), SetInGroup(), setPassword(), update(), update_clicktodial(), and update_last_login_date().

fetch()

User::fetch	(		$id = 0,
			$login = '',
			$sid = '',
			$loadpersonalconf = 0,
			$entity = -1,
			$email = '',
			$fk_socpeople = 0,
			$use_email_oauth2 = 0 )

Load a user from database with its id or ref (login).

This function does not load permissions, only user properties. Use loadRights() for this just after the fetch.

Parameters

int	$id	If defined, id to used for search
string	$login	If defined, login to used for search
string	$sid	If defined, sid to used for search
	int<0,1>	$loadpersonalconf 1=also load personal conf of user (in $user->conf->xxx), 0=do not load personal conf.
int	$entity	If a value is >= 0, we force the search on a specific entity. If -1, means search depens on default setup.
string	$email	If defined, email to used for search
int	$fk_socpeople	If defined, id of contact for search
	int<0,1>	$use_email_oauth2 1=Use also email_oauth2 to fetch on email

Returns

int Return integer <0 if KO, 0 not found, >0 if OK

Definition at line 538 of file user.class.php.

References $conf, address, dol_syslog(), dolDecrypt(), email, error(), CommonObject\fetch_optionals(), getDolGlobalString(), loadDefaultValues(), loadPersonalConf(), ref, and status.

Referenced by delete().

fetch_clicktodial()

User::fetch_clicktodial

(

)

Read clicktodial information for user.

Returns

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

Definition at line 2765 of file user.class.php.

References error().

fetchAll()

User::fetchAll	(		$sortorder = '',
			$sortfield = '',
			$limit = 0,
			$offset = 0,
			$filter = '',
			$filtermode = 'AND',
			$entityfilter = false )

Load all objects into $this->users.

Parameters

string	$sortorder	sort order
string	$sortfield	sort field
int	$limit	limit page
int	$offset	page
string	$filter	Filter as an Universal Search string. Example: '((client:=:1) OR ((client:>=:2) AND (client:<=:3))) AND (client:!=:8) AND (nom:like:'a')'
string	$filtermode	No more used
bool	$entityfilter	Activate entity filter

Returns

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

Definition at line 4210 of file user.class.php.

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

findUserIdByEmail()

User::findUserIdByEmail

(

$email

)

Find a user by the given e-mail and return it's user id when found.

NOTE: Use AGENDA_DISABLE_EXACT_USER_EMAIL_COMPARE_FOR_EXTERNAL_CALENDAR to disable exact e-mail search

Parameters

string

$email

The full e-mail (or a part of a e-mail)

Returns

int Return integer <0 = user was not found, >0 = The id of the user

Definition at line 4290 of file user.class.php.

References getDolGlobalString().

generateDocument()

User::generateDocument	(		$modele,
			$outputlangs,
			$hidedetails = 0,
			$hidedesc = 0,
			$hideref = 0,
			$moreparams = null )

Create a document onto disk according to template module.

Parameters

string	$modele	Force model to use ('' to not force)
Translate	$outputlangs	Object langs to use for output
	int<0,1>	$hidedetails Hide details of lines
	int<0,1>	$hidedesc Hide description
	int<0,1>	$hideref Hide ref
	?array<string,mixed>	$moreparams Array to provide more information

Returns

int 0 if KO, 1 if OK

Definition at line 4103 of file user.class.php.

References CommonObject\commonGenerateDocument(), dol_strlen(), and getDolGlobalString().

get_children()

User::get_children

(

)

Return and array with all instantiated first level children users of current user.

Returns

User[]|int<-1,-1>

See also

getAllChildIds()

Definition at line 3796 of file user.class.php.

References dol_print_error(), and dol_syslog().

get_full_tree()

User::get_full_tree	(		$deleteafterid = 0,
			$filter = '' )

Build the hierarchy/tree of users into an array.

Set and return this->users that is an array sorted according to tree with arrays of: id = id user lastname firstname fullname = Name with full path to user fullpath = Full path composed of the ids: "_grandparentid_parentid_id"

Parameters

int	$deleteafterid	Removed all users including the leaf $deleteafterid (and all its child) in user tree.
string	$filter	SQL filter on users. This parameter must not come from user input.

Returns

int<-1,-1>|array<int,array{rowid:int,id:int,fk_user:int,fk_soc:int,firstname:string,lastname:string,login:string,statut:int,entity:int,email:string,gender:string|int<-1,-1>,admin:int<0,1>,photo:string,fullpath:string,fullname:string,level:int}> Array of user information (also: $this->users). Note: $this->parentof is also set.

Definition at line 3863 of file user.class.php.

References build_path_from_id_user(), dol_print_error(), dol_sort_array(), dol_syslog(), error(), and loadParentOf().

Referenced by getAllChildIds().

getAllChildIds()

User::getAllChildIds

(

$addcurrentuser = 0

)

Return list of all child user ids in hierarchy (all sublevels).

Note: Calling this function also reset full list of users into $this->users.

Parameters

int<0,1>

$addcurrentuser 1=Add also current user id to the list.

Returns

array<int,int> Array of user id lower than user (all levels under user). This overwrites this->users.

See also

get_children()

Definition at line 3963 of file user.class.php.

References dol_syslog(), and get_full_tree().

getKanbanView()

User::getKanbanView	(		$option = '',
			$arraydata = null )

Return clickable link of object (optionally with picto)

Parameters

string	$option	Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
	array{string,mixed}	$arraydata Array of data

Returns

string HTML Code for Kanban thumb.

Definition at line 3343 of file user.class.php.

References email, getNomUrl(), img_picto(), and Form\showphoto().

getLibStatut()

User::getLibStatut

(

$mode = 0

)

Return the label of the status of user (active, inactive)

Parameters

int

$mode

0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto

Returns

string Label of status

Definition at line 3287 of file user.class.php.

References LibStatut(), and status.

Referenced by getTooltipContentArray().

getLoginUrl()

User::getLoginUrl	(		$withpictoimg = 0,
			$option = '',
			$notooltip = 0,
			$morecss = '' )

Return clickable link of login (optionally with picto)

Parameters

int	$withpictoimg	Include picto into link (1=picto, -1=photo)
string	$option	On what the link point to ('leave', 'accountancy', 'nolink', )
integer	$notooltip	1=Disable tooltip on picto and name
string	$morecss	Add more css on link

Returns

string String with URL

Definition at line 3236 of file user.class.php.

References img_object(), and Form\showphoto().

getNbOfEMailings()

User::getNbOfEMailings

(

)

Return number of mass Emailing received by this contacts with its email.

Returns

int Number of EMailings

Definition at line 3676 of file user.class.php.

References email, and error().

getNbOfUsers()

User::getNbOfUsers	(		$limitTo,
			$option = '',
			$admin = -1 )

Return number of existing users.

Parameters

string	$limitTo	Limit to '' or 'active'
string	$option	'superadmin' = return for entity 0 only
int	$admin	Filter on admin tag

Returns

int Number of users

Definition at line 3704 of file user.class.php.

References error().

getNomUrl()

User::getNomUrl	(		$withpictoimg = 0,
			$option = '',
			$infologin = 0,
			$notooltip = 0,
			$maxlen = 24,
			$hidethirdpartylogo = 0,
			$mode = '',
			$morecss = '',
			$save_lastsearch_value = -1 )

Return a HTML link to the user card (with optionally the picto) Use this->id,this->lastname, this->firstname.

Parameters

int	$withpictoimg	Include picto in link (0=No picto, 1=Include picto into link, 2=Only picto, -1=Include photo into link, -2=Only picto photo, -3=Only photo very small)
string	$option	On what the link point to ('leave', 'accountancy', 'nolink', )
integer	$infologin	0=Add default info tooltip, 1=Add complete info tooltip, -1=No info tooltip
integer	$notooltip	1=Disable tooltip on picto and name
int	$maxlen	Max length of visible user name
int	$hidethirdpartylogo	Hide logo of thirdparty if user is external user
string	$mode	''=Show firstname and lastname, 'firstname'=Show only firstname, 'firstelselast'=Show firstname or lastname if not defined, 'login'=Show login
string	$morecss	Add more css on link
	int<-1,1>	$save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking

Returns

string String with URL

Definition at line 3104 of file user.class.php.

References dol_string_nohtmltag(), dol_trunc(), getDolGlobalInt(), getDolGlobalString(), getFullName(), getTooltipContentArray(), img_object(), Form\showphoto(), and status.

Referenced by getKanbanView().

getOnlineVirtualCardUrl()

User::getOnlineVirtualCardUrl	(		$mode = '',
			$typeofurl = 'external' )

Return string with full Url to virtual card.

Parameters

string	$mode	Mode for link
string	$typeofurl	'external' or 'internal'

Returns

string Url string link

Definition at line 4174 of file user.class.php.

References $conf, and dol_hash().

getPhotoUrl()

User::getPhotoUrl	(		$width,
			$height,
			$cssclass = '',
			$imagesize = '' )

Return a link with photo Use this->id,this->photo.

Parameters

int	$width	Width of image
int	$height	Height of image
string	$cssclass	Force a css class
string	$imagesize	'mini', 'small' or '' (original)

Returns

string String with URL link

See also

getImagePublicURLOfObject()

Definition at line 2983 of file user.class.php.

References Form\showphoto().

getrights()

User::getrights	(		$moduletag = '',
			$forcereload = 0 )

Load permissions granted to a user->id into object user->rights TODO Remove this method.

It has a name conflict with getRights() in CommonObject and was replaced in v20 with loadRights()

Parameters

string	$moduletag	Limit permission for a particular module ('' by default means load all permissions)
int	$forcereload	Force reload of permissions even if they were already loaded (ignore cache)

Returns

void

Deprecated

Use loadRights

See also

clearrights(), delrights(), addrights(), hasRight() @phpstan-ignore-next-line

Definition at line 1558 of file user.class.php.

References loadRights().

getTooltipContentArray()

User::getTooltipContentArray

(

$params

)

getTooltipContentArray

Parameters

array<string,mixed>

$params params to construct tooltip data

Since

v18

Returns

array{picto?:string,ref?:string,refsupplier?:string,label?:string,date?:string,date_echeance?:string,amountht?:string,total_ht?:string,totaltva?:string,amountlt1?:string,amountlt2?:string,amountrevenustamp?:string,totalttc?:string}|array{optimize:string}

Reimplemented from CommonObject.

Definition at line 2998 of file user.class.php.

References $conf, dol_print_date(), dol_print_phone(), dol_string_nohtmltag(), email, getDolGlobalString(), getFullName(), getLibStatut(), getUserRemoteIP(), img_picto(), picto_from_langcode(), Form\showphoto(), and yn().

Referenced by getNomUrl().

hasRight()

User::hasRight	(		$module,
			$permlevel1,
			$permlevel2 = '' )

Return if a user has a permission.

You can use it like this: if ($user->hasRight('module', 'level11')). It replaces old syntax: if ($user->rights->module->level1)

Parameters

string	$module	Module of permission to check
string	$permlevel1	Permission level1 (Example: 'read', 'write', 'delete')
string	$permlevel2	Permission level2

Returns

int<0,1> Return integer 1 if user has permission, 0 if not.

See also

clearrights(), delrights(), loadRights(), hasRight()

Definition at line 865 of file user.class.php.

Referenced by Product\delete(), and Facture\validate().

info()

User::info

(

$id

)

Load info of user object.

Parameters

int

$id

Id of user to load

Returns

void

Definition at line 3644 of file user.class.php.

References dol_print_error(), and ref.

initAsSpecimen()

User::initAsSpecimen

(

)

Initialise an instance with random values.

Used to build previews or test instances. id must be 0 if object instance is a specimen.

Returns

int

Definition at line 3590 of file user.class.php.

References dol_now(), email, ref, and status.

isNotIntoValidityDateRange()

User::isNotIntoValidityDateRange

(

)

Return a link with photo Use this->id,this->photo.

Returns

int 0=Valid, >0 if not valid

Definition at line 2951 of file user.class.php.

References dol_get_first_hour(), dol_get_last_hour(), and dol_now().

LibStatut()

User::LibStatut	(		$status,
			$mode = 0 )

Return the label of a status of user (active, inactive)

Parameters

int	$status	Id status
int	$mode	0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto

Returns

string Label of status

Definition at line 3300 of file user.class.php.

References dol_now(), and dolGetStatus().

Referenced by getLibStatut().

loadDefaultValues()

User::loadDefaultValues

(

)

Load default values from database table into property ->default_values.

Returns

int > 0 if OK, < 0 if KO

Definition at line 813 of file user.class.php.

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

Referenced by fetch().

loadParentOf()

User::loadParentOf ( )

private

Load this->parentof that is array(id_son=>id_parent, ...)

Returns

int<-1,1> Return integer <0 if KO, >0 if OK

Definition at line 3824 of file user.class.php.

References dol_print_error(), and dol_syslog().

Referenced by get_full_tree().

loadPersonalConf()

User::loadPersonalConf

(

)

Load const values from database table user_param and set it into user->conf->XXX.

Returns

int >= 0 if OK, < 0 if KO

Definition at line 777 of file user.class.php.

References $conf, conf(), and error().

Referenced by fetch().

loadRights()

User::loadRights	(		$moduletag = '',
			$forcereload = 0 )

Load permissions granted to a user->id into object user->rights.

Parameters

string	$moduletag	Limit permission for a particular module ('' by default means load all permissions)
int	$forcereload	Force reload of permissions even if they were already loaded (ignore cache)

Returns

void

See also

clearrights(), delrights(), addrights(), hasRight()

Definition at line 1300 of file user.class.php.

References $conf, and getDolGlobalString().

Referenced by getrights().

loadStateBoard()

User::loadStateBoard

(

)

Load metrics this->nb for dashboard.

Returns

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

Definition at line 4060 of file user.class.php.

References dol_print_error(), error(), and getDolGlobalString().

RemoveFromGroup()

User::RemoveFromGroup	(		$group,
			$entity,
			$notrigger = 0 )

Remove a user from a group.

Parameters

int	$group	Id of group
int	$entity	Entity
int	$notrigger	Disable triggers

Returns

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

Definition at line 2898 of file user.class.php.

References CommonObject\call_trigger(), dol_syslog(), and error().

replaceThirdparty()

static User::replaceThirdparty ( DoliDB $dbs, $origin_id, $dest_id )

static

Function used to replace a thirdparty id with another one.

Parameters

DoliDB	$dbs	Database handler, because function is static we name it $dbs not $db to avoid breaking coding test
int	$origin_id	Old thirdparty id
int	$dest_id	New thirdparty id

Returns

bool

Definition at line 4045 of file user.class.php.

References CommonObject\commonReplaceThirdparty().

send_password()

User::send_password	(		$user,
			$password = '',
			$changelater = 0 )

Send a new password (or instructions to reset it) by email.

Parameters

User	$user	Object user that send the email (not the user we send to)
string	$password	New password
int	$changelater	0=Send clear passwod into email, 1=Change password only after clicking on confirm email.

Returns

int Return integer < 0 si erreur, > 0 si ok

Definition at line 2641 of file user.class.php.

References $conf, conf(), dol_hash(), dol_syslog(), email, error(), and getDolGlobalString().

set_default_rights()

User::set_default_rights

(

)

Assign rights by default.

Returns

integer erreur <0, si ok renvoi le nbre de droits par default positions

Definition at line 2043 of file user.class.php.

References $conf.

Referenced by create().

setCategories()

User::setCategories

(

$categories

)

Sets object to supplied categories.

Deletes object from existing categories not supplied. Adds it to non existing supplied categories. Existing categories are left untouch.

Parameters

int[] | int

$categories

Category or categories IDs

Returns

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

Definition at line 1628 of file user.class.php.

SetInGroup()

User::SetInGroup	(		$group,
			$entity,
			$notrigger = 0 )

Add user into a group.

Parameters

int	$group	Id of group
int	$entity	Entity
int	$notrigger	Disable triggers

Returns

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

Definition at line 2842 of file user.class.php.

References CommonObject\call_trigger(), dol_syslog(), and error().

setPassword()

User::setPassword	(		$user,
			$password = '',
			$changelater = 0,
			$notrigger = 0,
			$nosyncmember = 0,
			$passwordalreadycrypted = 0,
			$flagdelsessionsbefore = 1 )

Change password of a user.

Parameters

User	$user	Object user of user requesting the change (not the user for who we change the password). May be unknown.
string	$password	New password, in clear text or already encrypted (to generate if not provided)
int	$changelater	0=Default, 1=Save password into pass_temp to change password only after clicking on confirm email
int	$notrigger	1=Does not launch triggers
int	$nosyncmember	Do not synchronize linked member
int	$passwordalreadycrypted	0=Value is cleartext password, 1=Value is encrypted value.
int	$flagdelsessionsbefore	1=Save also the current date to ask to invalidate all other session before this date.

Returns

int|string If OK return clear password, 0 if no change (warning, you may retrieve 1 instead of 0 even if password was same), < 0 if error

Definition at line 2489 of file user.class.php.

References $conf, CommonObject\call_trigger(), dol_hash(), dol_now(), dol_print_error(), dol_syslog(), error(), getDolGlobalString(), and getRandomPassword().

Referenced by create_from_member(), and update().

setstatus()

User::setstatus

(

$status

)

Change status of a user.

Parameters

int

$status

Status to set

Returns

int Return integer <0 if KO, 0 if nothing is done, >0 if OK

Definition at line 1569 of file user.class.php.

References CommonObject\call_trigger(), dol_syslog(), and status.

update()

User::update	(		$user,
			$notrigger = 0,
			$nosyncmember = 0,
			$nosyncmemberpass = 0,
			$nosynccontact = 0 )

Update a user into database (and also password if this->pass is defined)

Parameters

User	$user	User making update
int	$notrigger	1=do not execute triggers, 0 by default
int	$nosyncmember	0=Synchronize linked member (standard info), 1=Do not synchronize linked member
int	$nosyncmemberpass	0=Synchronize linked member (password), 1=Do not synchronize linked member
int	$nosynccontact	0=Synchronize linked contact, 1=Do not synchronize linked contact

Returns

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

Definition at line 2091 of file user.class.php.

References address, CommonObject\call_trigger(), dol_syslog(), dol_verifyHash(), dolEncrypt(), email, error(), getDolGlobalString(), CommonObject\insertExtraFields(), isValidEmail(), setPassword(), and setUpperOrLowerCase().

Referenced by create(), and update_ldap2dolibarr().

update_clicktodial()

User::update_clicktodial

(

)

Update clicktodial info.

Returns

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

Definition at line 2799 of file user.class.php.

References dol_syslog(), and error().

update_last_login_date()

User::update_last_login_date

(

)

Update the user's last login date in the database.

Function called when a new connection is made by the user

Returns

int Return integer <0 si echec, >=0 si ok

Definition at line 2447 of file user.class.php.

References dol_now(), dol_syslog(), error(), and getUserRemoteIP().

update_ldap2dolibarr()

User::update_ldap2dolibarr

(

&

$ldapuser

)

Update user using data from the LDAP.

Parameters

Object

$ldapuser

Ladp User

Returns

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

Definition at line 3742 of file user.class.php.

References dol_syslog(), email, getArrayOfSocialNetworks(), getDolGlobalString(), and update().

user_get_property()

User::user_get_property	(		$rowid,
			$mode )

Return property of user from its id.

Parameters

int	$rowid	id of contact
string	$mode	'email', 'mobile', or 'name'

Returns

string Email of user with format: "Full name <email>"

Definition at line 4131 of file user.class.php.

References dol_print_error(), and dolGetFirstLastname().

---

The documentation for this class was generated from the following file:

• dolibarr_dev/htdocs/user/class/user.class.php