Qual: More POO.
Qual: Doxygen
This commit is contained in:
Laurent Destailleur
parent
604f454320
commit
35913a1c19
@ -116,11 +116,11 @@ class User extends CommonObject
|
|||||||
/**
|
/**
|
||||||
* Load a user from database with its id or ref (login)
|
* Load a user from database with its id or ref (login)
|
||||||
*
|
*
|
||||||
* @param id Si defini, id a utiliser pour recherche
|
* @param int $id Si defini, id a utiliser pour recherche
|
||||||
* @param login Si defini, login a utiliser pour recherche
|
* @param string $login Si defini, login a utiliser pour recherche
|
||||||
* @param sid Si defini, sid a utiliser pour recherche
|
* @param strinf $sid Si defini, sid a utiliser pour recherche
|
||||||
* @param $loadpersonalconf Also load personal conf of user (in $user->conf->xxx)
|
* @param int $loadpersonalconf Also load personal conf of user (in $user->conf->xxx)
|
||||||
* @return int <0 if KO, 0 not found, >0 if OK
|
* @return int <0 if KO, 0 not found, >0 if OK
|
||||||
*/
|
*/
|
||||||
function fetch($id='', $login='',$sid='',$loadpersonalconf=1)
|
function fetch($id='', $login='',$sid='',$loadpersonalconf=1)
|
||||||
{
|
{
|
||||||
@ -267,12 +267,12 @@ class User extends CommonObject
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Ajoute un droit a l'utilisateur
|
* Ajoute un droit a l'utilisateur
|
||||||
*
|
*
|
||||||
* @param rid id du droit a ajouter
|
* @param int $rid id du droit a ajouter
|
||||||
* @param allmodule Ajouter tous les droits du module allmodule
|
* @param string $allmodule Ajouter tous les droits du module allmodule
|
||||||
* @param allperms Ajouter tous les droits du module allmodule, perms allperms
|
* @param string $allperms Ajouter tous les droits du module allmodule, perms allperms
|
||||||
* @return int > 0 si ok, < 0 si erreur
|
* @return int > 0 si ok, < 0 si erreur
|
||||||
*/
|
*/
|
||||||
function addrights($rid,$allmodule='',$allperms='')
|
function addrights($rid,$allmodule='',$allperms='')
|
||||||
{
|
{
|
||||||
@ -366,12 +366,12 @@ class User extends CommonObject
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retire un droit a l'utilisateur
|
* Retire un droit a l'utilisateur
|
||||||
*
|
*
|
||||||
* @param rid id du droit a retirer
|
* @param int $rid Id du droit a retirer
|
||||||
* @param allmodule Retirer tous les droits du module allmodule
|
* @param string $allmodule Retirer tous les droits du module allmodule
|
||||||
* @param allperms Retirer tous les droits du module allmodule, perms allperms
|
* @param string $allperms Retirer tous les droits du module allmodule, perms allperms
|
||||||
* @return int > 0 si ok, < 0 si erreur
|
* @return int > 0 si ok, < 0 si erreur
|
||||||
*/
|
*/
|
||||||
function delrights($rid,$allmodule='',$allperms='')
|
function delrights($rid,$allmodule='',$allperms='')
|
||||||
{
|
{
|
||||||
@ -462,7 +462,9 @@ class User extends CommonObject
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Clear all permissions array of user
|
* Clear all permissions array of user
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
*/
|
*/
|
||||||
function clearrights()
|
function clearrights()
|
||||||
{
|
{
|
||||||
@ -476,7 +478,8 @@ class User extends CommonObject
|
|||||||
/**
|
/**
|
||||||
* Load permissions granted to user into object user
|
* Load permissions granted to user into object user
|
||||||
*
|
*
|
||||||
* @param moduletag Limit permission for a particular module ('' by default means load all permissions)
|
* @param string $moduletag Limit permission for a particular module ('' by default means load all permissions)
|
||||||
|
* @return void
|
||||||
*/
|
*/
|
||||||
function getrights($moduletag='')
|
function getrights($moduletag='')
|
||||||
{
|
{
|
||||||
@ -597,9 +600,10 @@ class User extends CommonObject
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Change status of a user
|
* Change status of a user
|
||||||
*
|
*
|
||||||
* @return int <0 if KO, 0 if nothing is done, >0 if OK
|
* @param int $statut Status to set
|
||||||
|
* @return int <0 if KO, 0 if nothing is done, >0 if OK
|
||||||
*/
|
*/
|
||||||
function setstatus($statut)
|
function setstatus($statut)
|
||||||
{
|
{
|
||||||
@ -706,9 +710,9 @@ class User extends CommonObject
|
|||||||
/**
|
/**
|
||||||
* Create a user into database
|
* Create a user into database
|
||||||
*
|
*
|
||||||
* @param user Objet user qui demande la creation
|
* @param User $user Objet user qui demande la creation
|
||||||
* @param notrigger 1 ne declenche pas les triggers, 0 sinon
|
* @param int $notrigger 1 ne declenche pas les triggers, 0 sinon
|
||||||
* @return int <0 si KO, id compte cree si OK
|
* @return int <0 si KO, id compte cree si OK
|
||||||
*/
|
*/
|
||||||
function create($user,$notrigger=0)
|
function create($user,$notrigger=0)
|
||||||
{
|
{
|
||||||
@ -832,12 +836,12 @@ class User extends CommonObject
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a user from a contact object. User will be internal but if contact is linked to a third party, user will be external
|
* Create a user from a contact object. User will be internal but if contact is linked to a third party, user will be external
|
||||||
*
|
*
|
||||||
* @param contact Object for source contact
|
* @param Contact $contact Object for source contact
|
||||||
* @param login Login to force
|
* @param string $login Login to force
|
||||||
* @param password Password to force
|
* @param string $password Password to force
|
||||||
* @return int <0 if error, if OK returns id of created user
|
* @return int <0 if error, if OK returns id of created user
|
||||||
*/
|
*/
|
||||||
function create_from_contact($contact,$login='',$password='')
|
function create_from_contact($contact,$login='',$password='')
|
||||||
{
|
{
|
||||||
@ -900,11 +904,11 @@ class User extends CommonObject
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a user into database from a member object
|
* Create a user into database from a member object
|
||||||
*
|
*
|
||||||
* @param member Object member source
|
* @param Adherent $member Object member source
|
||||||
* @param login Login to force
|
* @param string $login Login to force
|
||||||
* @return int <0 if KO, if OK, return id of created account
|
* @return int <0 if KO, if OK, return id of created account
|
||||||
*/
|
*/
|
||||||
function create_from_member($member,$login='')
|
function create_from_member($member,$login='')
|
||||||
{
|
{
|
||||||
@ -1005,11 +1009,11 @@ class User extends CommonObject
|
|||||||
/**
|
/**
|
||||||
* Update a user into databse (and also password if this->pass is defined)
|
* Update a user into databse (and also password if this->pass is defined)
|
||||||
*
|
*
|
||||||
* @param user User qui fait la mise a jour
|
* @param User $user User qui fait la mise a jour
|
||||||
* @param notrigger 1 ne declenche pas les triggers, 0 sinon
|
* @param int $notrigger 1 ne declenche pas les triggers, 0 sinon
|
||||||
* @param nosyncmember 0=Synchronize linked member (standard info), 1=Do not synchronize linked member
|
* @param int $nosyncmember 0=Synchronize linked member (standard info), 1=Do not synchronize linked member
|
||||||
* @param nosyncmemberpass 0=Synchronize linked member (password), 1=Do not synchronize linked member
|
* @param int $nosyncmemberpass 0=Synchronize linked member (password), 1=Do not synchronize linked member
|
||||||
* @return int <0 si KO, >=0 si OK
|
* @return int <0 si KO, >=0 si OK
|
||||||
*/
|
*/
|
||||||
function update($user,$notrigger=0,$nosyncmember=0,$nosyncmemberpass=0)
|
function update($user,$notrigger=0,$nosyncmember=0,$nosyncmemberpass=0)
|
||||||
{
|
{
|
||||||
@ -1198,7 +1202,7 @@ class User extends CommonObject
|
|||||||
$sql.= " tms = tms"; // La date de derniere modif doit changer sauf pour la mise a jour de date de derniere connexion
|
$sql.= " tms = tms"; // La date de derniere modif doit changer sauf pour la mise a jour de date de derniere connexion
|
||||||
$sql.= " WHERE rowid = ".$this->id;
|
$sql.= " WHERE rowid = ".$this->id;
|
||||||
|
|
||||||
dol_syslog ("Update last login date for user->id=".$this->id." ".$sql, LOG_DEBUG);
|
dol_syslog("Update last login date for user->id=".$this->id." ".$sql, LOG_DEBUG);
|
||||||
$resql = $this->db->query($sql);
|
$resql = $this->db->query($sql);
|
||||||
if ($resql)
|
if ($resql)
|
||||||
{
|
{
|
||||||
@ -1217,12 +1221,12 @@ class User extends CommonObject
|
|||||||
/**
|
/**
|
||||||
* Change password of a user
|
* Change password of a user
|
||||||
*
|
*
|
||||||
* @param user Object user of user making change
|
* @param User $user Object user of user making change
|
||||||
* @param password New password in clear text (to generate if not provided)
|
* @param string $password New password in clear text (to generate if not provided)
|
||||||
* @param changelater 1=Change password only after clicking on confirm email
|
* @param int $changelater 1=Change password only after clicking on confirm email
|
||||||
* @param notrigger 1=Does not launch triggers
|
* @param int $notrigger 1=Does not launch triggers
|
||||||
* @param nosyncmember Do not synchronize linked member
|
* @param int $nosyncmember Do not synchronize linked member
|
||||||
* @return string If OK return clear password, 0 if no change, < 0 if error
|
* @return string If OK return clear password, 0 if no change, < 0 if error
|
||||||
*/
|
*/
|
||||||
function setPassword($user, $password='', $changelater=0, $notrigger=0, $nosyncmember=0)
|
function setPassword($user, $password='', $changelater=0, $notrigger=0, $nosyncmember=0)
|
||||||
{
|
{
|
||||||
@ -1344,12 +1348,12 @@ class User extends CommonObject
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Envoie mot de passe par mail
|
* Envoie mot de passe par mail
|
||||||
*
|
*
|
||||||
* @param user Object user de l'utilisateur qui fait l'envoi
|
* @param User $user Object user de l'utilisateur qui fait l'envoi
|
||||||
* @param password Nouveau mot de passe
|
* @param string $password Nouveau mot de passe
|
||||||
* @param changelater 1=Change password only after clicking on confirm email
|
* @param int $changelater 1=Change password only after clicking on confirm email
|
||||||
* @return int < 0 si erreur, > 0 si ok
|
* @return int < 0 si erreur, > 0 si ok
|
||||||
*/
|
*/
|
||||||
function send_password($user, $password='', $changelater=0)
|
function send_password($user, $password='', $changelater=0)
|
||||||
{
|
{
|
||||||
@ -1411,8 +1415,19 @@ class User extends CommonObject
|
|||||||
$mesg.= "If you didn't ask anything, just forget this email\n\n";
|
$mesg.= "If you didn't ask anything, just forget this email\n\n";
|
||||||
dol_syslog("User::send_password url=".$url);
|
dol_syslog("User::send_password url=".$url);
|
||||||
}
|
}
|
||||||
$mailfile = new CMailFile($subject,$this->email,$conf->notification->email_from,$mesg,
|
$mailfile = new CMailFile(
|
||||||
array(),array(),array(),'', '', 0, $msgishtml);
|
$subject,
|
||||||
|
$this->email,
|
||||||
|
$conf->notification->email_from,
|
||||||
|
$mesg,
|
||||||
|
array(),
|
||||||
|
array(),
|
||||||
|
array(),
|
||||||
|
'',
|
||||||
|
'',
|
||||||
|
0,
|
||||||
|
$msgishtml
|
||||||
|
);
|
||||||
|
|
||||||
if ($mailfile->sendfile())
|
if ($mailfile->sendfile())
|
||||||
{
|
{
|
||||||
@ -1473,7 +1488,9 @@ class User extends CommonObject
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Update clicktodial info
|
* Update clicktodial info
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
*/
|
*/
|
||||||
function update_clicktodial()
|
function update_clicktodial()
|
||||||
{
|
{
|
||||||
@ -1508,12 +1525,12 @@ class User extends CommonObject
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Add user into a group
|
* Add user into a group
|
||||||
*
|
*
|
||||||
* @param group Id of group
|
* @param Group $group Id of group
|
||||||
* @param entity Entity
|
* @param int $entity Entity
|
||||||
* @param notrigger Disable triggers
|
* @param int $notrigger Disable triggers
|
||||||
* @return int <0 if KO, >0 if OK
|
* @return int <0 if KO, >0 if OK
|
||||||
*/
|
*/
|
||||||
function SetInGroup($group, $entity, $notrigger=0)
|
function SetInGroup($group, $entity, $notrigger=0)
|
||||||
{
|
{
|
||||||
@ -1569,12 +1586,12 @@ class User extends CommonObject
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Remove a user from a group
|
* Remove a user from a group
|
||||||
*
|
*
|
||||||
* @param group Id of group
|
* @param Group $group Id of group
|
||||||
* @param entity Entity
|
* @param int $entity Entity
|
||||||
* @param notrigger Disable triggers
|
* @param int $notrigger Disable triggers
|
||||||
* @return int <0 if KO, >0 if OK
|
* @return int <0 if KO, >0 if OK
|
||||||
*/
|
*/
|
||||||
function RemoveFromGroup($group, $entity, $notrigger=0)
|
function RemoveFromGroup($group, $entity, $notrigger=0)
|
||||||
{
|
{
|
||||||
@ -1625,12 +1642,12 @@ class User extends CommonObject
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return a link to the user card (with optionnaly the picto)
|
* Return a link to the user card (with optionnaly the picto)
|
||||||
* Use this->id,this->nom, this->prenom
|
* Use this->id,this->nom, this->prenom
|
||||||
*
|
*
|
||||||
* @param withpicto Include picto in link (0=No picto, 1=Inclut le picto dans le lien, 2=Picto seul)
|
* @param int $withpicto Include picto in link (0=No picto, 1=Inclut le picto dans le lien, 2=Picto seul)
|
||||||
* @param option On what the link point to
|
* @param string $option On what the link point to
|
||||||
* @return string String with URL
|
* @return string String with URL
|
||||||
*/
|
*/
|
||||||
function getNomUrl($withpicto=0,$option='')
|
function getNomUrl($withpicto=0,$option='')
|
||||||
{
|
{
|
||||||
@ -1654,11 +1671,11 @@ class User extends CommonObject
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Renvoie login clicable (avec eventuellement le picto)
|
* Renvoie login clicable (avec eventuellement le picto)
|
||||||
*
|
*
|
||||||
* @param withpicto Inclut le picto dans le lien
|
* @param int $withpicto Inclut le picto dans le lien
|
||||||
* @param option Sur quoi pointe le lien
|
* @param string $option Sur quoi pointe le lien
|
||||||
* @return string Chaine avec URL
|
* @return string Chaine avec URL
|
||||||
*/
|
*/
|
||||||
function getLoginUrl($withpicto=0,$option='')
|
function getLoginUrl($withpicto=0,$option='')
|
||||||
{
|
{
|
||||||
@ -1681,12 +1698,12 @@ class User extends CommonObject
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return full name (civility+' '+name+' '+lastname)
|
* Return full name (civility+' '+name+' '+lastname)
|
||||||
*
|
*
|
||||||
* @param langs Language object for translation of civility
|
* @param Translate $langs Language object for translation of civility
|
||||||
* @param option 0=No option, 1=Add civility
|
* @param int $option 0=No option, 1=Add civility
|
||||||
* @param nameorder -1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname
|
* @param int $nameorder -1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname
|
||||||
* @return string String with full name
|
* @return string String with full name
|
||||||
*/
|
*/
|
||||||
function getFullName($langs,$option=0,$nameorder=-1)
|
function getFullName($langs,$option=0,$nameorder=-1)
|
||||||
{
|
{
|
||||||
@ -1720,10 +1737,10 @@ class User extends CommonObject
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retourne le libelle du statut d'un user (actif, inactif)
|
* Retourne le libelle du statut d'un user (actif, inactif)
|
||||||
*
|
*
|
||||||
* @param mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long
|
* @param int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long
|
||||||
* @return string Label of status
|
* @return string Label of status
|
||||||
*/
|
*/
|
||||||
function getLibStatut($mode=0)
|
function getLibStatut($mode=0)
|
||||||
{
|
{
|
||||||
@ -1731,11 +1748,11 @@ class User extends CommonObject
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Renvoi le libelle d'un statut donne
|
* Renvoi le libelle d'un statut donne
|
||||||
*
|
*
|
||||||
* @param statut Id statut
|
* @param int $statut Id statut
|
||||||
* @param mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
|
* @param int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
|
||||||
* @return string Label of status
|
* @return string Label of status
|
||||||
*/
|
*/
|
||||||
function LibStatut($statut,$mode=0)
|
function LibStatut($statut,$mode=0)
|
||||||
{
|
{
|
||||||
@ -1779,11 +1796,11 @@ class User extends CommonObject
|
|||||||
/**
|
/**
|
||||||
* Retourne chaine DN complete dans l'annuaire LDAP pour l'objet
|
* Retourne chaine DN complete dans l'annuaire LDAP pour l'objet
|
||||||
*
|
*
|
||||||
* @param info Info string loaded by _load_ldap_info
|
* @param string $info Info string loaded by _load_ldap_info
|
||||||
* @param mode 0=Return full DN (uid=qqq,ou=xxx,dc=aaa,dc=bbb)
|
* @param int $mode 0=Return full DN (uid=qqq,ou=xxx,dc=aaa,dc=bbb)
|
||||||
* 1=
|
* 1=
|
||||||
* 2=Return key only (uid=qqq)
|
* 2=Return key only (uid=qqq)
|
||||||
* @return string DN
|
* @return string DN
|
||||||
*/
|
*/
|
||||||
function _load_ldap_dn($info,$mode=0)
|
function _load_ldap_dn($info,$mode=0)
|
||||||
{
|
{
|
||||||
@ -1905,9 +1922,10 @@ class User extends CommonObject
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Load info of user object
|
* Load info of user object
|
||||||
*
|
*
|
||||||
* @param id id of user to load
|
* @param int $id Id of user to load
|
||||||
|
* @return void
|
||||||
*/
|
*/
|
||||||
function info($id)
|
function info($id)
|
||||||
{
|
{
|
||||||
@ -1969,10 +1987,10 @@ class User extends CommonObject
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return number of existing users
|
* Return number of existing users
|
||||||
*
|
*
|
||||||
* @param limitTo limit to 'active' or 'superadmin' users
|
* @param string $limitTo Limit to 'active' or 'superadmin' users
|
||||||
* @return int Number of users
|
* @return int Number of users
|
||||||
*/
|
*/
|
||||||
function getNbOfUsers($limitTo='')
|
function getNbOfUsers($limitTo='')
|
||||||
{
|
{
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user