Commit beed52ef authored by Feu's avatar Feu
Browse files

un peu de docs et de ménage

parent 3eadfdcb
......@@ -18,7 +18,7 @@ FULL_PATH_NAMES = YES
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
JAVADOC_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
......@@ -63,8 +63,8 @@ FILE_VERSION_FILTER =
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARNINGS = NO
WARN_IF_UNDOCUMENTED = NO
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
WARN_FORMAT = "$file:$line: $text"
......@@ -73,9 +73,9 @@ WARN_LOGFILE =
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = ./
FILE_PATTERNS =
FILE_PATTERNS = *.php
RECURSIVE = YES
EXCLUDE =
EXCLUDE = ./temp/ ./font/
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXAMPLE_PATH =
......
<?php
/* Copyright 2005,2006,2007
* - Julien Etelain <julien CHEZ pmad POINT net>
*
* Ce fichier fait partie du site de l'Association des étudiants de
* l'UTBM, http://ae.utbm.fr.
*
* 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 the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
* 02111-1307, USA.
*/
/**
* @file
*/
/**
* Budget à placer dans un classeur de compta
* @ingroup compta
*/
class budget extends stdentity
{
......
<?php
/* Copyright 2005,2006,2007
* - Julien Etelain <julien CHEZ pmad POINT net>
*
* Ce fichier fait partie du site de l'Association des étudiants de
* l'UTBM, http://ae.utbm.fr.
*
* 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 the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
* 02111-1307, USA.
*/
/**
* @file
*/
require_once($topdir."include/site.inc.php");
/**
* @defgroup compta Comptabilité
*
* Avant tout chose, comme pour les comptoirs : LA COMPTA EST EN CENTIMES !
*
* @todo Il y a plein de choses à dire ici
*
*
*
*/
/* LA COMPTA EST EN CENTIMES !!! */
require_once($topdir."include/site.inc.php");
require_once("comptes.inc.php");
require_once("defines.inc.php");
......@@ -15,7 +45,11 @@ require_once("typeop.inc.php");
require_once("budget.inc.php");
require_once("libelle.inc.php");
/**
* Version spécialisée du site pour la compta
* @ingroup compta
* @see site
*/
class sitecompta extends site
{
var $id_asso;
......
......@@ -31,6 +31,7 @@ require_once($topdir . "include/entities/asso.inc.php");
/**
* Compte bancaire
* @ingroup compta
*/
class compte_bancaire extends stdentity
{
......@@ -180,6 +181,7 @@ class compte_bancaire extends stdentity
/**
* Compte association (associé à un compte bancaire)
* @ingroup compta
*/
class compte_asso extends stdentity
{
......@@ -248,6 +250,7 @@ class compte_asso extends stdentity
/**
* Classeur de compta (relatif à un seul compte association)
* @ingroup compta
*/
class classeur_compta extends stdentity /* table: cpta_classeur */
{
......@@ -375,6 +378,4 @@ class classeur_compta extends stdentity /* table: cpta_classeur */
}
?>
?>
\ No newline at end of file
......
......@@ -27,17 +27,20 @@
/**
* Etiquette à associer à une opération pour classer ses dernières.
* @ingroup compta
*/
class compta_libelle extends stdentity /* table: cpta_libelle */
class compta_libelle extends stdentity
{
/** Id de l'activité/association associé */
var $id_asso;
/** Nom de l'etiquette */
var $nom;
/** Charge un libellé en fonction de son id
* @param $id Id du compte bancaire
*/
/** Charge une etiquette en fonction de son id
* En cas d'erreur, l'id est défini à null
* @param $id id de l'etiquette
* @return true en cas de succès, false sinon
*/
function load_by_id ( $id )
{
$req = new requete ($this->db, "SELECT * FROM `cpta_libelle`
......@@ -100,13 +103,10 @@ class compta_libelle extends stdentity /* table: cpta_libelle */
function remove_libelle ()
{
$sql = new delete ($this->dbrw,"cpta_libelle",array("id_libelle" => $this->id));
new delete ($this->dbrw,"cpta_libelle",array("id_libelle" => $this->id));
}
}
?>
\ No newline at end of file
<?php
/* Copyright 2005,2006, 2007
* - Julien Etelain <julien CHEZ pmad POINT net>
*
* Ce fichier fait partie du site de l'Association des 0tudiants de
* l'UTBM, http://ae.utbm.fr.
*
* 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 the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
* 02111-1307, USA.
*/
/**
* @file
*/
/**
* Modes de paiements possibles pour une opération de compta.
*/
$modes_operation = array(2=>"Espèces",1=>"Chèque",3=>"Virement",4=>"Carte Bancaire");
/**
* Opération comptable
* Une opération de compta [dans un classeur de compta].
*
* Une opération doit être liée au moins à un tiers. Cela représente la personne
* qui a été crédité (si l'opération est un débit), ou qui a été débité (si il
* s'agit d'un débit). Un tiers peut être :
* - un utlisateur
* - une association
* - une entreprise
* - un compte association (pour les mouvements interne)
* Un général un seul doit être définit, hormis si un utilisateur a servi
* d'intermédiaire, alors il doit être définit en plus du tiers "réel".
*
* Une opération peut être liée à un ou plusieurs fichiers de la partie fichier.
* (pour stocker des justificatifs).
*
* @ingroup compta
* @see classeur
* @see operation_comptable
* @see operation_club
* @see compta_libelle
*/
class operation extends stdentity
{
/** Id du classeur dans le quel se trouve cette opération */
var $id_classeur;
/** Numéro d'ordre de l'opération.
* Attention: il ne doit pas y avoir d'interruption dans la numérotation.
*/
var $num;
/** Id de l'étiquette associée (libelle). Facultatif : peut être null.
* Permet de creer des catégories d'opérations au sein d'un classeur pour
* suivre par exemples des catégories budgetaires
*/
var $id_libelle;
/* type d'opération*/
/** Id du type d'opération simplifié (obgligatoire */
var $id_opclb;
var $id_opstd;
/* étudiant éventuellement remboursé */
var $id_utilisateur;
/** Id du type comptable (facultatif), peut être null. */
var $id_opstd;
/* opération liée, pour les opération jumelles (de compte bancaire à compte bancaire)*/
/** Opération liée, pour les opération jumelles (de compte à compte en interne)*/
var $id_op_liee;
/* bénéficiaire : asso, entreprise ou compte bancaire*/
/** Id de l'utilisateur tiers (crédité/débité) ou qui a servi d'intermédiaire. Facultatif. */
var $id_utilisateur;
/** Id de l'association tiers (crédité/débité). Facultatif. */
var $id_asso;
/** Id de l'entreprise tiers (crédité/débité). Facultatif. */
var $id_ent;
/** Id du compte association tiers (crédité/débité). Facultatif. */
var $id_cptasso;
/* informations sur l'opération */
/** Montant de l'opération en centimes */
var $montant;
/** Date de l'opération (timestamp) */
var $date;
/** Commentaire sue l'opération */
var $commentaire;
/** Marquage effectué (1: effctue, 0: non effectué) */
var $effectue;
/** Mode de paiement de l'opération
* @see $modes_operation
*/
var $mode;
/** Si le mode est par chèque, le numéro du chèque */
var $num_cheque;
......@@ -266,6 +327,11 @@ class operation extends stdentity
}
/**
* Définit l'étiquette (libelle) associée à cette opération.
* @param $id_libelle Id de l'étiquette. Peut être null.
* @see compta_libelle
*/
function set_libelle($id_libelle)
{
$this->id_libelle = $id_libelle;
......@@ -277,6 +343,12 @@ class operation extends stdentity
);
}
/**
* Récupère la liste des ids des fichiers associés à cette opération.
* @return la liste des ids des fichiers
* @see dfile
* @see operation::get_files
*/
function get_files_ids()
{
$list = array();
......@@ -286,6 +358,11 @@ class operation extends stdentity
return $list;
}
/**
* Récupère la liste des fichiers associés à cette opération.
* @return la liste des fichiers sous forme d'instances de dfile
* @see dfile
*/
function get_files()
{
global $topdir;
......@@ -301,6 +378,11 @@ class operation extends stdentity
return $files;
}
/**
* Définit la liste des fichiers associées à cett opération
* @param $files liste d'instances de dfile
* @see dfile
*/
function set_files ( &$files )
{
$actual = $this->get_files_ids();
......
<?php
/* Copyright 2005,2006,2007
* - Julien Etelain <julien CHEZ pmad POINT net>
*
* Ce fichier fait partie du site de l'Association des étudiants de
* l'UTBM, http://ae.utbm.fr.
*
* 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 the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
* 02111-1307, USA.
*/
/**
* @file
* Type des opérations de la compta
......@@ -8,12 +30,18 @@ $types_mouvements = array (1 => "Credit",-1 => "Debit",0 => "Pas de mouvement de
$types_mouvements_reel = array (1 => "Credit",-1 => "Debit");
/**
* Opération comptable = opération selon le plan comptable
* Type d'opération selon le plan comptable
* @ingroup compta
*/
class operation_comptable extends stdentity
{
/** Code du plan comptable du type d'opération */
var $code;
/** Nom du type d'opération */
var $libelle;
/** Mouvement du type d'opération
* @see $types_mouvements
*/
var $type_mouvement;
......@@ -68,12 +96,23 @@ class operation_comptable extends stdentity
/**
* Type d'opération simplifié pour les clubs (relatif au compte association)
* @ingroup compta
*/
class operation_club extends stdentity
{
/** Id de l'activité/association associé, null si cette opération est communes
* à l'ensemble des activités
*/
var $id_asso;
/** Id du type d'operation comptable associé, peut être null
* @see operation_comptable
*/
var $id_opstd;
/** Nom du type d'opération */
var $libelle;
/** Mouvement du type d'opération
* @see $types_mouvements_reel
*/
var $type_mouvement;
/** Charge le type d'opération simplifié par son id
......@@ -139,17 +178,15 @@ class operation_club extends stdentity
*/
function attach ( $id_opstd )
{
$req = new update($this->dbrw,
new update($this->dbrw,
"cpta_operation",
array("id_opstd"=>$id_opstd),
array("id_opclb"=>$this->id));
$req = new update($this->dbrw,
new update($this->dbrw,
"cpta_op_clb",
array("id_opstd"=>$id_opstd),
array("id_opclb"=>$this->id));
}
/** Ajoute un nouveau type d'opération sur le compte asso
......@@ -214,19 +251,19 @@ class operation_club extends stdentity
/** Remplace le type d'opération par un autre (et supprime ce type)
* @param $op Instance de operation_club
*/
function replace_and_remove ( $op )
function replace_and_remove ( &$op )
{
$req = new update($this->dbrw,
new update($this->dbrw,
"cpta_operation",
array("id_opstd"=>$op->id_opstd,"id_opclb"=>$op->id),
array("id_opclb"=>$this->id));
$req = new update($this->dbrw,
new update($this->dbrw,
"cpta_ligne_budget",
array("id_opclb"=>$op->id),
array("id_opclb"=>$this->id));
$req = new delete($this->dbrw,
new delete($this->dbrw,
"cpta_op_clb",
array("id_opclb"=>$this->id));
}
......@@ -244,7 +281,7 @@ class operation_club extends stdentity
$this->libelle = $libelle;
$this->type_mouvement = $type_mouvement;
$sql = new update ($this->dbrw,
new update ($this->dbrw,
"cpta_op_clb",
array(
"id_asso" => $this->id_asso,
......@@ -257,14 +294,12 @@ class operation_club extends stdentity
)
);
$req = new update($this->dbrw,
new update($this->dbrw,
"cpta_operation",
array("id_opstd"=>$this->id_opstd),
array("id_opclb"=>$this->id));
}
}
?>
?>
\ No newline at end of file
......@@ -44,10 +44,6 @@ function first ( $array )
return current($array);
}
/**
* @addtogroup comptoirs
* @{
*/
/**
* Classe gérant un comptoir et des sessions de vente.
......@@ -84,6 +80,7 @@ function first ( $array )
* @see produit
* @see venteproduit
* @see comptoir/frontend.inc.php
* @ingroup comptoirs
*/
class comptoir extends stdentity
{
......
......@@ -22,9 +22,11 @@
* 02111-1307, USA.
*/
/** @file
* @defgroup comptoirs Comptoirs/E-boutic
* @{
/** @file */
/**
* @defgroup comptoirs Comptoirs et E-boutic
* Avant tout chose, comme pour la compta : TOUS LES PRIX SONT EN CENTIMES !
*/
......@@ -39,6 +41,10 @@ require_once($topdir . "comptoir/include/typeproduit.inc.php");
require_once($topdir . "comptoir/include/venteproduit.inc.php");
require_once($topdir."include/entities/books.inc.php");
/**
* Version spéciale de site pour les comptoirs
* @ingroup comptoirs
*/
class sitecomptoirs extends site
{
var $id_asso;
......@@ -135,7 +141,4 @@ class sitecomptoirs extends site
}
/**@}*/
?>
......@@ -4,13 +4,10 @@
*/
/**
* @addtogroup comptoirs
* @{
*/
/**
* Classe gérant un compte association
* @ingroup comptoirs
*/
class assocpt extends stdentity
{
......
......@@ -27,14 +27,10 @@
* Gestion des factures (et debits) des comptes AE et de l'eboutic.
*/
/**
* @addtogroup comptoirs
* @{
*/
/**
* Classe gérant les factures cartes AE/e-boutic. Elle permet le debit sur les comptes AE.
* @see venteproduit
* @ingroup comptoirs
*/
class debitfacture extends stdentity
{
......
......@@ -30,16 +30,12 @@
* 02111-1307, USA.
*/
/**
* @addtogroup comptoirs
* @{
*/
/**
* Classe gérant un produit
* @see venteproduit
* @see comptoir
* @see debitfacture
* @ingroup comptoirs
*/
class produit extends stdentity
{
......
......@@ -3,27 +3,28 @@
* @file
*/
/**
* @addtogroup comptoirs
* @{
*/
//cpt_typeproduit
/**
* Classe gérant un type de produit
* @see produit
* @ingroup comptoirs
*/
class typeproduit extends stdentity
{
/** Nom du type de produit */
var $nom;
var $action; // <=> action par défaut lors de l'ajout
var $id_assocpt; // <=> association par défaut lors de l'ajout
/** Action par défaut lors de l'ajout */
var $action;
/** Association par défaut lors de l'ajout */
var $id_assocpt;
/** Id du fichier utilisé pour la vignette du type de produit */
var $id_file;
/** Description du type de produit */
var $description;
function load_by_id ( $id )
{
......@@ -106,4 +107,4 @@ class typeproduit extends stdentity