Subversion Repositories Applications.framework

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
464 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
 
7
	<title>Class Url | TBFramework - v0.4</title>
8
 
9
	<script type="text/javascript" src="resources/combined.js?4205936287"></script>
10
	<script type="text/javascript" src="elementlist.js?1964084359"></script>
11
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360">
12
 
13
</head>
14
 
15
<body>
16
<div id="left">
17
	<div id="menu">
18
		<a href="index.html" title="Overview"><span>Overview</span></a>
19
 
20
 
21
		<div id="groups">
22
			<h3>Packages</h3>
23
			<ul>
24
				<li class="active"><a href="package-Framework.html">Framework</a>
25
						</li>
26
				<li><a href="package-None.html">None</a>
27
						</li>
28
				<li><a href="package-PHP.html">PHP</a>
29
						</li>
30
				<li><a href="package-Utilitaire.html">Utilitaire</a>
31
						</li>
32
			</ul>
33
		</div>
34
 
35
		<hr>
36
 
37
 
38
		<div id="elements">
39
			<h3>Classes</h3>
40
			<ul>
41
				<li><a href="class-Bdd.html">Bdd</a></li>
42
				<li><a href="class-Cache.html">Cache</a></li>
43
				<li><a href="class-CacheSimple.html">CacheSimple</a></li>
44
				<li><a href="class-Chronometre.html">Chronometre</a></li>
45
				<li><a href="class-Cli.html">Cli</a></li>
46
				<li><a href="class-Config.html">Config</a></li>
47
				<li><a href="class-Controleur.html">Controleur</a></li>
48
				<li><a href="class-Debug.html">Debug</a></li>
49
				<li><a href="class-Framework.html">Framework</a></li>
50
				<li><a href="class-GestionnaireException.html">GestionnaireException</a></li>
51
				<li><a href="class-I18n.html">I18n</a></li>
52
				<li><a href="class-Log.html">Log</a></li>
53
				<li><a href="class-MonService.html">MonService</a></li>
54
				<li><a href="class-Registre.html">Registre</a></li>
55
				<li><a href="class-RestClient.html">RestClient</a></li>
56
				<li><a href="class-RestServeur.html">RestServeur</a></li>
57
				<li><a href="class-RestService.html">RestService</a></li>
58
				<li><a href="class-Script.html">Script</a></li>
59
				<li><a href="class-ServiceCacheFichier.html">ServiceCacheFichier</a></li>
60
				<li><a href="class-ServiceCacheSimple.html">ServiceCacheSimple</a></li>
61
				<li><a href="class-ServiceCacheSqlite.html">ServiceCacheSqlite</a></li>
62
				<li><a href="class-SquelettePhp.html">SquelettePhp</a></li>
63
				<li class="active"><a href="class-Url.html">Url</a></li>
64
			</ul>
65
 
66
 
67
 
68
 
69
 
70
		</div>
71
	</div>
72
</div>
73
 
74
<div id="splitter"></div>
75
 
76
<div id="right">
77
<div id="rightInner">
78
	<form id="search">
79
		<input type="hidden" name="cx" value="">
80
		<input type="hidden" name="ie" value="UTF-8">
81
		<input type="text" name="q" class="text">
82
		<input type="submit" value="Search">
83
	</form>
84
 
85
	<div id="navigation">
86
		<ul>
87
			<li>
88
				<a href="index.html" title="Overview"><span>Overview</span></a>
89
			</li>
90
			<li>
91
				<a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a>
92
			</li>
93
			<li class="active">
94
<span>Class</span>			</li>
95
		</ul>
96
		<ul>
97
			<li>
98
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
99
			</li>
100
			<li>
101
				<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
102
			</li>
103
			<li>
104
				<a href="todo.html" title="Todo list"><span>Todo</span></a>
105
			</li>
106
		</ul>
107
		<ul>
108
		</ul>
109
	</div>
110
 
111
<div id="content" class="class">
112
	<h1>Class Url</h1>
113
 
114
 
115
	<div class="description">
116
 
117
<p>Classe Url, gérant le découpage des paramètres, leurs modification etc...
118
Traduction et conversion d'une classe (NET_Url2) issue de Pear</p>
119
 
120
	</div>
121
 
122
 
123
 
124
 
125
 
126
 
127
 
128
 
129
 
130
	<div class="info">
131
 
132
 
133
 
134
		<b>Package:</b> <a href="package-Framework.html">Framework</a><br>
135
 
136
				<b>Category:</b>
137
				Php 5.2<br>
138
				<b>Copyright:</b>
139
				Copyright (c) 2010, Tela Botanica (<a
140
href="mailto:accueil&#64;tela-botanica.org">accueil&#64;<!-- -->tela-botanica.org</a>)<br>
141
				<b>License:</b>
142
				<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a><br>
143
				<b>License:</b>
144
				<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a><br>
145
				<b>Author:</b>
146
				Christian SCHMIDT &lt;<a
147
href="mailto:schmidt&#64;php.net">schmidt&#64;<!-- -->php.net</a>&gt; (Auteur
148
classe originale)<br>
149
				<b>Author:</b>
150
				Aurélien PERONNET &lt;<a
151
href="mailto:aurelien&#64;tela-botanica.org">aurelien&#64;<!-- -->tela-botanica.org</a>&gt;<br>
152
				<b>Author:</b>
153
				Jean-Pascal MILCENT &lt;<a
154
href="mailto:jpm&#64;tela-botanica.org">jpm&#64;<!-- -->tela-botanica.org</a>&gt;<br>
155
				<b>Version:</b>
156
				SVN: $Id: Url.php 405 2012-02-22 15:45:39Z gduche $<br>
157
				<b>Link:</b>
158
				/doc/framework/<br>
159
		<b>Located at</b> <a href="source-class-Url.html#3-425" title="Go to source code">framework/Url.php</a><br>
160
	</div>
161
 
162
 
163
 
164
	<table class="summary" id="methods">
165
	<caption>Methods summary</caption>
166
	<tr data-order="__construct" id="___construct">
167
 
168
		<td class="attributes"><code>
169
			 public
170
 
171
 
172
			</code>
173
		</td>
174
 
175
		<td class="name"><div>
176
		<a class="anchor" href="#___construct">#</a>
177
		<code><a href="source-class-Url.html#97-134" title="Go to source code">__construct</a>( <span>string <var>$url</var></span>, <span>array <var>$options</var> = <span class="php-keyword1">null</span></span> )</code>
178
 
179
		<div class="description short">
180
 
181
		</div>
182
 
183
		<div class="description detailed hidden">
184
 
185
 
186
 
187
				<h4>Parameters</h4>
188
				<div class="list"><dl>
189
					<dt><var>$url</var></dt>
190
					<dd><code>string</code><br>$url une URL relative ou absolue</dd>
191
					<dt><var>$options</var></dt>
192
					<dd><code>array</code><br>$options</dd>
193
				</dl></div>
194
 
195
 
196
 
197
 
198
 
199
		</div>
200
		</div></td>
201
	</tr>
202
	<tr data-order="getOption" id="_getOption">
203
 
204
		<td class="attributes"><code>
205
			 public
206
			mixed
207
 
208
			</code>
209
		</td>
210
 
211
		<td class="name"><div>
212
		<a class="anchor" href="#_getOption">#</a>
213
		<code><a href="source-class-Url.html#136-145" title="Go to source code">getOption</a>( <span>string <var>$nomOption</var></span> )</code>
214
 
215
		<div class="description short">
216
 
217
<p>Renvoie la valeur de l'option specifiée.</p>
218
 
219
		</div>
220
 
221
		<div class="description detailed hidden">
222
 
223
<p>Renvoie la valeur de l'option specifiée.</p>
224
 
225
 
226
 
227
				<h4>Parameters</h4>
228
				<div class="list"><dl>
229
					<dt><var>$nomOption</var></dt>
230
					<dd><code>string</code><br>$nomOption Nom de l'option demandée</dd>
231
				</dl></div>
232
 
233
				<h4>Returns</h4>
234
				<div class="list">
235
					<code>mixed</code><br>
236
				</div>
237
 
238
 
239
 
240
 
241
		</div>
242
		</div></td>
243
	</tr>
244
	<tr data-order="setOption" id="_setOption">
245
 
246
		<td class="attributes"><code>
247
			 public
248
 
249
 
250
			</code>
251
		</td>
252
 
253
		<td class="name"><div>
254
		<a class="anchor" href="#_setOption">#</a>
255
		<code><a href="source-class-Url.html#147-163" title="Go to source code">setOption</a>( <span>string <var>$nomOption</var></span>, <span>mixed <var>$valeur</var></span> )</code>
256
 
257
		<div class="description short">
258
 
259
<p>Met à jour la valeur de l'option spécifiée.</p>
260
 
261
		</div>
262
 
263
		<div class="description detailed hidden">
264
 
265
<p>Met à jour la valeur de l'option spécifiée.</p>
266
 
267
 
268
 
269
				<h4>Parameters</h4>
270
				<div class="list"><dl>
271
					<dt><var>$nomOption</var></dt>
272
					<dd><code>string</code><br>$nomOption une des constantes commençant par self::OPTION_</dd>
273
					<dt><var>$valeur</var></dt>
274
					<dd><code>mixed</code><br>$valeur valeur de l'option</dd>
275
				</dl></div>
276
 
277
 
278
 
279
				<h4>See</h4>
280
				<div class="list">
281
						self::OPTION_STRICTE<br>
282
						<code><code><a href="class-Url.html#OPTION_UTILISER_CROCHETS">Url::<b>OPTION_UTILISER_CROCHETS</b></a></code></code><br>
283
						<code><code><a href="class-Url.html#OPTION_ENCODER_CLES">Url::<b>OPTION_ENCODER_CLES</b></a></code></code><br>
284
				</div>
285
 
286
 
287
		</div>
288
		</div></td>
289
	</tr>
290
	<tr data-order="setRequete" id="_setRequete">
291
 
292
		<td class="attributes"><code>
293
			 public
294
 
295
 
296
			</code>
297
		</td>
298
 
299
		<td class="name"><div>
300
		<a class="anchor" href="#_setRequete">#</a>
301
		<code><a href="source-class-Url.html#264-299" title="Go to source code">setRequete</a>( <span>array <var>$parametres</var></span> )</code>
302
 
303
		<div class="description short">
304
 
305
<p>(Re-)Création de la partie requête de l'URL à partir des données du
306
tableau (passé en paramètre).</p>
307
 
308
		</div>
309
 
310
		<div class="description detailed hidden">
311
 
312
<p>(Re-)Création de la partie requête de l'URL à partir des données du
313
tableau (passé en paramètre).</p>
314
 
315
 
316
 
317
				<h4>Parameters</h4>
318
				<div class="list"><dl>
319
					<dt><var>$parametres</var></dt>
320
					<dd><code>array</code><br>(nom =&gt; valeur) tableau de clés &amp; valeurs pour la partie requête de
321
l'url.</dd>
322
				</dl></div>
323
 
324
				<h4>Returns</h4>
325
				<div class="list">
326
					<code></code><br>(Re-)Création de la partie requête.<br>
327
				</div>
328
 
329
 
330
 
331
 
332
		</div>
333
		</div></td>
334
	</tr>
335
	<tr data-order="fusionnerRequete" id="_fusionnerRequete">
336
 
337
		<td class="attributes"><code>
338
			 public
339
 
340
 
341
			</code>
342
		</td>
343
 
344
		<td class="name"><div>
345
		<a class="anchor" href="#_fusionnerRequete">#</a>
346
		<code><a href="source-class-Url.html#301-313" title="Go to source code">fusionnerRequete</a>( <span>array <var>$parametres</var></span> )</code>
347
 
348
		<div class="description short">
349
 
350
<p>(Re-)Création de la partie requête de l'URL à partir de la fusion du
351
tableau (passé en paramètre) et les valeurs présentes dans $_GET.</p>
352
 
353
		</div>
354
 
355
		<div class="description detailed hidden">
356
 
357
<p>(Re-)Création de la partie requête de l'URL à partir de la fusion du
358
tableau (passé en paramètre) et les valeurs présentes dans $_GET.</p>
359
 
360
 
361
 
362
				<h4>Parameters</h4>
363
				<div class="list"><dl>
364
					<dt><var>$parametres</var></dt>
365
					<dd><code>array</code><br>(nom =&gt; valeur) tableau de clés &amp; valeurs pour la partie requête de
366
l'url.</dd>
367
				</dl></div>
368
 
369
				<h4>Returns</h4>
370
				<div class="list">
371
					<code></code><br>(Re-)Création de la partie requête.<br>
372
				</div>
373
 
374
 
375
 
376
 
377
		</div>
378
		</div></td>
379
	</tr>
380
	<tr data-order="normaliser" id="_normaliser">
381
 
382
		<td class="attributes"><code>
383
			 public
384
 
385
 
386
			</code>
387
		</td>
388
 
389
		<td class="name"><div>
390
		<a class="anchor" href="#_normaliser">#</a>
391
		<code><a href="source-class-Url.html#315-352" title="Go to source code">normaliser</a>( )</code>
392
 
393
		<div class="description short">
394
 
395
<p>Normalise les données de l'instance d'Url faisant appel à cette
396
méthode.</p>
397
 
398
		</div>
399
 
400
		<div class="description detailed hidden">
401
 
402
<p>Normalise les données de l'instance d'Url faisant appel à cette
403
méthode.</p>
404
 
405
 
406
 
407
 
408
				<h4>Returns</h4>
409
				<div class="list">
410
					<code></code><br>l'instance d'Url courrante est normalisée.<br>
411
				</div>
412
 
413
 
414
 
415
 
416
		</div>
417
		</div></td>
418
	</tr>
419
	<tr data-order="getCanonique" id="_getCanonique">
420
 
421
		<td class="attributes"><code>
422
			 public static
423
			<code><a href="class-Url.html">Url</a></code>
424
 
425
			</code>
426
		</td>
427
 
428
		<td class="name"><div>
429
		<a class="anchor" href="#_getCanonique">#</a>
430
		<code><a href="source-class-Url.html#354-374" title="Go to source code">getCanonique</a>( )</code>
431
 
432
		<div class="description short">
433
 
434
<p>Renvoie une instance d'objet Url representant l'URL canonique du script PHP
435
en cours d'éxécution.</p>
436
 
437
		</div>
438
 
439
		<div class="description detailed hidden">
440
 
441
<p>Renvoie une instance d'objet Url representant l'URL canonique du script PHP
442
en cours d'éxécution.</p>
443
 
444
 
445
 
446
 
447
				<h4>Returns</h4>
448
				<div class="list">
449
					<code><code><a href="class-Url.html">Url</a></code></code><br>retourne un objet Url ou null en cas d'erreur.<br>
450
				</div>
451
 
452
 
453
 
454
 
455
		</div>
456
		</div></td>
457
	</tr>
458
	<tr data-order="getDemande" id="_getDemande">
459
 
460
		<td class="attributes"><code>
461
			 public static
462
			<code><a href="class-Url.html">Url</a></code>
463
 
464
			</code>
465
		</td>
466
 
467
		<td class="name"><div>
468
		<a class="anchor" href="#_getDemande">#</a>
469
		<code><a href="source-class-Url.html#376-393" title="Go to source code">getDemande</a>( )</code>
470
 
471
		<div class="description short">
472
 
473
<p>Renvoie une instance d'objet Url representant l'URL utilisée pour
474
récupérer la requête en cours.</p>
475
 
476
		</div>
477
 
478
		<div class="description detailed hidden">
479
 
480
<p>Renvoie une instance d'objet Url representant l'URL utilisée pour
481
récupérer la requête en cours.</p>
482
 
483
 
484
 
485
 
486
				<h4>Returns</h4>
487
				<div class="list">
488
					<code><code><a href="class-Url.html">Url</a></code></code><br>retourne un objet Url ou null en cas d'erreur.<br>
489
				</div>
490
 
491
 
492
 
493
 
494
		</div>
495
		</div></td>
496
	</tr>
497
	<tr data-order="getURL" id="_getURL">
498
 
499
		<td class="attributes"><code>
500
			 public
501
			string
502
 
503
			</code>
504
		</td>
505
 
506
		<td class="name"><div>
507
		<a class="anchor" href="#_getURL">#</a>
508
		<code><a href="source-class-Url.html#396-424" title="Go to source code">getURL</a>( )</code>
509
 
510
		<div class="description short">
511
 
512
<p>Renvoie un représentation sous forme de chaine de l'URL.</p>
513
 
514
		</div>
515
 
516
		<div class="description detailed hidden">
517
 
518
<p>Renvoie un représentation sous forme de chaine de l'URL.</p>
519
 
520
 
521
 
522
 
523
				<h4>Returns</h4>
524
				<div class="list">
525
					<code>string</code><br>l'url<br>
526
				</div>
527
 
528
 
529
 
530
 
531
		</div>
532
		</div></td>
533
	</tr>
534
	</table>
535
 
536
 
537
 
538
 
539
 
540
 
541
 
542
 
543
	<table class="summary" id="constants">
544
	<caption>Constants summary</caption>
545
	<tr data-order="OPTION_UTILISER_CROCHETS" id="OPTION_UTILISER_CROCHETS">
546
 
547
		<td class="attributes"><code>string</code></td>
548
		<td class="name"><code>
549
				<a href="source-class-Url.html#20-23" title="Go to source code"><b>OPTION_UTILISER_CROCHETS</b></a>
550
		</code></td>
551
		<td class="value"><code><span class="php-quote">'utiliser_crochets'</span></code></td>
552
		<td class="description"><div>
553
			<a href="#OPTION_UTILISER_CROCHETS" class="anchor">#</a>
554
 
555
			<div class="description short">
556
 
557
<p>Répresenter les tableaux dans les requêtes en utilisant la notation php [].
558
Par défaut à true.</p>
559
 
560
			</div>
561
 
562
			<div class="description detailed hidden">
563
 
564
<p>Répresenter les tableaux dans les requêtes en utilisant la notation php [].
565
Par défaut à true.</p>
566
 
567
 
568
			</div>
569
		</div></td>
570
	</tr>
571
	<tr data-order="OPTION_ENCODER_CLES" id="OPTION_ENCODER_CLES">
572
 
573
		<td class="attributes"><code>string</code></td>
574
		<td class="name"><code>
575
				<a href="source-class-Url.html#25-28" title="Go to source code"><b>OPTION_ENCODER_CLES</b></a>
576
		</code></td>
577
		<td class="value"><code><span class="php-quote">'encoder_cles'</span></code></td>
578
		<td class="description"><div>
579
			<a href="#OPTION_ENCODER_CLES" class="anchor">#</a>
580
 
581
			<div class="description short">
582
 
583
<p>URL-encoder les clés des variables dans les requêtes. Par défaut à
584
true.</p>
585
 
586
			</div>
587
 
588
			<div class="description detailed hidden">
589
 
590
<p>URL-encoder les clés des variables dans les requêtes. Par défaut à
591
true.</p>
592
 
593
 
594
			</div>
595
		</div></td>
596
	</tr>
597
	<tr data-order="OPTION_ENCODER_VALEURS" id="OPTION_ENCODER_VALEURS">
598
 
599
		<td class="attributes"><code>string</code></td>
600
		<td class="name"><code>
601
				<a href="source-class-Url.html#30-33" title="Go to source code"><b>OPTION_ENCODER_VALEURS</b></a>
602
		</code></td>
603
		<td class="value"><code><span class="php-quote">'encoder_valeurs'</span></code></td>
604
		<td class="description"><div>
605
			<a href="#OPTION_ENCODER_VALEURS" class="anchor">#</a>
606
 
607
			<div class="description short">
608
 
609
<p>URL-encoder les valeurs des variables dans les requêtes. Par défaut à
610
false.</p>
611
 
612
			</div>
613
 
614
			<div class="description detailed hidden">
615
 
616
<p>URL-encoder les valeurs des variables dans les requêtes. Par défaut à
617
false.</p>
618
 
619
 
620
			</div>
621
		</div></td>
622
	</tr>
623
	<tr data-order="OPTION_SEPARATEUR_ENTREE" id="OPTION_SEPARATEUR_ENTREE">
624
 
625
		<td class="attributes"><code>string</code></td>
626
		<td class="name"><code>
627
				<a href="source-class-Url.html#35-40" title="Go to source code"><b>OPTION_SEPARATEUR_ENTREE</b></a>
628
		</code></td>
629
		<td class="value"><code><span class="php-quote">'separateur_entree'</span></code></td>
630
		<td class="description"><div>
631
			<a href="#OPTION_SEPARATEUR_ENTREE" class="anchor">#</a>
632
 
633
			<div class="description short">
634
 
635
<p>Séparateurs de variables lors du parsing de la requête. Chaque caractère
636
est considéré comme un séparateur. Par défaut, spécifié par le paramêtre
637
arg_separator.input dans php.ini (par défaut "&amp;").</p>
638
 
639
			</div>
640
 
641
			<div class="description detailed hidden">
642
 
643
<p>Séparateurs de variables lors du parsing de la requête. Chaque caractère
644
est considéré comme un séparateur. Par défaut, spécifié par le paramêtre
645
arg_separator.input dans php.ini (par défaut "&amp;").</p>
646
 
647
 
648
			</div>
649
		</div></td>
650
	</tr>
651
	<tr data-order="OPTION_SEPARATEUR_SORTIE" id="OPTION_SEPARATEUR_SORTIE">
652
 
653
		<td class="attributes"><code>string</code></td>
654
		<td class="name"><code>
655
				<a href="source-class-Url.html#42-46" title="Go to source code"><b>OPTION_SEPARATEUR_SORTIE</b></a>
656
		</code></td>
657
		<td class="value"><code><span class="php-quote">'separateur_sortie'</span></code></td>
658
		<td class="description"><div>
659
			<a href="#OPTION_SEPARATEUR_SORTIE" class="anchor">#</a>
660
 
661
			<div class="description short">
662
 
663
<p>Séparateur de variables lors de la génération de la requête. Par défaut,
664
spécifié par le paramètre arg_separator.output dans php.ini (par défaut
665
"&amp;").</p>
666
 
667
			</div>
668
 
669
			<div class="description detailed hidden">
670
 
671
<p>Séparateur de variables lors de la génération de la requête. Par défaut,
672
spécifié par le paramètre arg_separator.output dans php.ini (par défaut
673
"&amp;").</p>
674
 
675
 
676
			</div>
677
		</div></td>
678
	</tr>
679
	</table>
680
 
681
 
682
 
683
 
684
 
685
 
686
 
687
 
688
 
689
 
690
</div>
691
 
692
	<div id="footer">
693
		TBFramework - v0.4 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
694
	</div>
695
</div>
696
</div>
697
</body>
698
</html>