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

Doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2012-02-16 18:39:22 +01:00
parent 446cfff515
commit 0a17345415
19 changed files with 246 additions and 182 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
htdocs/comm/mailing/class/mailing.class.php
View File

@ -61,12 +61,13 @@ class Mailing extends CommonObject
/**
* \brief Constructeur de la classe
* \param DB handler acces base de donnees
* Constructor
*
* @param DoliDb $db Database handler
*/
function Mailing($DB)
function Mailing($db)
{
$this->db = $DB ;
$this->db = $db;
// List of language codes for status
$this->statuts[0] = 'MailingStatusDraft';

6
htdocs/contrat/class/contrat.class.php
View File

@ -1559,9 +1559,9 @@ class ContratLigne
/**
* Constructeur d'objets ligne de contrat
*
* @param DoliDB $db Database access handler
* Constructor
*
* @param DoliDb $db Database handler
*/
function ContratLigne($db)
{

12
htdocs/core/menus/smartphone/smartphone_backoffice.php
View File

@ -23,8 +23,7 @@
/**
* \class MenuSmart
* \brief Class to manage smartphone menu smartphone (for internal users)
* Class to manage smartphone menu smartphone (for internal users)
*/
class MenuSmart {
@ -35,8 +34,9 @@ class MenuSmart {
/**
* Constructeur
* @param db Database handler
* Constructor
*
* @param DoliDb $db Database handler
*/
function MenuSmart($db)
{
@ -46,7 +46,9 @@ class MenuSmart {
/**
* Show menu
* @param limitmenuto To limit menu to a top or left menu value
*
* @param string $limitmenuto To limit menu to a top or left menu value
* @return void
*/
function showmenu($limitmenuto)
{

12
htdocs/core/menus/standard/auguria_backoffice.php
View File

@ -42,8 +42,9 @@ class MenuTop {
/**
* Constructeur
* @param db Database access handler
* Constructor
*
* @param DoliDb $db Database handler
*/
function MenuTop($db)
{
@ -52,7 +53,9 @@ class MenuTop {
/**
* Show menu
* Show menu
*
* @return void
*/
function showmenu()
{
@ -65,8 +68,7 @@ class MenuTop {
/**
* \class MenuLeft
* \brief Classe permettant la gestion du menu du gauche Auguria
* Classe permettant la gestion du menu du gauche Auguria
*/
class MenuLeft {

12
htdocs/core/menus/standard/auguria_frontoffice.php
View File

@ -42,8 +42,9 @@ class MenuTop {
/**
* \brief Constructeur
* \param db Database access handler
* Constructor
*
* @param DoliDb $db Database handler
*/
function MenuTop($db)
{
@ -53,7 +54,9 @@ class MenuTop {
/**
* Show menu
* Show menu
*
* @return void
*/
function showmenu()
{
@ -66,8 +69,7 @@ class MenuTop {
/**
* \class MenuLeft
* \brief Classe permettant la gestion du menu du gauche Auguria
* Classe permettant la gestion du menu du gauche Auguria
*/
class MenuLeft {

9
htdocs/core/menus/standard/eldy_backoffice.php
View File

@ -40,8 +40,9 @@ class MenuTop {
/**
* Constructeur
* @param db Handler d'acces base de donnee
* Constructor
*
* @param DoliDb $db Database handler
*/
function MenuTop($db)
{
@ -50,7 +51,9 @@ class MenuTop {
/**
* Show menu
* Show menu
*
* @return void
*/
function showmenu()
{

15
htdocs/core/menus/standard/eldy_frontoffice.php
View File

@ -28,8 +28,7 @@
/**
* \class MenuTop
* \brief Class to manage top menu Eldy (for external users)
* Class to manage top menu Eldy (for external users)
*/
class MenuTop {
@ -40,8 +39,9 @@ class MenuTop {
/**
* Constructeur
* @param db Handler d'acces base de donnee
* Constructor
*
* @param DoliDb $db Database handler
*/
function MenuTop($db)
{
@ -50,7 +50,9 @@ class MenuTop {
/**
* Show menu
* Show menu
*
* @return void
*/
function showmenu()
{
@ -63,8 +65,7 @@ class MenuTop {
/**
* \class MenuLeft
* \brief Classe permettant la gestion du menu du gauche Eldy
* Classe permettant la gestion du menu du gauche Eldy
*/
class MenuLeft {

8
htdocs/core/modules/commande/doc/pdf_edison.modules.php
View File

@ -30,18 +30,16 @@ require_once(DOL_DOCUMENT_ROOT."/core/lib/company.lib.php");
require_once(DOL_DOCUMENT_ROOT.'/core/lib/pdf.lib.php');
/**
* \class pdf_edison
* \brief Classe permettant de generer les commandes au modele Edison
* Classe permettant de generer les commandes au modele Edison
*/
class pdf_edison extends ModelePDFCommandes
{
var $emetteur; // Objet societe qui emet
/**
* Constructeur
* Constructor
*
* @param DoliDb $db Database access handler
* @param DoliDb $db Database access handler
*/
function pdf_edison($db=0)
{

30
htdocs/core/modules/dons/html_cerfafr.modules.php
View File

@ -27,15 +27,15 @@ require_once(DOL_DOCUMENT_ROOT."/core/lib/company.lib.php");
/**
\class html_cerfafr
\brief Classe permettant de generer les propales au modele Azur
*/
* Class to generate document for subscriptions
*/
class html_cerfafr extends ModeleDon
{
/**
\brief Constructeur
\param db Handler acces base de donnees
*/
* Constructor
*
* @param DoliDb $db Database handler
*/
function html_cerfafr($db)
{
global $conf,$langs;
@ -49,9 +49,11 @@ class html_cerfafr extends ModeleDon
}
/** \brief Return if a module can be used or not
* \return boolean true if module can be used
*/
/**
* Return if a module can be used or not
*
* @return boolean true if module can be used
*/
function isEnabled()
{
return true;
@ -60,9 +62,10 @@ class html_cerfafr extends ModeleDon
/**
* 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
*
* @param Don $don Donation object
* @param Translate $outputlangs Lang object for output language
* @return int >0 if OK, <0 if KO
*/
function write_file($don,$outputlangs)
{
@ -155,10 +158,7 @@ class html_cerfafr extends ModeleDon
}
$this->error=$langs->trans("ErrorUnknown");
return 0; // Erreur par defaut
}
}
?>

59
htdocs/core/modules/dons/modules_don.php
View File

@ -30,8 +30,7 @@ require_once(DOL_DOCUMENT_ROOT."/compta/dons/class/don.class.php");
/**
* \class ModeleDon
* \brief Classe mere des modeles de dons
* Parent class of subscription templates
*/
abstract class ModeleDon extends CommonDocGenerator
{
@ -59,23 +58,26 @@ abstract class ModeleDon extends CommonDocGenerator
/**
* \class ModeleNumRefDons
* \brief Classe mere des modeles de numerotation des references des dons
* Parent class of donation numbering templates
*/
abstract class ModeleNumRefDons
{
var $error='';
/** \brief Return if a module can be used or not
* \return boolean true if module can be used
/**
* Return if a module can be used or not
*
* @return boolean true if module can be used
*/
function isEnabled()
{
return true;
}
/** \brief Renvoi la description par defaut du modele de num<EFBFBD>rotation
* \return string Texte descripif
/**
* Renvoi la description par defaut du modele de numerotation
*
* @return string Texte descripif
*/
function info()
{
@ -84,8 +86,10 @@ abstract class ModeleNumRefDons
return $langs->trans("NoDescription");
}
/** \brief Renvoi un exemple de numerotation
* \return string Example
/**
* Renvoi un exemple de numerotation
*
* @return string Example
*/
function getExample()
{
@ -94,17 +98,21 @@ abstract class ModeleNumRefDons
return $langs->trans("NoExample");
}
/** \brief Test si les numeros deja en vigueur dans la base ne provoquent pas d
* de conflits qui empechera cette numerotation de fonctionner.
* \return boolean false si conflit, true si ok
/**
* Test si les numeros deja en vigueur dans la base ne provoquent pas d
* de conflits qui empechera cette numerotation de fonctionner.
*
* @return boolean false si conflit, true si ok
*/
function canBeActivated()
{
return true;
}
/** \brief Renvoi prochaine valeur attribuee
* \return string Valeur
/**
* Renvoi prochaine valeur attribuee
*
* @return string Valeur
*/
function getNextValue()
{
@ -112,8 +120,10 @@ abstract class ModeleNumRefDons
return $langs->trans("NotAvailable");
}
/** \brief Renvoi version du module numerotation
* \return string Valeur
/**
* Renvoi version du module numerotation
*
* @return string Valeur
*/
function getVersion()
{
@ -129,13 +139,14 @@ abstract class ModeleNumRefDons
/**
* \brief Cree un don sur disque en fonction du modele de DON_ADDON_PDF
* \param db objet base de donnee
* \param id id du don e creer
* \param message message
* \param modele force le modele a utiliser ('' par defaut)
* \param outputlangs objet lang a utiliser pour traduction
* \return int 0 si KO, 1 si OK
* Cree un don sur disque en fonction du modele de DON_ADDON_PDF
*
* @param DoliDB $db Databse handler
* @param int $id Id donation
* @param string $message Message
* @param string $modele Force le modele a utiliser ('' par defaut)
* @param Translate $outputlangs Object langs
* @return int 0 if KO, 1 if OK
*/
function don_create($db, $id, $message, $modele, $outputlangs)
{

46
htdocs/core/modules/fichinter/mod_arctic.php
View File

@ -27,8 +27,7 @@
require_once(DOL_DOCUMENT_ROOT ."/core/modules/fichinter/modules_fichinter.php");
/**
* \class mod_arctic
* \brief Class to manage numbering of intervention cards with rule Artic.
* Class to manage numbering of intervention cards with rule Artic.
*/
class mod_arctic extends ModeleNumRefFicheinter
{
@ -36,15 +35,20 @@ class mod_arctic extends ModeleNumRefFicheinter
var $error = '';
var $nom = 'Artic';
/** \brief Constructeur
*/
/**
* Constructor
*
* @param DoliDb $db Database handler
*/
function mod_arctic()
{
$this->nom = "arctic";
}
/** \brief Renvoi la description du modele de numerotation
* \return string Texte descripif
/**
* Renvoi la description du modele de numerotation
*
* @return string Texte descripif
*/
function info()
{
@ -81,8 +85,10 @@ class mod_arctic extends ModeleNumRefFicheinter
return $texte;
}
/** \brief Renvoi un exemple de numerotation
* \return string Example
/**
* Renvoi un exemple de numerotation
*
* @return string Example
*/
function getExample()
{
@ -100,11 +106,13 @@ class mod_arctic extends ModeleNumRefFicheinter
return $numExample;
}
/** \brief Renvoi prochaine valeur attribuee
* \param objsoc Objet societe
* \param ficheinter Object ficheinter
* \return string Valeur
*/
/**
* Renvoi prochaine valeur attribuee
*
* @param Societe $objsoc Objet societe
* @param Ficheinter $object Object ficheinter
* @return string Valeur
*/
function getNextValue($objsoc=0,$object='')
{
global $db,$conf;
@ -126,11 +134,13 @@ class mod_arctic extends ModeleNumRefFicheinter
}
/** \brief Return next free value
* \param objsoc Object third party
* \param objforref Object for number to search
* \return string Next free value
*/
/**
* Return next free value
*
* @param Societe $objsoc Object third party
* @param Object $objforref Object for number to search
* @return string Next free value
*/
function getNumRef($objsoc,$objforref)
{
return $this->getNextValue($objsoc,$objforref);

43
htdocs/core/modules/fichinter/mod_pacific.php
View File

@ -25,8 +25,7 @@
require_once(DOL_DOCUMENT_ROOT ."/core/modules/fichinter/modules_fichinter.php");
/**
* \class mod_pacific
* \brief Class to manage numbering of intervention cards with rule Pacific.
* Class to manage numbering of intervention cards with rule Pacific.
*/
class mod_pacific extends ModeleNumRefFicheinter
{
@ -36,8 +35,10 @@ class mod_pacific extends ModeleNumRefFicheinter
var $nom = 'pacific';
/** \brief Return description of numbering module
* \return string Text with description
/**
* Return description of numbering module
*
* @return string Text with description
*/
function info()
{
@ -45,17 +46,21 @@ class mod_pacific extends ModeleNumRefFicheinter
return $langs->trans("SimpleNumRefModelDesc",$this->prefix);
}
/** \brief Renvoi un exemple de numerotation
* \return string Example
/**
* Renvoi un exemple de numerotation
*
* @return string Example
*/
function getExample()
{
return $this->prefix."0501-0001";
}
/** \brief Test si les numeros deja en vigueur dans la base ne provoquent pas de
* de conflits qui empechera cette numerotation de fonctionner.
* \return boolean false si conflit, true si ok
/**
* Test si les numeros deja en vigueur dans la base ne provoquent pas de
* de conflits qui empechera cette numerotation de fonctionner.
*
* @return boolean false si conflit, true si ok
*/
function canBeActivated()
{
@ -89,10 +94,12 @@ class mod_pacific extends ModeleNumRefFicheinter
}
}
/** \brief Renvoi prochaine valeur attribuee
* \param objsoc Objet societe
* \param ficheinter Object ficheinter
* \return string Valeur
/**
* Renvoi prochaine valeur attribuee
*
* @param objsoc Objet societe
* @param ficheinter Object ficheinter
* @return string Valeur
*/
function getNextValue($objsoc=0,$object='')
{
@ -121,10 +128,12 @@ class mod_pacific extends ModeleNumRefFicheinter
return $this->prefix.$yymm."-".$num;
}
/** \brief Return next free value
* \param objsoc Object third party
* \param objforref Object for number to search
* \return string Next free value
/**
* Return next free value
*
* @param Societe $objsoc Object third party
* @param Object $objforref Object for number to search
* @return string Next free value
*/
function getNumRef($objsoc,$objforref)
{

6
htdocs/core/modules/import/import_csv.modules.php
View File

@ -27,8 +27,7 @@ require_once(DOL_DOCUMENT_ROOT ."/core/modules/import/modules_import.php");
/**
* \class ImportCsv
* \brief Class to import CSV files
* Class to import CSV files
*/
class ImportCsv extends ModeleImports
{
@ -529,6 +528,9 @@ class ImportCsv extends ModeleImports
/**
* Clean a string from separator
*
* @param string $value Remove separator
* @return string String without separator
*/
function cleansep($value)
{

2
htdocs/core/modules/import/modules_import.php
View File

@ -42,7 +42,7 @@ class ModeleImports
/**
* \brief Constructeur
* Constructor
*/
function ModeleImports()
{

41
htdocs/core/modules/project/mod_project_simple.php
View File

@ -27,8 +27,7 @@ require_once(DOL_DOCUMENT_ROOT ."/core/modules/project/modules_project.php");
/**
* \class mod_project_simple
* \brief Class to manage the numbering module Simple for project references
* Class to manage the numbering module Simple for project references
*/
class mod_project_simple extends ModeleNumRefProjects
{
@ -38,8 +37,10 @@ class mod_project_simple extends ModeleNumRefProjects
var $nom = "Simple";
/** \brief Return description of numbering module
* \return string Text with description
/**
* Return description of numbering module
*
* @return string Text with description
*/
function info()
{
@ -48,8 +49,10 @@ class mod_project_simple extends ModeleNumRefProjects
}
/** \brief Return an example of numbering module values
* \return string Example
/**
* Return an example of numbering module values
*
* @return string Example
*/
function getExample()
{
@ -57,9 +60,10 @@ class mod_project_simple extends ModeleNumRefProjects
}
/** \brief Test si les numeros deja en vigueur dans la base ne provoquent pas de
* de conflits qui empechera cette numerotation de fonctionner.
* \return boolean false si conflit, true si ok
/** Test si les numeros deja en vigueur dans la base ne provoquent pas de
* de conflits qui empechera cette numerotation de fonctionner.
*
* @return boolean false si conflit, true si ok
*/
function canBeActivated()
{
@ -92,10 +96,11 @@ class mod_project_simple extends ModeleNumRefProjects
/**
* \brief Return next value
* \param objsoc Object third party
* \param project Object project
* \return string Value if OK, 0 if KO
* Return next value
*
* @param Societe $objsoc Object third party
* @param Project $project Object project
* @return string Value if OK, 0 if KO
*/
function getNextValue($objsoc=0,$project='')
{
@ -132,10 +137,12 @@ class mod_project_simple extends ModeleNumRefProjects
}
/** \brief Return next reference not yet used as a reference
* \param objsoc Object third party
* \param project Object project
* \return string Next not used reference
/**
* Return next reference not yet used as a reference
*
* @param Societe $objsoc Object third party
* @param Project $project Object project
* @return string Next not used reference
*/
function project_get_num($objsoc=0,$project='')
{

32
htdocs/core/modules/project/mod_project_universal.php
View File

@ -26,8 +26,7 @@ require_once(DOL_DOCUMENT_ROOT ."/core/modules/project/modules_project.php");
/**
* \class mod_project_universal
* \brief Classe du modele de numerotation de reference de projet Universal
* Classe du modele de numerotation de reference de projet Universal
*/
class mod_project_universal extends ModeleNumRefProjects
{
@ -37,8 +36,9 @@ class mod_project_universal extends ModeleNumRefProjects
/**
* \brief Renvoi la description du modele de numerotation
* \return string Texte descripif
* Renvoi la description du modele de numerotation
*
* @return string Texte descripif
*/
function info()
{
@ -77,8 +77,9 @@ class mod_project_universal extends ModeleNumRefProjects
}
/**
* \brief Renvoi un exemple de numerotation
* \return string Example
* Renvoi un exemple de numerotation
*
* @return string Example
*/
function getExample()
{
@ -97,10 +98,11 @@ class mod_project_universal extends ModeleNumRefProjects
}
/**
* \brief Return next value
* \param objsoc Object third party
* \param project Object project
* \return string Value if OK, 0 if KO
* Return next value
*
* @param Societe $objsoc Object third party
* @param Project $project Object project
* @return string Value if OK, 0 if KO
*/
function getNextValue($objsoc=0,$project='')
{
@ -124,10 +126,12 @@ class mod_project_universal extends ModeleNumRefProjects
}
/** \brief Return next reference not yet used as a reference
* \param objsoc Object third party
* \param project Object project
* \return string Next not used reference
/**
* Return next reference not yet used as a reference
*
* @param Societe $objsoc Object third party
* @param Project $project Object project
* @return string Next not used reference
*/
function project_get_num($objsoc=0,$project='')
{

56
htdocs/core/modules/project/modules_project.php
View File

@ -26,8 +26,7 @@ require_once(DOL_DOCUMENT_ROOT."/core/class/commondocgenerator.class.php");
/**
* \class ModelePDFProjects
* \brief Parent class for projects models
* Parent class for projects models
*/
abstract class ModelePDFProjects extends CommonDocGenerator
{
@ -35,8 +34,9 @@ abstract class ModelePDFProjects extends CommonDocGenerator
/**
* \brief Return list of active generation modules
* \param $db Database handler
* Return list of active generation modules
*
* @param DoliDB $db Database handler
*/
function liste_modeles($db)
{
@ -55,16 +55,16 @@ abstract class ModelePDFProjects extends CommonDocGenerator
/**
* \class ModeleNumRefProjects
* \brief Classe mere des modeles de numerotation des references de projets
* Classe mere des modeles de numerotation des references de projets
*/
abstract class ModeleNumRefProjects
{
var $error='';
/**
* \brief Return if a module can be used or not
* \return boolean true if module can be used
* Return if a module can be used or not
*
* @return boolean true if module can be used
*/
function isEnabled()
{
@ -72,8 +72,9 @@ abstract class ModeleNumRefProjects
}
/**
* \brief Renvoi la description par defaut du modele de numerotation
* \return string Texte descripif
* Renvoi la description par defaut du modele de numerotation
*
* @return string Texte descripif
*/
function info()
{
@ -83,8 +84,9 @@ abstract class ModeleNumRefProjects
}
/**
* \brief Renvoi un exemple de numerotation
* \return string Example
* Renvoi un exemple de numerotation
*
* @return string Example
*/
function getExample()
{
@ -94,9 +96,10 @@ abstract class ModeleNumRefProjects
}
/**
* \brief Test si les numeros deja en vigueur dans la base ne provoquent pas de
* de conflits qui empechera cette numerotation de fonctionner.
* \return boolean false si conflit, true si ok
* Test si les numeros deja en vigueur dans la base ne provoquent pas de
* de conflits qui empechera cette numerotation de fonctionner.
*
* @return boolean false si conflit, true si ok
*/
function canBeActivated()
{
@ -104,8 +107,9 @@ abstract class ModeleNumRefProjects
}
/**
* \brief Renvoi prochaine valeur attribuee
* \return string Valeur
* Renvoi prochaine valeur attribuee
*
* @return string Valeur
*/
function getNextValue()
{
@ -114,8 +118,9 @@ abstract class ModeleNumRefProjects
}
/**
* \brief Renvoi version du module numerotation
* \return string Valeur
* Renvoi version du module numerotation
*
* @return string Valeur
*/
function getVersion()
{
@ -131,12 +136,13 @@ abstract class ModeleNumRefProjects
/**
* Create object on disk
* @param db objet base de donnee
* @param object object project
* @param model force le modele a utiliser ('' to not force)
* @param outputlangs objet lang a utiliser pour traduction
* @return int 0 si KO, 1 si OK
* Create object on disk
*
* @param DoliDB $db objet base de donnee
* @param Object $object object project
* @param string $model force le modele a utiliser ('' to not force)
* @param Translate $outputlangs objet lang a utiliser pour traduction
* @return int 0 if KO, 1 if OK
*/
function project_pdf_create($db, $object, $model,$outputlangs)
{

3
htdocs/core/modules/propale/doc/doc_generic_proposal_odt.modules.php
View File

@ -31,8 +31,7 @@ require_once(DOL_DOCUMENT_ROOT."/core/lib/files.lib.php");
/**
* \class doc_generic_iproposal_odt
* \brief Class to build documents using ODF templates generator
* Class to build documents using ODF templates generator
*/
class doc_generic_proposal_odt extends ModelePDFPropales
{

27
htdocs/core/modules/rapport/pdf_paiement.class.php
View File

@ -27,14 +27,14 @@ require_once(DOL_DOCUMENT_ROOT."/core/lib/company.lib.php");
/**
* \class pdf_paiement
* \brief Classe permettant de generer les rapports de paiement
* Classe permettant de generer les rapports de paiement
*/
class pdf_paiement
{
/**
* \brief Constructeur
* \param db handler acces base de donnee
* Constructor
*
* @param DoliDb $db Database handler
*/
function pdf_paiement($db)
{
@ -66,11 +66,12 @@ class pdf_paiement
/**
* \brief Fonction generant le rapport sur le disque
* \param _dir repertoire
* \param month mois du rapport
* \param year annee du rapport
* \param outputlangs Lang output object
* Fonction generant la rapport sur le disque
*
* @param string $_dir repertoire
* @param int $month mois du rapport
* @param int $year annee du rapport
* @param string $outputlangs Lang output object
*/
function write_file($_dir, $month, $year, $outputlangs)
{
@ -127,7 +128,7 @@ class pdf_paiement
$sql.= " AND p.datep BETWEEN '".$this->db->idate(dol_get_first_day($year,$month))."' AND '".$this->db->idate(dol_get_last_day($year,$month))."'";
$sql.= " ORDER BY p.datep ASC, pf.fk_paiement ASC";
dol_syslog("pdf_paiement::write_file sql=".$sql);
dol_syslog(get_class($this)."::write_file sql=".$sql);
$result = $this->db->query($sql);
if ($result)
{
@ -263,7 +264,13 @@ class pdf_paiement
/**
* Output body
*
* @param PDF &$pdf PDF object
* @param string $page Page
* @param array $lines Array of lines
* @param Translate $langs Object langs
* @return void
*/
function Body(&$pdf, $page, $lines, $outputlangs)
{