lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2011-12-28 13:25:05 +01:00
parent 8a83b273ef
commit bb3d9e9197
5 changed files with 158 additions and 134 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
htdocs/adherents/admin/public.php
View File

@ -1,8 +1,8 @@
<?php <?php
/* Copyright (C) 2001-2002 Rodolphe Quiedeville <rodolphe@quiedeville.org> /* Copyright (C) 2001-2002 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2006-2010 Laurent Destailleur <eldy@users.sourceforge.net> * Copyright (C) 2006-2011 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2011 Juanjo Menent <jmenent@2byte.es> * Copyright (C) 2011 Juanjo Menent <jmenent@2byte.es>
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or * the Free Software Foundation; either version 2 of the License, or
@ -34,6 +34,8 @@ $langs->load("admin");
$action=GETPOST('action'); $action=GETPOST('action');
if (! $user->admin) accessforbidden();
/* /*
* Actions * Actions
@ -45,7 +47,7 @@ if ($action == 'update')
$res=dolibarr_set_const($db, "MEMBER_NEWFORM_AMOUNT",$_POST["MEMBER_NEWFORM_AMOUNT"],'chaine',0,'',$conf->entity); $res=dolibarr_set_const($db, "MEMBER_NEWFORM_AMOUNT",$_POST["MEMBER_NEWFORM_AMOUNT"],'chaine',0,'',$conf->entity);
$res=dolibarr_set_const($db, "MEMBER_NEWFORM_EDITAMOUNT",$_POST["MEMBER_NEWFORM_EDITAMOUNT"],'chaine',0,'',$conf->entity); $res=dolibarr_set_const($db, "MEMBER_NEWFORM_EDITAMOUNT",$_POST["MEMBER_NEWFORM_EDITAMOUNT"],'chaine',0,'',$conf->entity);
$res=dolibarr_set_const($db, "MEMBER_NEWFORM_PAYONLINE",$_POST["MEMBER_NEWFORM_PAYONLINE"],'chaine',0,'',$conf->entity); $res=dolibarr_set_const($db, "MEMBER_NEWFORM_PAYONLINE",$_POST["MEMBER_NEWFORM_PAYONLINE"],'chaine',0,'',$conf->entity);
if (! $res > 0) $error++; if (! $res > 0) $error++;
if (! $error) if (! $error)
@ -66,7 +68,6 @@ if ($action == 'update')
$form=new Form($db); $form=new Form($db);
$help_url='EN:Module_Foundations|FR:Module_Adh&eacute;rents|ES:M&oacute;dulo_Miembros'; $help_url='EN:Module_Foundations|FR:Module_Adh&eacute;rents|ES:M&oacute;dulo_Miembros';
llxHeader('',$langs->trans("MembersSetup"),$help_url); llxHeader('',$langs->trans("MembersSetup"),$help_url);
@ -181,7 +182,7 @@ dol_fiche_end();
print '<br>'; print '<br>';
//print $langs->trans('FollowingLinksArePublic').'<br>'; //print $langs->trans('FollowingLinksArePublic').'<br>';
print img_picto('','object_globe.png').' '.$langs->trans('BlankSubscriptionForm').':<br>'; print img_picto('','object_globe.png').' '.$langs->trans('BlankSubscriptionForm').':<br>';
print '<a target="_blank" href="'.DOL_URL_ROOT.'/public/members/new.php'.'">'.DOL_MAIN_URL_ROOT.'/public/members/new.php'.'</a>'; print '<a target="_blank" href="'.DOL_URL_ROOT.'/public/members/new.php'.'">'.DOL_MAIN_URL_ROOT.'/public/members/new.php</a>';
/* /*
print '<table class="border" cellspacing="0" cellpadding="3">'; print '<table class="border" cellspacing="0" cellpadding="3">';
@ -192,7 +193,7 @@ print '<tr><td>'.$langs->trans("PublicMemberCard").'</td><td>'.img_picto('','obj
print '</table>'; print '</table>';
*/ */
$db->close();
llxFooter(); llxFooter();
$db->close();
?> ?>

210
htdocs/adherents/class/adherent.class.php
View File

@ -131,17 +131,17 @@ class Adherent extends CommonObject
/** /**
* Fonction envoyant un email a l'adherent avec le texte fourni en parametre. * Fonction envoyant un email a l'adherent avec le texte fourni en parametre.
* *
* @param text contenu du message (not html entities encoded) * @param string $text Content of message (not html entities encoded)
* @param subject subject of message * @param string $subject Subject of message
* @param filename_list tableau de fichiers attaches * @param array $filename_list Array of attached files
* @param mimetype_list tableau des types des fichiers attaches * @param array $mimetype_list Array of mime types of attached files
* @param mimefilename_list tableau des noms des fichiers attaches * @param array $mimefilename_list Array of public names of attached files
* @param addr_cc email cc * @param string $addr_cc Email cc
* @param addr_bcc email bcc * @param string $addr_bcc Email bcc
* @param deliveryreceipt demande accuse reception * @param int $deliveryreceipt Ask a delivery receipt
* @param msgishtml 1=String IS already html, 0=String IS NOT html, -1=Unknown need autodetection * @param int $msgishtml 1=String IS already html, 0=String IS NOT html, -1=Unknown need autodetection
* @param errors_to erros to * @param string $errors_to erros to
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
function send_an_email($text, $subject, $filename_list=array(), $mimetype_list=array(), $mimefilename_list=array(), $addr_cc="", $addr_bcc="", $deliveryreceipt=0, $msgishtml=-1, $errors_to='') function send_an_email($text, $subject, $filename_list=array(), $mimetype_list=array(), $mimefilename_list=array(), $addr_cc="", $addr_bcc="", $deliveryreceipt=0, $msgishtml=-1, $errors_to='')
{ {
@ -179,8 +179,8 @@ class Adherent extends CommonObject
/** /**
* Make substitution * Make substitution
* *
* @param text Text to make substitution to * @param string $text Text to make substitution to
* @return string Value of input text string with substitutions done * @return string Value of input text string with substitutions done
*/ */
function makeSubstitution($text) function makeSubstitution($text)
{ {
@ -234,7 +234,9 @@ class Adherent extends CommonObject
/** /**
* Renvoie le libelle traduit de la nature d'un adherent (physique ou morale) * Renvoie le libelle traduit de la nature d'un adherent (physique ou morale)
* @param morphy Nature physique ou morale de l'adherent *
* @param string $morphy Nature physique ou morale de l'adherent
* @return string Label
*/ */
function getmorphylib($morphy='') function getmorphylib($morphy='')
{ {
@ -248,16 +250,16 @@ class Adherent extends CommonObject
/** /**
* Create a member into database * Create a member 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 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
function create($user,$notrigger=0) function create($user,$notrigger=0)
{ {
global $conf,$langs; global $conf,$langs;
$error=0; $error=0;
$now=dol_now(); $now=dol_now();
// Check parameters // Check parameters
@ -369,12 +371,12 @@ class Adherent extends CommonObject
/** /**
* Update a member in database (standard information and password) * Update a member in database (standard information and password)
* *
* @param user User making update * @param User $user User making update
* @param notrigger 1=disable trigger UPDATE (when called by create) * @param int $notrigger 1=disable trigger UPDATE (when called by create)
* @param nosyncuser 0=Synchronize linked user (standard info), 1=Do not synchronize linked user * @param int $nosyncuser 0=Synchronize linked user (standard info), 1=Do not synchronize linked user
* @param nosyncuserpass 0=Synchronize linked user (password), 1=Do not synchronize linked user * @param int $nosyncuserpass 0=Synchronize linked user (password), 1=Do not synchronize linked user
* @param nosyncthirdparty 0=Synchronize linked thirdparty (standard info), 1=Do not synchronize linked thirdparty * @param int $nosyncthirdparty 0=Synchronize linked thirdparty (standard info), 1=Do not synchronize linked thirdparty
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
function update($user,$notrigger=0,$nosyncuser=0,$nosyncuserpass=0,$nosyncthirdparty=0) function update($user,$notrigger=0,$nosyncuser=0,$nosyncuserpass=0,$nosyncthirdparty=0)
{ {
@ -411,16 +413,16 @@ class Adherent extends CommonObject
$sql.= ", ville=" .($this->ville?"'".$this->db->escape($this->ville)."'":"null"); $sql.= ", ville=" .($this->ville?"'".$this->db->escape($this->ville)."'":"null");
$sql.= ", pays=" .($this->pays_id>0?"'".$this->pays_id."'":"null"); $sql.= ", pays=" .($this->pays_id>0?"'".$this->pays_id."'":"null");
$sql.= ", fk_departement=".($this->fk_departement>0?"'".$this->fk_departement."'":"null"); $sql.= ", fk_departement=".($this->fk_departement>0?"'".$this->fk_departement."'":"null");
$sql.= ", email=" ."'".$this->email."'"; $sql.= ", email='".$this->email."'";
$sql.= ", phone=" .($this->phone?"'".$this->db->escape($this->phone)."'":"null"); $sql.= ", phone=" .($this->phone?"'".$this->db->escape($this->phone)."'":"null");
$sql.= ", phone_perso=" .($this->phone_perso?"'".$this->db->escape($this->phone_perso)."'":"null"); $sql.= ", phone_perso=" .($this->phone_perso?"'".$this->db->escape($this->phone_perso)."'":"null");
$sql.= ", phone_mobile=" .($this->phone_mobile?"'".$this->db->escape($this->phone_mobile)."'":"null"); $sql.= ", phone_mobile=" .($this->phone_mobile?"'".$this->db->escape($this->phone_mobile)."'":"null");
$sql.= ", note=" .($this->note?"'".$this->db->escape($this->note)."'":"null"); $sql.= ", note=" .($this->note?"'".$this->db->escape($this->note)."'":"null");
$sql.= ", photo=" .($this->photo?"'".$this->photo."'":"null"); $sql.= ", photo=" .($this->photo?"'".$this->photo."'":"null");
$sql.= ", public=" ."'".$this->public."'"; $sql.= ", public='".$this->public."'";
$sql.= ", statut=" .$this->statut; $sql.= ", statut=" .$this->statut;
$sql.= ", fk_adherent_type=".$this->typeid; $sql.= ", fk_adherent_type=".$this->typeid;
$sql.= ", morphy=" ."'".$this->morphy."'"; $sql.= ", morphy='".$this->morphy."'";
$sql.= ", naiss=" .($this->naiss?"'".$this->db->idate($this->naiss)."'":"null"); $sql.= ", naiss=" .($this->naiss?"'".$this->db->idate($this->naiss)."'":"null");
if ($this->datefin) $sql.= ", datefin='".$this->db->idate($this->datefin)."'"; // Ne doit etre modifie que par effacement cotisation if ($this->datefin) $sql.= ", datefin='".$this->db->idate($this->datefin)."'"; // Ne doit etre modifie que par effacement cotisation
if ($this->datevalid) $sql.= ", datevalid='".$this->db->idate($this->datevalid)."'"; // Ne doit etre modifie que par validation adherent if ($this->datevalid) $sql.= ", datevalid='".$this->db->idate($this->datevalid)."'"; // Ne doit etre modifie que par validation adherent
@ -598,8 +600,9 @@ class Adherent extends CommonObject
/** /**
* Update denormalized last subscription date. * Update denormalized last subscription date.
* This function is called when we delete a subscription for example. * This function is called when we delete a subscription for example.
* @param user Utilisateur qui realise la mise a jour *
* @return int <0 if KO, >0 if OK * @param User $user User making change
* @return int <0 if KO, >0 if OK
*/ */
function update_end_date($user) function update_end_date($user)
{ {
@ -657,9 +660,9 @@ class Adherent extends CommonObject
/** /**
* Fonction qui supprime l'adherent et les donnees associees * Fonction qui supprime l'adherent et les donnees associees
* *
* @param rowid Id de l'adherent a effacer * @param int $rowid Id of member to delete
* @return int <0 si KO, 0=rien a effacer, >0 si OK * @return int <0 if KO, 0=nothing to do, >0 if OK
*/ */
function delete($rowid) function delete($rowid)
{ {
@ -667,7 +670,7 @@ class Adherent extends CommonObject
$result = 0; $result = 0;
$error=0; $error=0;
$this->db->begin(); $this->db->begin();
// Suppression options // Suppression options
@ -731,12 +734,13 @@ class Adherent extends CommonObject
/** /**
* Change password of a user * Change password of a user
* @param user Object user de l'utilisateur qui fait la modification *
* @param password Nouveau mot de passe (a generer si non communique) * @param User $user Object user de l'utilisateur qui fait la modification
* @param isencrypted 0 ou 1 si il faut crypter le mot de passe en base (0 par defaut) * @param string $password New password (to generate if empty)
* @param notrigger 1=Ne declenche pas les triggers * @param int $isencrypted 0 ou 1 si il faut crypter le mot de passe en base (0 par defaut)
* @param nosyncuser Do not synchronize linked user * @param int $notrigger 1=Ne declenche pas les triggers
* @return string If OK return clear password, 0 if no change, < 0 if error * @param int $nosyncuser Do not synchronize linked user
* @return string If OK return clear password, 0 if no change, < 0 if error
*/ */
function setPassword($user, $password='', $isencrypted=0, $notrigger=0, $nosyncuser=0) function setPassword($user, $password='', $isencrypted=0, $notrigger=0, $nosyncuser=0)
{ {
@ -908,19 +912,20 @@ class Adherent extends CommonObject
/** /**
* Method to get member from its login * Method to load member from its login
* @param login login of member *
* @param string $login login of member
* @return void
*/ */
function fetch_login($login) function fetch_login($login)
{ {
global $conf; global $conf;
$sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."adherent"; $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."adherent";
$sql.= " WHERE login='".$login."'"; $sql.= " WHERE login='".$this->db->escape($login)."'";
$sql.= " AND entity = ".$conf->entity; $sql.= " AND entity = ".$conf->entity;
$resql=$this->db->query($sql); $resql=$this->db->query($sql);
if ($resql) if ($resql)
{ {
if ($this->db->num_rows($resql)) if ($this->db->num_rows($resql))
@ -939,10 +944,10 @@ class Adherent extends CommonObject
/** /**
* Load member from database * Load member from database
* *
* @param rowid Id of object to load * @param int $rowid Id of object to load
* @param ref To load member from its ref * @param string $ref To load member from its ref
* @param fk_soc To load member from its link to third party * @param int $fk_soc To load member from its link to third party
* @return int >0 if OK, 0 if not found, <0 if KO * @return int >0 if OK, 0 if not found, <0 if KO
*/ */
function fetch($rowid,$ref='',$fk_soc='') function fetch($rowid,$ref='',$fk_soc='')
{ {
@ -1123,26 +1128,25 @@ class Adherent extends CommonObject
/** /**
* Fonction qui insere la cotisation dans la base de donnees * Insert subscription into database and eventually add links to banks, mailman, etc...
* et eventuellement liens dans banques, mailman, etc.
* *
* @param date Date d'effet de la cotisation * @param timestamp $date Date d'effet de la cotisation
* @param montant Montant cotisation (accepte 0 pour les adherents non soumis e cotisation) * @param amount $montant Montant cotisation (accepte 0 pour les adherents non soumis e cotisation)
* @param accountid Id compte bancaire * @param int $accountid Id compte bancaire
* @param operation Type operation (si Id compte bancaire fourni) * @param string $operation Type operation (si Id compte bancaire fourni)
* @param label Label operation (si Id compte bancaire fourni) * @param string $label Label operation (si Id compte bancaire fourni)
* @param num_chq Numero cheque (si Id compte bancaire fourni) * @param string $num_chq Numero cheque (si Id compte bancaire fourni)
* @param emetteur_nom Nom emetteur cheque * @param string $emetteur_nom Nom emetteur cheque
* @param emetteur_banque Nom banque emetteur cheque * @param string $emetteur_banque Nom banque emetteur cheque
* @param datesubend Date fin adhesion * @param timestamp $datesubend Date fin adhesion
* @return int rowid de l'entree ajoutee, <0 si erreur * @return int rowid of record added, <0 if KO
*/ */
function cotisation($date, $montant, $accountid=0, $operation='', $label='', $num_chq='', $emetteur_nom='', $emetteur_banque='', $datesubend=0) function cotisation($date, $montant, $accountid=0, $operation='', $label='', $num_chq='', $emetteur_nom='', $emetteur_banque='', $datesubend=0)
{ {
global $conf,$langs,$user; global $conf,$langs,$user;
$error=0; $error=0;
// Clean parameters // Clean parameters
if (! $montant) $montant=0; if (! $montant) $montant=0;
@ -1216,7 +1220,7 @@ class Adherent extends CommonObject
global $langs,$conf; global $langs,$conf;
$error=0; $error=0;
// Check parameters // Check parameters
if ($this->statut == 1) if ($this->statut == 1)
{ {
@ -1268,7 +1272,7 @@ class Adherent extends CommonObject
global $langs,$conf; global $langs,$conf;
$error=0; $error=0;
// Check paramaters // Check paramaters
if ($this->statut == 0) if ($this->statut == 0)
{ {
@ -1309,7 +1313,8 @@ class Adherent extends CommonObject
/** /**
* Fonction qui ajoute l'adherent au abonnements automatiques * Fonction qui ajoute l'adherent au abonnements automatiques
* mailing-list, spip, etc... * mailing-list, spip, etc.
*
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
function add_to_abo() function add_to_abo()
@ -1351,7 +1356,8 @@ class Adherent extends CommonObject
/** /**
* Fonction qui supprime l'adherent des abonnements automatiques * Fonction qui supprime l'adherent des abonnements automatiques
* mailing-list, spip, etc... * mailing-list, spip, etc.
*
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
function del_to_abo() function del_to_abo()
@ -1391,7 +1397,8 @@ class Adherent extends CommonObject
/** /**
* Fonction qui donne les droits redacteurs dans spip * Fonction qui donne les droits redacteurs dans spip
* @return int =0 si KO, >0 si OK *
* @return int =0 if KO, >0 if OK
*/ */
function add_to_spip() function add_to_spip()
{ {
@ -1426,6 +1433,8 @@ class Adherent extends CommonObject
/** /**
* Fonction qui enleve les droits redacteurs dans spip * Fonction qui enleve les droits redacteurs dans spip
*
* @return int =0 if KO, >0 if OK
*/ */
function del_to_spip() function del_to_spip()
{ {
@ -1457,7 +1466,7 @@ class Adherent extends CommonObject
/** /**
* Fonction qui dit si cet utilisateur est un redacteur existant dans spip * Fonction qui dit si cet utilisateur est un redacteur existant dans spip
* *
* @return int 1=existe, 0=n'existe pas, -1=erreur * @return int 1=exists, 0=does not exists, -1=error
*/ */
function is_in_spip() function is_in_spip()
{ {
@ -1507,8 +1516,8 @@ class Adherent extends CommonObject
/** /**
* Subscribe an email to all mailing-lists * Subscribe an email to all mailing-lists
* *
* @param listes To force mailing-list (string separated with ,) * @param array $listes To force mailing-list (string separated with ,)
* @return int <=0 if KO, >0 if OK * @return int <=0 if KO, >0 if OK
*/ */
function add_to_mailman($listes='') function add_to_mailman($listes='')
{ {
@ -1586,8 +1595,8 @@ class Adherent extends CommonObject
* Unsubscribe an email from all mailing-lists * Unsubscribe an email from all mailing-lists
* Used when a user is resiliated * Used when a user is resiliated
* *
* @param listes To force mailing-list (string separated with ,) * @param array $listes To force mailing-list (string separated with ,)
* @return int <=0 if KO, >0 if OK * @return int <=0 if KO, >0 if OK
*/ */
function del_to_mailman($listes='') function del_to_mailman($listes='')
{ {
@ -1619,7 +1628,7 @@ class Adherent extends CommonObject
$this->pass, $this->pass,
$conf->global->ADHERENT_MAILMAN_ADMINPW $conf->global->ADHERENT_MAILMAN_ADMINPW
); );
$curl_url = preg_replace ($patterns, $replace, $conf->global->ADHERENT_MAILMAN_UNSUB_URL); $curl_url = preg_replace($patterns, $replace, $conf->global->ADHERENT_MAILMAN_UNSUB_URL);
dol_syslog("Call URL to unsubscribe : ".$curl_url); dol_syslog("Call URL to unsubscribe : ".$curl_url);
$ch = curl_init(); $ch = curl_init();
@ -1657,10 +1666,10 @@ class Adherent 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)
{ {
@ -1695,8 +1704,8 @@ class Adherent extends CommonObject
/** /**
* Return label of a civility of a contact * Return label of a civility of a contact
* *
* @param nohtmlentities 0=Encode with htmlentities for HTML output, 1=No htmlentities for memory translation * @param int $nohtmlentities 0=Encode with htmlentities for HTML output, 1=No htmlentities for memory translation
* @return string Name translated of civility * @return string Name translated of civility
*/ */
function getCivilityLabel($nohtmlentities=0) function getCivilityLabel($nohtmlentities=0)
{ {
@ -1711,10 +1720,10 @@ class Adherent extends CommonObject
/** /**
* Renvoie nom clicable (avec eventuellement le picto) * Renvoie nom clicable (avec eventuellement le picto)
* *
* @param withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul * @param int $withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul
* @param maxlen length max libelle * @param int $maxlen length max libelle
* @param option Page lien * @param string $option Page lien
* @return string Chaine avec URL * @return string Chaine avec URL
*/ */
function getNomUrl($withpicto=0,$maxlen=0,$option='card') function getNomUrl($withpicto=0,$maxlen=0,$option='card')
{ {
@ -1746,9 +1755,9 @@ class Adherent extends CommonObject
/** /**
* Return full address of member * Return full address of member
* *
* @param withcountry 1=Add country into address string * @param int $withcountry 1=Add country into address string
* @param sep Separator to use to build string * @param string $sep Separator to use to build string
* @return string Full address string * @return string Full address string
*/ */
function getFullAddress($withcountry=0,$sep="\n") function getFullAddress($withcountry=0,$sep="\n")
{ {
@ -1772,8 +1781,8 @@ class Adherent extends CommonObject
/** /**
* Retourne le libelle du statut d'un adherent (brouillon, valide, resilie) * Retourne le libelle du statut d'un adherent (brouillon, valide, resilie)
* *
* @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 Libelle * @return string Label
*/ */
function getLibStatut($mode=0) function getLibStatut($mode=0)
{ {
@ -1783,11 +1792,11 @@ class Adherent 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 need_subscription 1 si type adherent avec cotisation, 0 sinon * @param int $need_subscription 1 si type adherent avec cotisation, 0 sinon
* @param date_end_subscription Date fin adhesion * @param timestamp $date_end_subscription Date fin adhesion
* @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 Libelle * @return string Label
*/ */
function LibStatut($statut,$need_subscription,$date_end_subscription,$mode=0) function LibStatut($statut,$need_subscription,$date_end_subscription,$mode=0)
{ {
@ -1865,7 +1874,7 @@ class Adherent extends CommonObject
/** /**
* Charge indicateurs this->nb de tableau de bord * Charge indicateurs this->nb de tableau de bord
* *
* @return int <0 si ko, >0 si ok * @return int <0 if KO, >0 if OK
*/ */
function load_state_board() function load_state_board()
{ {
@ -1899,8 +1908,8 @@ class Adherent extends CommonObject
/** /**
* Load indicators for dashboard (this->nbtodo and this->nbtodolate) * Load indicators for dashboard (this->nbtodo and this->nbtodolate)
* *
* @param user Objet user * @param User $user Objet user
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
function load_board($user) function load_board($user)
{ {
@ -1994,11 +2003,11 @@ class Adherent 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=Return DN without key inside (ou=xxx,dc=aaa,dc=bbb) * 1=Return DN without key inside (ou=xxx,dc=aaa,dc=bbb)
* 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)
{ {
@ -2061,7 +2070,8 @@ class Adherent extends CommonObject
/** /**
* Charge les informations d'ordre info dans l'objet adherent * Charge les informations d'ordre info dans l'objet adherent
* *
* @param int $id Id of member to load * @param int $id Id of member to load
* @return void
*/ */
function info($id) function info($id)
{ {

27
htdocs/adherents/class/adherentstats.class.php
View File

@ -46,16 +46,16 @@ class AdherentStats extends Stats
/** /**
* Constructor * Constructor
* *
* @param DoliDB $DB Database handler * @param DoliDB $db Database handler
* @param int $socid Id third party * @param int $socid Id third party
* @param int $userid Id user for filter * @param int $userid Id user for filter
* @return AdherentStats * @return AdherentStats
*/ */
function AdherentStats($DB, $socid=0, $userid=0) function AdherentStats($db, $socid=0, $userid=0)
{ {
global $user, $conf; global $user, $conf;
$this->db = $DB; $this->db = $db;
$this->socid = $socid; $this->socid = $socid;
$this->userid = $userid; $this->userid = $userid;
@ -79,6 +79,9 @@ class AdherentStats extends Stats
/** /**
* Renvoie le nombre de proposition par mois pour une annee donnee * Renvoie le nombre de proposition par mois pour une annee donnee
*
* @param int $year Year
* @return array Array of nb each month
*/ */
function getNbByMonth($year) function getNbByMonth($year)
{ {
@ -98,6 +101,7 @@ class AdherentStats extends Stats
/** /**
* Renvoie le nombre de cotisation par annee * Renvoie le nombre de cotisation par annee
* *
* @return array Array of nb each year
*/ */
function getNbByYear() function getNbByYear()
{ {
@ -112,9 +116,12 @@ class AdherentStats extends Stats
return $this->_getNbByYear($sql); return $this->_getNbByYear($sql);
} }
/** /**
* Renvoie le nombre de cotisation par mois pour une annee donnee * Renvoie le nombre de cotisation par mois pour une annee donnee
* *
* @param int $year Year
* @return array Array of amount each month
*/ */
function getAmountByMonth($year) function getAmountByMonth($year)
{ {
@ -130,9 +137,12 @@ class AdherentStats extends Stats
return $this->_getAmountByMonth($year, $sql); return $this->_getAmountByMonth($year, $sql);
} }
/** /**
* Return average amount each month
* *
* * @param int $year Year
* @return array Array of average each month
*/ */
function getAverageByMonth($year) function getAverageByMonth($year)
{ {
@ -151,8 +161,9 @@ class AdherentStats extends Stats
/** /**
* \brief Return nb, total and average * Return nb, total and average
* \return array Array of values *
* @return array Array with nb, total amount, average for each year
*/ */
function getAllByYear() function getAllByYear()
{ {

31
htdocs/adherents/class/cotisation.class.php
View File

@ -48,19 +48,19 @@ class Cotisation extends CommonObject
/** /**
* Constructor * Constructor
* *
* @param DoliDB $DB Database handler * @param DoliDB $db Database handler
*/ */
function Cotisation($DB) function Cotisation($db)
{ {
$this->db = $DB; $this->db = $db;
} }
/** /**
* Fonction qui permet de creer la cotisation * Fonction qui permet de creer la cotisation
* *
* @param userid userid de celui qui insere * @param int $userid userid de celui qui insere
* @return int <0 si KO, Id cotisation cree si OK * @return int <0 if KO, Id subscription created if OK
*/ */
function create($userid) function create($userid)
{ {
@ -96,8 +96,8 @@ class Cotisation extends CommonObject
/** /**
* Fonction qui permet de recuperer une cotisation * Fonction qui permet de recuperer une cotisation
* *
* @param rowid Id cotisation * @param int $rowid Id cotisation
* @return int <0 si KO, =0 si OK mais non trouve, >0 si OK * @return int <0 if KO, =0 if not found, >0 if OK
*/ */
function fetch($rowid) function fetch($rowid)
{ {
@ -146,9 +146,9 @@ class Cotisation extends CommonObject
/** /**
* Met a jour en base la cotisation * Met a jour en base la cotisation
* *
* @param user Objet user qui met a jour * @param User $user Objet user qui met a jour
* @param notrigger 0=Desactive les triggers * @param int $notrigger 0=Desactive les triggers
* @param int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
function update($user,$notrigger=0) function update($user,$notrigger=0)
{ {
@ -187,8 +187,8 @@ class Cotisation extends CommonObject
/** /**
* Delete a subscription * Delete a subscription
* *
* @param rowid Id cotisation * @param User $user User that delete
* @return int <0 si KO, 0 si OK mais non trouve, >0 si OK * @return int <0 if KO, 0 if not found, >0 if OK
*/ */
function delete($user) function delete($user)
{ {
@ -254,8 +254,8 @@ class Cotisation extends CommonObject
/** /**
* Renvoie nom clicable (avec eventuellement le picto) * Renvoie nom clicable (avec eventuellement le picto)
* *
* @param withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul * @param int $withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul
* @return string Chaine avec URL * @return string Chaine avec URL
*/ */
function getNomUrl($withpicto=0) function getNomUrl($withpicto=0)
{ {
@ -279,7 +279,8 @@ class Cotisation extends CommonObject
/** /**
* Charge les informations d'ordre info dans l'objet cotisation * Charge les informations d'ordre info dans l'objet cotisation
* *
* @param id Id adhesion a charger * @param int $id Id subscription
* @return void
*/ */
function info($id) function info($id)
{ {

9
htdocs/core/class/stats.class.php
View File

@ -136,10 +136,10 @@ abstract class Stats
} }
/** /**
* Return nb of elements, total amount and avg amount by year * Return nb of elements, total amount and avg amount each year
* *
* @param sql SQL request * @param sql SQL request
* @return array * @return array Array with nb, total amount, average for each year
*/ */
function _getAllByYear($sql) function _getAllByYear($sql)
{ {
@ -171,8 +171,9 @@ abstract class Stats
/** /**
* Renvoie le nombre de proposition par mois pour une annee donnee * Renvoie le nombre de proposition par mois pour une annee donnee
* *
* @param year Year * @param int $year Year
* @param sql SQL * @param string $sql SQL
* @return array Array of nb each month
*/ */
function _getNbByMonth($year, $sql) function _getNbByMonth($year, $sql)
{ {