Qual: More POO.
Qual: Doxygen
This commit is contained in:
Laurent Destailleur
parent
3e02af4db9
commit
604f454320
@ -58,9 +58,9 @@ class Menubase
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param DoliDB $DB Database handler
|
||||
* @param string $menu_handler Menu handler
|
||||
* @param string $type Type
|
||||
* @param DoliDB $DB Database handler
|
||||
* @param string $menu_handler
|
||||
* @param string $type
|
||||
*/
|
||||
function Menubase($DB,$menu_handler='',$type='')
|
||||
{
|
||||
@ -167,11 +167,10 @@ class Menubase
|
||||
}
|
||||
|
||||
/**
|
||||
* Update menu entry into database.
|
||||
*
|
||||
* @param User $user User that modify
|
||||
* @param int $notrigger 0=no, 1=yes (no update trigger)
|
||||
* @return int <0 if KO, >0 if OK
|
||||
* Update menu entry into database
|
||||
* @param user User that modify
|
||||
* @param notrigger 0=no, 1=yes (no update trigger)
|
||||
* @return int <0 if KO, >0 if OK
|
||||
*/
|
||||
function update($user=0, $notrigger=0)
|
||||
{
|
||||
@ -303,11 +302,10 @@ class Menubase
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Delete object in database
|
||||
*
|
||||
* @param User $user User that delete
|
||||
* @return int <0 if KO, >0 if OK
|
||||
/*
|
||||
* \brief Delete object in database
|
||||
* \param user User that delete
|
||||
* \return int <0 if KO, >0 if OK
|
||||
*/
|
||||
function delete($user)
|
||||
{
|
||||
@ -360,13 +358,12 @@ class Menubase
|
||||
|
||||
|
||||
/**
|
||||
* Complete this->newmenu with menu entry found in $tab
|
||||
* Complete this->newmenu with menu entry found in $tab
|
||||
*
|
||||
* @param array $tab Tab array
|
||||
* @param int $pere Id of parent
|
||||
* @param int $rang Rang
|
||||
* @param string $myleftmenu Value for left that defined leftmenu
|
||||
* @return void
|
||||
* @param $tab
|
||||
* @param $pere
|
||||
* @param $rang
|
||||
* @param $myleftmenu Value for left that defined leftmenu
|
||||
*/
|
||||
function recur($tab, $pere, $rang, $myleftmenu)
|
||||
{
|
||||
@ -403,14 +400,12 @@ class Menubase
|
||||
}
|
||||
|
||||
/**
|
||||
* Load tabMenu array
|
||||
*
|
||||
* @param string $mainmenu Value for mainmenu that defined top menu
|
||||
* @param string $myleftmenu Left menu name
|
||||
* @param int $type_user 0=Internal,1=External,2=All
|
||||
* @param string $menu_handler Name of menu_handler used (auguria, eldy...)
|
||||
* @param array &$tabMenu If array with menu entries already loaded, we put this array here (in most cases, it's empty)
|
||||
* @return array Return array with menu entries for top menu
|
||||
* Load tabMenu array
|
||||
* @param type_user 0=Internal,1=External,2=All
|
||||
* @param mainmenu Value for mainmenu that defined top menu
|
||||
* @param menu_handler Name of menu_handler used (auguria, eldy...)
|
||||
* @param tabMenu If array with menu entries already loaded, we put this array here (in most cases, it's empty)
|
||||
* @return array Return array with menu entries for top menu
|
||||
*/
|
||||
function menuTopCharger($mainmenu, $myleftmenu, $type_user, $menu_handler, &$tabMenu=null)
|
||||
{
|
||||
@ -454,15 +449,14 @@ class Menubase
|
||||
}
|
||||
|
||||
/**
|
||||
* Load entries found in database in a menu array.
|
||||
*
|
||||
* @param array $newmenu Menu array to complete
|
||||
* @param string $mainmenu Value for mainmenu that defined top menu of left menu
|
||||
* @param string $myleftmenu Value that defined leftmenu
|
||||
* @param int $type_user 0=Internal,1=External,2=All
|
||||
* @param string $menu_handler Name of menu_handler used (auguria, eldy...)
|
||||
* @param array &$tabMenu If array with menu entries already loaded, we put this array here (in most cases, it's empty)
|
||||
* @return array Menu array for particular mainmenu value or full tabArray
|
||||
* Load entries found in database in a menu array
|
||||
* @param $newmenu Menu array to complete
|
||||
* @param $mainmenu Value for mainmenu that defined top menu of left menu
|
||||
* @param $myleftmenu Value that defined leftmenu
|
||||
* @param $type_user 0=Internal,1=External,2=All
|
||||
* @param $menu_handler Name of menu_handler used (auguria, eldy...)
|
||||
* @param $tabMenu If array with menu entries already loaded, we put this array here (in most cases, it's empty)
|
||||
* @return array Menu array for particular mainmenu value or full tabArray
|
||||
*/
|
||||
function menuLeftCharger($newmenu, $mainmenu, $myleftmenu, $type_user, $menu_handler, &$tabMenu=null)
|
||||
{
|
||||
@ -502,13 +496,12 @@ class Menubase
|
||||
|
||||
|
||||
/**
|
||||
* Load entries found in database in a menu array.
|
||||
*
|
||||
* @param string $myleftmenu Value for left that defined leftmenu
|
||||
* @param int $type_user 0=Internal,1=External,2=All
|
||||
* @param string $menu_handler Name of menu_handler used (auguria, eldy...)
|
||||
* @param array &$tabMenu If array with menu entries already load, we put this array here (in most cases, it's empty)
|
||||
* @return int >0 if OK, <0 if KO
|
||||
* Load entries found in database in a menu array
|
||||
* @param $myleftmenu Value for left that defined leftmenu
|
||||
* @param $type_user 0=Internal,1=External,2=All
|
||||
* @param $menu_handler Name of menu_handler used (auguria, eldy...)
|
||||
* @param $tabMenu If array with menu entries already load, we put this array here (in most cases, it's empty)
|
||||
* @return int >0 if OK, <0 if KO
|
||||
*/
|
||||
function menuLoad($myleftmenu, $type_user, $menu_handler, &$tabMenu=array())
|
||||
{
|
||||
|
||||
@ -116,11 +116,11 @@ class User extends CommonObject
|
||||
/**
|
||||
* Load a user from database with its id or ref (login)
|
||||
*
|
||||
* @param int $id Si defini, id a utiliser pour recherche
|
||||
* @param string $login Si defini, login a utiliser pour recherche
|
||||
* @param strinf $sid Si defini, sid a utiliser pour recherche
|
||||
* @param int $loadpersonalconf Also load personal conf of user (in $user->conf->xxx)
|
||||
* @return int <0 if KO, 0 not found, >0 if OK
|
||||
* @param id Si defini, id a utiliser pour recherche
|
||||
* @param login Si defini, login a utiliser pour recherche
|
||||
* @param sid Si defini, sid a utiliser pour recherche
|
||||
* @param $loadpersonalconf Also load personal conf of user (in $user->conf->xxx)
|
||||
* @return int <0 if KO, 0 not found, >0 if OK
|
||||
*/
|
||||
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 int $rid id du droit a ajouter
|
||||
* @param string $allmodule Ajouter tous les droits du module allmodule
|
||||
* @param string $allperms Ajouter tous les droits du module allmodule, perms allperms
|
||||
* @return int > 0 si ok, < 0 si erreur
|
||||
* @param rid id du droit a ajouter
|
||||
* @param allmodule Ajouter tous les droits du module allmodule
|
||||
* @param allperms Ajouter tous les droits du module allmodule, perms allperms
|
||||
* @return int > 0 si ok, < 0 si erreur
|
||||
*/
|
||||
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 int $rid Id du droit a retirer
|
||||
* @param string $allmodule Retirer tous les droits du module allmodule
|
||||
* @param string $allperms Retirer tous les droits du module allmodule, perms allperms
|
||||
* @return int > 0 si ok, < 0 si erreur
|
||||
* @param rid id du droit a retirer
|
||||
* @param allmodule Retirer tous les droits du module allmodule
|
||||
* @param allperms Retirer tous les droits du module allmodule, perms allperms
|
||||
* @return int > 0 si ok, < 0 si erreur
|
||||
*/
|
||||
function delrights($rid,$allmodule='',$allperms='')
|
||||
{
|
||||
@ -462,9 +462,7 @@ class User extends CommonObject
|
||||
|
||||
|
||||
/**
|
||||
* Clear all permissions array of user
|
||||
*
|
||||
* @return void
|
||||
* Clear all permissions array of user
|
||||
*/
|
||||
function clearrights()
|
||||
{
|
||||
@ -478,8 +476,7 @@ class User extends CommonObject
|
||||
/**
|
||||
* Load permissions granted to user into object user
|
||||
*
|
||||
* @param string $moduletag Limit permission for a particular module ('' by default means load all permissions)
|
||||
* @return void
|
||||
* @param moduletag Limit permission for a particular module ('' by default means load all permissions)
|
||||
*/
|
||||
function getrights($moduletag='')
|
||||
{
|
||||
@ -600,10 +597,9 @@ class User extends CommonObject
|
||||
}
|
||||
|
||||
/**
|
||||
* Change status of a user
|
||||
* Change status of a user
|
||||
*
|
||||
* @param int $statut Status to set
|
||||
* @return int <0 if KO, 0 if nothing is done, >0 if OK
|
||||
* @return int <0 if KO, 0 if nothing is done, >0 if OK
|
||||
*/
|
||||
function setstatus($statut)
|
||||
{
|
||||
@ -710,9 +706,9 @@ class User extends CommonObject
|
||||
/**
|
||||
* Create a user into database
|
||||
*
|
||||
* @param User $user Objet user qui demande la creation
|
||||
* @param int $notrigger 1 ne declenche pas les triggers, 0 sinon
|
||||
* @return int <0 si KO, id compte cree si OK
|
||||
* @param user Objet user qui demande la creation
|
||||
* @param notrigger 1 ne declenche pas les triggers, 0 sinon
|
||||
* @return int <0 si KO, id compte cree si OK
|
||||
*/
|
||||
function create($user,$notrigger=0)
|
||||
{
|
||||
@ -836,12 +832,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 $contact Object for source contact
|
||||
* @param string $login Login to force
|
||||
* @param string $password Password to force
|
||||
* @return int <0 if error, if OK returns id of created user
|
||||
* @param contact Object for source contact
|
||||
* @param login Login to force
|
||||
* @param password Password to force
|
||||
* @return int <0 if error, if OK returns id of created user
|
||||
*/
|
||||
function create_from_contact($contact,$login='',$password='')
|
||||
{
|
||||
@ -904,11 +900,11 @@ class User extends CommonObject
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a user into database from a member object
|
||||
* Create a user into database from a member object
|
||||
*
|
||||
* @param Adherent $member Object member source
|
||||
* @param string $login Login to force
|
||||
* @return int <0 if KO, if OK, return id of created account
|
||||
* @param member Object member source
|
||||
* @param login Login to force
|
||||
* @return int <0 if KO, if OK, return id of created account
|
||||
*/
|
||||
function create_from_member($member,$login='')
|
||||
{
|
||||
@ -1009,11 +1005,11 @@ class User extends CommonObject
|
||||
/**
|
||||
* Update a user into databse (and also password if this->pass is defined)
|
||||
*
|
||||
* @param User $user User qui fait la mise a jour
|
||||
* @param int $notrigger 1 ne declenche pas les triggers, 0 sinon
|
||||
* @param int $nosyncmember 0=Synchronize linked member (standard info), 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
|
||||
* @param user User qui fait la mise a jour
|
||||
* @param notrigger 1 ne declenche pas les triggers, 0 sinon
|
||||
* @param 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
|
||||
* @return int <0 si KO, >=0 si OK
|
||||
*/
|
||||
function update($user,$notrigger=0,$nosyncmember=0,$nosyncmemberpass=0)
|
||||
{
|
||||
@ -1202,7 +1198,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.= " 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);
|
||||
if ($resql)
|
||||
{
|
||||
@ -1221,12 +1217,12 @@ class User extends CommonObject
|
||||
/**
|
||||
* Change password of a user
|
||||
*
|
||||
* @param User $user Object user of user making change
|
||||
* @param string $password New password in clear text (to generate if not provided)
|
||||
* @param int $changelater 1=Change password only after clicking on confirm email
|
||||
* @param int $notrigger 1=Does not launch triggers
|
||||
* @param int $nosyncmember Do not synchronize linked member
|
||||
* @return string If OK return clear password, 0 if no change, < 0 if error
|
||||
* @param user Object user of user making change
|
||||
* @param password New password in clear text (to generate if not provided)
|
||||
* @param changelater 1=Change password only after clicking on confirm email
|
||||
* @param notrigger 1=Does not launch triggers
|
||||
* @param nosyncmember Do not synchronize linked member
|
||||
* @return string If OK return clear password, 0 if no change, < 0 if error
|
||||
*/
|
||||
function setPassword($user, $password='', $changelater=0, $notrigger=0, $nosyncmember=0)
|
||||
{
|
||||
@ -1348,12 +1344,12 @@ class User extends CommonObject
|
||||
|
||||
|
||||
/**
|
||||
* Envoie mot de passe par mail
|
||||
* Envoie mot de passe par mail
|
||||
*
|
||||
* @param User $user Object user de l'utilisateur qui fait l'envoi
|
||||
* @param string $password Nouveau mot de passe
|
||||
* @param int $changelater 1=Change password only after clicking on confirm email
|
||||
* @return int < 0 si erreur, > 0 si ok
|
||||
* @param user Object user de l'utilisateur qui fait l'envoi
|
||||
* @param password Nouveau mot de passe
|
||||
* @param changelater 1=Change password only after clicking on confirm email
|
||||
* @return int < 0 si erreur, > 0 si ok
|
||||
*/
|
||||
function send_password($user, $password='', $changelater=0)
|
||||
{
|
||||
@ -1415,19 +1411,8 @@ class User extends CommonObject
|
||||
$mesg.= "If you didn't ask anything, just forget this email\n\n";
|
||||
dol_syslog("User::send_password url=".$url);
|
||||
}
|
||||
$mailfile = new CMailFile(
|
||||
$subject,
|
||||
$this->email,
|
||||
$conf->notification->email_from,
|
||||
$mesg,
|
||||
array(),
|
||||
array(),
|
||||
array(),
|
||||
'',
|
||||
'',
|
||||
0,
|
||||
$msgishtml
|
||||
);
|
||||
$mailfile = new CMailFile($subject,$this->email,$conf->notification->email_from,$mesg,
|
||||
array(),array(),array(),'', '', 0, $msgishtml);
|
||||
|
||||
if ($mailfile->sendfile())
|
||||
{
|
||||
@ -1488,9 +1473,7 @@ class User extends CommonObject
|
||||
}
|
||||
|
||||
/**
|
||||
* Update clicktodial info
|
||||
*
|
||||
* @return void
|
||||
* Update clicktodial info
|
||||
*/
|
||||
function update_clicktodial()
|
||||
{
|
||||
@ -1525,12 +1508,12 @@ class User extends CommonObject
|
||||
|
||||
|
||||
/**
|
||||
* Add user into a group
|
||||
* Add user into a group
|
||||
*
|
||||
* @param Group $group Id of group
|
||||
* @param int $entity Entity
|
||||
* @param int $notrigger Disable triggers
|
||||
* @return int <0 if KO, >0 if OK
|
||||
* @param group Id of group
|
||||
* @param entity Entity
|
||||
* @param notrigger Disable triggers
|
||||
* @return int <0 if KO, >0 if OK
|
||||
*/
|
||||
function SetInGroup($group, $entity, $notrigger=0)
|
||||
{
|
||||
@ -1586,12 +1569,12 @@ class User extends CommonObject
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove a user from a group
|
||||
* Remove a user from a group
|
||||
*
|
||||
* @param Group $group Id of group
|
||||
* @param int $entity Entity
|
||||
* @param int $notrigger Disable triggers
|
||||
* @return int <0 if KO, >0 if OK
|
||||
* @param group Id of group
|
||||
* @param entity Entity
|
||||
* @param notrigger Disable triggers
|
||||
* @return int <0 if KO, >0 if OK
|
||||
*/
|
||||
function RemoveFromGroup($group, $entity, $notrigger=0)
|
||||
{
|
||||
@ -1642,12 +1625,12 @@ class User extends CommonObject
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a link to the user card (with optionnaly the picto)
|
||||
* Use this->id,this->nom, this->prenom
|
||||
* Return a link to the user card (with optionnaly the picto)
|
||||
* Use this->id,this->nom, this->prenom
|
||||
*
|
||||
* @param int $withpicto Include picto in link (0=No picto, 1=Inclut le picto dans le lien, 2=Picto seul)
|
||||
* @param string $option On what the link point to
|
||||
* @return string String with URL
|
||||
* @param 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
|
||||
* @return string String with URL
|
||||
*/
|
||||
function getNomUrl($withpicto=0,$option='')
|
||||
{
|
||||
@ -1671,11 +1654,11 @@ class User extends CommonObject
|
||||
}
|
||||
|
||||
/**
|
||||
* Renvoie login clicable (avec eventuellement le picto)
|
||||
* Renvoie login clicable (avec eventuellement le picto)
|
||||
*
|
||||
* @param int $withpicto Inclut le picto dans le lien
|
||||
* @param string $option Sur quoi pointe le lien
|
||||
* @return string Chaine avec URL
|
||||
* @param withpicto Inclut le picto dans le lien
|
||||
* @param option Sur quoi pointe le lien
|
||||
* @return string Chaine avec URL
|
||||
*/
|
||||
function getLoginUrl($withpicto=0,$option='')
|
||||
{
|
||||
@ -1698,12 +1681,12 @@ class User extends CommonObject
|
||||
}
|
||||
|
||||
/**
|
||||
* Return full name (civility+' '+name+' '+lastname)
|
||||
* Return full name (civility+' '+name+' '+lastname)
|
||||
*
|
||||
* @param Translate $langs Language object for translation of civility
|
||||
* @param int $option 0=No option, 1=Add civility
|
||||
* @param int $nameorder -1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname
|
||||
* @return string String with full name
|
||||
* @param langs Language object for translation of civility
|
||||
* @param option 0=No option, 1=Add civility
|
||||
* @param nameorder -1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname
|
||||
* @return string String with full name
|
||||
*/
|
||||
function getFullName($langs,$option=0,$nameorder=-1)
|
||||
{
|
||||
@ -1737,10 +1720,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 int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long
|
||||
* @return string Label of status
|
||||
* @param mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long
|
||||
* @return string Label of status
|
||||
*/
|
||||
function getLibStatut($mode=0)
|
||||
{
|
||||
@ -1748,11 +1731,11 @@ class User extends CommonObject
|
||||
}
|
||||
|
||||
/**
|
||||
* Renvoi le libelle d'un statut donne
|
||||
* Renvoi le libelle d'un statut donne
|
||||
*
|
||||
* @param int $statut Id statut
|
||||
* @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
|
||||
* @param 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
|
||||
* @return string Label of status
|
||||
*/
|
||||
function LibStatut($statut,$mode=0)
|
||||
{
|
||||
@ -1796,11 +1779,11 @@ class User extends CommonObject
|
||||
/**
|
||||
* Retourne chaine DN complete dans l'annuaire LDAP pour l'objet
|
||||
*
|
||||
* @param string $info Info string loaded by _load_ldap_info
|
||||
* @param int $mode 0=Return full DN (uid=qqq,ou=xxx,dc=aaa,dc=bbb)
|
||||
* 1=
|
||||
* 2=Return key only (uid=qqq)
|
||||
* @return string DN
|
||||
* @param info Info string loaded by _load_ldap_info
|
||||
* @param mode 0=Return full DN (uid=qqq,ou=xxx,dc=aaa,dc=bbb)
|
||||
* 1=
|
||||
* 2=Return key only (uid=qqq)
|
||||
* @return string DN
|
||||
*/
|
||||
function _load_ldap_dn($info,$mode=0)
|
||||
{
|
||||
@ -1922,10 +1905,9 @@ class User extends CommonObject
|
||||
}
|
||||
|
||||
/**
|
||||
* Load info of user object
|
||||
* Load info of user object
|
||||
*
|
||||
* @param int $id Id of user to load
|
||||
* @return void
|
||||
* @param id id of user to load
|
||||
*/
|
||||
function info($id)
|
||||
{
|
||||
@ -1987,10 +1969,10 @@ class User extends CommonObject
|
||||
}
|
||||
|
||||
/**
|
||||
* Return number of existing users
|
||||
* Return number of existing users
|
||||
*
|
||||
* @param string $limitTo Limit to 'active' or 'superadmin' users
|
||||
* @return int Number of users
|
||||
* @param limitTo limit to 'active' or 'superadmin' users
|
||||
* @return int Number of users
|
||||
*/
|
||||
function getNbOfUsers($limitTo='')
|
||||
{
|
||||
|
||||
Loading…
Reference in New Issue
Block a user