Wavyzz/dolibarr
2
0
Fork 1
mirror of https://github.com/Dolibarr/dolibarr.git synced 2025-12-05 17:18:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Doxygen

Browse Source
This commit is contained in:
Laurent Destailleur
2011-09-12 17:43:31 +00:00
parent d7b943ec0f
commit ac7b8484de
9 changed files with 139 additions and 184 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -143,7 +143,7 @@ class Adherent extends CommonObject
* @param addr_bcc email bcc * @param addr_bcc email bcc
* @param deliveryreceipt demande accuse reception * @param deliveryreceipt demande accuse reception
* @param msgishtml 1=String IS already html, 0=String IS NOT html, -1=Unknown need autodetection * @param msgishtml 1=String IS already html, 0=String IS NOT html, -1=Unknown need autodetection
* @param errors_to erros to * @param errorsto 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='')
@@ -1454,7 +1454,6 @@ 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=existe, 0=n'existe pas, -1=erreur
*/ */
function is_in_spip() function is_in_spip()
@@ -1477,19 +1476,20 @@ class Adherent extends CommonObject
{ {
if ($mydb->num_rows($result)) if ($mydb->num_rows($result))
{ {
// nous avons au moins une reponse # nous avons au moins une reponse
$mydb->close($result); $mydb->close($result);
return 1; return 1;
} }
else else
{ {
// nous n'avons pas de reponse => n'existe pas # nous n'avons pas de reponse => n'existe pas
$mydb->close($result); $mydb->close($result);
return 0; return 0;
} }
} }
else else
{ {
# error
$this->error=$mydb->error(); $this->error=$mydb->error();
return -1; return -1;
} }
@@ -1502,7 +1502,6 @@ 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 listes To force mailing-list (string separated with ,)
* @return int <=0 if KO, >0 if OK * @return int <=0 if KO, >0 if OK
*/ */
@@ -1545,7 +1544,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_URL); $curl_url = preg_replace ($patterns, $replace, $conf->global->ADHERENT_MAILMAN_URL);
dol_syslog("Call URL to subscribe : ".$curl_url); dol_syslog("Call URL to subscribe : ".$curl_url);
$ch = curl_init(); $ch = curl_init();
@@ -1559,7 +1558,7 @@ class Adherent extends CommonObject
//curl_setopt($ch, CURLOPT_POSTFIELDS, "a=3&b=5"); //curl_setopt($ch, CURLOPT_POSTFIELDS, "a=3&b=5");
//--- Start buffering //--- Start buffering
//ob_start(); //ob_start();
$result=curl_exec($ch); $result=curl_exec ($ch);
dol_syslog($result); dol_syslog($result);
//--- End buffering and clean output //--- End buffering and clean output
//ob_end_clean(); //ob_end_clean();
@@ -1568,7 +1567,7 @@ class Adherent extends CommonObject
// error // error
return -2; return -2;
} }
curl_close($ch); curl_close ($ch);
} }
return 1; return 1;
@@ -1583,7 +1582,6 @@ 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 listes To force mailing-list (string separated with ,)
* @return int <=0 if KO, >0 if OK * @return int <=0 if KO, >0 if OK
*/ */
@@ -1631,7 +1629,7 @@ class Adherent extends CommonObject
//curl_setopt($ch, CURLOPT_POSTFIELDS, "a=3&b=5"); //curl_setopt($ch, CURLOPT_POSTFIELDS, "a=3&b=5");
//--- Start buffering //--- Start buffering
//ob_start(); //ob_start();
$result=curl_exec($ch); $result=curl_exec ($ch);
dol_syslog($result); dol_syslog($result);
//--- End buffering and clean output //--- End buffering and clean output
//ob_end_clean(); //ob_end_clean();
@@ -1642,7 +1640,7 @@ class Adherent extends CommonObject
// error // error
return -2; return -2;
} }
curl_close($ch); curl_close ($ch);
} }
return 1; return 1;
@@ -1656,7 +1654,6 @@ 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 langs Language object for translation of civility
* @param option 0=No option, 1=Add civility * @param option 0=No option, 1=Add civility
* @param nameorder -1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname * @param nameorder -1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname
@@ -1694,7 +1691,6 @@ 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 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
*/ */
@@ -1710,7 +1706,6 @@ 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 withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul
* @param maxlen length max libelle * @param maxlen length max libelle
* @param option Page lien * @param option Page lien
@@ -1745,7 +1740,6 @@ class Adherent extends CommonObject
/** /**
* Return full address of member * Return full address of member
*
* @param withcountry 1=Add country into address string * @param withcountry 1=Add country into address string
* @param sep Separator to use to build string * @param sep Separator to use to build string
* @return string Full address string * @return string Full address string
@@ -1771,7 +1765,6 @@ 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 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 Libelle
*/ */
@@ -1782,7 +1775,6 @@ class Adherent extends CommonObject
/** /**
* Renvoi le libelle d'un statut donne * Renvoi le libelle d'un statut donne
*
* @param statut Id statut * @param statut Id statut
* @param need_subscription 1 si type adherent avec cotisation, 0 sinon * @param need_subscription 1 si type adherent avec cotisation, 0 sinon
* @param date_end_subscription Date fin adhesion * @param date_end_subscription Date fin adhesion
@@ -1864,7 +1856,6 @@ 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 si ko, >0 si ok
*/ */
function load_state_board() function load_state_board()
@@ -1898,7 +1889,6 @@ 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 Objet user
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
@@ -1989,7 +1979,6 @@ 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 info Info string loaded by _load_ldap_info
* @param mode 0=Return full DN (uid=qqq,ou=xxx,dc=aaa,dc=bbb) * @param 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)
@@ -2009,7 +1998,6 @@ class Adherent extends CommonObject
/** /**
* Initialise tableau info (tableau des attributs LDAP) * Initialise tableau info (tableau des attributs LDAP)
*
* @return array Tableau info des attributs * @return array Tableau info des attributs
*/ */
function _load_ldap_info() function _load_ldap_info()
@@ -2056,8 +2044,7 @@ 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 id Id du membre a charger
* @param int $id Id of member to load
*/ */
function info($id) function info($id)
{ {

97
htdocs/comm/propal/class/propal.class.php
View File

@@ -430,20 +430,22 @@ class Propal extends CommonObject
/** /**
* Update a proposal line * Update a proposal line
* @param rowid Id de la ligne *
* @param pu Prix unitaire (HT ou TTC selon price_base_type) * @param rowid Id de la ligne
* @param qty Quantity * @param pu Prix unitaire (HT ou TTC selon price_base_type)
* @param remise_percent Remise effectuee sur le produit * @param qty Quantity
* @param txtva Taux de TVA * @param remise_percent Remise effectuee sur le produit
* @param txlocaltax1 Local tax 1 rate * @param txtva Taux de TVA
* @param txlocaltax2 Local tax 2 rate * @param txlocaltax1 Local tax 1 rate
* @param desc Description * @param txlocaltax2 Local tax 2 rate
* @param price_base_type HT ou TTC * @param desc Description
* @param info_bits Miscellanous informations * @param price_base_type HT ou TTC
* @param special_code Set special code ('' = we don't change it) * @param info_bits Miscellanous informations
* @param fk_parent_line Id of line parent * @param special_code Set special code ('' = we don't change it)
* @return int 0 en cas de succes * @param fk_parent_line Id of line parent
* @param skip_update_total Skip update total
* @return int 0 if OK, <0 if KO
*/ */
function updateline($rowid, $pu, $qty, $remise_percent=0, $txtva, $txlocaltax1=0, $txlocaltax2=0, $desc='', $price_base_type='HT', $info_bits=0, $special_code=0, $fk_parent_line=0, $skip_update_total=0) function updateline($rowid, $pu, $qty, $remise_percent=0, $txtva, $txlocaltax1=0, $txlocaltax2=0, $desc='', $price_base_type='HT', $info_bits=0, $special_code=0, $fk_parent_line=0, $skip_update_total=0)
{ {
@@ -543,9 +545,10 @@ class Propal extends CommonObject
/** /**
* \brief Supprime une ligne de detail * Supprime une ligne de detail
* \param idligne Id de la ligne detail a supprimer *
* \return int >0 si ok, <0 si ko * @param int $lineid Id of line to delete
* @return int >0 if OK, <0 if KO
*/ */
function deleteline($lineid) function deleteline($lineid)
{ {
@@ -575,10 +578,12 @@ class Propal extends CommonObject
/** /**
* Create commercial proposal into database * Create commercial proposal into database
* this->ref can be set or empty. If empty, we will use "(PROVid)" * this->ref can be set or empty. If empty, we will use "(PROVid)"
* @param user User that create *
* @return int <0 if KO, >=0 if OK * @param User $user User that create
* @param int $notrigger Disable trigger
* @return int <0 if KO, >=0 if OK
*/ */
function create($user='', $notrigger=0) function create($user='', $notrigger=0)
{ {
@@ -1288,10 +1293,11 @@ class Propal extends CommonObject
} }
/** /**
* \brief Set delivery * Set delivery
* \param user Objet utilisateur qui modifie *
* \param delivery delai de livraison * @param User $user Objet utilisateur qui modifie
* \return int <0 si ko, >0 si ok * @param int $id Availability id
* @return int <0 if KO, >0 if OK
*/ */
function set_availability($user, $id) function set_availability($user, $id)
{ {
@@ -1316,10 +1322,11 @@ class Propal extends CommonObject
} }
/** /**
* \brief Set source of demand * Set source of demand
* \param user Objet utilisateur qui modifie *
* \param demand_reason source of demand * @param User $user Objet utilisateur qui modifie
* \return int <0 si ko, >0 si ok * @param int $id Input reason id
* @return int <0 if KO, >0 if OK
*/ */
function set_demand_reason($user, $id) function set_demand_reason($user, $id)
{ {
@@ -1344,10 +1351,11 @@ class Propal extends CommonObject
} }
/** /**
* \brief Positionne numero reference client * Positionne numero reference client
* \param user Utilisateur qui modifie *
* \param ref_client Reference client * @param user Utilisateur qui modifie
* \return int <0 si ko, >0 si ok * @param ref_client Reference client
* @return int <0 si ko, >0 si ok
*/ */
function set_ref_client($user, $ref_client) function set_ref_client($user, $ref_client)
{ {
@@ -1802,9 +1810,10 @@ class Propal extends CommonObject
/** /**
* \brief Change les conditions de reglement de la facture * Change les conditions de reglement de la facture
* \param cond_reglement_id Id de la nouvelle condition de reglement *
* \return int >0 si ok, <0 si ko * @param cond_reglement_id Id de la nouvelle condition de reglement
* @return int >0 if OK, <0 if KO
*/ */
function cond_reglement($cond_reglement_id) function cond_reglement($cond_reglement_id)
{ {
@@ -1836,9 +1845,10 @@ class Propal extends CommonObject
/** /**
* \brief Change le mode de reglement * Change le mode de reglement
* \param mode_reglement Id du nouveau mode *
* \return int >0 si ok, <0 si ko * @param mode_reglement_id Id du nouveau mode
* @return int >0 if OK, <0 if KO
*/ */
function mode_reglement($mode_reglement_id) function mode_reglement($mode_reglement_id)
{ {
@@ -1868,10 +1878,11 @@ class Propal extends CommonObject
} }
} }
/** /**
* \brief Change le delai de livraison * Change le delai de livraison
* \param availability_id Id du nouveau delai de livraison *
* \return int >0 si ok, <0 si ko * @param availability_id Id du nouveau delai de livraison
* @return int >0 if OK, <0 if KO
*/ */
function availability($availability_id) function availability($availability_id)
{ {

94
htdocs/core/class/smtps.class.php
View File

@@ -261,19 +261,14 @@ class SMTPs
} }
// =============================================================
function setDebug( $_vDebug = false ) function setDebug( $_vDebug = false )
{ {
$this->_debug = $_vDebug; $this->_debug = $_vDebug;
} }
// ** Class methods
/** /**
* build RECIPIENT List, all addresses who will recieve this message * build RECIPIENT List, all addresses who will recieve this message
* *
* @param void
* @return void * @return void
*/ */
function buildRCPTlist() function buildRCPTlist()
@@ -285,7 +280,6 @@ class SMTPs
/** /**
* Attempt a connection to mail server * Attempt a connection to mail server
* *
* @param void
* @return mixed $_retVal Boolean indicating success or failure on connection * @return mixed $_retVal Boolean indicating success or failure on connection
*/ */
function _server_connect() function _server_connect()
@@ -343,7 +337,6 @@ class SMTPs
/** /**
* Attempt mail server authentication for a secure connection * Attempt mail server authentication for a secure connection
* *
* @param void
* @return mixed $_retVal Boolean indicating success or failure of authentication * @return mixed $_retVal Boolean indicating success or failure of authentication
*/ */
function _server_authenticate() function _server_authenticate()
@@ -544,7 +537,6 @@ class SMTPs
* - 'pipe [1] - use UNIX path to EXE * - 'pipe [1] - use UNIX path to EXE
* - 'phpmail [2] - use the PHP built-in mail function * - 'phpmail [2] - use the PHP built-in mail function
* *
* @param void
* @return int $_strHost Host Name or IP of the Mail Server to use * @return int $_strHost Host Name or IP of the Mail Server to use
*/ */
function getTransportType() function getTransportType()
@@ -576,7 +568,7 @@ class SMTPs
* @param string $_strHost Host Name or IP of the Mail Server to use * @param string $_strHost Host Name or IP of the Mail Server to use
* @return void * @return void
*/ */
function setHost ( $_strHost ) function setHost($_strHost)
{ {
if ( $_strHost ) if ( $_strHost )
$this->_smtpsHost = $_strHost; $this->_smtpsHost = $_strHost;
@@ -586,10 +578,9 @@ class SMTPs
* Retrieves the Host Name or IP of the Mail Server to use * Retrieves the Host Name or IP of the Mail Server to use
* This is used only with 'socket' based mail transmission * This is used only with 'socket' based mail transmission
* *
* @param void
* @return string $_strHost Host Name or IP of the Mail Server to use * @return string $_strHost Host Name or IP of the Mail Server to use
*/ */
function getHost () function getHost()
{ {
return $this->_smtpsHost; return $this->_smtpsHost;
} }
@@ -602,7 +593,7 @@ class SMTPs
* @param int $_smtpsPort Port Number of the Mail Server to use * @param int $_smtpsPort Port Number of the Mail Server to use
* @return void * @return void
*/ */
function setPort ( $_intPort ) function setPort($_intPort)
{ {
if ( ( is_numeric ($_intPort) ) && if ( ( is_numeric ($_intPort) ) &&
( ( $_intPort >= 1 ) && ( $_intPort <= 65536 ) ) ) ( ( $_intPort >= 1 ) && ( $_intPort <= 65536 ) ) )
@@ -613,10 +604,9 @@ class SMTPs
* Retrieves the Port Number of the Mail Server to use * Retrieves the Port Number of the Mail Server to use
* This is used only with 'socket' based mail transmission * This is used only with 'socket' based mail transmission
* *
* @param void
* @return string $_smtpsPort Port Number of the Mail Server to use * @return string $_smtpsPort Port Number of the Mail Server to use
*/ */
function getPort () function getPort()
{ {
return $this->_smtpsPort; return $this->_smtpsPort;
} }
@@ -627,7 +617,7 @@ class SMTPs
* @param string $_strID User Name for authentication on Mail Server * @param string $_strID User Name for authentication on Mail Server
* @return void * @return void
*/ */
function setID ( $_strID ) function setID($_strID )
{ {
$this->_smtpsID = $_strID; $this->_smtpsID = $_strID;
} }
@@ -635,10 +625,9 @@ class SMTPs
/** /**
* Retrieves the User Name for authentication on Mail Server * Retrieves the User Name for authentication on Mail Server
* *
* @param void
* @return string _smtpsID User Name for authentication on Mail Server * @return string _smtpsID User Name for authentication on Mail Server
*/ */
function getID () function getID()
{ {
return $this->_smtpsID; return $this->_smtpsID;
} }
@@ -649,7 +638,7 @@ class SMTPs
* @param string $_strPW User Password for authentication on Mail Server * @param string $_strPW User Password for authentication on Mail Server
* @return void * @return void
*/ */
function setPW ( $_strPW ) function setPW($_strPW)
{ {
$this->_smtpsPW = $_strPW; $this->_smtpsPW = $_strPW;
} }
@@ -657,10 +646,9 @@ class SMTPs
/** /**
* Retrieves the User Password for authentication on Mail Server * Retrieves the User Password for authentication on Mail Server
* *
* @param void
* @return string $_smtpsPW User Password for authentication on Mail Server * @return string $_smtpsPW User Password for authentication on Mail Server
*/ */
function getPW () function getPW()
{ {
return $this->_smtpsPW; return $this->_smtpsPW;
} }
@@ -672,7 +660,7 @@ class SMTPs
* @param string $_strCharSet Character set used for current message * @param string $_strCharSet Character set used for current message
* @return void * @return void
*/ */
function setCharSet ( $_strCharSet ) function setCharSet($_strCharSet)
{ {
if ( $_strCharSet ) if ( $_strCharSet )
$this->_smtpsCharSet = $_strCharSet; $this->_smtpsCharSet = $_strCharSet;
@@ -681,10 +669,9 @@ class SMTPs
/** /**
* Retrieves the Character set used for current message * Retrieves the Character set used for current message
* *
* @param void
* @return string $_smtpsCharSet Character set used for current message * @return string $_smtpsCharSet Character set used for current message
*/ */
function getCharSet () function getCharSet()
{ {
return $this->_smtpsCharSet; return $this->_smtpsCharSet;
} }
@@ -713,10 +700,9 @@ class SMTPs
/** /**
* Retrieves the Content-Transfer-Encoding * Retrieves the Content-Transfer-Encoding
* *
* @param void
* @return string $_smtpsTransEncode Content-Transfer-Encoding * @return string $_smtpsTransEncode Content-Transfer-Encoding
*/ */
function getTransEncode () function getTransEncode()
{ {
return $this->_smtpsTransEncode; return $this->_smtpsTransEncode;
} }
@@ -746,9 +732,7 @@ class SMTPs
/** /**
* Retrieves the Content-Transfer-Encoding * Retrieves the Content-Transfer-Encoding
* *
* @param void
* @return string $_smtpsTransEncode Content-Transfer-Encoding * @return string $_smtpsTransEncode Content-Transfer-Encoding
*
*/ */
function getTransEncodeType() function getTransEncodeType()
{ {
@@ -761,10 +745,10 @@ class SMTPs
/** /**
* FROM Address from which mail will be sent * FROM Address from which mail will be sent
* *
* @param string $_msgFrom Address from which mail will be sent * @param string $_strFrom Address from which mail will be sent
* @return void * @return void
*/ */
function setFrom ( $_strFrom ) function setFrom($_strFrom)
{ {
if ( $_strFrom ) if ( $_strFrom )
$this->_msgFrom = $this->_strip_email ( $_strFrom ); $this->_msgFrom = $this->_strip_email ( $_strFrom );
@@ -773,10 +757,10 @@ class SMTPs
/** /**
* Retrieves the Address from which mail will be sent * Retrieves the Address from which mail will be sent
* *
* @param boolean $_strip To "strip" 'Real name' from address * @param boolean $_part To "strip" 'Real name' from address
* @return string $_msgFrom Address from which mail will be sent * @return string Address from which mail will be sent
*/ */
function getFrom ( $_part = true ) function getFrom($_part = true)
{ {
$_retValue = ''; $_retValue = '';
@@ -870,7 +854,6 @@ class SMTPs
* - $_aryEmail[host] = "domain.tld" * - $_aryEmail[host] = "domain.tld"
* - $_aryEmail[user] = "userName" * - $_aryEmail[user] = "userName"
* *
* @param void
* @return array $_aryEmail An array of the various parts of an email address * @return array $_aryEmail An array of the various parts of an email address
*/ */
function _strip_email($_strAddr) function _strip_email($_strAddr)
@@ -913,7 +896,6 @@ class SMTPs
* This is a "build as you go" method. Each time this method is called * This is a "build as you go" method. Each time this method is called
* the underlaying array is destroyed and reconstructed. * the underlaying array is destroyed and reconstructed.
* *
* @param void
* @return array $_RCPT_list Returns an array of bares addresses * @return array $_RCPT_list Returns an array of bares addresses
*/ */
function get_RCPT_list() function get_RCPT_list()
@@ -1005,10 +987,9 @@ class SMTPs
/** /**
* Retrieves the TO Address[es] inwhich to send mail to * Retrieves the TO Address[es] inwhich to send mail to
* *
* @param void
* @return string $_msgRecipients TO Address[es] inwhich to send mail to * @return string $_msgRecipients TO Address[es] inwhich to send mail to
*/ */
function getTo () function getTo()
{ {
return $this->get_email_list( 'to' ); return $this->get_email_list( 'to' );
} }
@@ -1019,7 +1000,7 @@ class SMTPs
* @param string $_msgRecipients CC Address[es] inwhich to send mail to * @param string $_msgRecipients CC Address[es] inwhich to send mail to
* @return void * @return void
*/ */
function setCC ( $_strCC ) function setCC($_strCC)
{ {
if ( $_strCC ) if ( $_strCC )
$this->_buildAddrList( 'cc', $_strCC ); $this->_buildAddrList( 'cc', $_strCC );
@@ -1028,10 +1009,9 @@ class SMTPs
/** /**
* Retrieves the CC Address[es] inwhich to send mail to * Retrieves the CC Address[es] inwhich to send mail to
* *
* @param void
* @return string $_msgRecipients CC Address[es] inwhich to send mail to * @return string $_msgRecipients CC Address[es] inwhich to send mail to
*/ */
function getCC () function getCC()
{ {
return $this->get_email_list( 'cc' ); return $this->get_email_list( 'cc' );
} }
@@ -1042,7 +1022,7 @@ class SMTPs
* @param string $_msgRecipients BCC Address[es] inwhich to send mail to * @param string $_msgRecipients BCC Address[es] inwhich to send mail to
* @return void * @return void
*/ */
function setBCC ( $_strBCC ) function setBCC($_strBCC)
{ {
if ( $_strBCC ) if ( $_strBCC )
$this->_buildAddrList( 'bcc', $_strBCC ); $this->_buildAddrList( 'bcc', $_strBCC );
@@ -1051,10 +1031,9 @@ class SMTPs
/** /**
* Retrieves the BCC Address[es] inwhich to send mail to * Retrieves the BCC Address[es] inwhich to send mail to
* *
* @param void
* @return string $_msgRecipients BCC Address[es] inwhich to send mail to * @return string $_msgRecipients BCC Address[es] inwhich to send mail to
*/ */
function getBCC () function getBCC()
{ {
return $this->get_email_list( 'bcc' ); return $this->get_email_list( 'bcc' );
} }
@@ -1065,7 +1044,7 @@ class SMTPs
* @param string $_msgSubject Message Subject * @param string $_msgSubject Message Subject
* @return void * @return void
*/ */
function setSubject ( $_strSubject = '' ) function setSubject($_strSubject = '')
{ {
if ( $_strSubject ) if ( $_strSubject )
$this->_msgSubject = $_strSubject; $this->_msgSubject = $_strSubject;
@@ -1074,10 +1053,9 @@ class SMTPs
/** /**
* Retrieves the Message Subject * Retrieves the Message Subject
* *
* @param void
* @return string $_msgSubject Message Subject * @return string $_msgSubject Message Subject
*/ */
function getSubject () function getSubject()
{ {
return $this->_msgSubject; return $this->_msgSubject;
} }
@@ -1085,7 +1063,6 @@ class SMTPs
/** /**
* Constructes and returns message header * Constructes and returns message header
* *
* @param void
* @return string Complete message header * @return string Complete message header
*/ */
function getHeader() function getHeader()
@@ -1163,10 +1140,9 @@ class SMTPs
/** /**
* Retrieves the Message Content * Retrieves the Message Content
* *
* @param void * @return string Message Content
* @return string $_msgContent Message Content
*/ */
function getBodyContent () function getBodyContent()
{ {
// Generate a new Boundary string // Generate a new Boundary string
$this->_setBoundary(); $this->_setBoundary();
@@ -1430,7 +1406,7 @@ class SMTPs
* @param string $_value Message Priority * @param string $_value Message Priority
* @return void * @return void
*/ */
function setMD5flag ( $_flag = false ) function setMD5flag($_flag = false)
{ {
$this->_smtpMD5 = $_flag; $this->_smtpMD5 = $_flag;
} }
@@ -1438,10 +1414,9 @@ class SMTPs
/** /**
* Gets flag which determines whether to calculate message MD5 checksum. * Gets flag which determines whether to calculate message MD5 checksum.
* *
* @param void
* @return string $_value Message Priority * @return string $_value Message Priority
*/ */
function getMD5flag ( ) function getMD5flag()
{ {
return $this->_smtpMD5; return $this->_smtpMD5;
} }
@@ -1454,7 +1429,7 @@ class SMTPs
* @param string $strXdata Message X-Header Content * @param string $strXdata Message X-Header Content
* @return void * @return void
*/ */
function setXheader ( $strXdata ) function setXheader($strXdata)
{ {
if ( $strXdata ) if ( $strXdata )
$this->_msgXheader[] = $strXdata; $this->_msgXheader[] = $strXdata;
@@ -1463,10 +1438,9 @@ class SMTPs
/** /**
* Retrieves the Message X-Header Content * Retrieves the Message X-Header Content
* *
* @param void
* @return string $_msgContent Message X-Header Content * @return string $_msgContent Message X-Header Content
*/ */
function getXheader () function getXheader()
{ {
return $this->_msgXheader; return $this->_msgXheader;
} }
@@ -1474,7 +1448,6 @@ class SMTPs
/** /**
* Generates Random string for MIME message Boundary * Generates Random string for MIME message Boundary
* *
* @param void
* @return void * @return void
*/ */
function _setBoundary() function _setBoundary()
@@ -1485,7 +1458,6 @@ class SMTPs
/** /**
* Retrieves the MIME message Boundary * Retrieves the MIME message Boundary
* *
* @param void
* @return string $_smtpsBoundary MIME message Boundary * @return string $_smtpsBoundary MIME message Boundary
*/ */
function _getBoundary() function _getBoundary()
@@ -1557,7 +1529,6 @@ class SMTPs
/** /**
* Returns errors codes and messages for Class * Returns errors codes and messages for Class
* *
* @param void
* @return string $_errMsg Error Message * @return string $_errMsg Error Message
*/ */
function getErrors() function getErrors()
@@ -1573,10 +1544,9 @@ class SMTPs
} }
// ============================================================= }
} // end of Class
// =============================================================
// ============================================================= // =============================================================
// ** CSV Version Control Info // ** CSV Version Control Info

40
htdocs/lib/pdf.lib.php
View File

@@ -198,6 +198,7 @@ function pdf_format_address($outputlangs,$object)
/** /**
* Return a string with full address formated * Return a string with full address formated
*
* @param outputlangs Output langs object * @param outputlangs Output langs object
* @param sourcecompany Source company object * @param sourcecompany Source company object
* @param targetcompany Target company object * @param targetcompany Target company object
@@ -296,9 +297,10 @@ function pdf_build_address($outputlangs,$sourcecompany,$targetcompany='',$target
/** /**
* Show header of page for PDF generation * Show header of page for PDF generation
* @param pdf Object PDF *
* @param outputlang Object lang for output * @param PDF $pdf Object PDF
* @param page_height * @param Translate $outputlang Object lang for output
* @param int $page_height Height of page
*/ */
function pdf_pagehead(&$pdf,$outputlangs,$page_height) function pdf_pagehead(&$pdf,$outputlangs,$page_height)
{ {
@@ -314,10 +316,11 @@ function pdf_pagehead(&$pdf,$outputlangs,$page_height)
/** /**
* Add a draft watermark on PDF files * Add a draft watermark on PDF files
*
* @param pdf Object PDF * @param pdf Object PDF
* @param outputlangs Object lang * @param outputlangs Object lang
* @param height Height of PDF * @param h Height of PDF
* @param width Width of PDF * @param w Width of PDF
* @param unit Unit of height (mmn, pt, ...) * @param unit Unit of height (mmn, pt, ...)
* @param text Text to show * @param text Text to show
*/ */
@@ -492,8 +495,9 @@ function pdf_bank(&$pdf,$outputlangs,$curx,$cury,$account,$onlynumber=0)
/** /**
* Show footer of page for PDF generation * Show footer of page for PDF generation
*
* @param pdf The PDF factory * @param pdf The PDF factory
* @param outputlang Object lang for output * @param outputlangs Object lang for output
* @param paramfreetext Constant name of free text * @param paramfreetext Constant name of free text
* @param fromcompany Object company * @param fromcompany Object company
* @param marge_basse Margin bottom * @param marge_basse Margin bottom
@@ -688,17 +692,19 @@ function pdf_pagefoot(&$pdf,$outputlangs,$paramfreetext,$fromcompany,$marge_bass
/** /**
* Output line description into PDF * Output line description into PDF
* @param pdf PDF object *
* @param object Object * @param PDF $pdf PDF object
* @param i Current line number * @param Object $object Object
* @param outputlang Object lang for output * @param int $i Current line number
* @param w * @param Translate $outputlangs Object lang for output
* @param h * @param int $w Width
* @param posx * @param int $h Height
* @param posy * @param int $posx Pos x
* @param hideref Hide reference * @param int $posy Pos y
* @param hidedesc Hide description * @param int $hideref Hide reference
* @param issupplierline Is it a line for a supplier object ? * @param int $hidedesc Hide description
* @param int $issupplierline Is it a line for a supplier object ?
* @param HookManager $hookmanager Instance of HookManager
*/ */
function pdf_writelinedesc(&$pdf,$object,$i,$outputlangs,$w,$h,$posx,$posy,$hideref=0,$hidedesc=0,$issupplierline=0,$hookmanager=false) function pdf_writelinedesc(&$pdf,$object,$i,$outputlangs,$w,$h,$posx,$posy,$hideref=0,$hidedesc=0,$issupplierline=0,$hookmanager=false)
{ {

25
htdocs/main.inc.php
View File

@@ -85,6 +85,7 @@ function test_sql_and_script_inject($val, $get)
if ($get) $sql_inj += preg_match('/"/i', $val); // We refused " in GET parameters value if ($get) $sql_inj += preg_match('/"/i', $val); // We refused " in GET parameters value
return $sql_inj; return $sql_inj;
} }
/** /**
* Security: Return true if OK, false otherwise * Security: Return true if OK, false otherwise
* *
@@ -784,17 +785,17 @@ if (! function_exists("llxHeader"))
{ {
/** /**
* Show HTML header HTML + BODY + Top menu + left menu + DIV * Show HTML header HTML + BODY + Top menu + left menu + DIV
* @param head Add optionnal head lines *
* @param title Title of web page * @param string $head Optionnal head lines
* @param help_url Url links to help page * @param string $title HTML title
* Syntax is: For a wiki page: EN:EnglishPage|FR:FrenchPage|ES:SpanishPage * @param string $help_url Url links to help page
* For other external page: http://server/url * Syntax is: For a wiki page: EN:EnglishPage|FR:FrenchPage|ES:SpanishPage
* @param target Target to use in menu links * For other external page: http://server/url
* @param disablejs Do not output links to js (Ex: qd fonction utilisee par sous formulaire Ajax) * @param int $disablejs More content into html header
* @param disablehead Do not output head section * @param int $disablehead More content into html header
* @param arrayofjs Array of js files to add in header * @param array $arrayofjs Array of complementary js files
* @param arrayofcss Array of css files to add in header * @param array $arrayofcss Array of complementary css files
* @param morequerystring Query string to add to the link "print" to get same parameters (use only if autodetect fails) * @param string $morequerystring Query string to add to the link "print" to get same parameters (use only if autodetect fails)
*/ */
function llxHeader($head = '', $title='', $help_url='', $target='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='', $morequerystring='') function llxHeader($head = '', $title='', $help_url='', $target='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='', $morequerystring='')
{ {
@@ -829,7 +830,7 @@ function top_httphead()
* @param int $disablehead More content into html header * @param int $disablehead More content into html header
* @param array $arrayofjs Array of complementary js files * @param array $arrayofjs Array of complementary js files
* @param array $arrayofcss Array of complementary css files * @param array $arrayofcss Array of complementary css files
* @return none * @return void
*/ */
function top_htmlhead($head, $title='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='') function top_htmlhead($head, $title='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='')
{ {

11
htdocs/product/canvas/product/actions_card_product.class.php
View File

@@ -72,17 +72,6 @@ class ActionsCardProduct extends Product
return $langs->trans("Products"); return $langs->trans("Products");
} }
/**
* \brief Lecture des donnees dans la base
* \param id Product id
*/
function fetch($id='', $ref='', $action='')
{
$result = parent::fetch($id);
return $result;
}
/** /**
* Assign custom values for canvas (for example into this->tpl to be used by templates) * Assign custom values for canvas (for example into this->tpl to be used by templates)
* *

11
htdocs/product/canvas/service/actions_card_service.class.php
View File

@@ -72,17 +72,6 @@ class ActionsCardService extends Product
return $langs->trans("Products"); return $langs->trans("Products");
} }
/**
* \brief Lecture des donnees dans la base
* \param id Product id
*/
function fetch($id='', $ref='', $action='')
{
$result = parent::fetch($id);
return $result;
}
/** /**
* Assign custom values for canvas (for example into this->tpl to be used by templates) * Assign custom values for canvas (for example into this->tpl to be used by templates)
* *

5
htdocs/societe/canvas/default/actions_card_default.class.php
View File

@@ -69,7 +69,8 @@ class ActionsCardDefault extends ActionsCardCommon
/** /**
* Execute actions * Execute actions
* @param Id of object (may be empty for creation) *
* @param int $socid Id of object (may be empty for creation)
*/ */
function doActions($socid) function doActions($socid)
{ {
@@ -81,7 +82,7 @@ class ActionsCardDefault extends ActionsCardCommon
/** /**
* Assign custom values for canvas (for example into this->tpl to be used by templates) * Assign custom values for canvas (for example into this->tpl to be used by templates)
* *
* @param action Type of action * @param string $action Type of action
*/ */
function assign_values($action='') function assign_values($action='')
{ {

7
htdocs/societe/canvas/individual/actions_card_individual.class.php
View File

@@ -69,7 +69,8 @@ class ActionsCardIndividual extends ActionsCardCommon
/** /**
* Execute actions * Execute actions
* @param Id of object (may be empty for creation) *
* @param int $socid Id of object (may be empty for creation)
*/ */
function doActions($socid) function doActions($socid)
{ {
@@ -79,9 +80,9 @@ class ActionsCardIndividual extends ActionsCardCommon
} }
/** /**
* Assign custom values for canvas (for example into this->tpl to be used by templates) * Assign custom values for canvas (for example into this->tpl to be used by templates)
* *
* @param action Type of action * @param string $action Type of action
*/ */
function assign_values($action='') function assign_values($action='')
{ {