From d018d4be8bbee957b96c8a7b0693a0fe2d708805 Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@users.sourceforge.net>
Date: Thu, 11 Nov 2010 01:09:41 +0000
Subject: [PATCH] Qual: Uniformize all document generation into function
write_file Doxygen
---
htdocs/comm/action/rapport/index.php | 2 +-
htdocs/includes/modules/action/rapport.pdf.php | 9 ++++++++-
.../modules/cheque/pdf/pdf_blochet.class.php | 10 +++++-----
.../includes/modules/dons/html_cerfafr.modules.php | 9 +++++----
.../expedition/pdf/pdf_expedition_merou.modules.php | 2 +-
.../expedition/pdf/pdf_expedition_rouget.modules.php | 2 +-
.../includes/modules/facture/pdf_crabe.modules.php | 2 +-
.../modules/livraison/pdf/pdf_sirocco.modules.php | 8 ++++----
.../modules/livraison/pdf/pdf_typhon.modules.php | 8 ++++----
.../modules/project/pdf/pdf_baleine.modules.php | 2 +-
.../modules/propale/pdf_propale_jaune.modules.php | 2 +-
.../supplier_invoice/pdf/pdf_canelle.modules.php | 2 +-
.../supplier_order/pdf/pdf_muscadet.modules.php | 12 ++++++------
13 files changed, 39 insertions(+), 31 deletions(-)
diff --git a/htdocs/comm/action/rapport/index.php b/htdocs/comm/action/rapport/index.php
index 9459373f15b..127de0cbba2 100644
--- a/htdocs/comm/action/rapport/index.php
+++ b/htdocs/comm/action/rapport/index.php
@@ -54,7 +54,7 @@ $result = restrictedArea($user, 'agenda', $socid, '', 'myactions');
if ($_GET["action"] == 'builddoc')
{
$cat = new CommActionRapport($db, $_GET["month"], $_GET["year"]);
- $result=$cat->generate($_GET["id"]);
+ $result=$cat->write_file(GETPOST("id"));
if ($result < 0)
{
$mesg=$cat->error;
diff --git a/htdocs/includes/modules/action/rapport.pdf.php b/htdocs/includes/modules/action/rapport.pdf.php
index c88906aecfc..91a6da57f84 100644
--- a/htdocs/includes/modules/action/rapport.pdf.php
+++ b/htdocs/includes/modules/action/rapport.pdf.php
@@ -70,7 +70,14 @@ class CommActionRapport
$this->subject=$langs->trans("ActionsReport").' '.$this->year."-".$this->month;
}
- function generate($socid = 0, $catid = 0, $outputlangs='')
+ /**
+ * Write the object to document file to disk
+ * @param socid
+ * @param catid
+ * @param outputlangs Lang object for output language
+ * @return int 1=OK, 0=KO
+ */
+ function write_file($socid = 0, $catid = 0, $outputlangs='')
{
global $user,$conf,$langs;
diff --git a/htdocs/includes/modules/cheque/pdf/pdf_blochet.class.php b/htdocs/includes/modules/cheque/pdf/pdf_blochet.class.php
index 3b0a06cde2e..948c47144c7 100644
--- a/htdocs/includes/modules/cheque/pdf/pdf_blochet.class.php
+++ b/htdocs/includes/modules/cheque/pdf/pdf_blochet.class.php
@@ -77,11 +77,11 @@ class BordereauChequeBlochet extends ModeleChequeReceipts
}
/**
- * \brief Fonction generant le rapport sur le disque
- * \param _dir Directory
- * \param number Number
- * \param outputlangs Lang output object
- * \return int 1=ok, 0=ko
+ * Fonction generant le rapport sur le disque
+ * @param _dir Directory
+ * @param number Number
+ * @param outputlangs Lang output object
+ * @return int 1=ok, 0=ko
*/
function write_file($_dir, $number, $outputlangs)
{
diff --git a/htdocs/includes/modules/dons/html_cerfafr.modules.php b/htdocs/includes/modules/dons/html_cerfafr.modules.php
index 1f3053cded9..f6ba8039a87 100644
--- a/htdocs/includes/modules/dons/html_cerfafr.modules.php
+++ b/htdocs/includes/modules/dons/html_cerfafr.modules.php
@@ -61,10 +61,11 @@ class html_cerfafr extends ModeleDon
/**
- \brief Fonction generant le recu sur le disque
- \param id Id du recu a generer
- \return int >0 si ok, <0 si ko
- */
+ * Write the object to document file to disk
+ * @param don Donation object
+ * @param outputlangs Lang object for output language
+ * @return int >0 if OK, <0 if KO
+ */
function write_file($don,$outputlangs)
{
global $user,$conf,$langs,$mysoc;
diff --git a/htdocs/includes/modules/expedition/pdf/pdf_expedition_merou.modules.php b/htdocs/includes/modules/expedition/pdf/pdf_expedition_merou.modules.php
index cf14c01dbdd..d245ec692f3 100644
--- a/htdocs/includes/modules/expedition/pdf/pdf_expedition_merou.modules.php
+++ b/htdocs/includes/modules/expedition/pdf/pdf_expedition_merou.modules.php
@@ -68,7 +68,7 @@ Class pdf_expedition_merou extends ModelePdfExpedition
/**
* \brief Fonction generant le document sur le disque
- * \param obj Objet expedition a generer (ou id si ancienne methode)
+ * \param object Objet expedition a generer (ou id si ancienne methode)
* \param outputlangs Lang output object
* \return int 1=ok, 0=ko
*/
diff --git a/htdocs/includes/modules/expedition/pdf/pdf_expedition_rouget.modules.php b/htdocs/includes/modules/expedition/pdf/pdf_expedition_rouget.modules.php
index 72fd54f8ed1..cf9501966e4 100644
--- a/htdocs/includes/modules/expedition/pdf/pdf_expedition_rouget.modules.php
+++ b/htdocs/includes/modules/expedition/pdf/pdf_expedition_rouget.modules.php
@@ -210,7 +210,7 @@ Class pdf_expedition_rouget extends ModelePdfExpedition
/**
* \brief Fonction generant le document sur le disque
- * \param obj Objet expedition a generer (ou id si ancienne methode)
+ * \param object Objet expedition a generer (ou id si ancienne methode)
* \param outputlangs Lang output object
* \return int 1=ok, 0=ko
*/
diff --git a/htdocs/includes/modules/facture/pdf_crabe.modules.php b/htdocs/includes/modules/facture/pdf_crabe.modules.php
index 02c43bcb32d..e98ea95126f 100644
--- a/htdocs/includes/modules/facture/pdf_crabe.modules.php
+++ b/htdocs/includes/modules/facture/pdf_crabe.modules.php
@@ -103,7 +103,7 @@ class pdf_crabe extends ModelePDFFactures
/**
- * Write the invoice to disk
+ * Write the object to document file to disk
* @param object Object invoice to build (or id if old method)
* @param outputlangs Lang object for output language
* @return int 1=OK, 0=KO
diff --git a/htdocs/includes/modules/livraison/pdf/pdf_sirocco.modules.php b/htdocs/includes/modules/livraison/pdf/pdf_sirocco.modules.php
index 8f968e617a4..1d850e7cebe 100644
--- a/htdocs/includes/modules/livraison/pdf/pdf_sirocco.modules.php
+++ b/htdocs/includes/modules/livraison/pdf/pdf_sirocco.modules.php
@@ -74,10 +74,10 @@ class pdf_sirocco extends ModelePDFDeliveryOrder
/**
- * \brief Fonction generant le bon de livraison sur le disque
- * \param delivery Object livraison a generer
- * \param outputlangs Lang output object
- * \return int 1 if OK, <=0 if KO
+ * Fonction generant le bon de livraison sur le disque
+ * @param object Object livraison a generer
+ * @param outputlangs Lang output object
+ * @return int 1 if OK, <=0 if KO
*/
function write_file($object,$outputlangs)
{
diff --git a/htdocs/includes/modules/livraison/pdf/pdf_typhon.modules.php b/htdocs/includes/modules/livraison/pdf/pdf_typhon.modules.php
index 16ed5982f69..c6d8fd2aaf7 100644
--- a/htdocs/includes/modules/livraison/pdf/pdf_typhon.modules.php
+++ b/htdocs/includes/modules/livraison/pdf/pdf_typhon.modules.php
@@ -95,10 +95,10 @@ class pdf_typhon extends ModelePDFDeliveryOrder
/**
- * \brief Fonction generant le bon de livraison sur le disque
- * \param delivery Object livraison a generer
- * \param outputlangs Lang output object
- * \return int 1 if OK, <=0 if KO
+ * Fonction generant le bon de livraison sur le disque
+ * @param object Object livraison a generer
+ * @param outputlangs Lang output object
+ * @return int 1 if OK, <=0 if KO
*/
function write_file($object,$outputlangs)
{
diff --git a/htdocs/includes/modules/project/pdf/pdf_baleine.modules.php b/htdocs/includes/modules/project/pdf/pdf_baleine.modules.php
index d1674d99925..ff36d09c948 100644
--- a/htdocs/includes/modules/project/pdf/pdf_baleine.modules.php
+++ b/htdocs/includes/modules/project/pdf/pdf_baleine.modules.php
@@ -85,7 +85,7 @@ class pdf_baleine extends ModelePDFProjects
/**
* \brief Fonction generant le projet sur le disque
- * \param delivery Object project a generer
+ * \param object Object project a generer
* \param outputlangs Lang output object
* \return int 1 if OK, <=0 if KO
*/
diff --git a/htdocs/includes/modules/propale/pdf_propale_jaune.modules.php b/htdocs/includes/modules/propale/pdf_propale_jaune.modules.php
index b59b9523029..5ceff0170f2 100644
--- a/htdocs/includes/modules/propale/pdf_propale_jaune.modules.php
+++ b/htdocs/includes/modules/propale/pdf_propale_jaune.modules.php
@@ -77,7 +77,7 @@ class pdf_propale_jaune extends ModelePDFPropales
/**
* \brief Fonction generant la propale sur le disque
- * \param propale Objet propal
+ * \param object Objet propal
* \param outputlangs Lang object for output language
* \return int 1=ok, 0=ko
*/
diff --git a/htdocs/includes/modules/supplier_invoice/pdf/pdf_canelle.modules.php b/htdocs/includes/modules/supplier_invoice/pdf/pdf_canelle.modules.php
index f00e05d0b1c..9fc936e7c5e 100755
--- a/htdocs/includes/modules/supplier_invoice/pdf/pdf_canelle.modules.php
+++ b/htdocs/includes/modules/supplier_invoice/pdf/pdf_canelle.modules.php
@@ -92,7 +92,7 @@ class pdf_canelle extends ModelePDFSuppliersInvoices
/**
- * Write the invoice to disk
+ * Write the invoice as a document onto disk
* @param object Object invoice to build (or id if old method)
* @param outputlangs Lang object for output language
* @return int 1=OK, 0=KO
diff --git a/htdocs/includes/modules/supplier_order/pdf/pdf_muscadet.modules.php b/htdocs/includes/modules/supplier_order/pdf/pdf_muscadet.modules.php
index 09e9153f714..a812f3ab153 100644
--- a/htdocs/includes/modules/supplier_order/pdf/pdf_muscadet.modules.php
+++ b/htdocs/includes/modules/supplier_order/pdf/pdf_muscadet.modules.php
@@ -91,12 +91,12 @@ class pdf_muscadet extends ModelePDFSuppliersOrders
}
- /**
- * \brief Fonction generant la commande sur le disque
- * \param id Id de la commande a generer
- * \param outputlangs Lang output object
- * \return int 1=ok, 0=ko
- */
+ /**
+ * Write the order as a document onto disk
+ * @param object Object invoice to build (or id if old method)
+ * @param outputlangs Lang object for output language
+ * @return int 1=OK, 0=KO
+ */
function write_file($object,$outputlangs='')
{
global $user,$langs,$conf;
--
GitLab