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

Doc: Ajout commentaires pour doc doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2004-08-15 18:09:30 +00:00
parent 19ed309301
commit 67c6d9052a
1 changed files with 41 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
htdocs/translate.class.php
View File

@ -18,7 +18,18 @@
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* ************************************************************************* */ * ************************************************************************* */
Class Translate { /*! \file htdocs/translate.class.php
\brief Fichier de la classe de traduction
\author Laurent Destailleur
\version $Revision$
*/
/*! \class Translate
\brief Classe permettant de gérer les traductions
*/
class Translate {
var $tab_loaded=array(); var $tab_loaded=array();
var $tab_translate=array(); var $tab_translate=array();
@ -27,6 +38,11 @@ Class Translate {
var $dir; var $dir;
var $debug; var $debug;
/**
* \brief Constructeur de la classe
* \param dir repertoire racine des fichiers de traduction
* \param defaultlang langue par defaut à utiliser
*/
function Translate($dir = "", $defaultlang = "") { function Translate($dir = "", $defaultlang = "") {
$this->dir=$dir; $this->dir=$dir;
$this->defaultlang=$defaultlang; $this->defaultlang=$defaultlang;
@ -34,7 +50,11 @@ Class Translate {
$this->tab_translate = array(); $this->tab_translate = array();
} }
/*!
\brief Charge en mémoire le tableau de traduction pour un domaine particulier
Si le domaine est deja chargé, la fonction ne fait rien
\param domain Nom du domain (fichier lang) à charger
*/
function Load($domain = "main") { function Load($domain = "main") {
if ($this->tab_loaded[$domain]) { return; } # Ce fichier est deja chargé if ($this->tab_loaded[$domain]) { return; } # Ce fichier est deja chargé
@ -67,21 +87,25 @@ Class Translate {
} }
/*!
\brief Retourne la liste des domaines chargées en memoire
\return array Tableau des domaines chargées
*/
function list_domainloaded() { function list_domainloaded() {
return join(",",array_keys($this->tab_loaded)); return join(",",array_keys($this->tab_loaded));
} }
/* /*
* Return translated version of parameter string * \brief Retourne la version traduite du texte passé en paramètre
* [fr] Retourne la version traduite du texte passé en paramètre * Si il n'y a pas de correspondance pour ce texte, il est retourné
* Si il n'y a pas de correspondance pour ce texte, il est retourn * "tel quel" précédé d'un "<b>[vo]</b> <i>" et terminé par un </i>
* "tel quel" précédé d'un "<b>[vo]</b> <i>" et terminé par un </i> * [en] Return translated version of parameter string
* * \param str original string to translate
* @access public * \param param1 chaine de param1
* @return string translated version of parameter string, or original version of this string with "<b>[vo]</b> <i>" before and "</i>" after * \param param2 chaine de param1
* @param string $str original string to translate * \param param3 chaine de param1
* @param int $mark bolean, 1 or nothing: add [vo] if this translation does not exists, 0 don't add [vo] tags * \return string translated version of parameter string, or original version of this string with "<b>[vo]</b> <i>" before and "</i>" after
*/ */
function trans($str, $param1='', $param2='', $param3='') { function trans($str, $param1='', $param2='', $param3='') {
if ($this->tab_translate[$str]) { if ($this->tab_translate[$str]) {
@ -92,10 +116,8 @@ Class Translate {
} }
/** /**
* Return the list of available languages * \brief Retourne la liste des langues disponibles
* * \return array list of languages
* @access public
* @return array: list of languages
*/ */
function get_available_languages() function get_available_languages()
{ {
@ -111,11 +133,10 @@ Class Translate {
} }
/** /**
* Send header and return a string of html start page * \brief Expédie le header correct et retourne le début de la page html
* [fr] Expédie le header correct et retourne le début de la page html * [en] Send header and return a string of html start page
* * \access public
* @access public * \return string html header avec charset
* @return string
*/ */
function lang_header() function lang_header()
{ {
@ -128,7 +149,6 @@ Class Translate {
return $texte; return $texte;
} }
} }
?> ?>