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

Doc: Mise a jour doc doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2006-06-06 22:54:23 +00:00
parent e474b0aa67
commit dda86fad98
4 changed files with 24 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/dev/dolibarr-doxygen.conf
View File

@ -1,4 +1,4 @@
# Doxyfile 1.3.8 # Doxyfile 1.4.6
# #
# $Id$ # $Id$
# $Source$ # $Source$
@ -8,7 +8,7 @@
# Project related configuration options # Project related configuration options
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
PROJECT_NAME = dolibarr PROJECT_NAME = dolibarr
PROJECT_NUMBER = 2.0.0 PROJECT_NUMBER = 2.1.0
OUTPUT_DIRECTORY = doc/dev OUTPUT_DIRECTORY = doc/dev
CREATE_SUBDIRS = NO CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English OUTPUT_LANGUAGE = English

2
htdocs/includes/modules/export/modules_export.php
View File

@ -29,7 +29,7 @@
/** /**
\class ModeleExport \class ModeleExports
\brief Classe mère des modèles de format d'export \brief Classe mère des modèles de format d'export
*/ */

35
htdocs/user.class.php
View File

@ -1,7 +1,7 @@
<?php <?php
/* Copyright (c) 2002-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org> /* Copyright (c) 2002-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (c) 2002-2003 Jean-Louis Bergamo <jlb@j1b.org> * Copyright (c) 2002-2003 Jean-Louis Bergamo <jlb@j1b.org>
* Copyright (c) 2004-2005 Laurent Destailleur <eldy@users.sourceforge.net> * Copyright (c) 2004-2006 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2004 Sebastien Di Cintio <sdicintio@ressource-toi.org> * Copyright (C) 2004 Sebastien Di Cintio <sdicintio@ressource-toi.org>
* Copyright (C) 2004 Benoit Mortier <benoit.mortier@opensides.be> * Copyright (C) 2004 Benoit Mortier <benoit.mortier@opensides.be>
* Copyright (C) 2005 Regis Houssin <regis.houssin@cap-networks.com> * Copyright (C) 2005 Regis Houssin <regis.houssin@cap-networks.com>
@ -75,8 +75,8 @@ class User
/** /**
* \brief Constructeur de la classe * \brief Constructeur de la classe
* \param $DB handler accès base de données * \param DB Handler accès base de données
* \param $id id de l'utilisateur (0 par défaut) * \param id Id de l'utilisateur (0 par défaut)
*/ */
function User($DB, $id=0) function User($DB, $id=0)
{ {
@ -98,8 +98,7 @@ class User
* \brief Charge un objet user avec toutes ces caractéristiques depuis un id ou login * \brief Charge un objet user avec toutes ces caractéristiques depuis un id ou login
* \param login Si défini, login a utiliser pour recherche * \param login Si défini, login a utiliser pour recherche
*/ */
function fetch($login='')
function fetch($login='')
{ {
// Recupere utilisateur // Recupere utilisateur
$sql = "SELECT u.rowid, u.name, u.firstname, u.email, u.office_phone, u.office_fax, u.user_mobile, u.code, u.admin, u.login, u.pass, u.webcal_login, u.note,"; $sql = "SELECT u.rowid, u.name, u.firstname, u.email, u.office_phone, u.office_fax, u.user_mobile, u.code, u.admin, u.login, u.pass, u.webcal_login, u.note,";
@ -217,7 +216,6 @@ class User
* \param allperms Ajouter tous les droits du module allmodule, perms allperms * \param allperms Ajouter tous les droits du module allmodule, perms allperms
* \return int > 0 si ok, < 0 si erreur * \return int > 0 si ok, < 0 si erreur
*/ */
function addrights($rid,$allmodule='',$allperms='') function addrights($rid,$allmodule='',$allperms='')
{ {
dolibarr_syslog("User::addrights $rid, $allmodule, $allperms"); dolibarr_syslog("User::addrights $rid, $allmodule, $allperms");
@ -311,7 +309,6 @@ class User
* \param allperms Retirer tous les droits du module allmodule, perms allperms * \param allperms Retirer tous les droits du module allmodule, perms allperms
* \return int > 0 si ok, < 0 si erreur * \return int > 0 si ok, < 0 si erreur
*/ */
function delrights($rid,$allmodule='',$allperms='') function delrights($rid,$allmodule='',$allperms='')
{ {
$err=0; $err=0;
@ -398,8 +395,7 @@ class User
* \brief Charge dans l'objet user, la liste des permissions auxquelles l'utilisateur a droit * \brief Charge dans l'objet user, la liste des permissions auxquelles l'utilisateur a droit
* \param module nom du module dont il faut récupérer les droits ('' par defaut signifie tous les droits) * \param module nom du module dont il faut récupérer les droits ('' par defaut signifie tous les droits)
*/ */
function getrights($module='')
function getrights($module='')
{ {
if ($this->all_permissions_are_loaded) if ($this->all_permissions_are_loaded)
{ {
@ -713,8 +709,7 @@ class User
* \brief Affectation des permissions par défaut * \brief Affectation des permissions par défaut
* \return si erreur <0, si ok renvoi le nbre de droits par defaut positionnés * \return si erreur <0, si ok renvoi le nbre de droits par defaut positionnés
*/ */
function set_default_rights()
function set_default_rights()
{ {
$sql = "SELECT id FROM ".MAIN_DB_PREFIX."rights_def WHERE bydefault = 1"; $sql = "SELECT id FROM ".MAIN_DB_PREFIX."rights_def WHERE bydefault = 1";
@ -752,7 +747,7 @@ class User
* \param create 1 si update durant le create, 0 sinon * \param create 1 si update durant le create, 0 sinon
* \return int <0 si echec, >=0 si ok * \return int <0 si echec, >=0 si ok
*/ */
function update($create=0) function update($create=0)
{ {
global $langs; global $langs;
@ -816,7 +811,7 @@ class User
* \brief Mise à jour en base de la date de deniere connexion d'un utilisateur * \brief Mise à jour en base de la date de deniere connexion d'un utilisateur
* \return <0 si echec, >=0 si ok * \return <0 si echec, >=0 si ok
*/ */
function update_last_login_date() function update_last_login_date()
{ {
dolibarr_syslog ("Mise a jour date derniere connexion pour user->id=".$this->id); dolibarr_syslog ("Mise a jour date derniere connexion pour user->id=".$this->id);
@ -937,8 +932,7 @@ class User
* \brief Renvoie la dernière erreur fonctionnelle de manipulation de l'objet * \brief Renvoie la dernière erreur fonctionnelle de manipulation de l'objet
* \return string chaine erreur * \return string chaine erreur
*/ */
function error()
function error()
{ {
return $this->error; return $this->error;
} }
@ -947,7 +941,7 @@ class User
/** /**
* \brief Lecture des infos de click to dial * \brief Lecture des infos de click to dial
*/ */
function fetch_clicktodial() function fetch_clicktodial()
{ {
$sql = "SELECT login, pass, poste FROM ".MAIN_DB_PREFIX."user_clicktodial as u"; $sql = "SELECT login, pass, poste FROM ".MAIN_DB_PREFIX."user_clicktodial as u";
@ -985,7 +979,7 @@ class User
/** /**
* \brief Mise à jour des infos de click to dial * \brief Mise à jour des infos de click to dial
*/ */
function update_clicktodial() function update_clicktodial()
{ {
$sql = "DELETE FROM ".MAIN_DB_PREFIX."user_clicktodial"; $sql = "DELETE FROM ".MAIN_DB_PREFIX."user_clicktodial";
@ -1017,8 +1011,7 @@ class User
* \brief Ajoute l'utilisateur dans un groupe * \brief Ajoute l'utilisateur dans un groupe
* \param group id du groupe * \param group id du groupe
*/ */
function SetInGroup($group)
function SetInGroup($group)
{ {
$sql = "DELETE FROM ".MAIN_DB_PREFIX."usergroup_user"; $sql = "DELETE FROM ".MAIN_DB_PREFIX."usergroup_user";
@ -1037,8 +1030,7 @@ class User
* \brief Retire l'utilisateur d'un groupe * \brief Retire l'utilisateur d'un groupe
* \param group id du groupe * \param group id du groupe
*/ */
function RemoveFromGroup($group)
function RemoveFromGroup($group)
{ {
$sql = "DELETE FROM ".MAIN_DB_PREFIX."usergroup_user"; $sql = "DELETE FROM ".MAIN_DB_PREFIX."usergroup_user";
@ -1047,6 +1039,7 @@ class User
$result = $this->db->query($sql); $result = $this->db->query($sql);
} }
} }
?> ?>

22
htdocs/usergroup.class.php
View File

@ -45,10 +45,9 @@ class UserGroup
/** /**
* \brief Constructeur de la classe * \brief Constructeur de la classe
* \param $DB handler accès base de données * \param DB Handler accès base de données
* \param $id id du groupe (0 par défaut) * \param id Id du groupe (0 par défaut)
*/ */
function UserGroup($DB, $id=0) function UserGroup($DB, $id=0)
{ {
$this->db = $DB; $this->db = $DB;
@ -62,7 +61,6 @@ class UserGroup
* \brief Charge un objet user avec toutes ces caractéristiques * \brief Charge un objet user avec toutes ces caractéristiques
* \param id id du groupe à charger * \param id id du groupe à charger
*/ */
function fetch($id) function fetch($id)
{ {
$this->id = $id; $this->id = $id;
@ -103,7 +101,6 @@ class UserGroup
* \param allperms Ajouter tous les droits du module allmodule, perms allperms * \param allperms Ajouter tous les droits du module allmodule, perms allperms
* \return int > 0 si ok, < 0 si erreur * \return int > 0 si ok, < 0 si erreur
*/ */
function addrights($rid,$allmodule='',$allperms='') function addrights($rid,$allmodule='',$allperms='')
{ {
$err=0; $err=0;
@ -200,7 +197,6 @@ class UserGroup
* \param allperms Retirer tous les droits du module allmodule, perms allperms * \param allperms Retirer tous les droits du module allmodule, perms allperms
* \return int > 0 si ok, < 0 si erreur * \return int > 0 si ok, < 0 si erreur
*/ */
function delrights($rid,$allmodule='',$allperms='') function delrights($rid,$allmodule='',$allperms='')
{ {
$err=0; $err=0;
@ -290,10 +286,9 @@ class UserGroup
/** /**
* \brief Charge dans l'objet group, la liste des permissions auquels le groupe a droit * \brief Charge dans l'objet group, la liste des permissions auquels le groupe a droit
* \param module nom du module dont il faut récupérer les droits ('' par defaut signifie tous les droits) * \param module Nom du module dont il faut récupérer les droits ('' par defaut signifie tous les droits)
*/ */
function getrights($module='')
function getrights($module='')
{ {
if ($this->all_permissions_are_loaded) if ($this->all_permissions_are_loaded)
{ {
@ -345,7 +340,6 @@ class UserGroup
* \brief Efface un groupe de la base * \brief Efface un groupe de la base
* \return < 0 si erreur, > 0 si ok * \return < 0 si erreur, > 0 si ok
*/ */
function delete() function delete()
{ {
$this->db->begin(); $this->db->begin();
@ -378,10 +372,8 @@ class UserGroup
* \brief Crée un groupe en base * \brief Crée un groupe en base
* \return si erreur <0, si ok renvoie id groupe créé * \return si erreur <0, si ok renvoie id groupe créé
*/ */
function create()
function create() {
{
$sql = "INSERT into ".MAIN_DB_PREFIX."usergroup (datec,nom)"; $sql = "INSERT into ".MAIN_DB_PREFIX."usergroup (datec,nom)";
$sql .= " VALUES(now(),'".addslashes($this->nom)."')"; $sql .= " VALUES(now(),'".addslashes($this->nom)."')";
@ -407,7 +399,7 @@ class UserGroup
* \brief Mise à jour en base d'un utilisateur * \brief Mise à jour en base d'un utilisateur
* \return <0 si echec, >=0 si ok * \return <0 si echec, >=0 si ok
*/ */
function update() function update()
{ {
$sql = "UPDATE ".MAIN_DB_PREFIX."usergroup SET "; $sql = "UPDATE ".MAIN_DB_PREFIX."usergroup SET ";
$sql .= " nom = '".addslashes($this->nom)."',"; $sql .= " nom = '".addslashes($this->nom)."',";