From d9408d1847dfac69161de449dae56716deddb852 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Mon, 12 Sep 2011 18:15:11 +0000 Subject: [PATCH] Doxygen --- htdocs/adherents/class/adherent.class.php | 33 ++++--- .../adherents/class/adherent_type.class.php | 42 ++++----- htdocs/comm/propal/class/propal.class.php | 41 +++++---- .../actions_contactcard_common.class.php | 11 ++- .../actions_contactcard_default.class.php | 24 +---- htdocs/core/class/rssparser.class.php | 2 +- htdocs/core/class/smtps.class.php | 88 +++++++++---------- .../modules/member/labels/modules_labels.php | 11 ++- .../modules_facturefournisseur.php | 1 - .../modules_commandefournisseur.php | 1 - htdocs/lib/pdf.lib.php | 8 +- htdocs/main.inc.php | 3 + .../stock/class/mouvementstock.class.php | 75 ++++++---------- 13 files changed, 163 insertions(+), 177 deletions(-) diff --git a/htdocs/adherents/class/adherent.class.php b/htdocs/adherents/class/adherent.class.php index 376a800dc5b..944d7772e85 100644 --- a/htdocs/adherents/class/adherent.class.php +++ b/htdocs/adherents/class/adherent.class.php @@ -143,7 +143,7 @@ class Adherent extends CommonObject * @param addr_bcc email bcc * @param deliveryreceipt demande accuse reception * @param msgishtml 1=String IS already html, 0=String IS NOT html, -1=Unknown need autodetection - * @param errorsto erros to + * @param errors_to erros to * @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='') @@ -1454,6 +1454,7 @@ class Adherent extends CommonObject /** * Fonction qui dit si cet utilisateur est un redacteur existant dans spip + * * @return int 1=existe, 0=n'existe pas, -1=erreur */ function is_in_spip() @@ -1476,20 +1477,19 @@ class Adherent extends CommonObject { if ($mydb->num_rows($result)) { - # nous avons au moins une reponse + // nous avons au moins une reponse $mydb->close($result); return 1; } else { - # nous n'avons pas de reponse => n'existe pas + // nous n'avons pas de reponse => n'existe pas $mydb->close($result); return 0; } } else { - # error $this->error=$mydb->error(); return -1; } @@ -1502,6 +1502,7 @@ class Adherent extends CommonObject /** * Subscribe an email to all mailing-lists + * * @param listes To force mailing-list (string separated with ,) * @return int <=0 if KO, >0 if OK */ @@ -1544,7 +1545,7 @@ class Adherent extends CommonObject $this->pass, $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); $ch = curl_init(); @@ -1558,7 +1559,7 @@ class Adherent extends CommonObject //curl_setopt($ch, CURLOPT_POSTFIELDS, "a=3&b=5"); //--- Start buffering //ob_start(); - $result=curl_exec ($ch); + $result=curl_exec($ch); dol_syslog($result); //--- End buffering and clean output //ob_end_clean(); @@ -1567,7 +1568,7 @@ class Adherent extends CommonObject // error return -2; } - curl_close ($ch); + curl_close($ch); } return 1; @@ -1582,6 +1583,7 @@ class Adherent extends CommonObject /** * Unsubscribe an email from all mailing-lists * Used when a user is resiliated + * * @param listes To force mailing-list (string separated with ,) * @return int <=0 if KO, >0 if OK */ @@ -1629,7 +1631,7 @@ class Adherent extends CommonObject //curl_setopt($ch, CURLOPT_POSTFIELDS, "a=3&b=5"); //--- Start buffering //ob_start(); - $result=curl_exec ($ch); + $result=curl_exec($ch); dol_syslog($result); //--- End buffering and clean output //ob_end_clean(); @@ -1640,7 +1642,7 @@ class Adherent extends CommonObject // error return -2; } - curl_close ($ch); + curl_close($ch); } return 1; @@ -1654,6 +1656,7 @@ class Adherent extends CommonObject /** * Return full name (civility+' '+name+' '+lastname) + * * @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 @@ -1691,6 +1694,7 @@ class Adherent extends CommonObject /** * Return label of a civility of a contact + * * @param nohtmlentities 0=Encode with htmlentities for HTML output, 1=No htmlentities for memory translation * @return string Name translated of civility */ @@ -1706,6 +1710,7 @@ class Adherent extends CommonObject /** * Renvoie nom clicable (avec eventuellement le picto) + * * @param withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul * @param maxlen length max libelle * @param option Page lien @@ -1740,6 +1745,7 @@ class Adherent extends CommonObject /** * Return full address of member + * * @param withcountry 1=Add country into address string * @param sep Separator to use to build string * @return string Full address string @@ -1765,6 +1771,7 @@ class Adherent extends CommonObject /** * 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 * @return string Libelle */ @@ -1775,6 +1782,7 @@ class Adherent extends CommonObject /** * Renvoi le libelle d'un statut donne + * * @param statut Id statut * @param need_subscription 1 si type adherent avec cotisation, 0 sinon * @param date_end_subscription Date fin adhesion @@ -1856,6 +1864,7 @@ class Adherent extends CommonObject /** * Charge indicateurs this->nb de tableau de bord + * * @return int <0 si ko, >0 si ok */ function load_state_board() @@ -1889,6 +1898,7 @@ class Adherent extends CommonObject /** * Load indicators for dashboard (this->nbtodo and this->nbtodolate) + * * @param user Objet user * @return int <0 if KO, >0 if OK */ @@ -1979,6 +1989,7 @@ class Adherent extends CommonObject /** * Retourne chaine DN complete dans l'annuaire LDAP pour l'objet + * * @param info Info string loaded by _load_ldap_info * @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) @@ -1998,6 +2009,7 @@ class Adherent extends CommonObject /** * Initialise tableau info (tableau des attributs LDAP) + * * @return array Tableau info des attributs */ function _load_ldap_info() @@ -2044,7 +2056,8 @@ class Adherent extends CommonObject /** * 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) { diff --git a/htdocs/adherents/class/adherent_type.class.php b/htdocs/adherents/class/adherent_type.class.php index 3793be3b38d..de78dcb5b3c 100644 --- a/htdocs/adherents/class/adherent_type.class.php +++ b/htdocs/adherents/class/adherent_type.class.php @@ -61,11 +61,12 @@ class AdherentType extends CommonObject /** - * \brief Fonction qui permet de creer le status de l'adherent - * \param userid userid de l'adherent - * \return > 0 si ok, < 0 si ko + * Fonction qui permet de creer le status de l'adherent + * + * @param User $user User making creation + * @return >0 if OK, < 0 if KO */ - function create($userid) + function create($user) { global $conf; @@ -84,7 +85,7 @@ class AdherentType extends CommonObject if ($result) { $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX."adherent_type"); - return $this->update(); + return $this->update($user); } else { @@ -95,10 +96,12 @@ class AdherentType extends CommonObject /** - * \brief Met a jour en base donnees du type - * \return > 0 si ok, < 0 si ko + * Met a jour en base donnees du type + * + * @param User $user Object user making change + * @return int >0 if OK, < 0 if KO */ - function update() + function update($user) { $this->libelle=trim($this->libelle); @@ -110,11 +113,9 @@ class AdherentType extends CommonObject $sql.= "note = '".$this->db->escape($this->note)."',"; $sql.= "vote = '".$this->vote."',"; $sql.= "mail_valid = '".$this->db->escape($this->mail_valid)."'"; - $sql .= " WHERE rowid = $this->id"; $result = $this->db->query($sql); - if ($result) { return 1; @@ -127,12 +128,13 @@ class AdherentType extends CommonObject } /** - * \brief Fonction qui permet de supprimer le status de l'adherent - * \param rowid + * Fonction qui permet de supprimer le status de l'adherent + * + * @param int $rowid Id of member type to delete + * @return int >0 if OK, < 0 if KO */ function delete($rowid) { - $sql = "DELETE FROM ".MAIN_DB_PREFIX."adherent_type WHERE rowid = $rowid"; $resql=$this->db->query($sql); @@ -155,9 +157,10 @@ class AdherentType extends CommonObject } /** - * \brief Fonction qui permet de recuperer le status de l'adherent - * \param rowid - * \return int <0 si KO, >0 si OK + * Fonction qui permet de recuperer le status de l'adherent + * + * @param int $rowid Id of member type to load + * @return int <0 if KO, >0 if OK */ function fetch($rowid) { @@ -237,10 +240,9 @@ class AdherentType extends CommonObject /** * Renvoie nom clicable (avec eventuellement le picto) * - * @param withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul - * @param maxlen length max libelle - * @param option Page lien - * @return string Chaine avec URL + * @param int $withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul + * @param int $maxlen length max libelle + * @return string String with URL */ function getNomUrl($withpicto=0,$maxlen=0) { diff --git a/htdocs/comm/propal/class/propal.class.php b/htdocs/comm/propal/class/propal.class.php index 9c8328f0071..1ab5857648b 100644 --- a/htdocs/comm/propal/class/propal.class.php +++ b/htdocs/comm/propal/class/propal.class.php @@ -279,26 +279,29 @@ class Propal extends CommonObject /** * Add a proposal line into database (linked to product/service or not) - * \param propalid Id de la propale - * \param desc Description de la ligne - * \param pu_ht Prix unitaire - * \param qty Quantite - * \param txtva Taux de tva - * \param txlocaltax1 Local tax 1 rate - * \param txlocaltax2 Local tax 2 rate - * \param fk_product Id du produit/service predefini - * \param remise_percent Pourcentage de remise de la ligne - * \param price_base_type HT or TTC - * \param pu_ttc Prix unitaire TTC - * \param info_bits Bits de type de lignes - * \param type Type of line (product, service) - * \param rang Position of line - * \return int >0 if OK, <0 if KO + * Les parametres sont deja cense etre juste et avec valeurs finales a l'appel + * de cette methode. Aussi, pour le taux tva, il doit deja avoir ete defini + * par l'appelant par la methode get_default_tva(societe_vendeuse,societe_acheteuse,'',produit) + * et le desc doit deja avoir la bonne valeur (a l'appelant de gerer le multilangue) + * + * @param propalid Id de la propale + * @param desc Description de la ligne + * @param pu_ht Prix unitaire + * @param qty Quantite + * @param txtva Taux de tva + * @param txlocaltax1 Local tax 1 rate + * @param txlocaltax2 Local tax 2 rate + * @param fk_product Id du produit/service predefini + * @param remise_percent Pourcentage de remise de la ligne + * @param price_base_type HT or TTC + * @param pu_ttc Prix unitaire TTC + * @param info_bits Bits de type de lignes + * @param type Type of line (product, service) + * @param rang Position of line + * @param special_code Special code + * @param fk_parent_line Id of parent line + * @return int >0 if OK, <0 if KO * @see add_product - * \remarks Les parametres sont deja cense etre juste et avec valeurs finales a l'appel - * de cette methode. Aussi, pour le taux tva, il doit deja avoir ete defini - * par l'appelant par la methode get_default_tva(societe_vendeuse,societe_acheteuse,'',produit) - * et le desc doit deja avoir la bonne valeur (a l'appelant de gerer le multilangue) */ function addline($propalid, $desc, $pu_ht, $qty, $txtva, $txlocaltax1=0, $txlocaltax2=0, $fk_product=0, $remise_percent=0, $price_base_type='HT', $pu_ttc=0, $info_bits=0, $type=0, $rang=-1, $special_code=0, $fk_parent_line=0) { diff --git a/htdocs/contact/canvas/actions_contactcard_common.class.php b/htdocs/contact/canvas/actions_contactcard_common.class.php index 3de4ff37be5..d4162aafef2 100644 --- a/htdocs/contact/canvas/actions_contactcard_common.class.php +++ b/htdocs/contact/canvas/actions_contactcard_common.class.php @@ -47,7 +47,7 @@ abstract class ActionsContactCardCommon * Constructor * * @param DoliDB $DB Handler acces base de donnees - * @param string $targmetmodule Name of directory of module where canvas is stored + * @param string $targetmodule Name of directory of module where canvas is stored * @param string $canvas Name of canvas * @param streing $card Name of tab (sub-canvas) */ @@ -61,7 +61,9 @@ abstract class ActionsContactCardCommon /** - * Load data control + * Load data control + * + * @param int $id Id of object */ function doActions($id) { @@ -186,6 +188,8 @@ abstract class ActionsContactCardCommon /** * Return the title of card + * + * @param string $action Type of action */ function getTitle($action) { @@ -201,7 +205,8 @@ abstract class ActionsContactCardCommon /** * Set content of ->tpl array, to use into template - * @param action Type of template + * + * @param string $action Type of action */ function assign_values($action='') { diff --git a/htdocs/contact/canvas/default/actions_contactcard_default.class.php b/htdocs/contact/canvas/default/actions_contactcard_default.class.php index 1575e120a6e..c96cec3d6e6 100644 --- a/htdocs/contact/canvas/default/actions_contactcard_default.class.php +++ b/htdocs/contact/canvas/default/actions_contactcard_default.class.php @@ -38,7 +38,7 @@ class ActionsContactCardDefault extends ActionsContactCardCommon * Constructor * * @param DoliDB $DB Handler acces base de donnees - * @param string $targmetmodule Name of directory of module where canvas is stored + * @param string $targetmodule Name of directory of module where canvas is stored * @param string $canvas Name of canvas * @param string $card Name of tab (sub-canvas) */ @@ -50,24 +50,6 @@ class ActionsContactCardDefault extends ActionsContactCardCommon $this->card = $card; } - /** - * Execute actions - * @param Id of object (may be empty for creation) - */ - function doActions($id) - { - $return = parent::doActions($id); - return $return; - } - - - /** - * Return the title of card - */ - function getTitle($action) - { - return parent::getTitle($action); - } /** * Assigne les valeurs POST dans l'objet @@ -79,7 +61,8 @@ class ActionsContactCardDefault extends ActionsContactCardCommon /** * Assign custom values for canvas - * @param action Type of action + * + * @param string $action Type of action */ function assign_values($action='') { @@ -122,6 +105,7 @@ class ActionsContactCardDefault extends ActionsContactCardCommon /** * Check permissions of a user to show a page and an object. Check read permission * If $_REQUEST['action'] defined, we also check write permission. + * * @param user User to check * @param features Features to check (in most cases, it's module name) * @param objectid Object ID if we want to check permission on a particular record (optionnal) diff --git a/htdocs/core/class/rssparser.class.php b/htdocs/core/class/rssparser.class.php index cc144e2332c..fdf46ebf62e 100755 --- a/htdocs/core/class/rssparser.class.php +++ b/htdocs/core/class/rssparser.class.php @@ -61,7 +61,7 @@ class RssParser /** * Constructor * - * @param DoliDB $DB Database handler + * @param DoliDB $db Database handler */ public function RssParser($db) { diff --git a/htdocs/core/class/smtps.class.php b/htdocs/core/class/smtps.class.php index ea002ee18b5..b7bb607e93b 100755 --- a/htdocs/core/class/smtps.class.php +++ b/htdocs/core/class/smtps.class.php @@ -565,8 +565,8 @@ class SMTPs * This is defaulted to 'localhost' * This is used only with 'socket' based mail transmission * - * @param string $_strHost Host Name or IP of the Mail Server to use - * @return void + * @param string $_strHost Host Name or IP of the Mail Server to use + * @return void */ function setHost($_strHost) { @@ -578,7 +578,7 @@ class SMTPs * Retrieves the Host Name or IP of the Mail Server to use * This is used only with 'socket' based mail transmission * - * @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() { @@ -590,8 +590,8 @@ class SMTPs * This is defaulted to '25' * This is used only with 'socket' based mail transmission * - * @param int $_smtpsPort Port Number of the Mail Server to use - * @return void + * @param int $_intPort Port Number of the Mail Server to use + * @return void */ function setPort($_intPort) { @@ -604,7 +604,7 @@ class SMTPs * Retrieves the Port Number of the Mail Server to use * This is used only with 'socket' based mail transmission * - * @return string $_smtpsPort Port Number of the Mail Server to use + * @return string Port Number of the Mail Server to use */ function getPort() { @@ -614,10 +614,10 @@ class SMTPs /** * User Name for authentication on Mail Server * - * @param string $_strID User Name for authentication on Mail Server - * @return void + * @param string $_strID User Name for authentication on Mail Server + * @return void */ - function setID($_strID ) + function setID($_strID) { $this->_smtpsID = $_strID; } @@ -625,7 +625,7 @@ class SMTPs /** * Retrieves the User Name for authentication on Mail Server * - * @return string _smtpsID User Name for authentication on Mail Server + * @return string User Name for authentication on Mail Server */ function getID() { @@ -635,8 +635,8 @@ class SMTPs /** * User Password for authentication on Mail Server * - * @param string $_strPW User Password for authentication on Mail Server - * @return void + * @param string $_strPW User Password for authentication on Mail Server + * @return void */ function setPW($_strPW) { @@ -646,7 +646,7 @@ class SMTPs /** * Retrieves the User Password for authentication on Mail Server * - * @return string $_smtpsPW User Password for authentication on Mail Server + * @return string User Password for authentication on Mail Server */ function getPW() { @@ -732,7 +732,7 @@ class SMTPs /** * Retrieves the Content-Transfer-Encoding * - * @return string $_smtpsTransEncode Content-Transfer-Encoding + * @return string Content-Transfer-Encoding */ function getTransEncodeType() { @@ -780,8 +780,8 @@ class SMTPs * structured array. This array is designed to remove duplicate * addresses and to sort them by Domain. * - * @param string $_type TO, CC, or BCC lists to add addrresses into - * @param mixed $_addrList Array or COMMA delimited string of addresses + * @param string $_type TO, CC, or BCC lists to add addrresses into + * @param mixed $_addrList Array or COMMA delimited string of addresses * @return void * */ @@ -854,7 +854,8 @@ class SMTPs * - $_aryEmail[host] = "domain.tld" * - $_aryEmail[user] = "userName" * - * @return array $_aryEmail An array of the various parts of an email address + * @param string $_strAddr Email address + * @return array An array of the various parts of an email address */ function _strip_email($_strAddr) { @@ -896,7 +897,7 @@ class SMTPs * This is a "build as you go" method. Each time this method is called * the underlaying array is destroyed and reconstructed. * - * @return array $_RCPT_list Returns an array of bares addresses + * @return array Returns an array of bares addresses */ function get_RCPT_list() { @@ -924,10 +925,10 @@ class SMTPs /** * Returns an array of addresses for a specific type; TO, CC or BCC * - * @param mixed $_which Which collection of adresses to return - * @return array $_RCPT_list Array of emaill address + * @param mixed $_which Which collection of adresses to return + * @return array Array of emaill address */ - function get_email_list( $_which = null ) + function get_email_list($_which = null) { // We need to know which address segment to pull if ( $_which ) @@ -975,10 +976,10 @@ class SMTPs /** * TO Address[es] inwhich to send mail to * - * @param mixed $_addrTo TO Address[es] inwhich to send mail to - * @return void + * @param mixed $_addrTo TO Address[es] inwhich to send mail to + * @return void */ - function setTO ( $_addrTo ) + function setTO($_addrTo) { if ( $_addrTo ) $this->_buildAddrList( 'to', $_addrTo ); @@ -987,7 +988,7 @@ class SMTPs /** * Retrieves the TO Address[es] inwhich to send mail to * - * @return string $_msgRecipients TO Address[es] inwhich to send mail to + * @return string TO Address[es] inwhich to send mail to */ function getTo() { @@ -997,8 +998,8 @@ class SMTPs /** * CC Address[es] inwhich to send mail to * - * @param string $_msgRecipients CC Address[es] inwhich to send mail to - * @return void + * @param string $_strCC CC Address[es] inwhich to send mail to + * @return void */ function setCC($_strCC) { @@ -1009,7 +1010,7 @@ class SMTPs /** * Retrieves the CC Address[es] inwhich to send mail to * - * @return string $_msgRecipients CC Address[es] inwhich to send mail to + * @return string CC Address[es] inwhich to send mail to */ function getCC() { @@ -1019,8 +1020,8 @@ class SMTPs /** * BCC Address[es] inwhich to send mail to * - * @param string $_msgRecipients BCC Address[es] inwhich to send mail to - * @return void + * @param string $_strBCC Recipients BCC Address[es] inwhich to send mail to + * @return void */ function setBCC($_strBCC) { @@ -1031,7 +1032,7 @@ class SMTPs /** * Retrieves the BCC Address[es] inwhich to send mail to * - * @return string $_msgRecipients BCC Address[es] inwhich to send mail to + * @return string BCC Address[es] inwhich to send mail to */ function getBCC() { @@ -1041,8 +1042,8 @@ class SMTPs /** * Message Subject * - * @param string $_msgSubject Message Subject - * @return void + * @param string $_strSubject Message Subject + * @return void */ function setSubject($_strSubject = '') { @@ -1053,7 +1054,7 @@ class SMTPs /** * Retrieves the Message Subject * - * @return string $_msgSubject Message Subject + * @return string Message Subject */ function getSubject() { @@ -1334,8 +1335,8 @@ class SMTPs * - [2] Private * - [3] Company Confidential * - * @param string $_value Message Sensitivity - * @return void + * @param string $_value Message Sensitivity + * @return void */ function setSensitivity($_value = 0) { @@ -1352,8 +1353,8 @@ class SMTPs * - [2] Private * - [3] Company Confidential * - * @param string $_msgSensitivity Message Sensitivity - * @return void + * @param string Message Sensitivity + * @return void */ function getSensitivity() { @@ -1370,8 +1371,8 @@ class SMTPs * - [4] 'Low' * - [5] 'Lowest' * - * @param string $_value Message Priority - * @return void + * @param string $_value Message Priority + * @return void */ function setPriority ( $_value = 3 ) { @@ -1390,7 +1391,6 @@ class SMTPs * - [4] 'Low' * - [5] 'Lowest' * - * @param string $_value Message Priority * @return void */ function getPriority() @@ -1403,8 +1403,8 @@ class SMTPs /** * Set flag which determines whether to calculate message MD5 checksum. * - * @param string $_value Message Priority - * @return void + * @param string $_flag Message Priority + * @return void */ function setMD5flag($_flag = false) { @@ -1414,7 +1414,7 @@ class SMTPs /** * Gets flag which determines whether to calculate message MD5 checksum. * - * @return string $_value Message Priority + * @return string Message Priority */ function getMD5flag() { diff --git a/htdocs/includes/modules/member/labels/modules_labels.php b/htdocs/includes/modules/member/labels/modules_labels.php index 1bd63add071..144619964ec 100644 --- a/htdocs/includes/modules/member/labels/modules_labels.php +++ b/htdocs/includes/modules/member/labels/modules_labels.php @@ -61,12 +61,11 @@ class ModelePDFLabels /** * Create a document onto disk accordign to template module * - * @param DoliDB $db objet base de donnee - * @param int $id id de la facture a creer - * @param string $message message - * @param string $modele force le modele a utiliser ('' to not force) - * @param string $outputlangs objet lang a utiliser pour traduction - * @return int <0 if KO, >0 if OK + * @param DoliDB $db Database handler + * @param array $arrayofmembers Array of members + * @param string $modele Force le modele a utiliser ('' to not force) + * @param Translate $outputlangs Objet lang a utiliser pour traduction + * @return int <0 if KO, >0 if OK */ function members_label_pdf_create($db, $arrayofmembers, $modele, $outputlangs) { diff --git a/htdocs/includes/modules/supplier_invoice/modules_facturefournisseur.php b/htdocs/includes/modules/supplier_invoice/modules_facturefournisseur.php index 4db49f84484..387d4b3bb05 100755 --- a/htdocs/includes/modules/supplier_invoice/modules_facturefournisseur.php +++ b/htdocs/includes/modules/supplier_invoice/modules_facturefournisseur.php @@ -60,7 +60,6 @@ abstract class ModelePDFSuppliersInvoices extends CommonDocGenerator * @param Object $object object supplier invoice * @param string $model force le modele a utiliser ('' to not force) * @param Translate $outputlangs objet lang a utiliser pour traduction - * @param HookManager $hookmanager Hook manager instance * @return int 0 if KO, 1 if OK */ function supplier_invoice_pdf_create($db, $object, $model, $outputlangs) diff --git a/htdocs/includes/modules/supplier_order/modules_commandefournisseur.php b/htdocs/includes/modules/supplier_order/modules_commandefournisseur.php index 37bdfb7d965..e54e109193a 100644 --- a/htdocs/includes/modules/supplier_order/modules_commandefournisseur.php +++ b/htdocs/includes/modules/supplier_order/modules_commandefournisseur.php @@ -146,7 +146,6 @@ class ModeleNumRefSuppliersOrders * @param int $hidedetails Hide details of lines * @param int $hidedesc Hide description * @param int $hideref Hide ref - * @param HookManager $hookmanager Hook manager instance * @return int 0 if KO, 1 if OK */ function supplier_order_pdf_create($db, $object, $model, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0) diff --git a/htdocs/lib/pdf.lib.php b/htdocs/lib/pdf.lib.php index bcd27ef7ef5..8396d89bb6a 100644 --- a/htdocs/lib/pdf.lib.php +++ b/htdocs/lib/pdf.lib.php @@ -299,7 +299,7 @@ function pdf_build_address($outputlangs,$sourcecompany,$targetcompany='',$target * Show header of page for PDF generation * * @param PDF $pdf Object PDF - * @param Translate $outputlang Object lang for output + * @param Translate $outputlangs Object lang for output * @param int $page_height Height of page */ function pdf_pagehead(&$pdf,$outputlangs,$page_height) @@ -1193,9 +1193,9 @@ function pdf_getTotalQty($object,$type='',$outputlangs,$hookmanager=false) /** * Convert a currency code into its symbol * - * @param pdf PDF object - * @param currency_code Currency code - * @param string Currency symbol encoded into UTF8 + * @param PDF $pdf PDF object + * @param string $currency_code Currency code + * @return string Currency symbol encoded into UTF8 */ function pdf_getCurrencySymbol(&$pdf, $currency_code) { diff --git a/htdocs/main.inc.php b/htdocs/main.inc.php index 78cb30beddf..8d51312eaf9 100644 --- a/htdocs/main.inc.php +++ b/htdocs/main.inc.php @@ -67,6 +67,7 @@ if (function_exists('get_magic_quotes_gpc')) // magic_quotes_* removed in PHP6 * * @param string $val Value * @param string $get 1=GET, 0=POST + * @return boolean true if ther is an injection */ function test_sql_and_script_inject($val, $get) { @@ -91,6 +92,7 @@ function test_sql_and_script_inject($val, $get) * * @param string $var Variable name * @param string $get 1=GET, 0=POST + * @return boolean true if ther is an injection */ function analyse_sql_and_script(&$var, $get) { @@ -115,6 +117,7 @@ function analyse_sql_and_script(&$var, $get) return (test_sql_and_script_inject($var,$get) <= 0); } } + // Sanity check on URL if (! empty($_SERVER["PHP_SELF"])) { diff --git a/htdocs/product/stock/class/mouvementstock.class.php b/htdocs/product/stock/class/mouvementstock.class.php index 3f2f31006ad..3c6d2e051e6 100644 --- a/htdocs/product/stock/class/mouvementstock.class.php +++ b/htdocs/product/stock/class/mouvementstock.class.php @@ -247,8 +247,15 @@ class MouvementStock /** * Create movement in database for all subproducts - * @param label Label of stock movement - * @return int <0 if KO, 0 if OK + * + * @param User $user Object user + * @param int $idProduct Id product + * @param int $entrepot_id Warehouse id + * @param int $qty Quantity + * @param int $type Type + * @param int $price Price + * @param string $label Label of movement + * @return int <0 if KO, 0 if OK */ function _createSubProduct($user, $idProduct, $entrepot_id, $qty, $type, $price=0, $label='') { @@ -289,50 +296,16 @@ class MouvementStock } - /** - * Cree un mouvement en base pour toutes les compositions de produits - * @param label Label of stock movement - * @return int <0 if KO, 0 if OK - */ - /* This function is specific to a module. Should be inside the trigger of module instead of core code. - function _createProductComposition($user, $fk_product, $entrepot_id, $qty, $type, $price=0, $label='') - { - dol_syslog("MouvementStock::_createProductComposition $user->id, $fk_product, $entrepot_id, $qty, $type, $price, $label"); - $products_compo = array(); - - $sql = "SELECT fk_product_composition, qte, etat_stock"; - $sql.= " FROM ".MAIN_DB_PREFIX."product_composition"; - $sql.= " WHERE fk_product = $fk_product;"; - - $resql = $this->db->query($sql); - if ($resql) - { - while ($item = $this->db->fetch_object($resql)) - { - if ($item->etat_stock != 0) array_push($products_compo,$item); - } - $this->db->free($resql); - } - else - { - dol_syslog("MouvementStock::_createProductComposition echec update ".$this->error, LOG_ERR); - return -1; - } - - // Create movement for each subproduct - foreach($products_compo as $product) - { - $this->_create($user, $product->fk_product_composition, $entrepot_id, ($qty*$product->qte), $type, 0, $label); - } - - return 0; - }*/ - - /** * Decrease stock for product and subproducts - * @param label Label of stock movement - * @return int <0 if KO, >0 if OK + * + * @param User $user Object user + * @param int $fk_product Id product + * @param int $entrepot_id Warehouse id + * @param int $qty Quantity + * @param int $price Price + * @param string $label Label of stock movement + * @return int <0 if KO, >0 if OK */ function livraison($user, $fk_product, $entrepot_id, $qty, $price=0, $label='') { @@ -342,8 +315,13 @@ class MouvementStock /** * Increase stock for product and subproducts - * @param label Label of stock movement - * @return int <0 if KO, >0 if OK + * + * @param User $user Object user + * @param int $fk_product Id product + * @param int $entrepot_id Warehouse id + * @param int $qty Quantity + * @param int $price Price + * @param string $label Label of stock movement */ function reception($user, $fk_product, $entrepot_id, $qty, $price=0, $label='') { @@ -353,8 +331,9 @@ class MouvementStock /** * Return nb of subproducts lines for a product - * @param $id - * @return int + * + * @param int $id Id of product + * @return int <0 if KO, nb of subproducts if OK */ function nbOfSubProdcuts($id) {