Subversion Repositories Applications.framework

Rev

Rev 467 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
467 jpm 1
<!DOCTYPE html>
2
<html>
3
<head>
4
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5
	<meta name="generator" content="ApiGen 2.8.0">
6
	<meta name="robots" content="noindex">
7
 
8
	<title>File Application.php | TBFramework - v0.2</title>
9
 
10
	<script type="text/javascript" src="resources/combined.js?4205936287"></script>
476 jpm 11
	<script type="text/javascript" src="elementlist.js?1835392179"></script>
467 jpm 12
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360">
13
 
14
</head>
15
 
16
<body>
17
<div id="left">
18
	<div id="menu">
19
		<a href="index.html" title="Overview"><span>Overview</span></a>
20
 
21
 
22
		<div id="groups">
23
			<h3>Packages</h3>
24
			<ul>
25
				<li class="active"><a href="package-Framework.html">Framework</a>
26
						</li>
27
				<li><a href="package-PHP.html">PHP</a>
28
						</li>
29
			</ul>
30
		</div>
31
 
32
		<hr>
33
 
34
 
35
		<div id="elements">
36
			<h3>Classes</h3>
37
			<ul>
38
				<li class="active"><a href="class-Application.html">Application</a></li>
39
				<li><a href="class-Chronometre.html">Chronometre</a></li>
40
				<li><a href="class-Config.html">Config</a></li>
41
				<li><a href="class-Controleur.html">Controleur</a></li>
42
				<li><a href="class-Debug.html">Debug</a></li>
43
				<li><a href="class-GestionnaireException.html">GestionnaireException</a></li>
476 jpm 44
				<li><a href="class-I18n.html">I18n</a></li>
467 jpm 45
				<li><a href="class-Log.html">Log</a></li>
46
				<li><a href="class-Modele.html">Modele</a></li>
47
				<li><a href="class-Registre.html">Registre</a></li>
48
				<li><a href="class-SquelettePhp.html">SquelettePhp</a></li>
49
				<li><a href="class-Url.html">Url</a></li>
50
			</ul>
51
 
52
 
53
 
54
 
55
 
56
			<h3>Functions</h3>
57
			<ul>
58
				<li><a href="function-autoloadAppliDefaut.html">autoloadAppliDefaut</a></li>
59
				<li><a href="function-autoloadFw.html">autoloadFw</a></li>
60
			</ul>
61
		</div>
62
	</div>
63
</div>
64
 
65
<div id="splitter"></div>
66
 
67
<div id="right">
68
<div id="rightInner">
69
	<form id="search">
70
		<input type="hidden" name="cx" value="">
71
		<input type="hidden" name="ie" value="UTF-8">
72
		<input type="text" name="q" class="text">
73
		<input type="submit" value="Search">
74
	</form>
75
 
76
	<div id="navigation">
77
		<ul>
78
			<li>
79
				<a href="index.html" title="Overview"><span>Overview</span></a>
80
			</li>
81
			<li>
82
				<a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a>
83
			</li>
84
			<li>
85
				<a href="class-Application.html" title="Summary of Application"><span>Class</span></a>
86
			</li>
87
		</ul>
88
		<ul>
89
			<li>
90
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
91
			</li>
92
			<li>
93
				<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
94
			</li>
95
			<li>
96
				<a href="todo.html" title="Todo list"><span>Todo</span></a>
97
			</li>
98
		</ul>
99
		<ul>
100
		</ul>
101
	</div>
102
 
103
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
104
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-comment">// declare(encoding='UTF-8');</span>
105
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-comment">/**
106
</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.
107
</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> *
476 jpm 108
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * @category    PHP 5.2
109
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * @package     Framework
110
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * @author      Jean-Pascal MILCENT &lt;jpm@tela-botanica.org&gt;
111
</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)
112
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * @license     GNU-GPL-v3 &lt;http://www.gnu.org/licenses/gpl.html&gt;
113
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * @license     CECILL-v2 &lt;http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt&gt;
114
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> */</span>
115
</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> {
116
</span><span id="14" class="l"><a class="l" href="#14">14: </a>
117
</span><span id="15" class="l"><a class="l" href="#15">15: </a>    <span class="php-comment">/**
118
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment">     * Tableau d'informations sur l'application
119
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment">     */</span>
120
</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>;
121
</span><span id="19" class="l"><a class="l" href="#19">19: </a>    <span class="php-comment">/**
122
</span></span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment">     * Chemin de base de l'application
123
</span></span><span id="21" class="l"><a class="l" href="#21">21: </a><span class="php-comment">     */</span>
124
</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>;
125
</span><span id="23" class="l"><a class="l" href="#23">23: </a>
467 jpm 126
</span><span id="24" class="l"><a class="l" href="#24">24: </a>    <span class="php-comment">/**
476 jpm 127
</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.
128
</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.
129
</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().
130
</span></span><span id="28" class="l"><a class="l" href="#28">28: </a><span class="php-comment">     */</span>
131
</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>() {
132
</span><span id="30" class="l"><a class="l" href="#30">30: </a>        <span class="php-comment">// Configuration du gestionnaire d'exception</span>
133
</span><span id="31" class="l"><a class="l" href="#31">31: </a>        GestionnaireException::configurer();
134
</span><span id="32" class="l"><a class="l" href="#32">32: </a>        <span class="php-comment">// Configuration du gestionnaire de logs</span>
135
</span><span id="33" class="l"><a class="l" href="#33">33: </a>        <span class="php-comment">//Log::configurer();</span>
136
</span><span id="34" class="l"><a class="l" href="#34">34: </a>    }
137
</span><span id="35" class="l"><a class="l" href="#35">35: </a>
138
</span><span id="36" class="l"><a class="l" href="#36">36: </a>    <span class="php-comment">/**
139
</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.
140
</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.
141
</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
142
</span></span><span id="40" class="l"><a class="l" href="#40">40: </a><span class="php-comment">     */</span>
143
</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>) {
144
</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>) {
145
</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>)) {
146
</span><span id="44" class="l"><a class="l" href="#44">44: </a>                <span class="php-keyword2">trigger_error</span>(<span class="php-quote">&quot;Le fichier indiqué n'existe pas. Utilisez __FILE__ dans la méthode set().&quot;</span>, E_USER_ERROR);
147
</span><span id="45" class="l"><a class="l" href="#45">45: </a>            } <span class="php-keyword1">else</span> {
148
</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;
149
</span><span id="47" class="l"><a class="l" href="#47">47: </a>                self::initialiser();
150
</span><span id="48" class="l"><a class="l" href="#48">48: </a>            }
151
</span><span id="49" class="l"><a class="l" href="#49">49: </a>        } <span class="php-keyword1">else</span> {
152
</span><span id="50" class="l"><a class="l" href="#50">50: </a>            <span class="php-keyword2">trigger_error</span>(<span class="php-quote">&quot;Le chemin de l'application a déjà été enregistré auprès du Framework&quot;</span>, E_USER_WARNING);
153
</span><span id="51" class="l"><a class="l" href="#51">51: </a>        }
154
</span><span id="52" class="l"><a class="l" href="#52">52: </a>    }
155
</span><span id="53" class="l"><a class="l" href="#53">53: </a>
156
</span><span id="54" class="l"><a class="l" href="#54">54: </a>    <span class="php-comment">/**
157
</span></span><span id="55" class="l"><a class="l" href="#55">55: </a><span class="php-comment">     * accesseur pour le chemin
158
</span></span><span id="56" class="l"><a class="l" href="#56">56: </a><span class="php-comment">     * @return string le chemin
159
</span></span><span id="57" class="l"><a class="l" href="#57">57: </a><span class="php-comment">     */</span>
160
</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>() {
161
</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>;
162
</span><span id="60" class="l"><a class="l" href="#60">60: </a>    }
163
</span><span id="61" class="l"><a class="l" href="#61">61: </a>
164
</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 :
165
</span></span><span id="63" class="l"><a class="l" href="#63">63: </a><span class="php-comment">     * - nom : nom de l'application
166
</span></span><span id="64" class="l"><a class="l" href="#64">64: </a><span class="php-comment">     * - abr : abréviation de l'application
167
</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...)
168
</span></span><span id="66" class="l"><a class="l" href="#66">66: </a><span class="php-comment">     *
169
</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
170
</span></span><span id="68" class="l"><a class="l" href="#68">68: </a><span class="php-comment">     * @return void
171
</span></span><span id="69" class="l"><a class="l" href="#69">69: </a><span class="php-comment">     */</span>
172
</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>) {
173
</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>) {
174
</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>;
175
</span><span id="73" class="l"><a class="l" href="#73">73: </a>        } <span class="php-keyword1">else</span> {
176
</span><span id="74" class="l"><a class="l" href="#74">74: </a>            <span class="php-keyword2">trigger_error</span>(<span class="php-quote">&quot;Le informations de l'application ont déjà été enregistrées auprès du Framework&quot;</span>, E_USER_WARNING);
177
</span><span id="75" class="l"><a class="l" href="#75">75: </a>        }
178
</span><span id="76" class="l"><a class="l" href="#76">76: </a>    }
179
</span><span id="77" class="l"><a class="l" href="#77">77: </a>
180
</span><span id="78" class="l"><a class="l" href="#78">78: </a>    <span class="php-comment">/**
181
</span></span><span id="79" class="l"><a class="l" href="#79">79: </a><span class="php-comment">     * accesseur pour le tableau d'infos
182
</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
183
</span></span><span id="81" class="l"><a class="l" href="#81">81: </a><span class="php-comment">     */</span>
184
</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>) {
185
</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>) {
186
</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>])) {
187
</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>];
188
</span><span id="86" class="l"><a class="l" href="#86">86: </a>            }
189
</span><span id="87" class="l"><a class="l" href="#87">87: </a>        } <span class="php-keyword1">else</span> {
190
</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>;
191
</span><span id="89" class="l"><a class="l" href="#89">89: </a>        }
192
</span><span id="90" class="l"><a class="l" href="#90">90: </a>    }
193
</span><span id="91" class="l"><a class="l" href="#91">91: </a></span>}</code></pre>
467 jpm 194
 
195
	<div id="footer">
196
		TBFramework - v0.2 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
197
	</div>
198
</div>
199
</div>
200
</body>
201
</html>