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

Qual: Documentation commentaires doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2004-08-28 12:19:06 +00:00
parent 179450cce0
commit 2a14b80e04
4 changed files with 82 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
htdocs/facture.class.php
View File

@ -56,7 +56,7 @@ class Facture
var $projetid; var $projetid;
/** /**
* \brief Constructeur de la classe * \brief Constructeur de la classe
* \param DB handler accès base de données * \param DB handler accès base de données
* \param soc_idp id societe ("" par defaut) * \param soc_idp id societe ("" par defaut)
* \param facid id facture ("" par defaut) * \param facid id facture ("" par defaut)
@ -78,7 +78,7 @@ class Facture
} }
/** /**
* \brief Création de la facture en base * \brief Création de la facture en base
* \param user object utilisateur qui crée * \param user object utilisateur qui crée
* *
*/ */

2
htdocs/includes/modules/fichinter/pdf_soleil.modules.php
View File

@ -21,7 +21,7 @@
* *
*/ */
/*! \file htdocs/includes/modules/ficheinter/pdf_soleil.modules.php /*! \file htdocs/includes/modules/fichinter/pdf_soleil.modules.php
\ingroup ficheinter \ingroup ficheinter
\brief Fichier de la classe permettant de générer les fiches d'intervention au modèle Soleil \brief Fichier de la classe permettant de générer les fiches d'intervention au modèle Soleil
\version $Revision$ \version $Revision$

136
htdocs/societe.class.php
View File

@ -23,6 +23,18 @@
* *
*/ */
/*!
\file htdocs/societe.class.php
\ingroup societe
\brief Fichier de la classe des societes
\version $Revision$
*/
/*! \class Societe
\brief Classe permettant la gestion des societes
*/
class Societe { class Societe {
var $db; var $db;
@ -44,6 +56,11 @@ class Societe {
var $fournisseur; var $fournisseur;
/**
* \brief Constructeur de la classe
* \param DB handler accès base de données
* \param id id societe (0 par defaut)
*/
function Societe($DB, $id=0) function Societe($DB, $id=0)
{ {
global $config; global $config;
@ -57,10 +74,10 @@ class Societe {
return 1; return 1;
} }
/*
* \brief Crée une société /**
* * \brief Crée la societe en base
* * \param user Utilisateur qui demande la création
*/ */
function create($user='') function create($user='')
{ {
@ -79,10 +96,11 @@ class Societe {
} }
} }
/*
* /**
* * \brief Mise a jour des paramètres de la société
* * \param id id societe
* \param user Utilisateur qui demande la mise à jour
*/ */
function update($id,$user='') function update($id,$user='')
{ {
@ -159,9 +177,9 @@ class Societe {
} }
} }
/* /**
* * \brief Recupére l'objet societe
* * \param socid id de la société à charger en mémoire
*/ */
function fetch($socid) function fetch($socid)
{ {
@ -266,16 +284,13 @@ class Societe {
} }
else else
{ {
/* Erreur select SQL */ dolibarr_print_error($this->db);
print $this->db->error();
return -1;
} }
} }
/* /**
* Suppression d'une societe. * \brief Suppression d'une societe de la base
* TODO: Cette fonction n'est pas utilisée.. * \TODO Cette fonction n'est pas utilisée. Attente des contraintes d'intégrité dans MySql
* Attente des contraintes d'intégrité dans MySql
*/ */
function delete($id) function delete($id)
{ {
@ -284,7 +299,7 @@ class Societe {
if (! $this->db->query($sql)) if (! $this->db->query($sql))
{ {
print $this->db->error(); dolibarr_print_error($this->db);
} }
// Suppression du répertoire document // Suppression du répertoire document
@ -315,9 +330,10 @@ class Societe {
deldir($docdir); deldir($docdir);
} }
} }
/*
* /**
* * \brief Retournes les factures impayées de la société
* \return array tableau des id de factures impayées
* *
*/ */
function factures_impayes() function factures_impayes()
@ -347,12 +363,11 @@ class Societe {
} }
return $facimp; return $facimp;
} }
/*
* /**
* * \brief Attribut le prefix de la société en base
* *
*/ */
function attribute_prefix() function attribute_prefix()
{ {
$sql = "SELECT nom FROM ".MAIN_DB_PREFIX."societe WHERE idp = '$this->id'"; $sql = "SELECT nom FROM ".MAIN_DB_PREFIX."societe WHERE idp = '$this->id'";
@ -384,25 +399,25 @@ class Societe {
} }
else else
{ {
print $this->db->error(); dolibarr_print_error($this->db);
} }
} }
} }
else else
{ {
print $this->db->error(); dolibarr_print_error($this->db);
} }
} }
} }
else else
{ {
print $this->db->error(); dolibarr_print_error($this->db);
} }
return $prefix; return $prefix;
} }
/** /**
* Définit la société comme un client * \brief Définit la société comme un client
*
* *
*/ */
function set_as_client() function set_as_client()
@ -416,9 +431,11 @@ class Societe {
return $this->db->query($sql); return $this->db->query($sql);
} }
} }
/** /**
* Définit la société comme un client * \brief Définit la société comme un client
* * \param remise montant de la remise
* \param user utilisateur qui place la remise
* *
*/ */
function set_remise_client($remise, $user) function set_remise_client($remise, $user)
@ -437,14 +454,15 @@ class Societe {
if (! $this->db->query($sql) ) if (! $this->db->query($sql) )
{ {
print $this->db->error(); dolibarr_print_error($this->db);
} }
} }
} }
/* /**
* Renvoie le nom d'une societe a partir d'un id * \brief Renvoie le nom d'une societe a partir d'un id
* \param id id de la société recherchée
* *
*/ */
function get_nom($id) function get_nom($id)
@ -464,14 +482,14 @@ class Societe {
$this->db->free(); $this->db->free();
} }
else { else {
dolibarr_print_error($db); dolibarr_print_error($this->db);
} }
} }
/* /**
* * \brief Renvoie la liste des contacts emails existant pour la société
* * \return array tableau des contacts emails
*/ */
function contact_email_array() function contact_email_array()
{ {
@ -498,13 +516,14 @@ class Societe {
} }
else else
{ {
print $this->db->error(); dolibarr_print_error($this->db);
} }
} }
/*
* /**
* * \brief Renvoie la liste des contacts de cette société
* \return array tableau des contacts
*/ */
function contact_array() function contact_array()
{ {
@ -531,13 +550,15 @@ class Societe {
} }
else else
{ {
print $this->db->error(); dolibarr_print_error($this->db);
} }
} }
/*
* /**
* * \brief Renvoie l'email d'un contact par son id
* \param rowid id du contact
* \return string email du contact
*/ */
function contact_get_email($rowid) function contact_get_email($rowid)
{ {
@ -560,14 +581,14 @@ class Societe {
} }
else else
{ {
print $this->db->error(); dolibarr_print_error($this->db);
print "<p>$rowid";
} }
} }
/*
* /**
* * \brief Renvoie la liste des types d'effectifs possibles
* \return array tableau des types d'effectifs
*/ */
function effectif_array() function effectif_array()
{ {
@ -593,9 +614,10 @@ class Societe {
} }
return $effs; return $effs;
} }
/*
* /**
* * \brief Renvoie la liste des formes juridiques existantes
* \return array tableau des formes juridiques
*/ */
function forme_juridique_array() function forme_juridique_array()
{ {

1
htdocs/translate.class.php
View File

@ -135,7 +135,6 @@ class Translate {
/** /**
* \brief Expédie le header correct et retourne le début de la page html * \brief Expédie le header correct et retourne le début de la page html
* [en] Send header and return a string of html start page * [en] Send header and return a string of html start page
* \access public
* \return string html header avec charset * \return string html header avec charset
*/ */
function lang_header() function lang_header()