Doc: Amélioration descriptif des modèles de numérotation factures

This commit is contained in:
Laurent Destailleur 2005-06-19 11:19:56 +00:00
parent a3cc488230
commit 4109e7f6dd
3 changed files with 30 additions and 28 deletions

View File

@ -1,6 +1,6 @@
<?php <?php
/* Copyright (C) 2004 Rodolphe Quiedeville <rodolphe@quiedeville.org> /* Copyright (C) 2004 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2004 Laurent Destailleur <eldy@users.sourceforge.net> * Copyright (C) 2004-2005 Laurent Destailleur <eldy@users.sourceforge.net>
* *
* This program is free software; you can redistribute it and/or modify * 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 * it under the terms of the GNU General Public License as published by
@ -22,41 +22,42 @@
* *
*/ */
/*! \file htdocs/includes/modules/facture/deneb/deneb.modules.php /**
\file htdocs/includes/modules/facture/deneb/deneb.modules.php
\ingroup facture \ingroup facture
\brief Fichier contenant la classe du modèle de numérotation de référence de facture Deneb \brief Fichier contenant la classe du modèle de numérotation de référence de facture Deneb
\version $Revision$ \version $Revision$
*/ */
/*! \class mod_facture_deneb /**
\class mod_facture_deneb
\brief Classe du modèle de numérotation de référence de facture Deneb \brief Classe du modèle de numérotation de référence de facture Deneb
*/ */
class mod_facture_deneb extends ModeleNumRefFactures class mod_facture_deneb extends ModeleNumRefFactures
{ {
/*! \brief Renvoi la description du modele de numérotation /** \brief Renvoi la description du modele de numérotation
* \return string Texte descripif * \return string Texte descripif
*/ */
function info() function info()
{ {
$texte = ' $texte = "Renvoie le numéro de facture sous la forme, PREF-03-06-2004-01, où PREF est le préfixe commercial de la société, et est suivi de la date (ici le 03 juin 2004) et d'un compteur.<br>";
Renvoie le numéro de facture sous la forme, PREF-03-06-2004-15, où PREF est le préfixe commercial de la société, et est suivi de la date (ici le 14 juin 2004) et d\'un compteur général. La constante FACTURE_DENEB_DELTA sert à la correction de plage. FACTURE_DENEB_DELTA '; $texte.= "Si la constante FACTURE_DENEB_DELTA est définie, un offset est appliqué sur le compteur";
if (defined("FACTURE_NEPTUNE_DELTA"))
if (defined("FACTURE_DENEB_DELTA"))
{ {
$texte .= "est défini et vaut : ".FACTURE_DENEB_DELTA; $texte .= " (Définie et vaut : ".FACTURE_DENEB_DELTA.")";
} }
else else
{ {
$texte .= "n'est pas défini"; $texte .= " (N'est pas définie)";
} }
return $texte; return $texte;
} }
/*! \brief Renvoi un exemple de numérotation /** \brief Renvoi un exemple de numérotation
* \return string Example * \return string Example
*/ */
function getExample() function getExample()
@ -64,7 +65,7 @@ class mod_facture_deneb extends ModeleNumRefFactures
return "PREF-31-12-04-10"; return "PREF-31-12-04-10";
} }
/*! \brief Renvoie la référence de facture suivante non utilisée /** \brief Renvoie la référence de facture suivante non utilisée
* \param objsoc Objet société * \param objsoc Objet société
* \return string Texte descripif * \return string Texte descripif
*/ */

View File

@ -1,7 +1,7 @@
<?PHP <?PHP
/* Copyright (C) 2004 Rodolphe Quiedeville <rodolphe@quiedeville.org> /* Copyright (C) 2004 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2004 Laurent Destailleur <eldy@users.sourceforge.net> * Copyright (C) 2004-2005 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2004 Christophe Combelles <ccomb@free.fr> * Copyright (C) 2004 Christophe Combelles <ccomb@free.fr>
* *
* This program is free software; you can redistribute it and/or modify * 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 * it under the terms of the GNU General Public License as published by
@ -23,41 +23,42 @@
* *
*/ */
/*! \file htdocs/includes/modules/facture/mars/mars.modules.php /**
\file htdocs/includes/modules/facture/mars/mars.modules.php
\ingroup facture \ingroup facture
\brief Fichier contenant la classe du modèle de numérotation de référence de facture Mars \brief Fichier contenant la classe du modèle de numérotation de référence de facture Mars
\version $Revision$ \version $Revision$
*/ */
/*! \class mod_facture_mars /** \class mod_facture_mars
\brief Classe du modèle de numérotation de référence de facture Mars \brief Classe du modèle de numérotation de référence de facture Mars
*/ */
class mod_facture_mars extends ModeleNumRefFactures class mod_facture_mars extends ModeleNumRefFactures
{ {
/*! \brief Renvoi la description du modele de numérotation /** \brief Renvoi la description du modele de numérotation
* \return string Texte descripif * \return string Texte descripif
*/ */
function info() function info()
{ {
$texte = ' $texte = "Numéro de facture sous la forme, PREF-10-2004-005, qui correspond à la 5ème facture d'octobre 2004 et où PREF est le préfix de la société.";
Numéro de facture sous la forme, PREF-10-2004-005, qui correspond à la 5ème facture d\'octobre 2004 pour la société dont le préfixe commercial est PREF. Le nombre final est formatté sur 3 chiffres ou plus.'; $texte.= "Le nombre final est formaté sur 3 chiffres ou plus.<br>";
$texte.= "Si la constante FACTURE_MARS_DELTA est définie, un offset est appliqué sur le compteur";
if (defined("FACTURE_MARS_DELTA")) if (defined("FACTURE_MARS_DELTA"))
{ {
$texte .= "est défini et vaut : ".FACTURE_MARS_DELTA; $texte .= " (Définie et vaut : ".FACTURE_MARS_DELTA.")";
} }
else else
{ {
$texte .= "n'est pas défini"; $texte .= " (N'est pas définie)";
} }
return $texte; return $texte;
} }
/*! \brief Renvoi un exemple de numérotation /** \brief Renvoi un exemple de numérotation
* \return string Example * \return string Example
*/ */
function getExample() function getExample()
@ -65,7 +66,7 @@ class mod_facture_mars extends ModeleNumRefFactures
return "PREF-10-2004-005"; return "PREF-10-2004-005";
} }
/*! \brief Renvoie la référence de facture suivante non utilisée /** \brief Renvoie la référence de facture suivante non utilisée
* \param objsoc Objet société * \param objsoc Objet société
* \return string Texte descriptif * \return string Texte descriptif
*/ */

View File

@ -46,7 +46,7 @@ class mod_facture_neptune extends ModeleNumRefFactures
$texte.= "Si la constante FACTURE_NEPTUNE_DELTA est définie, un offset est appliqué sur le compteur"; $texte.= "Si la constante FACTURE_NEPTUNE_DELTA est définie, un offset est appliqué sur le compteur";
if (defined("FACTURE_NEPTUNE_DELTA")) if (defined("FACTURE_NEPTUNE_DELTA"))
{ {
$texte .= " (Définie et vaut : ".FACTURE_NEPTUNE_DELTA.")"; $texte .= " (Définie et vaut: ".FACTURE_NEPTUNE_DELTA.")";
} }
else else
{ {
@ -66,7 +66,7 @@ class mod_facture_neptune extends ModeleNumRefFactures
} }
else else
{ {
return "FA040010"; return "FA040001";
} }
} }