Subversion Repositories Applications.framework

Rev

Rev 300 | Blame | Last modification | View Log | RSS feed

<!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 Config</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 Config</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>)
                                                
                                        </div>
        <div class="info-box-body">
                        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Config permet de charger automatiquement les fichiers ini du Framework et de l'application.</p>
<p class="description"><p>Elle offre l'accès en lecture seule aux paramètres de config.  C'est une Singleton.  Si vous avez besoin de modifier dynamiquement des paramètres de configuration, utiliser le @see Registe, il est fait pour ça.</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: Config.php 274 2010-12-28 15:37:22Z jpm $</li>
                                <li><span class="field">copyright:</span> Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</li>
                                <li><span class="field">link:</span> /doc/framework/</li>
                                <li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a></li>
                                <li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a></li>
                        </ul>
                <p class="notes">
                        Located in <a class="field" href="_Config.php.html">/Config.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__Config.php.html#a19">19</a></span>)
                </p>
                
                                
                <pre></pre>
        
                        </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> |
                                                                                                <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">array</span>
                                                                                <a href="#charger" title="details" class="method-name">charger</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$fichier_ini</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                        static                                          <span class="method-result">boolean</span>
                                                                                <a href="#existe" title="details" class="method-name">existe</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$param</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">string</span>&nbsp;<span class="var-name">$param</span> = <span class="var-default">null</span>])
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                        static                                          <span class="method-result">boolean</span>
                                                                                <a href="#verifierPresenceParametres" title="details" class="method-name">verifierPresenceParametres</a>
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$parametres</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-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__Config.php.html#a235">235</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> 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">
                        charger
                </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>
                                </ul>
                
                        
        </div>
<a name="methodexiste" id="existe"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">static existe</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Config.php.html#a255">255</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Vérifie si la valeur d'un paramètre existe.</p>
        <ul class="tags">
                                <li><span class="field">return:</span> vrai si le paramètre existe, false sinon</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">
                        existe
                </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>
                                </ul>
                
                        
        </div>
<a name="methodget" id="get"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">static get</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Config.php.html#a245">245</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Accesseur pour la valeur d'un paramètre.</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">string</span>&nbsp;<span class="var-name">$param</span> = <span class="var-default">null</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>
                                </ul>
                
                        
        </div>
<a name="methodverifierPresenceParametres" id="verifierPresenceParametres"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">static verifierPresenceParametres</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Config.php.html#a268">268</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Vérifie que tous les paramêtres de config nécessaires au fonctionnement d'une classe existe dans les fichiers  de configurations.</p>
<p class="description"><p>L'utilisation de cette méthode depuis la classe Config évite de faire appel à une classe supplémentaire.</p></p>
        <ul class="tags">
                                <li><span class="field">return:</span> true si tous les paramétres sont présents 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">
                        verifierPresenceParametres
                </span>
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$parametres</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">array</span>
                                <span class="var-name">$parametres</span><span class="var-description">: tableau des noms des paramètres de la config à verifier.</span>                      </li>
                                </ul>
                
                        
        </div>
                                                
                </div>
        </div>


        <p class="notes" id="credit">
                Documentation generated on Tue, 18 Jan 2011 15:30:46 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
        </p>
        </div></body>
</html>