From 4f23be1b50e0884d2c4f8319230f30b90a4585eb Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@destailleur.fr>
Date: Tue, 13 Mar 2012 01:43:13 +0100
Subject: [PATCH] Qual: Removed checkstyle errors and dead code
---
htdocs/comm/fiche.php | 5 -
htdocs/compta/clients.php | 7 -
.../canvas/actions_card_common.class.php | 2 +-
htdocs/societe/class/societe.class.php | 240 ++++++------------
4 files changed, 84 insertions(+), 170 deletions(-)
diff --git a/htdocs/comm/fiche.php b/htdocs/comm/fiche.php
index cc83e426ca0..8583b52ca97 100644
--- a/htdocs/comm/fiche.php
+++ b/htdocs/comm/fiche.php
@@ -85,11 +85,6 @@ if ($action == 'setcustomeraccountancycode')
$action="";
}
-if ($action == 'attribute_prefix' && $user->rights->societe->creer)
-{
- $object->fetch($id);
- $object->attribute_prefix($db, $id);
-}
// conditions de reglement
if ($action == 'setconditions' && $user->rights->societe->creer)
{
diff --git a/htdocs/compta/clients.php b/htdocs/compta/clients.php
index eb3292da8f1..c6a41159583 100644
--- a/htdocs/compta/clients.php
+++ b/htdocs/compta/clients.php
@@ -64,13 +64,6 @@ llxHeader();
$thirdpartystatic=new Societe($db);
-if ($action == 'attribute_prefix')
-{
- $societe = new Societe($db);
- $societe->fetch($socid);
- $societe->attribute_prefix($db, $socid);
-}
-
if ($action == 'note')
{
$sql = "UPDATE ".MAIN_DB_PREFIX."societe SET note='".$note."' WHERE rowid=".$socid;
diff --git a/htdocs/societe/canvas/actions_card_common.class.php b/htdocs/societe/canvas/actions_card_common.class.php
index 41894985623..fc239fb69a3 100644
--- a/htdocs/societe/canvas/actions_card_common.class.php
+++ b/htdocs/societe/canvas/actions_card_common.class.php
@@ -96,7 +96,7 @@ abstract class ActionsCardCommon
/**
* Load data control
*
- * @param int $socid Id of third party
+ * @param int &$action Action code
* @return void
*/
function doActions(&$action)
diff --git a/htdocs/societe/class/societe.class.php b/htdocs/societe/class/societe.class.php
index 77730fb5c31..d3b13369f2c 100644
--- a/htdocs/societe/class/societe.class.php
+++ b/htdocs/societe/class/societe.class.php
@@ -932,7 +932,7 @@ class Societe extends CommonObject
// Delete directory
$docdir = $conf->societe->dir_output . "/" . $id;
- if (file_exists ($docdir))
+ if (file_exists($docdir))
{
dol_delete_dir_recursive($docdir);
}
@@ -948,106 +948,10 @@ class Societe extends CommonObject
}
-
/**
- * Update record to set prefix
+ * Define third party as a customer
*
- * @return void
- */
- function attribute_prefix()
- {
- global $conf;
-
- $sql = "SELECT nom as name FROM ".MAIN_DB_PREFIX."societe WHERE rowid = '".$this->id."'";
- $resql=$this->db->query($sql);
- if ($resql)
- {
- if ($this->db->num_rows($resql))
- {
- $obj=$this->db->fetch_object($resql);
- $nom = preg_replace("/[[:punct:]]/","",$obj->name);
- $this->db->free();
-
- $prefix = $this->genprefix($nom,4);
-
- $sql = "SELECT count(*) as nb FROM ".MAIN_DB_PREFIX."societe";
- $sql.= " WHERE prefix_comm = '".$prefix."'";
- $sql.= " AND entity = ".$conf->entity;
-
- $resql=$this->db->query($sql);
- if ($resql)
- {
- $obj=$this->db->fetch_object($resql);
- $this->db->free($resql);
- if (! $obj->nb)
- {
- $sql = "UPDATE ".MAIN_DB_PREFIX."societe set prefix_comm='".$prefix."' WHERE rowid='".$this->id."'";
-
- if ( $this->db->query($sql) )
- {
-
- }
- else
- {
- dol_print_error($this->db);
- }
- }
- }
- else
- {
- dol_print_error($this->db);
- }
- }
- }
- else
- {
- dol_print_error($this->db);
- }
- return $prefix;
- }
-
- /**
- * Genere le prefix de la societe
- *
- * @param nom nom de la societe
- * @param taille taille du prefix a retourner
- * @param mot l'indice du mot a utiliser
- */
- function genprefix($nom, $taille=4, $mot=0)
- {
- $retour = "";
- $tab = explode(" ",$nom);
-
- if ($mot < count($tab))
- {
- $prefix = strtoupper(substr($tab[$mot],0,$taille));
-
- // On verifie que ce prefix n'a pas deja ete pris ...
- $sql = "SELECT count(*) as nb FROM ".MAIN_DB_PREFIX."societe";
- $sql.= " WHERE prefix_comm = '".$prefix."'";
- $sql.= " AND entity = ".$conf->entity;
-
- $resql=$this->db->query($sql);
- if ($resql)
- {
- $obj=$this->db->fetch_object($resql);
- if ($obj->nb)
- {
- $this->db->free();
- $retour = $this->genprefix($nom,$taille,$mot+1);
- }
- else
- {
- $retour = $prefix;
- }
- }
- }
- return $retour;
- }
-
- /**
- * \brief Define third party as a customer
- * \return int <0 if KO, >0 if OK
+ * @return int <0 if KO, >0 if OK
*/
function set_as_client()
{
@@ -1071,11 +975,12 @@ class Societe extends CommonObject
}
/**
- * \brief Definit la societe comme un client
- * \param remise Valeur en % de la remise
- * \param note Note/Motif de modification de la remise
- * \param user Utilisateur qui definie la remise
- * \return int <0 si ko, >0 si ok
+ * Definit la societe comme un client
+ *
+ * @param float $remise Valeur en % de la remise
+ * @param string $note Note/Motif de modification de la remise
+ * @param User $user Utilisateur qui definie la remise
+ * @return int <0 if KO, >0 if OK
*/
function set_remise_client($remise, $note, $user)
{
@@ -1208,9 +1113,10 @@ class Societe extends CommonObject
}
/**
- * Return array of sales representatives
+ * Return array of sales representatives
*
- * @return array Array of sales representatives of third party
+ * @param User $user Object user
+ * @return array Array of sales representatives of third party
*/
function getSalesRepresentatives($user='')
{
@@ -1249,6 +1155,7 @@ class Societe extends CommonObject
*
* @param int $price_level Level of price
* @param User $user Use making change
+ * @return int <0 if KO, >0 if OK
*/
function set_price_level($price_level, $user)
{
@@ -1277,34 +1184,38 @@ class Societe extends CommonObject
}
/**
+ * Add link to sales representative
*
- *
+ * @param User $user Object user
+ * @param int $commid Id of user
+ * @return void
*/
function add_commercial($user, $commid)
{
if ($this->id > 0 && $commid > 0)
{
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."societe_commerciaux ";
- $sql .= " WHERE fk_soc = ".$this->id." AND fk_user =".$commid;
+ $sql = "DELETE FROM ".MAIN_DB_PREFIX."societe_commerciaux";
+ $sql.= " WHERE fk_soc = ".$this->id." AND fk_user =".$commid;
$this->db->query($sql);
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."societe_commerciaux ";
- $sql .= " ( fk_soc, fk_user )";
- $sql .= " VALUES (".$this->id.",".$commid.")";
+ $sql = "INSERT INTO ".MAIN_DB_PREFIX."societe_commerciaux";
+ $sql.= " ( fk_soc, fk_user )";
+ $sql.= " VALUES (".$this->id.",".$commid.")";
if (! $this->db->query($sql) )
{
dol_syslog(get_class($this)."::add_commercial Erreur");
}
-
}
}
/**
+ * Add link to sales representative
*
- *
- *
+ * @param User $user Object user
+ * @param int $commid Id of user
+ * @return void
*/
function del_commercial($user, $commid)
{
@@ -1317,7 +1228,6 @@ class Societe extends CommonObject
{
dol_syslog(get_class($this)."::del_commercial Erreur");
}
-
}
}
@@ -1325,10 +1235,10 @@ class Societe extends CommonObject
/**
* Return a link on thirdparty (with picto)
*
- * @param withpicto Add picto into link (0=No picto, 1=Include picto with link, 2=Picto only)
- * @param option Target of link ('', 'customer', 'prospect', 'supplier')
- * @param maxlen Max length of text
- * @return string String with URL
+ * @param int $withpicto Add picto into link (0=No picto, 1=Include picto with link, 2=Picto only)
+ * @param string $option Target of link ('', 'customer', 'prospect', 'supplier')
+ * @param int $maxlen Max length of text
+ * @return string String with URL
*/
function getNomUrl($withpicto=0,$option='',$maxlen=0)
{
@@ -1377,8 +1287,9 @@ class Societe extends CommonObject
/**
* Return label of status (activity, closed)
- * @param mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long
- * @return string Libelle
+ *
+ * @param int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long
+ * @return string Libelle
*/
function getLibStatut($mode=0)
{
@@ -1386,10 +1297,11 @@ class Societe extends CommonObject
}
/**
- * Renvoi le libelle d'un statut donne
- * @param statut Id statut
- * @param mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
- * @return string Libelle du statut
+ * Renvoi le libelle d'un statut donne
+ *
+ * @param int $statut Id statut
+ * @param int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
+ * @return string Libelle du statut
*/
function LibStatut($statut,$mode=0)
{
@@ -1504,8 +1416,8 @@ class Societe extends CommonObject
/**
* Return list of contacts emails or mobile existing for third party
*
- * @param mode 'email' or 'mobile'
- * @return array Array of contacts emails or mobile
+ * @param string $mode 'email' or 'mobile'
+ * @return array Array of contacts emails or mobile
*/
function contact_property_array($mode='email')
{
@@ -1573,11 +1485,11 @@ class Societe extends CommonObject
}
/**
- * Return property of contact from its id
+ * Return property of contact from its id
*
- * @param rowid id of contact
- * @param mode 'email' or 'mobile'
- * @return string email of contact
+ * @param int $rowid id of contact
+ * @param string $mode 'email' or 'mobile'
+ * @return string email of contact
*/
function contact_get_property($rowid,$mode)
{
@@ -1637,6 +1549,8 @@ class Societe extends CommonObject
/**
* Load this->bank_account attribut
+ *
+ * @return int 1
*/
function load_ban()
{
@@ -1649,7 +1563,11 @@ class Societe extends CommonObject
return 1;
}
-
+ /**
+ * Check bank numbers
+ *
+ * @return int <0 if KO, >0 if OK
+ */
function verif_rib()
{
$this->load_ban();
@@ -1857,8 +1775,8 @@ class Societe extends CommonObject
* Peut etre identique a celui saisit ou genere automatiquement.
* A ce jour seule la generation automatique est implementee
*
- * @param type Type of thirdparty ('customer' or 'supplier')
- * @return string Code compta si ok, 0 si aucun, <0 si ko
+ * @param string $type Type of thirdparty ('customer' or 'supplier')
+ * @return string Code compta si ok, 0 si aucun, <0 si ko
*/
function get_codecompta($type)
{
@@ -1896,8 +1814,8 @@ class Societe extends CommonObject
/**
* Defini la societe mere pour les filiales
*
- * @param id id compagnie mere a positionner
- * @return int <0 si ko, >0 si ok
+ * @param int $id id compagnie mere a positionner
+ * @return int <0 if KO, >0 if OK
*/
function set_parent($id)
{
@@ -1919,9 +1837,10 @@ class Societe extends CommonObject
}
/**
- * \brief Supprime la societe mere
- * \param id id compagnie mere a effacer
- * \return int <0 si ko, >0 si ok
+ * Supprime la societe mere
+ *
+ * @param int $id id compagnie mere a effacer
+ * @return int <0 if KO, >0 if KO
*/
function remove_parent($id)
{
@@ -1943,9 +1862,10 @@ class Societe extends CommonObject
}
/**
- * Returns if a profid sould be verified
- * @param idprof 1,2,3,4 (Exemple: 1=siren,2=siret,3=naf,4=rcs/rm)
- * @return boolean true , false
+ * Returns if a profid sould be verified
+ *
+ * @param int $idprof 1,2,3,4 (Exemple: 1=siren,2=siret,3=naf,4=rcs/rm)
+ * @return boolean true , false
*/
function id_prof_verifiable($idprof)
{
@@ -2020,11 +1940,12 @@ class Societe extends CommonObject
}
/**
- * Verifie la validite d'un identifiant professionnel en fonction du pays de la societe (siren, siret, ...)
- * @param idprof 1,2,3,4 (Exemple: 1=siren,2=siret,3=naf,4=rcs/rm)
- * @param soc Objet societe
- * @return int <=0 if KO, >0 if OK
- * TODO not in business class
+ * Verifie la validite d'un identifiant professionnel en fonction du pays de la societe (siren, siret, ...)
+ *
+ * @param int $idprof 1,2,3,4 (Exemple: 1=siren,2=siret,3=naf,4=rcs/rm)
+ * @param Societe $soc Objet societe
+ * @return int <=0 if KO, >0 if OK
+ * TODO not in business class
*/
function id_prof_check($idprof,$soc)
{
@@ -2232,8 +2153,9 @@ class Societe extends CommonObject
}
/**
- * Return if third party is a company (Business) or an end user (Consumer)
- * @return boolean true=is a company, false=a and user
+ * Return if third party is a company (Business) or an end user (Consumer)
+ *
+ * @return boolean true=is a company, false=a and user
*/
function isACompany()
{
@@ -2250,8 +2172,9 @@ class Societe extends CommonObject
/**
- * Return if a country is inside the EEC (European Economic Community)
- * @return boolean true = pays inside EEC, false= pays outside EEC
+ * Return if a country is inside the EEC (European Economic Community)
+ *
+ * @return boolean true = pays inside EEC, false= pays outside EEC
*/
function isInEEC()
{
@@ -2295,6 +2218,7 @@ class Societe extends CommonObject
/**
* Charge la liste des categories fournisseurs
+ *
* @return int 0 if success, <> 0 if error
*/
function LoadSupplierCateg()
@@ -2321,7 +2245,9 @@ class Societe extends CommonObject
/**
* Charge la liste des categories fournisseurs
- * @return int 0 if success, <> 0 if error
+ *
+ * @param int $categorie_id Id of category
+ * @return int 0 if success, <> 0 if error
*/
function AddFournisseurInCategory($categorie_id)
{
@@ -2341,11 +2267,11 @@ class Societe extends CommonObject
/**
- * Create a third party into database from a member object
+ * Create a third party into database from a member object
*
- * @param member Object member
- * @param socname Name of third party to force
- * @return int <0 if KO, id of created account if OK
+ * @param Member $member Object member
+ * @param string $socname Name of third party to force
+ * @return int <0 if KO, id of created account if OK
*/
function create_from_member($member,$socname='')
{
--
GitLab