Skip to content

Commit

Permalink
Doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
eldy committed Sep 3, 2011
1 parent 116e215 commit 26badd5
Show file tree
Hide file tree
Showing 40 changed files with 918 additions and 853 deletions.
5 changes: 3 additions & 2 deletions htdocs/adherents/class/adherent.class.php
Expand Up @@ -116,8 +116,9 @@ class Adherent extends CommonObject


/**
* Adherent
* @param DB base de donnees
* Constructor
*
* @param DoliDB $DB Database handler
*/
function Adherent($DB)
{
Expand Down
20 changes: 13 additions & 7 deletions htdocs/adherents/class/adherent_type.class.php
Expand Up @@ -49,8 +49,9 @@ class AdherentType extends CommonObject


/**
* \brief AdherentType
* \param DB handler acces base de donnees
* Constructor
*
* @param DoliDB $DB Database handler
*/
function AdherentType($DB)
{
Expand Down Expand Up @@ -194,6 +195,7 @@ function fetch($rowid)

/**
* Return list of members' type
*
* @return array List of types of members
*/
function liste_array()
Expand Down Expand Up @@ -233,11 +235,12 @@ function liste_array()


/**
* \brief Renvoie nom clicable (avec eventuellement le picto)
* \param withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul
* \param maxlen length max libelle
* \param option Page lien
* \return string Chaine avec URL
* Renvoie nom clicable (avec eventuellement le picto)
*
* @param withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul
* @param maxlen length max libelle
* @param option Page lien
* @return string Chaine avec URL
*/
function getNomUrl($withpicto=0,$maxlen=0)
{
Expand All @@ -260,6 +263,7 @@ function getNomUrl($withpicto=0,$maxlen=0)

/**
* getMailOnValid
*
* @return Return mail model
*/
function getMailOnValid()
Expand All @@ -278,6 +282,7 @@ function getMailOnValid()

/**
* getMailOnSubscription
*
* @return Return mail model
*/
function getMailOnSubscription()
Expand All @@ -296,6 +301,7 @@ function getMailOnSubscription()

/**
* getMailOnResiliate
*
* @return Return mail model
*/
function getMailOnResiliate()
Expand Down
10 changes: 5 additions & 5 deletions htdocs/adherents/class/adherentstats.class.php
Expand Up @@ -45,12 +45,12 @@ class AdherentStats extends Stats


/**
* Constructor
* Constructor
*
* @param $DB Database handler
* @param $socid Id third party
* @param $userid Id user for filter
* @return AdherentStats
* @param DoliDB $DB Database handler
* @param int $socid Id third party
* @param int $userid Id user for filter
* @return AdherentStats
*/
function AdherentStats($DB, $socid=0, $userid=0)
{
Expand Down
47 changes: 27 additions & 20 deletions htdocs/adherents/class/cotisation.class.php
Expand Up @@ -49,8 +49,9 @@ class Cotisation extends CommonObject


/**
* \brief Constructor
* \param DB Handler base de donnees
* Constructor
*
* @param DoliDB $DB Database handler
*/
function Cotisation($DB)
{
Expand All @@ -59,9 +60,10 @@ function Cotisation($DB)


/**
* \brief Fonction qui permet de creer la cotisation
* \param userid userid de celui qui insere
* \return int <0 si KO, Id cotisation cree si OK
* Fonction qui permet de creer la cotisation
*
* @param userid userid de celui qui insere
* @return int <0 si KO, Id cotisation cree si OK
*/
function create($userid)
{
Expand Down Expand Up @@ -95,9 +97,10 @@ function create($userid)


/**
* \brief Fonction qui permet de recuperer une cotisation
* \param rowid Id cotisation
* \return int <0 si KO, =0 si OK mais non trouve, >0 si OK
* Fonction qui permet de recuperer une cotisation
*
* @param rowid Id cotisation
* @return int <0 si KO, =0 si OK mais non trouve, >0 si OK
*/
function fetch($rowid)
{
Expand Down Expand Up @@ -144,10 +147,11 @@ function fetch($rowid)


/**
* \brief Met a jour en base la cotisation
* \param user Objet user qui met a jour
* \param notrigger 0=Desactive les triggers
* \param int <0 if KO, >0 if OK
* Met a jour en base la cotisation
*
* @param user Objet user qui met a jour
* @param notrigger 0=Desactive les triggers
* @param int <0 if KO, >0 if OK
*/
function update($user,$notrigger=0)
{
Expand Down Expand Up @@ -184,9 +188,10 @@ function update($user,$notrigger=0)
}

/**
* \brief Delete a subscription
* \param rowid Id cotisation
* \return int <0 si KO, 0 si OK mais non trouve, >0 si OK
* Delete a subscription
*
* @param rowid Id cotisation
* @return int <0 si KO, 0 si OK mais non trouve, >0 si OK
*/
function delete($user)
{
Expand Down Expand Up @@ -250,9 +255,10 @@ function delete($user)


/**
* \brief Renvoie nom clicable (avec eventuellement le picto)
* \param withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul
* \return string Chaine avec URL
* Renvoie nom clicable (avec eventuellement le picto)
*
* @param withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul
* @return string Chaine avec URL
*/
function getNomUrl($withpicto=0)
{
Expand All @@ -274,8 +280,9 @@ function getNomUrl($withpicto=0)


/**
* \brief Charge les informations d'ordre info dans l'objet cotisation
* \param id Id adhesion a charger
* Charge les informations d'ordre info dans l'objet cotisation
*
* @param id Id adhesion a charger
*/
function info($id)
{
Expand Down
4 changes: 2 additions & 2 deletions htdocs/adherents/stats/geo.php
Expand Up @@ -168,7 +168,7 @@


// Print title
if ($mode && ! sizeof($data))
if ($mode && ! count($data))
{
print $langs->trans("NoValidatedMemberYet").'<br>';
print '<br>';
Expand Down Expand Up @@ -202,7 +202,7 @@
print "function drawMap() {\n\tvar data = new google.visualization.DataTable();\n";

// Get the total number of rows
print "\tdata.addRows(".sizeof($data).");\n";
print "\tdata.addRows(".count($data).");\n";
print "\tdata.addColumn('string', 'Country');\n";
print "\tdata.addColumn('number', 'Number');\n";

Expand Down
5 changes: 1 addition & 4 deletions htdocs/admin/agenda.php
Expand Up @@ -79,12 +79,9 @@
//print "param=".$param." - ".$_POST[$param];
if (! empty($_POST[$param])) $res = dolibarr_set_const($db,$param,$_POST[$param],'chaine',0,'',$conf->entity);
else $res = dolibarr_del_const($db,$param,$conf->entity);
if (! $res > 0) $error++;
}

$db->commit();

if (! $res > 0) $error++;

if (! $error)
{
$db->commit();
Expand Down
6 changes: 3 additions & 3 deletions htdocs/admin/barcode.php
@@ -1,6 +1,6 @@
<?php
/* Copyright (C) 2003-2004 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2004-2009 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2004-2011 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2005-2009 Regis Houssin <regis@dolibarr.fr>
*
* This program is free software; you can redistribute it and/or modify
Expand All @@ -18,9 +18,9 @@
*/

/**
* \file htdocs/includes/modules/barcode/admin/barcode.php
* \file htdocs/admin/barcode.php
* \ingroup barcode
* \brief Page d'administration/configuration du module Code barre
* \brief Page to setup barcode module
*/

require("../main.inc.php");
Expand Down
2 changes: 1 addition & 1 deletion htdocs/admin/menus/edit.php
Expand Up @@ -261,7 +261,7 @@ function init_topleft()
if ($res)
{

while ($menu = $db->fetch_array ($res))
while ($menu = $db->fetch_array($res))
{
$parent_rowid = $menu['rowid'];
$parent_mainmenu = $menu['mainmenu'];
Expand Down
2 changes: 1 addition & 1 deletion htdocs/admin/menus/index.php
Expand Up @@ -300,7 +300,7 @@
$num = $db->num_rows($res);

$i = 1;
while ($menu = $db->fetch_array ($res))
while ($menu = $db->fetch_array($res))
{
if (! empty($menu['langs'])) $langs->load($menu['langs']);
$titre = $langs->trans($menu['titre']);
Expand Down
2 changes: 1 addition & 1 deletion htdocs/admin/menus/menu.js.php
Expand Up @@ -32,7 +32,7 @@
if (! defined('NOREQUIREHTML')) define('NOREQUIREHTML',1);
if (! defined('NOREQUIREAJAX')) define('NOREQUIREAJAX','1');

session_cache_limiter( FALSE );
session_cache_limiter(FALSE);

require_once("../../master.inc.php");
require_once(DOL_DOCUMENT_ROOT."/lib/functions.lib.php");
Expand Down
5 changes: 3 additions & 2 deletions htdocs/admin/notification.php
Expand Up @@ -27,6 +27,7 @@
require_once(DOL_DOCUMENT_ROOT."/includes/triggers/interface_modNotification_Notification.class.php");

$langs->load("admin");
$langs->load("mails");

// Security check
if (!$user->admin)
Expand Down Expand Up @@ -63,7 +64,7 @@

print $langs->trans("NotificationsDesc").'<br><br>';

if ($mesg) print $mesg.'<br>';
dol_htmloutput_mesg($mesg);

print '<form method="post" action="'.$_SERVER["PHP_SELF"].'">';
print '<input type="hidden" name="token" value="'.$_SESSION['newtoken'].'">';
Expand All @@ -80,6 +81,7 @@
print '<tr '.$bc[$var].'><td>';
print $langs->trans("NotificationEMailFrom").'</td><td>';
print '<input size="32" type="text" name="email_from" value="'.$conf->global->NOTIFICATION_EMAIL_FROM.'">';
if (! empty($conf->global->NOTIFICATION_EMAIL_FROM) && ! isValidEmail($conf->global->NOTIFICATION_EMAIL_FROM)) print ' '.img_warning($langs->trans("BadEMail"));
print '</td></tr>';
print '</table>';

Expand Down Expand Up @@ -121,5 +123,4 @@


llxFooter();

?>
15 changes: 13 additions & 2 deletions htdocs/admin/prelevement.php
Expand Up @@ -40,9 +40,11 @@

if ($action == "set")
{
$db->begin();
for ($i = 0 ; $i < 2 ; $i++)
{
$res = dolibarr_set_const($db, $_POST["nom$i"], $_POST["value$i"],'chaine',0,'',$conf->entity);
if (! $res > 0) $error++;
}

$id=$_POST["PRELEVEMENT_ID_BANKACCOUNT"];
Expand All @@ -51,23 +53,32 @@
if($account->fetch($id)>0)
{
$res = dolibarr_set_const($db, "PRELEVEMENT_ID_BANKACCOUNT", $id,'chaine',0,'',$conf->entity);
if (! $res > 0) $error++;
$res = dolibarr_set_const($db, "PRELEVEMENT_CODE_BANQUE", $account->code_banque,'chaine',0,'',$conf->entity);
if (! $res > 0) $error++;
$res = dolibarr_set_const($db, "PRELEVEMENT_CODE_GUICHET", $account->code_guichet,'chaine',0,'',$conf->entity);
if (! $res > 0) $error++;
$res = dolibarr_set_const($db, "PRELEVEMENT_NUMERO_COMPTE", $account->number,'chaine',0,'',$conf->entity);
if (! $res > 0) $error++;
$res = dolibarr_set_const($db, "PRELEVEMENT_NUMBER_KEY", $account->cle_rib,'chaine',0,'',$conf->entity);
if (! $res > 0) $error++;
$res = dolibarr_set_const($db, "PRELEVEMENT_IBAN", $account->iban,'chaine',0,'',$conf->entity);
if (! $res > 0) $error++;
$res = dolibarr_set_const($db, "PRELEVEMENT_BIC", $account->bic,'chaine',0,'',$conf->entity);
if (! $res > 0) $error++;
$res = dolibarr_set_const($db, "PRELEVEMENT_RAISON_SOCIALE", $account->proprio,'chaine',0,'',$conf->entity);
if (! $res > 0) $error++;
}
else $error++;

if (! $res > 0) $error++;

if (! $error)
{
$db->commit();
$mesg = "<font class=\"ok\">".$langs->trans("SetupSaved")."</font>";
}
else
{
$db->rollback();
$mesg = "<font class=\"error\">".$langs->trans("Error")."</font>";
}
}
Expand Down

0 comments on commit 26badd5

Please sign in to comment.