New file |
0,0 → 1,363 |
<!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 Config | 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 class="active"><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><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 Config</h1> |
|
|
<div class="description"> |
|
<p>Config permet de charger automatiquement les fichiers ini du Framework et de |
l'application. 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> |
|
</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) 2009, Tela Botanica (<a |
href="mailto:accueil@tela-botanica.org">accueil@<!-- -->tela-botanica.org</a>)<br> |
<b>License:</b> |
<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a><br> |
<b>License:</b> |
<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a><br> |
<b>Author:</b> |
Jean-Pascal MILCENT <<a |
href="mailto:jpm@tela-botanica.org">jpm@<!-- -->tela-botanica.org</a>><br> |
<b>Version:</b> |
$Id: Config.php 447 2013-12-19 10:52:37Z jpm $<br> |
<b>Link:</b> |
/doc/framework/<br> |
<b>Located at</b> <a href="source-class-Config.html#4-282" title="Go to source code">framework/Config.php</a><br> |
</div> |
|
|
|
<table class="summary" id="methods"> |
<caption>Methods summary</caption> |
<tr data-order="charger" id="_charger"> |
|
<td class="attributes"><code> |
public static |
array |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_charger">#</a> |
<code><a href="source-class-Config.html#232-240" title="Go to source code">charger</a>( <span>string <var>$fichier_ini</var></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>$fichier_ini</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> |
<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-Config.html#242-250" title="Go to source code">get</a>( <span>string <var>$param</var> = <span class="php-keyword1">null</span></span> )</code> |
|
<div class="description short"> |
|
<p>Accesseur pour la valeur d'un paramètre.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Accesseur pour la valeur d'un paramètre.</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$param</var></dt> |
<dd><code>string</code><br>$param le nom du paramètre</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="existe" id="_existe"> |
|
<td class="attributes"><code> |
public static |
boolean |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_existe">#</a> |
<code><a href="source-class-Config.html#252-260" title="Go to source code">existe</a>( <span>string <var>$param</var></span> )</code> |
|
<div class="description short"> |
|
<p>Vérifie si la valeur d'un paramètre existe.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Vérifie si la valeur d'un paramètre existe.</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$param</var></dt> |
<dd><code>string</code><br>$param le nom du paramètre</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>boolean</code><br>vrai si le paramètre existe, false sinon<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="verifierPresenceParametres" id="_verifierPresenceParametres"> |
|
<td class="attributes"><code> |
public static |
boolean |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_verifierPresenceParametres">#</a> |
<code><a href="source-class-Config.html#262-281" title="Go to source code">verifierPresenceParametres</a>( <span>array <var>$parametres</var></span> )</code> |
|
<div class="description short"> |
|
<p>Vérifie que tous les paramêtres de config nécessaires au fonctionnement |
d'une classe existe dans les fichiers de configurations. L'utilisation de cette |
méthode depuis la classe Config évite de faire appel à une classe |
supplémentaire.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Vérifie que tous les paramêtres de config nécessaires au fonctionnement |
d'une classe existe dans les fichiers de configurations. L'utilisation de cette |
méthode depuis la classe Config évite de faire appel à une classe |
supplémentaire.</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$parametres</var></dt> |
<dd><code>array</code><br>$parametres tableau des noms des paramètres de la config à verifier.</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>boolean</code><br>true si tous les paramétres sont présents sinon false.<br> |
</div> |
|
|
|
|
</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> |