Subversion Repositories Applications.framework

Rev

Rev 5 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
5 aurelien 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html>
3
<head>
4
<title>Docs For Class Net_URL</title>
5
<link rel="stylesheet" type="text/css" id="layout"
6
	href="../media/layout.css" media="screen">
7
<link rel="stylesheet" type="text/css" href="../media/style.css"
8
	media="all">
9
<link rel="stylesheet" type="text/css" href="../media/print.css"
10
	media="print">
11
</head>
12
 
13
<body>
14
<div id="header">
15
<div id="navLinks">[ <a href="../classtrees_default.html">Class
16
Tree: default</a> ] [ <a href="../elementindex_default.html">Index:
17
default</a> ] [ <a href="../elementindex.html">All elements</a> ]</div>
18
<div id="packagePosition">
19
<div id="packageTitle2">default</div>
20
<div id="packageTitle">default</div>
21
<div id="elementPath">&middot;</div>
22
</div>
23
</div>
24
 
25
<div id="nav" class="small">
26
<div id="packages">Packages:
27
<p><a href="../li_default.html">default</a></p>
28
<p><a href="../li_eFlore.html">eFlore</a></p>
29
</div>
30
 
31
<div id="index">
32
<div id="files">Files:<br>
33
<a href="../default/_controleurs---AdminAdministrateur.php.html">
34
AdminAdministrateur.php </a><br>
35
<a href="../default/_admin_administrateur.php.html">
36
admin_administrateur.php </a><br>
37
<a href="../default/_autoload.inc.php.html"> autoload.inc.php </a><br>
38
<a href="../default/_configuration---config.inc.php.html">
39
config.inc.php </a><br>
40
<a href="../default/_configuration---config_chemin.inc.php.html">
41
config_chemin.inc.php </a><br>
42
<a href="../default/_bibliotheque---Controleur.php.html">
43
Controleur.php </a><br>
44
<a href="../default/_bibliotheque---GestionnaireException.php.html">
45
GestionnaireException.php </a><br>
46
<a href="../default/_index.php.html"> index.php </a><br>
47
<a href="../default/_modeles---ListeAdmin.php.html"> ListeAdmin.php
48
</a><br>
49
<a href="../default/_bibliotheque---Modele.php.html"> Modele.php </a><br>
50
<a href="../default/_bibliotheque---Net_URL.php.html"> Net_URL.php </a><br>
51
<a href="../default/_bibliotheque---Net_URL2.php.html"> Net_URL2.php
52
</a><br>
53
<a href="../default/_bibliotheque---Registre.php.html"> Registre.php
54
</a><br>
55
</div>
56
<div id="interfaces"></div>
57
<div id="classes">Classes:<br>
58
<a href="../default/AdminAdministrateur.html"> AdminAdministrateur </a><br>
59
<a href="../default/Controleur.html"> Controleur </a><br>
60
<a href="../default/GestionnaireException.html">
61
GestionnaireException </a><br>
62
<a href="../default/listeAdmin.html"> listeAdmin </a><br>
63
<a href="../default/Modele.html"> Modele </a><br>
64
<a href="../default/Net_URL.html"> Net_URL </a><br>
65
<a href="../default/Net_URL2.html"> Net_URL2 </a><br>
66
<a href="../default/Registre.html"> Registre </a><br>
67
</div>
68
</div>
69
</div>
70
 
71
<div id="body">
72
<h1>Class: Net_URL</h1>
73
<p style="margin: 0px;">Source Location: /bibliotheque/Net_URL.php</p>
74
 
75
 
76
<div class="leftcol">
77
<h3><a href="#class_details">Class Overview</a> <span
78
	class="smalllinenumber">[line 40]</span></h3>
79
<div id="classTree"><pre></pre></div>
80
<div class="small">
81
<p></p>
82
<h4>Author(s):</h4>
83
<ul>
84
</ul>
85
<h4>Version:</h4>
86
<ul>
87
</ul>
88
 
89
<h4>Copyright:</h4>
90
<ul>
91
	</li>
92
</div>
93
</div>
94
 
95
<div class="middlecol">
96
<h3><a href="#class_vars">Variables</a></h3>
97
<ul class="small">
98
	<li><a href="../default/Net_URL.html#var$anchor">$anchor</a></li>
99
	<li><a href="../default/Net_URL.html#var$host">$host</a></li>
100
	<li><a href="../default/Net_URL.html#var$options">$options</a></li>
101
	<li><a href="../default/Net_URL.html#var$password">$password</a></li>
102
	<li><a href="../default/Net_URL.html#var$path">$path</a></li>
103
	<li><a href="../default/Net_URL.html#var$port">$port</a></li>
104
	<li><a href="../default/Net_URL.html#var$protocol">$protocol</a></li>
105
	<li><a href="../default/Net_URL.html#var$querystring">$querystring</a></li>
106
	<li><a href="../default/Net_URL.html#var$url">$url</a></li>
107
	<li><a href="../default/Net_URL.html#var$useBrackets">$useBrackets</a></li>
108
	<li><a href="../default/Net_URL.html#var$username">$username</a></li>
109
</ul>
110
<h3><a href="#class_consts">Constants</a></h3>
111
<ul class="small">
112
</ul>
113
</div>
114
<div class="rightcol">
115
<h3><a href="#class_methods">Methods</a></h3>
116
<ul class="small">
117
	<li><a href="../default/Net_URL.html#method__construct">__construct</a></li>
118
	<li><a href="../default/Net_URL.html#methodNet_URL">Net_URL</a></li>
119
	<li><a href="../default/Net_URL.html#methodaddQueryString">addQueryString</a></li>
120
	<li><a href="../default/Net_URL.html#methodaddRawQueryString">addRawQueryString</a></li>
121
	<li><a href="../default/Net_URL.html#methodgetOption">getOption</a></li>
122
	<li><a href="../default/Net_URL.html#methodgetQueryString">getQueryString</a></li>
123
	<li><a href="../default/Net_URL.html#methodgetStandardPort">getStandardPort</a></li>
124
	<li><a href="../default/Net_URL.html#methodgetURL">getURL</a></li>
125
	<li><a href="../default/Net_URL.html#methodinitialize">initialize</a></li>
126
	<li><a href="../default/Net_URL.html#methodremoveQueryString">removeQueryString</a></li>
127
	<li><a href="../default/Net_URL.html#methodresolvePath">resolvePath</a></li>
128
	<li><a href="../default/Net_URL.html#methodsetOption">setOption</a></li>
129
	<li><a href="../default/Net_URL.html#methodsetProtocol">setProtocol</a></li>
130
	<li><a href="../default/Net_URL.html#method__toString">__toString</a></li>
131
</ul>
132
</div>
133
 
134
<div id="content">
135
<hr>
136
<div class="contents"></div>
137
 
138
<div class="leftCol">
139
<h2>Inherited Variables</h2>
140
<h2>Inherited Constants</h2>
141
</div>
142
 
143
<div class="rightCol">
144
<h2>Inherited Methods</h2>
145
</div>
146
<br clear="all">
147
<hr>
148
 
149
<a name="class_details"></a>
150
<h2>Class Details</h2>
151
<p class="small" style="color: #334B66;">[ <a href="#top">Top</a> ]</p>
152
 
153
<hr>
154
<a name="class_vars"></a>
155
<h2>Class Variables</h2>
156
<a name="var$anchor"></a>
157
<p></p>
158
<h4>$anchor</h4>
159
<div class="indent">
160
<p class="linenumber">[line 95]</p>
161
<p align="center"><strong>Anchor </strong></p>
162
<p><b>Type:</b> string</p>
163
<p><b>Overrides:</b></p>
164
</div>
165
<p class="top">[ <a href="#top">Top</a> ]</p>
166
<a name="var$host"></a>
167
<p></p>
168
<h4>$host</h4>
169
<div class="indent">
170
<p class="linenumber">[line 71]</p>
171
<p align="center"><strong>Host </strong></p>
172
<p><b>Type:</b> string</p>
173
<p><b>Overrides:</b></p>
174
</div>
175
<p class="top">[ <a href="#top">Top</a> ]</p>
176
<a name="var$options"></a>
177
<p></p>
178
<h4>$options = <span class="value">array('encode_query_keys'&nbsp;=&gt;&nbsp;false)</span></h4>
179
<div class="indent">
180
<p class="linenumber">[line 42]</p>
181
<p><b>Type:</b> mixed</p>
182
<p><b>Overrides:</b></p>
183
</div>
184
<p class="top">[ <a href="#top">Top</a> ]</p>
185
<a name="var$password"></a>
186
<p></p>
187
<h4>$password</h4>
188
<div class="indent">
189
<p class="linenumber">[line 65]</p>
190
<p align="center"><strong>Password </strong></p>
191
<p><b>Type:</b> string</p>
192
<p><b>Overrides:</b></p>
193
</div>
194
<p class="top">[ <a href="#top">Top</a> ]</p>
195
<a name="var$path"></a>
196
<p></p>
197
<h4>$path</h4>
198
<div class="indent">
199
<p class="linenumber">[line 83]</p>
200
<p align="center"><strong>Path </strong></p>
201
<p><b>Type:</b> string</p>
202
<p><b>Overrides:</b></p>
203
</div>
204
<p class="top">[ <a href="#top">Top</a> ]</p>
205
<a name="var$port"></a>
206
<p></p>
207
<h4>$port</h4>
208
<div class="indent">
209
<p class="linenumber">[line 77]</p>
210
<p align="center"><strong>Port </strong></p>
211
<p><b>Type:</b> integer</p>
212
<p><b>Overrides:</b></p>
213
</div>
214
<p class="top">[ <a href="#top">Top</a> ]</p>
215
<a name="var$protocol"></a>
216
<p></p>
217
<h4>$protocol</h4>
218
<div class="indent">
219
<p class="linenumber">[line 53]</p>
220
<p align="center"><strong>Protocol </strong></p>
221
<p><b>Type:</b> string</p>
222
<p><b>Overrides:</b></p>
223
</div>
224
<p class="top">[ <a href="#top">Top</a> ]</p>
225
<a name="var$querystring"></a>
226
<p></p>
227
<h4>$querystring</h4>
228
<div class="indent">
229
<p class="linenumber">[line 89]</p>
230
<p align="center"><strong>Query string </strong></p>
231
<p><b>Type:</b> array</p>
232
<p><b>Overrides:</b></p>
233
</div>
234
<p class="top">[ <a href="#top">Top</a> ]</p>
235
<a name="var$url"></a>
236
<p></p>
237
<h4>$url</h4>
238
<div class="indent">
239
<p class="linenumber">[line 47]</p>
240
<p align="center"><strong>Full url </strong></p>
241
<p><b>Type:</b> string</p>
242
<p><b>Overrides:</b></p>
243
</div>
244
<p class="top">[ <a href="#top">Top</a> ]</p>
245
<a name="var$useBrackets"></a>
246
<p></p>
247
<h4>$useBrackets</h4>
248
<div class="indent">
249
<p class="linenumber">[line 101]</p>
250
<p align="center"><strong>Whether to use [] </strong></p>
251
<p><b>Type:</b> bool</p>
252
<p><b>Overrides:</b></p>
253
</div>
254
<p class="top">[ <a href="#top">Top</a> ]</p>
255
<a name="var$username"></a>
256
<p></p>
257
<h4>$username</h4>
258
<div class="indent">
259
<p class="linenumber">[line 59]</p>
260
<p align="center"><strong>Username </strong></p>
261
<p><b>Type:</b> string</p>
262
<p><b>Overrides:</b></p>
263
</div>
264
<p class="top">[ <a href="#top">Top</a> ]</p>
265
 
266
<hr>
267
<a name="class_methods"></a>
268
<h2>Class Methods</h2>
269
 
270
<a name="method__construct"></a>
271
<p></p>
272
<h3>__construct</h3>
273
<div class="indent">
274
<p><code>Net_URL __construct( [string $url = null], [bool
275
$useBrackets = true])</code></p>
276
 
277
<p class="linenumber">[line 124]</p>
278
<p align="center"><strong>PHP5 Constructor </strong></p>
279
<p>Parses the given url and stores the various parts Defaults are
280
used in certain cases</p>
281
 
282
<h4>Parameters:</h4>
283
<ul>
284
	<li><span class="type">string</span> <b>$url</b> - Optional URL</li>
285
	<li><span class="type">bool</span> <b>$useBrackets</b> - Whether
286
	to use square brackets when multiple querystrings with the same name
287
	exist</li>
288
</ul>
289
</div>
290
<p class="top">[ <a href="#top">Top</a> ]</p>
291
<a name="methodNet_URL"></a>
292
<p></p>
293
<h3>Net_URL</h3>
294
<div class="indent">
295
<p><code>Net_URL Net_URL( [ $url = null], [ $useBrackets =
296
true])</code></p>
297
 
298
<p class="linenumber">[line 108]</p>
299
<p align="center"><strong>PHP4 Constructor </strong></p>
300
<h4>Tags:</h4>
301
<ul>
302
	<li><b>see</b> - <a
303
		href="../default/Net_URL.html#method__construct">Net_URL::__construct()</a></li>
304
</ul>
305
 
306
 
307
<h4>Parameters:</h4>
308
<ul>
309
	<li><span class="type"></span> <b>$url</b> -</li>
310
	<li><span class="type"></span> <b>$useBrackets</b> -</li>
311
</ul>
312
</div>
313
<p class="top">[ <a href="#top">Top</a> ]</p>
314
<a name="methodaddQueryString"></a>
315
<p></p>
316
<h3>addQueryString</h3>
317
<div class="indent">
318
<p><code>void addQueryString( string $name, string $value,
319
[bool $preencoded = false])</code></p>
320
 
321
<p class="linenumber">[line 245]</p>
322
<p align="center"><strong>Adds or updates a querystring
323
item (URL parameter). </strong></p>
324
<p>Automatically encodes parameters with rawurlencode() if
325
$preencoded is false. You can pass an array to $value, it gets mapped
326
via [] in the URL if $this-&gt;useBrackets is activated.</p>
327
<h4>Tags:</h4>
328
<ul>
329
	<li><b>access</b> - public</li>
330
</ul>
331
 
332
 
333
<h4>Parameters:</h4>
334
<ul>
335
	<li><span class="type">string</span> <b>$name</b> - Name of item</li>
336
	<li><span class="type">string</span> <b>$value</b> - Value of item</li>
337
	<li><span class="type">bool</span> <b>$preencoded</b> - Whether
338
	value is urlencoded or not, default = not</li>
339
</ul>
340
</div>
341
<p class="top">[ <a href="#top">Top</a> ]</p>
342
<a name="methodaddRawQueryString"></a>
343
<p></p>
344
<h3>addRawQueryString</h3>
345
<div class="indent">
346
<p><code>void addRawQueryString( string $querystring)</code></p>
347
 
348
<p class="linenumber">[line 281]</p>
349
<p align="center"><strong>Sets the querystring to literally
350
what you supply </strong></p>
351
<h4>Tags:</h4>
352
<ul>
353
	<li><b>access</b> - public</li>
354
</ul>
355
 
356
 
357
<h4>Parameters:</h4>
358
<ul>
359
	<li><span class="type">string</span> <b>$querystring</b> - The
360
	querystring data. Should be of the format foo=bar&amp;x=y etc</li>
361
</ul>
362
</div>
363
<p class="top">[ <a href="#top">Top</a> ]</p>
364
<a name="methodgetOption"></a>
365
<p></p>
366
<h3>getOption</h3>
367
<div class="indent">
368
<p><code>void getOption( $optionName, string $opionName)</code></p>
369
 
370
<p class="linenumber">[line 475]</p>
371
<p align="center"><strong>Get an option </strong></p>
372
<p>This function gets an option from the $this-&gt;options array and
373
return it's value.</p>
374
<h4>Tags:</h4>
375
<ul>
376
	<li><b>see</b> - $this-&gt;options</li>
377
	<li><b>access</b> - public</li>
378
</ul>
379
 
380
 
381
<h4>Parameters:</h4>
382
<ul>
383
	<li><span class="type">string</span> <b>$opionName</b> - The name
384
	of the option to retrieve</li>
385
	<li><span class="type"></span> <b>$optionName</b> -</li>
386
</ul>
387
</div>
388
<p class="top">[ <a href="#top">Top</a> ]</p>
389
<a name="methodgetQueryString"></a>
390
<p></p>
391
<h3>getQueryString</h3>
392
<div class="indent">
393
<p><code>string getQueryString( )</code></p>
394
 
395
<p class="linenumber">[line 292]</p>
396
<p align="center"><strong>Returns flat querystring </strong></p>
397
<h4>Tags:</h4>
398
<ul>
399
	<li><b>return</b> - Querystring</li>
400
	<li><b>access</b> - public</li>
401
</ul>
402
 
403
 
404
<h4>Parameters:</h4>
405
<ul>
406
</ul>
407
</div>
408
<p class="top">[ <a href="#top">Top</a> ]</p>
409
<a name="methodgetStandardPort"></a>
410
<p></p>
411
<h3>getStandardPort</h3>
412
<div class="indent">
413
<p><code>integer getStandardPort( string $scheme)</code></p>
414
 
415
<p class="linenumber">[line 418]</p>
416
<p align="center"><strong>Returns the standard port number
417
for a protocol </strong></p>
418
<h4>Tags:</h4>
419
<ul>
420
	<li><b>return</b> - Port number or NULL if no scheme matches</li>
421
	<li><b>author</b> - Philippe Jausions &lt;<a
422
		href="mailto:Philippe.Jausions@11abacus.com">Philippe.Jausions@11abacus.com</a>&gt;</li>
423
</ul>
424
 
425
 
426
<h4>Parameters:</h4>
427
<ul>
428
	<li><span class="type">string</span> <b>$scheme</b> - The protocol
429
	to lookup</li>
430
</ul>
431
</div>
432
<p class="top">[ <a href="#top">Top</a> ]</p>
433
<a name="methodgetURL"></a>
434
<p></p>
435
<h3>getURL</h3>
436
<div class="indent">
437
<p><code>string getURL( )</code></p>
438
 
439
<p class="linenumber">[line 218]</p>
440
<p align="center"><strong>Returns full url </strong></p>
441
<h4>Tags:</h4>
442
<ul>
443
	<li><b>return</b> - Full url</li>
444
	<li><b>access</b> - public</li>
445
</ul>
446
 
447
 
448
<h4>Parameters:</h4>
449
<ul>
450
</ul>
451
</div>
452
<p class="top">[ <a href="#top">Top</a> ]</p>
453
<a name="methodinitialize"></a>
454
<p></p>
455
<h3>initialize</h3>
456
<div class="indent">
457
<p><code>void initialize( )</code></p>
458
 
459
<p class="linenumber">[line 132]</p>
460
 
461
 
462
<h4>Parameters:</h4>
463
<ul>
464
</ul>
465
</div>
466
<p class="top">[ <a href="#top">Top</a> ]</p>
467
<a name="methodremoveQueryString"></a>
468
<p></p>
469
<h3>removeQueryString</h3>
470
<div class="indent">
471
<p><code>void removeQueryString( string $name)</code></p>
472
 
473
<p class="linenumber">[line 264]</p>
474
<p align="center"><strong>Removes a querystring item </strong></p>
475
<h4>Tags:</h4>
476
<ul>
477
	<li><b>access</b> - public</li>
478
</ul>
479
 
480
 
481
<h4>Parameters:</h4>
482
<ul>
483
	<li><span class="type">string</span> <b>$name</b> - Name of item</li>
484
</ul>
485
</div>
486
<p class="top">[ <a href="#top">Top</a> ]</p>
487
<a name="methodresolvePath"></a>
488
<p></p>
489
<h3>resolvePath</h3>
490
<div class="indent">
491
<p><code>string resolvePath( string $path)</code></p>
492
 
493
<p class="linenumber">[line 381]</p>
494
<p align="center"><strong>Resolves //, ../ and ./ from a
495
path and returns the result. Eg: </strong></p>
496
<p>/foo/bar/../boo.php =&gt; /foo/boo.php /foo/bar/../../boo.php
497
=&gt; /boo.php /foo/bar/.././/boo.php =&gt; /foo/boo.php</p>
498
<p>This method can also be called statically.</p>
499
<h4>Tags:</h4>
500
<ul>
501
	<li><b>return</b> - The result</li>
502
</ul>
503
 
504
 
505
<h4>Parameters:</h4>
506
<ul>
507
	<li><span class="type">string</span> <b>$path</b> - URL path to
508
	resolve</li>
509
</ul>
510
</div>
511
<p class="top">[ <a href="#top">Top</a> ]</p>
512
<a name="methodsetOption"></a>
513
<p></p>
514
<h3>setOption</h3>
515
<div class="indent">
516
<p><code>void setOption( string $optionName, string $value)</code></p>
517
 
518
<p class="linenumber">[line 454]</p>
519
<p align="center"><strong>Set an option </strong></p>
520
<p>This function set an option to be used thorough the script.</p>
521
<h4>Tags:</h4>
522
<ul>
523
	<li><b>access</b> - public</li>
524
</ul>
525
 
526
 
527
<h4>Parameters:</h4>
528
<ul>
529
	<li><span class="type">string</span> <b>$optionName</b> - The
530
	optionname to set</li>
531
	<li><span class="type">string</span> <b>$value</b> - The value of
532
	this option.</li>
533
</ul>
534
</div>
535
<p class="top">[ <a href="#top">Top</a> ]</p>
536
<a name="methodsetProtocol"></a>
537
<p></p>
538
<h3>setProtocol</h3>
539
<div class="indent">
540
<p><code>void setProtocol( string $protocol, [integer $port =
541
null])</code></p>
542
 
543
<p class="linenumber">[line 438]</p>
544
<p align="center"><strong>Forces the URL to a particular
545
protocol </strong></p>
546
 
547
 
548
<h4>Parameters:</h4>
549
<ul>
550
	<li><span class="type">string</span> <b>$protocol</b> - Protocol
551
	to force the URL to</li>
552
	<li><span class="type">integer</span> <b>$port</b> - Optional port
553
	(standard port is used by default)</li>
554
</ul>
555
</div>
556
<p class="top">[ <a href="#top">Top</a> ]</p>
557
<a name="method__toString"></a>
558
<p></p>
559
<h3>__toString</h3>
560
<div class="indent">
561
<p><code>void __toString( )</code></p>
562
 
563
<p class="linenumber">[line 484]</p>
564
 
565
 
566
<h4>Parameters:</h4>
567
<ul>
568
</ul>
569
</div>
570
<p class="top">[ <a href="#top">Top</a> ]</p>
571
 
572
<hr>
573
<a name="class_consts"></a>
574
<h2>Class Constants</h2>
575
</div>
576
<div id="credit">
577
<hr>
578
Documentation generated on Thu, 02 Apr 2009 10:23:02 +0200 by <a
579
	href="http://www.phpdoc.org">phpDocumentor 1.4.1</a></div>
580
</div>
581
</body>
582
</html>