Rev 467 | 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"><meta name="robots" content="noindex"><title>File Application.php | TBFramework - v0.2</title><script type="text/javascript" src="resources/combined.js?4205936287"></script><script type="text/javascript" src="elementlist.js?1835392179"></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-PHP.html">PHP</a></li></ul></div><hr><div id="elements"><h3>Classes</h3><ul><li class="active"><a href="class-Application.html">Application</a></li><li><a href="class-Chronometre.html">Chronometre</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-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-Modele.html">Modele</a></li><li><a href="class-Registre.html">Registre</a></li><li><a href="class-SquelettePhp.html">SquelettePhp</a></li><li><a href="class-Url.html">Url</a></li></ul><h3>Functions</h3><ul><li><a href="function-autoloadAppliDefaut.html">autoloadAppliDefaut</a></li><li><a href="function-autoloadFw.html">autoloadFw</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><a href="class-Application.html" title="Summary of Application"><span>Class</span></a></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><pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span></span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-comment">// declare(encoding='UTF-8');</span></span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-comment">/**</span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment"> * Classe fournissant des informations au Framework sur l'application.</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> *</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * @category PHP 5.2</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * @package Framework</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * @author Jean-Pascal MILCENT <jpm@tela-botanica.org></span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * @copyright Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * @license GNU-GPL-v3 <http://www.gnu.org/licenses/gpl.html></span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * @license CECILL-v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt></span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> */</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-keyword1">class</span> <a id="Application" href="#Application">Application</a> {</span><span id="14" class="l"><a class="l" href="#14">14: </a></span><span id="15" class="l"><a class="l" href="#15">15: </a> <span class="php-comment">/**</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> * Tableau d'informations sur l'application</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> */</span></span><span id="18" class="l"><a class="l" href="#18">18: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">static</span> <span class="php-var"><a id="$info" href="#$info">$info</a></span> = <span class="php-keyword1">null</span>;</span><span id="19" class="l"><a class="l" href="#19">19: </a> <span class="php-comment">/**</span></span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment"> * Chemin de base de l'application</span></span><span id="21" class="l"><a class="l" href="#21">21: </a><span class="php-comment"> */</span></span><span id="22" class="l"><a class="l" href="#22">22: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">static</span> <span class="php-var"><a id="$chemin" href="#$chemin">$chemin</a></span> = <span class="php-keyword1">null</span>;</span><span id="23" class="l"><a class="l" href="#23">23: </a></span><span id="24" class="l"><a class="l" href="#24">24: </a> <span class="php-comment">/**</span></span><span id="25" class="l"><a class="l" href="#25">25: </a><span class="php-comment"> * Initialise différentes classes du Framework nécessaires pour le fonctionnement de l'application.</span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment"> * Ces classes sont ensuites controlées via les fichiers de config.ini.</span></span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-comment"> * Elle est appelée automatiquement suite à la définition du chemin de l'application via Application::setChemin().</span></span><span id="28" class="l"><a class="l" href="#28">28: </a><span class="php-comment"> */</span></span><span id="29" class="l"><a class="l" href="#29">29: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_initialiser" href="#_initialiser">initialiser</a>() {</span><span id="30" class="l"><a class="l" href="#30">30: </a> <span class="php-comment">// Configuration du gestionnaire d'exception</span></span><span id="31" class="l"><a class="l" href="#31">31: </a> GestionnaireException::configurer();</span><span id="32" class="l"><a class="l" href="#32">32: </a> <span class="php-comment">// Configuration du gestionnaire de logs</span></span><span id="33" class="l"><a class="l" href="#33">33: </a> <span class="php-comment">//Log::configurer();</span></span><span id="34" class="l"><a class="l" href="#34">34: </a> }</span><span id="35" class="l"><a class="l" href="#35">35: </a></span><span id="36" class="l"><a class="l" href="#36">36: </a> <span class="php-comment">/**</span></span><span id="37" class="l"><a class="l" href="#37">37: </a><span class="php-comment"> * Permet d'indiquer le chemin de base de l'Application.</span></span><span id="38" class="l"><a class="l" href="#38">38: </a><span class="php-comment"> * Cette méthode doit obligatoirement être utilisée par l'application pour que le Framework fonctionne correctement.</span></span><span id="39" class="l"><a class="l" href="#39">39: </a><span class="php-comment"> * @param string $chemin_fichier_principal chemin de base</span></span><span id="40" class="l"><a class="l" href="#40">40: </a><span class="php-comment"> */</span></span><span id="41" class="l"><a class="l" href="#41">41: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_setChemin" href="#_setChemin">setChemin</a>(<span class="php-var">$chemin_fichier_principal</span>) {</span><span id="42" class="l"><a class="l" href="#42">42: </a> <span class="php-keyword1">if</span> (self::<span class="php-var">$chemin</span> === <span class="php-keyword1">null</span>) {</span><span id="43" class="l"><a class="l" href="#43">43: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">file_exists</span>(<span class="php-var">$chemin_fichier_principal</span>)) {</span><span id="44" class="l"><a class="l" href="#44">44: </a> <span class="php-keyword2">trigger_error</span>(<span class="php-quote">"Le fichier indiqué n'existe pas. Utilisez __FILE__ dans la méthode set()."</span>, E_USER_ERROR);</span><span id="45" class="l"><a class="l" href="#45">45: </a> } <span class="php-keyword1">else</span> {</span><span id="46" class="l"><a class="l" href="#46">46: </a> self::<span class="php-var">$chemin</span> = <span class="php-keyword2">dirname</span>(<span class="php-var">$chemin_fichier_principal</span>).DS;</span><span id="47" class="l"><a class="l" href="#47">47: </a> self::initialiser();</span><span id="48" class="l"><a class="l" href="#48">48: </a> }</span><span id="49" class="l"><a class="l" href="#49">49: </a> } <span class="php-keyword1">else</span> {</span><span id="50" class="l"><a class="l" href="#50">50: </a> <span class="php-keyword2">trigger_error</span>(<span class="php-quote">"Le chemin de l'application a déjà été enregistré auprès du Framework"</span>, E_USER_WARNING);</span><span id="51" class="l"><a class="l" href="#51">51: </a> }</span><span id="52" class="l"><a class="l" href="#52">52: </a> }</span><span id="53" class="l"><a class="l" href="#53">53: </a></span><span id="54" class="l"><a class="l" href="#54">54: </a> <span class="php-comment">/**</span></span><span id="55" class="l"><a class="l" href="#55">55: </a><span class="php-comment"> * accesseur pour le chemin</span></span><span id="56" class="l"><a class="l" href="#56">56: </a><span class="php-comment"> * @return string le chemin</span></span><span id="57" class="l"><a class="l" href="#57">57: </a><span class="php-comment"> */</span></span><span id="58" class="l"><a class="l" href="#58">58: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_getChemin" href="#_getChemin">getChemin</a>() {</span><span id="59" class="l"><a class="l" href="#59">59: </a> <span class="php-keyword1">return</span> self::<span class="php-var">$chemin</span>;</span><span id="60" class="l"><a class="l" href="#60">60: </a> }</span><span id="61" class="l"><a class="l" href="#61">61: </a></span><span id="62" class="l"><a class="l" href="#62">62: </a> <span class="php-comment">/** Le tableau des informations sur l'application possède les clés suivantes :</span></span><span id="63" class="l"><a class="l" href="#63">63: </a><span class="php-comment"> * - nom : nom de l'application</span></span><span id="64" class="l"><a class="l" href="#64">64: </a><span class="php-comment"> * - abr : abréviation de l'application</span></span><span id="65" class="l"><a class="l" href="#65">65: </a><span class="php-comment"> * - encodage : encodage de l'application (ISO-8859-15, UTF-8...)</span></span><span id="66" class="l"><a class="l" href="#66">66: </a><span class="php-comment"> *</span></span><span id="67" class="l"><a class="l" href="#67">67: </a><span class="php-comment"> * @param array $info tableau fournissant des informations sur l'application</span></span><span id="68" class="l"><a class="l" href="#68">68: </a><span class="php-comment"> * @return void</span></span><span id="69" class="l"><a class="l" href="#69">69: </a><span class="php-comment"> */</span></span><span id="70" class="l"><a class="l" href="#70">70: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_setInfo" href="#_setInfo">setInfo</a>(<span class="php-var">$info</span>) {</span><span id="71" class="l"><a class="l" href="#71">71: </a> <span class="php-keyword1">if</span> (self::<span class="php-var">$info</span> === <span class="php-keyword1">null</span>) {</span><span id="72" class="l"><a class="l" href="#72">72: </a> self::<span class="php-var">$info</span> = <span class="php-var">$info</span>;</span><span id="73" class="l"><a class="l" href="#73">73: </a> } <span class="php-keyword1">else</span> {</span><span id="74" class="l"><a class="l" href="#74">74: </a> <span class="php-keyword2">trigger_error</span>(<span class="php-quote">"Le informations de l'application ont déjà été enregistrées auprès du Framework"</span>, E_USER_WARNING);</span><span id="75" class="l"><a class="l" href="#75">75: </a> }</span><span id="76" class="l"><a class="l" href="#76">76: </a> }</span><span id="77" class="l"><a class="l" href="#77">77: </a></span><span id="78" class="l"><a class="l" href="#78">78: </a> <span class="php-comment">/**</span></span><span id="79" class="l"><a class="l" href="#79">79: </a><span class="php-comment"> * accesseur pour le tableau d'infos</span></span><span id="80" class="l"><a class="l" href="#80">80: </a><span class="php-comment"> * @param string $cle la clé à laquelle on veut accéder</span></span><span id="81" class="l"><a class="l" href="#81">81: </a><span class="php-comment"> */</span></span><span id="82" class="l"><a class="l" href="#82">82: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_getInfo" href="#_getInfo">getInfo</a>(<span class="php-var">$cle</span> = <span class="php-keyword1">null</span>) {</span><span id="83" class="l"><a class="l" href="#83">83: </a> <span class="php-keyword1">if</span> (<span class="php-var">$cle</span> !== <span class="php-keyword1">null</span>) {</span><span id="84" class="l"><a class="l" href="#84">84: </a> <span class="php-keyword1">if</span> (<span class="php-keyword1">isset</span>(self::<span class="php-var">$info</span>[<span class="php-var">$cle</span>])) {</span><span id="85" class="l"><a class="l" href="#85">85: </a> <span class="php-keyword1">return</span> self::<span class="php-var">$info</span>[<span class="php-var">$cle</span>];</span><span id="86" class="l"><a class="l" href="#86">86: </a> }</span><span id="87" class="l"><a class="l" href="#87">87: </a> } <span class="php-keyword1">else</span> {</span><span id="88" class="l"><a class="l" href="#88">88: </a> <span class="php-keyword1">return</span> self::<span class="php-var">$info</span>;</span><span id="89" class="l"><a class="l" href="#89">89: </a> }</span><span id="90" class="l"><a class="l" href="#90">90: </a> }</span><span id="91" class="l"><a class="l" href="#91">91: </a></span>}</code></pre><div id="footer">TBFramework - v0.2 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a></div></div></div></body></html>