Subversion Repositories Applications.framework

Rev

Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed

<!DOCTYPE html>
<html>
<head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
        <meta name="generator" content="ApiGen 2.8.0">

        <title>Class I18n | TBFramework - v0.4</title>

        <script type="text/javascript" src="resources/combined.js?4205936287"></script>
        <script type="text/javascript" src="elementlist.js?1964084359"></script>
        <link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360">

</head>

<body>
<div id="left">
        <div id="menu">
                <a href="index.html" title="Overview"><span>Overview</span></a>


                <div id="groups">
                        <h3>Packages</h3>
                        <ul>
                                <li class="active"><a href="package-Framework.html">Framework</a>
                                                </li>
                                <li><a href="package-None.html">None</a>
                                                </li>
                                <li><a href="package-PHP.html">PHP</a>
                                                </li>
                                <li><a href="package-Utilitaire.html">Utilitaire</a>
                                                </li>
                        </ul>
                </div>

                <hr>


                <div id="elements">
                        <h3>Classes</h3>
                        <ul>
                                <li><a href="class-Bdd.html">Bdd</a></li>
                                <li><a href="class-Cache.html">Cache</a></li>
                                <li><a href="class-CacheSimple.html">CacheSimple</a></li>
                                <li><a href="class-Chronometre.html">Chronometre</a></li>
                                <li><a href="class-Cli.html">Cli</a></li>
                                <li><a href="class-Config.html">Config</a></li>
                                <li><a href="class-Controleur.html">Controleur</a></li>
                                <li><a href="class-Debug.html">Debug</a></li>
                                <li><a href="class-Framework.html">Framework</a></li>
                                <li><a href="class-GestionnaireException.html">GestionnaireException</a></li>
                                <li class="active"><a href="class-I18n.html">I18n</a></li>
                                <li><a href="class-Log.html">Log</a></li>
                                <li><a href="class-MonService.html">MonService</a></li>
                                <li><a href="class-Registre.html">Registre</a></li>
                                <li><a href="class-RestClient.html">RestClient</a></li>
                                <li><a href="class-RestServeur.html">RestServeur</a></li>
                                <li><a href="class-RestService.html">RestService</a></li>
                                <li><a href="class-Script.html">Script</a></li>
                                <li><a href="class-ServiceCacheFichier.html">ServiceCacheFichier</a></li>
                                <li><a href="class-ServiceCacheSimple.html">ServiceCacheSimple</a></li>
                                <li><a href="class-ServiceCacheSqlite.html">ServiceCacheSqlite</a></li>
                                <li><a href="class-SquelettePhp.html">SquelettePhp</a></li>
                                <li><a href="class-Url.html">Url</a></li>
                        </ul>





                </div>
        </div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
        <form id="search">
                <input type="hidden" name="cx" value="">
                <input type="hidden" name="ie" value="UTF-8">
                <input type="text" name="q" class="text">
                <input type="submit" value="Search">
        </form>

        <div id="navigation">
                <ul>
                        <li>
                                <a href="index.html" title="Overview"><span>Overview</span></a>
                        </li>
                        <li>
                                <a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a>
                        </li>
                        <li class="active">
<span>Class</span>                      </li>
                </ul>
                <ul>
                        <li>
                                <a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
                        </li>
                        <li>
                                <a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
                        </li>
                        <li>
                                <a href="todo.html" title="Todo list"><span>Todo</span></a>
                        </li>
                </ul>
                <ul>
                </ul>
        </div>

<div id="content" class="class">
        <h1>Class I18n</h1>


        <div class="description">
        
<p>I18n permet de traduire une application à partir de données stockées dans
des fichiers ini. Si vous souhaitez utiliser le fonctionnement par défaut vous
devrez :</p>

<ul>
        <li>déposer les fichiers ini dans le dossier définit par la variable de config
        "chemin_i18n".</li>

        <li>nommer les fichiers selon la forme "locale.ini" (Ex.: fr.ini ou fr_CH.ini
        ).</li>
</ul>

<p>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>

        </div>









        <div class="info">
                
                
                
                <b>Package:</b> <a href="package-Framework.html">Framework</a><br>

                                <b>Category:</b>
                                PHP 5.2<br>
                                <b>Copyright:</b>
                                Copyright (c) 2010, Tela Botanica (<a
href="mailto:accueil&#64;tela-botanica.org">accueil&#64;<!-- -->tela-botanica.org</a>)<br>
                                <b>License:</b>
                                <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a><br>
                                <b>License:</b>
                                <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a><br>
                                <b>Author:</b>
                                Jean-Pascal MILCENT &lt;<a
href="mailto:jpm&#64;tela-botanica.org">jpm&#64;<!-- -->tela-botanica.org</a>&gt;<br>
                                <b>Version:</b>
                                $Id: I18n.php 331 2011-02-24 18:03:35Z jpm $<br>
                                <b>Since:</b>
                                0.3<br>
                                <b>Link:</b>
                                /doc/framework/<br>
                <b>Located at</b> <a href="source-class-I18n.html#3-234" title="Go to source code">framework/I18n.php</a><br>
        </div>



        <table class="summary" id="methods">
        <caption>Methods summary</caption>
        <tr data-order="get" id="_get">

                <td class="attributes"><code>
                         public static
                        string
                        
                        </code>
                </td>

                <td class="name"><div>
                <a class="anchor" href="#_get">#</a>
                <code><a href="source-class-I18n.html#43-80" title="Go to source code">get</a>( <span>string <var>$identifiant</var></span>, <span>mixed <var>$langue</var> = <span class="php-keyword1">null</span></span> )</code>

                <div class="description short">
                        
<p>Accesseur pour la valeur d'une traduction</p>

                </div>

                <div class="description detailed hidden">
                        
<p>Accesseur pour la valeur d'une traduction</p>



                                <h4>Parameters</h4>
                                <div class="list"><dl>
                                        <dt><var>$identifiant</var></dt>
                                        <dd><code>string</code><br>$param le nom du paramètre</dd>
                                        <dt><var>$langue</var></dt>
                                        <dd></dd>
                                </dl></div>

                                <h4>Returns</h4>
                                <div class="list">
                                        <code>string</code><br>la valeur du paramètre<br>
                                </div>




                </div>
                </div></td>
        </tr>
        <tr data-order="charger" id="_charger">

                <td class="attributes"><code>
                         public static
                        boolean
                        
                        </code>
                </td>

                <td class="name"><div>
                <a class="anchor" href="#_charger">#</a>
                <code><a href="source-class-I18n.html#82-105" title="Go to source code">charger</a>( <span>string <var>$langue</var></span>, <span>mixed <var>$fichier</var> = <span class="php-keyword1">null</span></span>, <span>mixed <var>$format</var> = <code><a href="class-I18n.html#FORMAT_INI">I18n::<b>FORMAT_INI</b></a></code></span> )</code>

                <div class="description short">
                        
<p>Charge un fichier ini dans le tableau des paramètres de l'appli</p>

                </div>

                <div class="description detailed hidden">
                        
<p>Charge un fichier ini dans le tableau des paramètres de l'appli</p>



                                <h4>Parameters</h4>
                                <div class="list"><dl>
                                        <dt><var>$langue</var></dt>
                                        <dd><code>string</code><br>$fichier_ini le nom du fichier à charger</dd>
                                        <dt><var>$fichier</var></dt>
                                        <dd></dd>
                                        <dt><var>$format</var></dt>
                                        <dd></dd>
                                </dl></div>

                                <h4>Returns</h4>
                                <div class="list">
                                        <code>boolean</code><br>true, si le fichier a été trouvé et correctement chargé, sinon false.<br>
                                </div>




                </div>
                </div></td>
        </tr>
        <tr data-order="setLangue" id="_setLangue">

                <td class="attributes"><code>
                         public static
                        array
                        
                        </code>
                </td>

                <td class="name"><div>
                <a class="anchor" href="#_setLangue">#</a>
                <code><a href="source-class-I18n.html#107-115" title="Go to source code">setLangue</a>( <span>string <var>$langue</var></span> )</code>

                <div class="description short">
                        
<p>Définit la langue utiliser pour rechercher une traduction.</p>

                </div>

                <div class="description detailed hidden">
                        
<p>Définit la langue utiliser pour rechercher une traduction.</p>



                                <h4>Parameters</h4>
                                <div class="list"><dl>
                                        <dt><var>$langue</var></dt>
                                        <dd><code>string</code><br>$fichier_ini le nom du fichier à charger</dd>
                                </dl></div>

                                <h4>Returns</h4>
                                <div class="list">
                                        <code>array</code><br>le fichier ini parsé<br>
                                </div>




                </div>
                </div></td>
        </tr>
        </table>








        <table class="summary" id="constants">
        <caption>Constants summary</caption>
        <tr data-order="FORMAT_INI" id="FORMAT_INI">

                <td class="attributes"><code>string</code></td>
                <td class="name"><code>
                                <a href="source-class-I18n.html#23-24" title="Go to source code"><b>FORMAT_INI</b></a>
                </code></td>
                <td class="value"><code><span class="php-quote">'.ini'</span></code></td>
                <td class="description"><div>
                        <a href="#FORMAT_INI" class="anchor">#</a>

                        <div class="description short">
                                
<p>Format de traduction utilisant les fichier .ini</p>

                        </div>

                        <div class="description detailed hidden">
                                
<p>Format de traduction utilisant les fichier .ini</p>


                        </div>
                </div></td>
        </tr>
        </table>










</div>

        <div id="footer">
                TBFramework - v0.4 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
        </div>
</div>
</div>
</body>
</html>