dolibarr  9.0.0
Public Member Functions | Static Public Member Functions | Public Attributes | Private Member Functions | List of all members
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. More...
 
 fetch ($id='', $login='', $sid='', $loadpersonalconf=0, $entity=-1)
 Load a user from database with its id or ref (login). More...
 
 loadDefaultValues ()
 Load default value in property ->default_values. More...
 
 addrights ($rid, $allmodule='', $allperms='', $entity=0, $notrigger=0)
 Add a right to the user. More...
 
 delrights ($rid, $allmodule='', $allperms='', $entity=0, $notrigger=0)
 Remove a right to the user. More...
 
 clearrights ()
 Clear all permissions array of user. More...
 
 getrights ($moduletag='', $forcereload=0)
 Load permissions granted to user into object user. More...
 
 setstatus ($statut)
 Change status of a user. More...
 
 setCategories ($categories)
 Sets object to supplied categories. More...
 
 delete ()
 Delete the user. More...
 
 create ($user, $notrigger=0)
 Create a user into database. More...
 
 create_from_contact ($contact, $login='', $password='')
 Create a user from a contact object. More...
 
 create_from_member ($member, $login='')
 Create a user into database from a member object. More...
 
 set_default_rights ()
 Assign rights by default. More...
 
 update ($user, $notrigger=0, $nosyncmember=0, $nosyncmemberpass=0, $nosynccontact=0)
 Update a user into database (and also password if this->pass is defined) More...
 
 update_last_login_date ()
 Mise a jour en base de la date de derniere connexion d'un utilisateur Fonction appelee lors d'une nouvelle connexion. More...
 
 setPassword ($user, $password='', $changelater=0, $notrigger=0, $nosyncmember=0)
 Change password of a user. More...
 
 send_password ($user, $password='', $changelater=0)
 Send new password by email. More...
 
 error ()
 Renvoie la derniere erreur fonctionnelle de manipulation de l'objet. More...
 
 fetch_clicktodial ()
 Read clicktodial information for user. More...
 
 update_clicktodial ()
 Update clicktodial info. More...
 
 SetInGroup ($group, $entity, $notrigger=0)
 Add user into a group. More...
 
 RemoveFromGroup ($group, $entity, $notrigger=0)
 Remove a user from a group. More...
 
 getPhotoUrl ($width, $height, $cssclass='', $imagesize='')
 Return a link with photo Use this->id,this->photo. More...
 
 getNomUrl ($withpictoimg=0, $option='', $infologin=0, $notooltip=0, $maxlen=24, $hidethirdpartylogo=0, $mode='', $morecss='', $save_lastsearch_value=-1)
 Return a link to the user card (with optionaly the picto) Use this->id,this->lastname, this->firstname. More...
 
 getLoginUrl ($withpicto=0, $option='')
 Return clickable link of login (eventualy with picto) More...
 
 getLibStatut ($mode=0)
 Return label of status of user (active, inactive) More...
 
 LibStatut ($statut, $mode=0)
 Renvoi le libelle d'un statut donne. More...
 
 _load_ldap_dn ($info, $mode=0)
 Retourne chaine DN complete dans l'annuaire LDAP pour l'objet. More...
 
 _load_ldap_info ()
 Initialize the info array (array of LDAP values) that will be used to call LDAP functions. More...
 
 initAsSpecimen ()
 Initialise an instance with random values. More...
 
 info ($id)
 Load info of user object. More...
 
 getNbOfEMailings ()
 Return number of mass Emailing received by this contacts with its email. More...
 
 getNbOfUsers ($limitTo, $option='', $admin=-1)
 Return number of existing users. More...
 
 update_ldap2dolibarr (&$ldapuser)
 Update user using data from the LDAP. More...
 
 get_children ()
 Return and array with all instanciated first level children users of current user. More...
 
 get_full_tree ($deleteafterid=0, $filter='')
 Reconstruit l'arborescence hierarchique des users sous la forme d'un tableau Set and return this->users that is an array sorted according to tree with arrays of: id = id user lastname firstname fullname = nom avec chemin complet du user fullpath = chemin complet compose des id: "_grandparentid_parentid_id". More...
 
 getAllChildIds ($addcurrentuser=0)
 Return list of all child users id in herarchy (all sublevels). More...
 
 build_path_from_id_user ($id_user, $protection=0)
 For user id_user and its childs available in this->users, define property fullpath and fullname. More...
 
 load_state_board ()
 Charge indicateurs this->nb pour le tableau de bord. More...
 
 generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
 Create a document onto disk according to template module. More...
 
 user_get_property ($rowid, $mode)
 Return property of user from its id. More...
 
 fetchAll ($sortorder='', $sortfield='', $limit=0, $offset=0, $filter=array(), $filtermode='AND')
 Load all objects into $this->users. More...
 
- Public Member Functions inherited from CommonObject
 errorsToString ()
 Method to output saved errors. More...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 getFullAddress ($withcountry=0, $sep="\, $withregion=0)
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. More...
 
 getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
 Return the link of last main doc file for direct public download. More...
 
 add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
 Add a link between element $this->element and a contact. More...
 
 copy_linked_contact ($objFrom, $source='internal')
 Copy contact from one element to current. More...
 
 update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
 Update a link to contact line. More...
 
 delete_contact ($rowid, $notrigger=0)
 Delete a link to contact line. More...
 
 delete_linked_contact ($source='', $code='')
 Delete all links between an object $this and all its contacts. More...
 
 liste_contact ($statut=-1, $source='external', $list=0, $code='')
 Get array of all contacts for an object. More...
 
 swapContactStatus ($rowid)
 Update status of a contact linked to object. More...
 
 liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
 Return array with list of possible values for type of contacts. More...
 
 getIdContact ($source, $code, $status=0)
 Return id of contacts for a source and a contact code. More...
 
 fetch_contact ($contactid=null)
 Load object contact with id=$this->contactid into $this->contact. More...
 
 fetch_thirdparty ($force_thirdparty_id=0)
 Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. More...
 
 fetchOneLike ($ref)
 Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. More...
 
 fetch_barcode ()
 Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. More...
 
 fetch_projet ()
 Load the project with id $this->fk_project into this->project. More...
 
 fetch_product ()
 Load the product with id $this->fk_product into this->product. More...
 
 fetch_user ($userid)
 Load the user with id $userid into this->user. More...
 
 fetch_origin ()
 Read linked origin object. More...
 
 fetchObjectFrom ($table, $field, $key, $element=null)
 Load object from specific field. More...
 
 getValueFrom ($table, $id, $field)
 Getter generic. More...
 
 setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
 Setter generic. More...
 
 load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
 Load properties id_previous and id_next by comparing $fieldid with $this->ref. More...
 
 getListContactId ($source='external')
 Return list of id of contacts of object. More...
 
 setProject ($projectid)
 Link element with a project. More...
 
 setPaymentMethods ($id)
 Change the payments methods. More...
 
 setMulticurrencyCode ($code)
 Change the multicurrency code. More...
 
 setMulticurrencyRate ($rate, $mode=1)
 Change the multicurrency rate. More...
 
 setPaymentTerms ($id)
 Change the payments terms. More...
 
 setDeliveryAddress ($id)
 Define delivery address. More...
 
 setShippingMethod ($shipping_method_id, $notrigger=false, $userused=null)
 Change the shipping method. More...
 
 setWarehouse ($warehouse_id)
 Change the warehouse. More...
 
 setDocModel ($user, $modelpdf)
 Set last model used by doc generator. More...
 
 setBankAccount ($fk_account, $notrigger=false, $userused=null)
 Change the bank account. More...
 
 line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
 Save a new position (field rang) for details lines. More...
 
 getChildrenOfLine ($id)
 Get children of line. More...
 
 line_up ($rowid, $fk_parent_line=true)
 Update a line to have a lower rank. More...
 
 line_down ($rowid, $fk_parent_line=true)
 Update a line to have a higher rank. More...
 
 updateRangOfLine ($rowid, $rang)
 Update position of line (rang) More...
 
 line_ajaxorder ($rows)
 Update position of line with ajax (rang) More...
 
 updateLineUp ($rowid, $rang)
 Update position of line up (rang) More...
 
 updateLineDown ($rowid, $rang, $max)
 Update position of line down (rang) More...
 
 getRangOfLine ($rowid)
 Get position of line (rang) More...
 
 getIdOfLine ($rang)
 Get rowid of the line relative to its position. More...
 
 line_max ($fk_parent_line=0)
 Get max value used for position of line (rang) More...
 
 update_ref_ext ($ref_ext)
 Update external ref of element. More...
 
 update_note ($note, $suffix='')
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 update_price ($exclspec=0, $roundingadjust='none', $nodatabaseupdate=0, $seller=null)
 Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More...
 
 add_object_linked ($origin=null, $origin_id=null)
 Add objects linked in llx_element_element. More...
 
 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). More...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='')
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid='')
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='', $trigkey='')
 Set status of an object. More...
 
 getCanvas ($id=0, $ref='')
 Load type of canvas of an object if it exists. More...
 
 getSpecialCode ($lineid)
 Get special code of a line. More...
 
 isObjectUsed ($id=0)
 Function to check if an object is used by others. More...
 
 hasProductsOrServices ($predefined=-1)
 Function to say how many lines object contains. More...
 
 getTotalDiscount ()
 Function that returns the total amount HT of discounts applied for all lines. More...
 
 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. More...
 
 setExtraParameters ()
 Set extra parameters. More...
 
 display_incoterms ()
 Return incoterms informations TODO Use a cache for label get. More...
 
 getIncotermsForPDF ()
 Return incoterms informations for pdf display. More...
 
 setIncoterms ($id_incoterm, $location)
 Define incoterms values of current object. More...
 
 formAddObjectLine ($dateSelector, $seller, $buyer)
 Show add free and predefined products/services form. More...
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0)
 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. More...
 
 printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafieldsline=0)
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
 
 printOriginLinesList ($restrictlist='')
 Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 printOriginLine ($line, $var, $restrictlist='')
 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). More...
 
 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. More...
 
 delete_resource ($rowid, $element, $notrigger=0)
 Delete a link to resource line. More...
 
 __clone ()
 Overwrite magic function to solve problem of cloning object that are kept as references. More...
 
 addThumbs ($file)
 Build thumb Move this into files.lib.php. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($trigger_name, $user)
 Call trigger based on this instance. More...
 
 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. More...
 
 deleteExtraFields ()
 Delete all extra fields values for the current object. More...
 
 insertExtraFields ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 updateExtraField ($key, $trigger=null, $userused=null)
 Update an extra field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
 
 showOutputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd=0)
 Function to show lines of extrafields with output datas. More...
 
 getRights ()
 Returns the rights used for this class. More...
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
 Get buy price to use for margin calculation. More...
 
 show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $notitle=0, $usesharelink=0)
 Show photos of an object (nbmax maximum), into several columns. More...
 
 isDate ($info)
 Function test if type is date. More...
 
 isInt ($info)
 Function test if type is integer. More...
 
 isFloat ($info)
 Function test if type is float. More...
 
 isText ($info)
 Function test if type is text. More...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null, $morewhere='')
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
 Delete object in database. More...
 
 initAsSpecimenCommon ()
 Initialise object with example values Id must be 0 if object instance is a specimen. More...
 
 fetchComments ()
 Load comments linked with current task. More...
 
 getNbComments ()
 Return nb comments already posted. More...
 
 trimParameters ($parameters)
 Trim object parameters. More...
 

Static Public Member Functions

static replaceThirdparty (DoliDB $db, $origin_id, $dest_id)
 Function used to replace a thirdparty id with another one. More...
 
- Static Public Member Functions inherited from CommonObject
static isExistingObject ($element, $id, $ref='', $ref_ext='')
 Check an object id/ref exists If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch. More...
 
static commonReplaceThirdparty (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 

Public Attributes

 $pass
 Clear password in memory.
 
 $pass_indatabase
 Clear password in database (defined if DATABASE_PWD_ENCRYPTED=0)
 
 $pass_indatabase_crypted
 Encrypted password in database (always defined)
 
 $societe_id
 If this is defined, it is an external user. More...
 
 $contact_id
 
- Public Attributes inherited from CommonObject
 $projet
 
 $note
 

Private Member Functions

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

Additional Inherited Members

- Protected Member Functions inherited from CommonObject
 commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
 Common function for all objects extending CommonObject for generating documents. More...
 
 isArray ($info)
 Function test if type is array. More...
 
 isNull ($info)
 Function test if type is null. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 setSaveQuery ()
 Function to prepare the values to insert. More...
 
 setVarsFromFetchObj (&$obj)
 Function to load data from a SQL pointer into properties of current object $this. More...
 
 getFieldList ()
 Function to concat keys of fields. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage Dolibarr users.

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

Constructor & Destructor Documentation

◆ __construct()

User::__construct (   $db)

Constructor of the class.

Parameters
DoliDb$dbDatabase handler

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

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$infoInfo array loaded by _load_ldap_info
int$mode0=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 2486 of file user.class.php.

◆ _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 Tableau info des attributs

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

◆ addrights()

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

Add a right to the user.

Parameters
int$ridId of permission to add or 0 to add several permissions
string$allmoduleAdd all permissions of module $allmodule
string$allpermsAdd all permissions of module $allmodule, subperms $allperms only
int$entityEntity to use
int$notrigger1=Does not execute triggers, 0=Execute triggers
Returns
int > 0 if OK, < 0 if KO
See also
clearrights, delrights, getrights

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

◆ build_path_from_id_user()

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

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

Function called by get_full_tree().

Parameters
int$id_userid_user entry to update
int$protectionDeep counter to avoid infinite loop (no more required, a protection is added with array useridfound)
Returns
int < 0 if KO (infinit loop), >= 0 if OK

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

References dol_syslog().

◆ clearrights()

User::clearrights ( )

Clear all permissions array of user.

Returns
void
See also
getrights

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

References dol_syslog().

◆ create()

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

Create a user into database.

Parameters
User$userObjet user doing creation
int$notrigger1=do not execute triggers, 0 otherwise
Returns
int <0 if KO, id of created user if OK

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

◆ 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$contactObject for source contact
string$loginLogin to force
string$passwordPassword to force
Returns
int <0 if error, if OK returns id of created user

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

◆ create_from_member()

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

Create a user into database from a member object.

Parameters
Adherent$memberObject member source
string$loginLogin to force
Returns
int <0 if KO, if OK, return id of created account

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

◆ delete()

User::delete ( )

Delete the user.

Returns
int <0 if KO, >0 if OK

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

◆ delrights()

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

Remove a right to the user.

Parameters
int$ridId du droit a retirer
string$allmoduleRetirer tous les droits du module allmodule
string$allpermsRetirer tous les droits du module allmodule, perms allperms
int$entityEntity to use
int$notrigger1=Does not execute triggers, 0=Execute triggers
Returns
int > 0 if OK, < 0 if OK
See also
clearrights, addrights, getrights

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

◆ error()

User::error ( )

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

Returns
string chaine erreur

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

◆ fetch()

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

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

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

Parameters
int$idIf defined, id to used for search
string$loginIf defined, login to used for search
string$sidIf defined, sid to used for search
int$loadpersonalconf1=also load personal conf of user (in $user->conf->xxx), 0=do not load personal conf.
int$entityIf a value is >= 0, we force the search on a specific entity. If -1, means search depens on default setup.
Returns
int <0 if KO, 0 not found, >0 if OK

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

◆ fetch_clicktodial()

User::fetch_clicktodial ( )

Read clicktodial information for user.

Returns
<0 if KO, >0 if OK

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

◆ fetchAll()

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

Load all objects into $this->users.

Parameters
string$sortordersort order
string$sortfieldsort field
int$limitlimit page
int$offsetpage
array$filterFilter array. Example array('field'=>'valueforlike', 'customurl'=>...)
string$filtermodeFilter mode (AND or OR)
Returns
int <0 if KO, >0 if OK

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

◆ generateDocument()

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

Create a document onto disk according to template module.

Parameters
string$modeleForce model to use ('' to not force)
Translate$outputlangsObject langs to use for output
int$hidedetailsHide details of lines
int$hidedescHide description
int$hiderefHide ref
null | array$moreparamsArray to provide more information
Returns
int 0 if KO, 1 if OK

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

◆ get_children()

User::get_children ( )

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

Returns
void
See also
getAllChildIds

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

◆ get_full_tree()

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

Reconstruit l'arborescence hierarchique des users sous la forme d'un tableau Set and return this->users that is an array sorted according to tree with arrays of: id = id user lastname firstname fullname = nom avec chemin complet du user fullpath = chemin complet compose des id: "_grandparentid_parentid_id".

Parameters
int$deleteafteridRemoved all users including the leaf $deleteafterid (and all its child) in user tree.
string$filterSQL filter on users
Returns
array Array of users $this->users. Note: $this->parentof is also set.

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

◆ getAllChildIds()

User::getAllChildIds (   $addcurrentuser = 0)

Return list of all child users id in herarchy (all sublevels).

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

Parameters
int$addcurrentuser1=Add also current user id to the list.
Returns
array Array of user id lower than user (all levels under user). This overwrite this->users.
See also
get_children

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

◆ getLibStatut()

User::getLibStatut (   $mode = 0)

Return label of status of user (active, inactive)

Parameters
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
Returns
string Label of status

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

◆ getLoginUrl()

User::getLoginUrl (   $withpicto = 0,
  $option = '' 
)

Return clickable link of login (eventualy with picto)

Parameters
int$withpictoInclude picto into link
string$optionSur quoi pointe le lien
Returns
string Chaine avec URL

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

◆ getNbOfEMailings()

User::getNbOfEMailings ( )

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

Returns
int Number of EMailings

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

◆ getNbOfUsers()

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

Return number of existing users.

Parameters
string$limitToLimit to '' or 'active'
string$option'superadmin' = return for entity 0 only
int$adminFilter on admin tag
Returns
int Number of users

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

◆ getNomUrl()

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

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

Parameters
int$withpictoimgInclude 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$optionOn what the link point to ('leave', 'nolink', )
integer$infologin0=Add default info tooltip, 1=Add complete info tooltip, -1=No info tooltip
integer$notooltip1=Disable tooltip on picto and name
int$maxlenMax length of visible user name
int$hidethirdpartylogoHide logo of thirdparty if user is external user
string$mode''=Show firstname and lastname, 'firstname'=Show only firstname, 'login'=Show login
string$morecssAdd more css on link
int$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 2250 of file user.class.php.

◆ getPhotoUrl()

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

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

Parameters
int$widthWidth of image
int$heightHeight of image
string$cssclassForce a css class
string$imagesize'mini', 'small' or '' (original)
Returns
string String with URL link

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

◆ getrights()

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

Load permissions granted to user into object user.

Parameters
string$moduletagLimit permission for a particular module ('' by default means load all permissions)
int$forcereloadForce reload of permissions even if they were already loaded (ignore cache)
Returns
void
See also
clearrights, delrights, addrights

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

◆ info()

User::info (   $id)

Load info of user object.

Parameters
int$idId of user to load
Returns
void

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

◆ 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
void

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

◆ LibStatut()

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

Renvoi le libelle d'un statut donne.

Parameters
int$statutId statut
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
Returns
string Label of status

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

◆ load_state_board()

User::load_state_board ( )

Charge indicateurs this->nb pour le tableau de bord.

Returns
int <0 if KO, >0 if OK

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

◆ loadDefaultValues()

User::loadDefaultValues ( )

Load default value in property ->default_values.

Returns
int > 0 if OK, < 0 if KO

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

◆ loadParentOf()

User::loadParentOf ( )
private

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

Returns
int <0 if KO, >0 if OK

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

◆ RemoveFromGroup()

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

Remove a user from a group.

Parameters
int$groupId of group
int$entityEntity
int$notriggerDisable triggers
Returns
int <0 if KO, >0 if OK

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

◆ replaceThirdparty()

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

Function used to replace a thirdparty id with another one.

Parameters
DoliDB$dbDatabase handler
int$origin_idOld thirdparty id
int$dest_idNew thirdparty id
Returns
bool

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

References CommonObject\commonReplaceThirdparty().

◆ send_password()

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

Send new password by email.

Parameters
User$userObject user that send email
string$passwordNew password
int$changelater0=Send clear passwod into email, 1=Change password only after clicking on confirm email. Add method 2 = Send link to reset password
Returns
int < 0 si erreur, > 0 si ok

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

◆ set_default_rights()

User::set_default_rights ( )

Assign rights by default.

Returns
integer erreur <0, si ok renvoi le nbre de droits par defaut positionnes

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

◆ 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
void

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

◆ SetInGroup()

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

Add user into a group.

Parameters
int$groupId of group
int$entityEntity
int$notriggerDisable triggers
Returns
int <0 if KO, >0 if OK

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

◆ setPassword()

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

Change password of a user.

Parameters
User$userObject user of user making change
string$passwordNew password in clear text (to generate if not provided)
int$changelater1=Change password only after clicking on confirm email
int$notrigger1=Does not launch triggers
int$nosyncmemberDo not synchronize linked member
Returns
string If OK return clear password, 0 if no change, < 0 if error

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

◆ setstatus()

User::setstatus (   $statut)

Change status of a user.

Parameters
int$statutStatus to set
Returns
int <0 if KO, 0 if nothing is done, >0 if OK

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

◆ 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$userUser qui fait la mise a jour
int$notrigger1 ne declenche pas les triggers, 0 sinon
int$nosyncmember0=Synchronize linked member (standard info), 1=Do not synchronize linked member
int$nosyncmemberpass0=Synchronize linked member (password), 1=Do not synchronize linked member
int$nosynccontact0=Synchronize linked contact, 1=Do not synchronize linked contact
Returns
int <0 si KO, >=0 si OK

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

◆ update_clicktodial()

User::update_clicktodial ( )

Update clicktodial info.

Returns
integer

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

◆ update_last_login_date()

User::update_last_login_date ( )

Mise a jour en base de la date de derniere connexion d'un utilisateur Fonction appelee lors d'une nouvelle connexion.

Returns
<0 si echec, >=0 si ok

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

◆ update_ldap2dolibarr()

User::update_ldap2dolibarr ( $ldapuser)

Update user using data from the LDAP.

Parameters
ldapuser$ldapuserLadp User
Returns
int <0 if KO, >0 if OK

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

◆ user_get_property()

User::user_get_property (   $rowid,
  $mode 
)

Return property of user from its id.

Parameters
int$rowidid of contact
string$mode'email' or 'mobile'
Returns
string Email of user with format: "Full name <email>"

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

Member Data Documentation

◆ $contact_id

User::$contact_id
Deprecated:
See also
contactid

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

◆ $societe_id

User::$societe_id

If this is defined, it is an external user.

Deprecated:
See also
socid

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


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