Subversion Repositories Applications.framework

Compare Revisions

Ignore whitespace Rev 296 → Rev 297

/trunk/doc/HTMLframesConverter/Framework/I18n.html
New file
0,0 → 1,343
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class I18n</title>
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
<link rel="stylesheet" href="../media/stylesheet.css" />
<script src="../media/lib/classTree.js"></script>
<script language="javascript" type="text/javascript">
var imgPlus = new Image();
var imgMinus = new Image();
imgPlus.src = "../media/images/plus.png";
imgMinus.src = "../media/images/minus.png";
function showNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgMinus.src;
oTable.style.display = "block";
}
function hideNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgPlus.src;
oTable.style.display = "none";
}
function nodeIsVisible(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
break;
}
return (oTable && oTable.style.display == "block");
}
function toggleNodeVisibility(Node){
if (nodeIsVisible(Node)){
hideNode(Node);
}else{
showNode(Node);
}
}
</script>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class I18n</h2>
 
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">I18n permet de traduire une application à partir de données stockées dans des fichiers ini.</p>
<p class="description"><p>Si vous souhaitez utiliser le fonctionnement par défaut vous devrez : <ul><li>déposer les fichiers ini dans le dossier définit par la variable de config &quot;chemin_i18n&quot;.</li><li>nommer les fichiers selon la forme &quot;locale.ini&quot; (Ex.: fr.ini ou fr_CH.ini ).</li></ul> Elle offre l'accès en lecture seule aux paramètres des fichiers ini. C'est une Singleton. Une seule classe de traduction peut être instanciée par Application.</p></p>
<ul class="tags">
<li><span class="field">author:</span> Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</li>
<li><span class="field">version:</span> $Id$</li>
<li><span class="field">copyright:</span> Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</li>
<li><span class="field">link:</span> /doc/framework/</li>
<li><span class="field">since:</span> 0.3</li>
<li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a></li>
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_I18n.php.html">/I18n.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__I18n.php.html#a22">22</a></span>)
</p>
<pre></pre>
</div>
</div>
 
 
<a name="sec-const-summary"></a>
<div class="info-box">
<div class="info-box-title">Class Constant Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="const-summary">
<div class="const-title">
<img src="../media/images/Constant.png" alt=" " />
<a href="#FORMAT_INI" title="details" class="const-name">FORMAT_INI</a> = <span class="var-type"> '.ini'</span>
 
</div>
</div>
</div>
</div>
 
 
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#charger" title="details" class="method-name">charger</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$langue</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$fichier</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">self::FORMAT_INI</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$fichier_ini</span>)
</div>
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#get" title="details" class="method-name">get</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$identifiant</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$langue</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$param</span>)
</div>
<div class="method-definition">
static <span class="method-result">array</span>
<a href="#setLangue" title="details" class="method-name">setLangue</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$langue</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$fichier_ini</span>)
</div>
</div>
</div>
</div>
 
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodcharger" id="charger"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static charger</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__I18n.php.html#a87">87</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Charge un fichier ini dans le tableau des paramètres de l'appli</p>
<ul class="tags">
<li><span class="field">return:</span> true, si le fichier a été trouvé et correctement chargé, sinon false.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">boolean</span>
<span class="method-name">
charger
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$langue</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$fichier</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">self::FORMAT_INI</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$fichier_ini</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$fichier_ini</span><span class="var-description">: le nom du fichier à charger</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$langue</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$fichier</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$format</span> </li>
</ul>
</div>
<a name="methodget" id="get"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static get</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__I18n.php.html#a48">48</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Accesseur pour la valeur d'une traduction</p>
<ul class="tags">
<li><span class="field">return:</span> la valeur du paramètre</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">string</span>
<span class="method-name">
get
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$identifiant</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$langue</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$param</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$param</span><span class="var-description">: le nom du paramètre</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$identifiant</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$langue</span> </li>
</ul>
</div>
<a name="methodsetLangue" id="setLangue"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static setLangue</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__I18n.php.html#a112">112</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Définit la langue utiliser pour rechercher une traduction.</p>
<ul class="tags">
<li><span class="field">return:</span> le fichier ini parsé</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">array</span>
<span class="method-name">
setLangue
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$langue</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$fichier_ini</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$fichier_ini</span><span class="var-description">: le nom du fichier à charger</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$langue</span> </li>
</ul>
</div>
</div>
</div>
 
<a name="sec-consts"></a>
<div class="info-box">
<div class="info-box-title">Class Constants</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="constFORMAT_INI" id="FORMAT_INI"><!-- --></A>
<div class="evenrow">
 
<div class="const-header">
<img src="../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">FORMAT_INI</span>
= <span class="const-default"> '.ini'</span>
(line <span class="line-number"><a href="../__filesource/fsource_Framework__I18n.php.html#a24">24</a></span>)
</span>
</div>
 
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Format de traduction utilisant les fichier .ini</p>
</div>
</div>
</div>
 
<p class="notes" id="credit">
Documentation generated on Tue, 18 Jan 2011 15:01:35 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>