Subversion Repositories Applications.framework

Rev

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