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

Doc: Ajout commentaires pour doc doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2004-08-15 17:33:05 +00:00
parent 821de49e77
commit ac6e3b1136
8 changed files with 240 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
htdocs/includes/modules/propale/mod_propale_ivoire.php
View File

@ -21,13 +21,32 @@
*
*/
Class mod_propale_ivoire
/*! \file htdocs/includes/modules/propale/mod_propale_ivoire.php
\ingroup propale
\brief Fichier contenant la classe du modèle de numérotation de référence de propale Ivoire
\version $Revision$
*/
/*! \class mod_propale_ivoire
\brief Classe du modèle de numérotation de référence de propale Ivoire
*/
class mod_propale_ivoire extends ModeleNumRefPropales
{
/*! \brief Renvoi la description du modele de numérotation
* \return string Texte descripif
*/
function info()
{
return "Renvoie le numéro sous la forme PR0012";
return "Renvoie le numéro sous la forme PR040001";
}
/*! \brief Renvoie la référence de propale suivante non utilisée
* \param objsoc Objet société
* \return string Texte descripif
*/
function propale_get_num($objsoc=0)
{
global $db;

22
htdocs/includes/modules/propale/mod_propale_jade.php
View File

@ -21,13 +21,31 @@
*
*/
Class mod_propale_jade
/*! \file htdocs/includes/modules/propale/mod_propale_jade.php
\ingroup propale
\brief Fichier contenant la classe du modèle de numérotation de référence de propale Jade
\version $Revision$
*/
/*! \class mod_propale_jade
\brief Classe du modèle de numérotation de référence de propale Jade
*/
class mod_propale_jade extends ModeleNumRefPropales
{
/*! \brief Renvoi la description du modele de numérotation
* \return string Texte descripif
*/
function info()
{
return "Renvoie le numéro sous la forme PROP2, PROP3";
return "Renvoie le numéro sous la forme PROP1, PROP2, ...";
}
/*! \brief Renvoie la référence de propale suivante non utilisée
* \param objsoc Objet société
* \return string Texte descripif
*/
function propale_get_num($objsoc=0)
{
global $db;

108
htdocs/includes/modules/propale/modules_propale.php
View File

@ -1,5 +1,6 @@
<?PHP
/* Copyright (C) 2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2004 Laurent Destailleur <eldy@users.sourceforge.net>
*
* 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
@ -21,23 +22,114 @@
*
*/
/*! \file htdocs/includes/modules/propale/modules_propale.php
\ingroup propale
\brief Fichier contenant la classe mère de generation des propales en PDF
et la classe mère de numérotation des propales
\version $Revision$
*/
/*! \class ModelePDFPropales
\brief Classe mère des modèles de propale
*/
class ModelePDFPropales extends FPDF
{
var $error='';
/*! \brief Constructeur
*/
function ModelePDFFactures()
{
}
/*!
\brief Renvoi le dernier message d'erreur de création de propale
*/
function pdferror()
{
return $this->error;
}
}
/*! \class ModeleNumRefPropales
\brief Classe mère des modèles de numérotation des références de propales
*/
class ModeleNumRefPropales
{
var $error='';
/*! \brief Constructeur
*/
function ModeleNumRefPropales()
{
}
/*! \brief Renvoi la description par defaut du modele de numérotation
* \return string Texte descripif
*/
function getDesc()
{
global $langs;
$langs->load("propale");
return $langs->trans("NoDescription");
}
/*! \brief Renvoi un exemple de numérotation
* \return string Example
*/
function getExample()
{
global $langs;
$langs->load("propale");
return $langs->trans("NoExample");
}
/*!
\brief Renvoi le dernier message d'erreur de création de propale
*/
function numreferror()
{
return $this->error;
}
}
/*!
\brief Crée une propale sur disque en fonction du modèle de PROPALE_ADDON_PDF
\param db objet base de donnée
\param facid id de la facture à créer
*/
function propale_pdf_create($db, $facid, $modele='')
{
global $langs;
$langs->load("propale");
$dir = DOL_DOCUMENT_ROOT."/includes/modules/propale/";
// Positionne modele sur le nom du modele de facture à utiliser
if (! strlen($modele))
{
if (defined("PROPALE_ADDON_PDF"))
if (defined("PROPALE_ADDON_PDF") && PROPALE_ADDON_PDF)
{
$modele = PROPALE_ADDON_PDF;
}
else
{
print $langs->trans("Error")." ".$langs->trans("Error_PROPALE_ADDON_PDF_NotDefined");
return 0;
}
}
// Charge le modele
$file = "pdf_propale_".$modele.".modules.php";
if (file_exists($dir.$file))
{
@ -46,11 +138,19 @@ function propale_pdf_create($db, $facid, $modele='')
$obj = new $classname($db);
return $obj->write_pdf_file($facid);
if ( $obj->write_pdf_file($facid) > 0)
{
return 1;
}
else
{
dolibarr_print_error($db,$obj->pdferror());
return 0;
}
}
else
{
print "Erreur : $modele";
print $langs->trans("Error")." ".$langs->trans("ErrorFileDoesNotExists",$dir.$file);
return 0;
}
}

20
htdocs/includes/modules/propale/pdf_propale_adytek.modules.php
View File

@ -21,9 +21,23 @@
*
*/
Class pdf_propale_adytek
/*! \file htdocs/includes/modules/propale/pdf_propale_adytek.modules.php
\ingroup propale
\brief Fichier de la classe permettant de générer les propales au modèle Adytek
\version $Revision$
*/
/*! \class pdf_propale_adytek
\brief Classe permettant de générer les propales au modèle Adytek
*/
class pdf_propale_adytek extends ModelePDFPropales
{
/*! \brief Constructeur
\param db handler accès base de donnée
*/
function pdf_propale_adytek($db=0)
{
$this->db = $db;
@ -31,6 +45,10 @@ Class pdf_propale_adytek
$this->description = "Modèle de proposition Adytek";
}
/*!
\brief Fonction générant la propale sur le disque
\param id id de la propale à générer
*/
function write_pdf_file($id)
{
global $user;

20
htdocs/includes/modules/propale/pdf_propale_bleu.modules.php
View File

@ -21,9 +21,23 @@
*
*/
Class pdf_propale_bleu
/*! \file htdocs/includes/modules/propale/pdf_propale_bleu.modules.php
\ingroup propale
\brief Fichier de la classe permettant de générer les propales au modèle Bleu
\version $Revision$
*/
/*! \class pdf_propale_bleu
\brief Classe permettant de générer les propales au modèle Bleu
*/
class pdf_propale_bleu extends ModelePDFPropales
{
/*! \brief Constructeur
\param db handler accès base de donnée
*/
function pdf_propale_bleu($db=0)
{
$this->db = $db;
@ -31,6 +45,10 @@ Class pdf_propale_bleu
$this->description = "Modèle de propale sans remise.";
}
/*!
\brief Fonction générant la propale sur le disque
\param id id de la propale à générer
*/
function write_pdf_file($id)
{
global $user;

20
htdocs/includes/modules/propale/pdf_propale_jaune.modules.php
View File

@ -21,9 +21,23 @@
*
*/
Class pdf_propale_jaune
/*! \file htdocs/includes/modules/propale/pdf_propale_jaune.modules.php
\ingroup propale
\brief Fichier de la classe permettant de générer les propales au modèle Jaune
\version $Revision$
*/
/*! \class pdf_propale_jaune
\brief Classe permettant de générer les propales au modèle Jaune
*/
class pdf_propale_jaune extends ModelePDFPropales
{
/*! \brief Constructeur
\param db handler accès base de donnée
*/
function pdf_propale_jaune($db=0)
{
$this->db = $db;
@ -31,6 +45,10 @@ Class pdf_propale_jaune
$this->description = "Modèle de proposition Jaune";
}
/*!
\brief Fonction générant la propale sur le disque
\param id id de la propale à générer
*/
function write_pdf_file($id)
{
global $user;

21
htdocs/includes/modules/propale/pdf_propale_rouge.modules.php
View File

@ -19,12 +19,25 @@
* $Id$
* $Source$
*
* PROP_PDF_MESSAGE
*/
Class pdf_propale_rouge
/*! \file htdocs/includes/modules/propale/pdf_propale_rouge.modules.php
\ingroup propale
\brief Fichier de la classe permettant de générer les propales au modèle Rouge
\version $Revision$
*/
/*! \class pdf_propale_rouge
\brief Classe permettant de générer les propales au modèle Rouge
*/
class pdf_propale_rouge extends ModelePDFPropales
{
/*! \brief Constructeur
\param db handler accès base de donnée
*/
function pdf_propale_rouge($db=0)
{
$this->db = $db;
@ -32,6 +45,10 @@ Class pdf_propale_rouge
$this->description = "Modèle de propale par défaut";
}
/*!
\brief Fonction générant la propale sur le disque
\param id id de la propale à générer
*/
function write_pdf_file($id)
{
global $user;

20
htdocs/includes/modules/propale/pdf_propale_vert.modules.php
View File

@ -21,9 +21,23 @@
*
*/
Class pdf_propale_vert
/*! \file htdocs/includes/modules/propale/pdf_propale_vert.modules.php
\ingroup propale
\brief Fichier de la classe permettant de générer les propales au modèle Vert
\version $Revision$
*/
/*! \class pdf_propale_vert
\brief Classe permettant de générer les propales au modèle Vert
*/
class pdf_propale_vert extends ModelePDFPropales
{
/*! \brief Constructeur
\param db handler accès base de donnée
*/
function pdf_propale_vert($db=0)
{
$this->db = $db;
@ -31,6 +45,10 @@ Class pdf_propale_vert
$this->description = "Affichage de la remise par produit";
}
/*!
\brief Fonction générant la propale sur le disque
\param id id de la propale à générer
*/
function write_pdf_file($id)
{
global $user;