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 2011-10-20 14:23:39 +02:00
parent 336c825309
commit ce3435b490
1 changed files with 40 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
htdocs/compta/deplacement/class/deplacement.class.php
View File

@ -51,22 +51,23 @@ class Deplacement extends CommonObject
var $fk_project; var $fk_project;
/** /**
* \brief Constructeur de la classe * Constructor
* \param DB handler acces base de donnees *
* @param DoliDB $db Database handler
*/ */
function Deplacement($DB) function Deplacement($db)
{ {
$this->db = $DB; $this->db = $db;
return 1; return 1;
} }
/** /**
* Create object in database * Create object in database
*
* @param $user User that creates
* @return int <0 if KO, >0 if OK
* TODO Add ref number * TODO Add ref number
*
* @param User $user User that creates
* @return int <0 if KO, >0 if OK
*/ */
function create($user) function create($user)
{ {
@ -138,7 +139,10 @@ class Deplacement extends CommonObject
} }
/** /**
* Update record
* *
* @param User $user User making update
* @return int <0 if KO, >0 if OK
*/ */
function update($user) function update($user)
{ {
@ -195,7 +199,10 @@ class Deplacement extends CommonObject
} }
/** /**
* Load an object from database * Load an object from database
*
* @param int $id Id of record to load
* @return int <0 if KO, >0 if OK
*/ */
function fetch($id) function fetch($id)
{ {
@ -231,7 +238,10 @@ class Deplacement extends CommonObject
} }
/** /**
* Delete record
* *
* @param int $id Id of record to delete
* @return int <0 if KO, >0 if OK
*/ */
function delete($id) function delete($id)
{ {
@ -252,9 +262,10 @@ class Deplacement extends CommonObject
/** /**
* \brief Retourne le libelle du statut * Retourne le libelle du statut
* \param mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto *
* \return string Libelle * @param int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto
* @return string Libelle
*/ */
function getLibStatut($mode=0) function getLibStatut($mode=0)
{ {
@ -262,10 +273,11 @@ class Deplacement extends CommonObject
} }
/** /**
* \brief Renvoi le libelle d'un statut donne * Renvoi le libelle d'un statut donne
* \param statut id statut *
* \param mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto * @param int $statut Id status
* \return string Libelle * @param int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto
* @return string Libelle
*/ */
function LibStatut($statut,$mode=0) function LibStatut($statut,$mode=0)
{ {
@ -302,9 +314,10 @@ class Deplacement extends CommonObject
} }
/** /**
* \brief Return clicable name (with picto eventually) * Return clicable name (with picto eventually)
* \param withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul *
* \return string Chaine avec URL * @param int $withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul
* @return string Chaine avec URL
*/ */
function getNomUrl($withpicto=0) function getNomUrl($withpicto=0)
{ {
@ -328,6 +341,9 @@ class Deplacement extends CommonObject
/** /**
* List of types * List of types
*
* @param int $active Active or not
* @return void
*/ */
function listOfTypes($active=1) function listOfTypes($active=1)
{ {
@ -357,9 +373,11 @@ class Deplacement extends CommonObject
return $ret; return $ret;
} }
/* /**
* \brief Information sur l'objet * Information on record
* \param id id du deplacement dont il faut afficher les infos *
* @param int $id Id of record
* @return void
*/ */
function info($id) function info($id)
{ {