Go to most recent revision | Blame | Last modification | View Log | RSS feed
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><title>Docs For Class Net_URL</title><link rel="stylesheet" type="text/css" id="layout"href="../media/layout.css" media="screen"><link rel="stylesheet" type="text/css" href="../media/style.css"media="all"><link rel="stylesheet" type="text/css" href="../media/print.css"media="print"></head><body><div id="header"><div id="navLinks">[ <a href="../classtrees_default.html">ClassTree: default</a> ] [ <a href="../elementindex_default.html">Index:default</a> ] [ <a href="../elementindex.html">All elements</a> ]</div><div id="packagePosition"><div id="packageTitle2">default</div><div id="packageTitle">default</div><div id="elementPath">·</div></div></div><div id="nav" class="small"><div id="packages">Packages:<p><a href="../li_default.html">default</a></p><p><a href="../li_eFlore.html">eFlore</a></p></div><div id="index"><div id="files">Files:<br><a href="../default/_controleurs---AdminAdministrateur.php.html">AdminAdministrateur.php </a><br><a href="../default/_admin_administrateur.php.html">admin_administrateur.php </a><br><a href="../default/_autoload.inc.php.html"> autoload.inc.php </a><br><a href="../default/_configuration---config.inc.php.html">config.inc.php </a><br><a href="../default/_configuration---config_chemin.inc.php.html">config_chemin.inc.php </a><br><a href="../default/_bibliotheque---Controleur.php.html">Controleur.php </a><br><a href="../default/_bibliotheque---GestionnaireException.php.html">GestionnaireException.php </a><br><a href="../default/_index.php.html"> index.php </a><br><a href="../default/_modeles---ListeAdmin.php.html"> ListeAdmin.php</a><br><a href="../default/_bibliotheque---Modele.php.html"> Modele.php </a><br><a href="../default/_bibliotheque---Net_URL.php.html"> Net_URL.php </a><br><a href="../default/_bibliotheque---Net_URL2.php.html"> Net_URL2.php</a><br><a href="../default/_bibliotheque---Registre.php.html"> Registre.php</a><br></div><div id="interfaces"></div><div id="classes">Classes:<br><a href="../default/AdminAdministrateur.html"> AdminAdministrateur </a><br><a href="../default/Controleur.html"> Controleur </a><br><a href="../default/GestionnaireException.html">GestionnaireException </a><br><a href="../default/listeAdmin.html"> listeAdmin </a><br><a href="../default/Modele.html"> Modele </a><br><a href="../default/Net_URL.html"> Net_URL </a><br><a href="../default/Net_URL2.html"> Net_URL2 </a><br><a href="../default/Registre.html"> Registre </a><br></div></div></div><div id="body"><h1>Class: Net_URL</h1><p style="margin: 0px;">Source Location: /bibliotheque/Net_URL.php</p><div class="leftcol"><h3><a href="#class_details">Class Overview</a> <spanclass="smalllinenumber">[line 40]</span></h3><div id="classTree"><pre></pre></div><div class="small"><p></p><h4>Author(s):</h4><ul></ul><h4>Version:</h4><ul></ul><h4>Copyright:</h4><ul></li></div></div><div class="middlecol"><h3><a href="#class_vars">Variables</a></h3><ul class="small"><li><a href="../default/Net_URL.html#var$anchor">$anchor</a></li><li><a href="../default/Net_URL.html#var$host">$host</a></li><li><a href="../default/Net_URL.html#var$options">$options</a></li><li><a href="../default/Net_URL.html#var$password">$password</a></li><li><a href="../default/Net_URL.html#var$path">$path</a></li><li><a href="../default/Net_URL.html#var$port">$port</a></li><li><a href="../default/Net_URL.html#var$protocol">$protocol</a></li><li><a href="../default/Net_URL.html#var$querystring">$querystring</a></li><li><a href="../default/Net_URL.html#var$url">$url</a></li><li><a href="../default/Net_URL.html#var$useBrackets">$useBrackets</a></li><li><a href="../default/Net_URL.html#var$username">$username</a></li></ul><h3><a href="#class_consts">Constants</a></h3><ul class="small"></ul></div><div class="rightcol"><h3><a href="#class_methods">Methods</a></h3><ul class="small"><li><a href="../default/Net_URL.html#method__construct">__construct</a></li><li><a href="../default/Net_URL.html#methodNet_URL">Net_URL</a></li><li><a href="../default/Net_URL.html#methodaddQueryString">addQueryString</a></li><li><a href="../default/Net_URL.html#methodaddRawQueryString">addRawQueryString</a></li><li><a href="../default/Net_URL.html#methodgetOption">getOption</a></li><li><a href="../default/Net_URL.html#methodgetQueryString">getQueryString</a></li><li><a href="../default/Net_URL.html#methodgetStandardPort">getStandardPort</a></li><li><a href="../default/Net_URL.html#methodgetURL">getURL</a></li><li><a href="../default/Net_URL.html#methodinitialize">initialize</a></li><li><a href="../default/Net_URL.html#methodremoveQueryString">removeQueryString</a></li><li><a href="../default/Net_URL.html#methodresolvePath">resolvePath</a></li><li><a href="../default/Net_URL.html#methodsetOption">setOption</a></li><li><a href="../default/Net_URL.html#methodsetProtocol">setProtocol</a></li><li><a href="../default/Net_URL.html#method__toString">__toString</a></li></ul></div><div id="content"><hr><div class="contents"></div><div class="leftCol"><h2>Inherited Variables</h2><h2>Inherited Constants</h2></div><div class="rightCol"><h2>Inherited Methods</h2></div><br clear="all"><hr><a name="class_details"></a><h2>Class Details</h2><p class="small" style="color: #334B66;">[ <a href="#top">Top</a> ]</p><hr><a name="class_vars"></a><h2>Class Variables</h2><a name="var$anchor"></a><p></p><h4>$anchor</h4><div class="indent"><p class="linenumber">[line 95]</p><p align="center"><strong>Anchor </strong></p><p><b>Type:</b> string</p><p><b>Overrides:</b></p></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="var$host"></a><p></p><h4>$host</h4><div class="indent"><p class="linenumber">[line 71]</p><p align="center"><strong>Host </strong></p><p><b>Type:</b> string</p><p><b>Overrides:</b></p></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="var$options"></a><p></p><h4>$options = <span class="value">array('encode_query_keys' => false)</span></h4><div class="indent"><p class="linenumber">[line 42]</p><p><b>Type:</b> mixed</p><p><b>Overrides:</b></p></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="var$password"></a><p></p><h4>$password</h4><div class="indent"><p class="linenumber">[line 65]</p><p align="center"><strong>Password </strong></p><p><b>Type:</b> string</p><p><b>Overrides:</b></p></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="var$path"></a><p></p><h4>$path</h4><div class="indent"><p class="linenumber">[line 83]</p><p align="center"><strong>Path </strong></p><p><b>Type:</b> string</p><p><b>Overrides:</b></p></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="var$port"></a><p></p><h4>$port</h4><div class="indent"><p class="linenumber">[line 77]</p><p align="center"><strong>Port </strong></p><p><b>Type:</b> integer</p><p><b>Overrides:</b></p></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="var$protocol"></a><p></p><h4>$protocol</h4><div class="indent"><p class="linenumber">[line 53]</p><p align="center"><strong>Protocol </strong></p><p><b>Type:</b> string</p><p><b>Overrides:</b></p></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="var$querystring"></a><p></p><h4>$querystring</h4><div class="indent"><p class="linenumber">[line 89]</p><p align="center"><strong>Query string </strong></p><p><b>Type:</b> array</p><p><b>Overrides:</b></p></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="var$url"></a><p></p><h4>$url</h4><div class="indent"><p class="linenumber">[line 47]</p><p align="center"><strong>Full url </strong></p><p><b>Type:</b> string</p><p><b>Overrides:</b></p></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="var$useBrackets"></a><p></p><h4>$useBrackets</h4><div class="indent"><p class="linenumber">[line 101]</p><p align="center"><strong>Whether to use [] </strong></p><p><b>Type:</b> bool</p><p><b>Overrides:</b></p></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="var$username"></a><p></p><h4>$username</h4><div class="indent"><p class="linenumber">[line 59]</p><p align="center"><strong>Username </strong></p><p><b>Type:</b> string</p><p><b>Overrides:</b></p></div><p class="top">[ <a href="#top">Top</a> ]</p><hr><a name="class_methods"></a><h2>Class Methods</h2><a name="method__construct"></a><p></p><h3>__construct</h3><div class="indent"><p><code>Net_URL __construct( [string $url = null], [bool$useBrackets = true])</code></p><p class="linenumber">[line 124]</p><p align="center"><strong>PHP5 Constructor </strong></p><p>Parses the given url and stores the various parts Defaults areused in certain cases</p><h4>Parameters:</h4><ul><li><span class="type">string</span> <b>$url</b> - Optional URL</li><li><span class="type">bool</span> <b>$useBrackets</b> - Whetherto use square brackets when multiple querystrings with the same nameexist</li></ul></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="methodNet_URL"></a><p></p><h3>Net_URL</h3><div class="indent"><p><code>Net_URL Net_URL( [ $url = null], [ $useBrackets =true])</code></p><p class="linenumber">[line 108]</p><p align="center"><strong>PHP4 Constructor </strong></p><h4>Tags:</h4><ul><li><b>see</b> - <ahref="../default/Net_URL.html#method__construct">Net_URL::__construct()</a></li></ul><h4>Parameters:</h4><ul><li><span class="type"></span> <b>$url</b> -</li><li><span class="type"></span> <b>$useBrackets</b> -</li></ul></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="methodaddQueryString"></a><p></p><h3>addQueryString</h3><div class="indent"><p><code>void addQueryString( string $name, string $value,[bool $preencoded = false])</code></p><p class="linenumber">[line 245]</p><p align="center"><strong>Adds or updates a querystringitem (URL parameter). </strong></p><p>Automatically encodes parameters with rawurlencode() if$preencoded is false. You can pass an array to $value, it gets mappedvia [] in the URL if $this->useBrackets is activated.</p><h4>Tags:</h4><ul><li><b>access</b> - public</li></ul><h4>Parameters:</h4><ul><li><span class="type">string</span> <b>$name</b> - Name of item</li><li><span class="type">string</span> <b>$value</b> - Value of item</li><li><span class="type">bool</span> <b>$preencoded</b> - Whethervalue is urlencoded or not, default = not</li></ul></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="methodaddRawQueryString"></a><p></p><h3>addRawQueryString</h3><div class="indent"><p><code>void addRawQueryString( string $querystring)</code></p><p class="linenumber">[line 281]</p><p align="center"><strong>Sets the querystring to literallywhat you supply </strong></p><h4>Tags:</h4><ul><li><b>access</b> - public</li></ul><h4>Parameters:</h4><ul><li><span class="type">string</span> <b>$querystring</b> - Thequerystring data. Should be of the format foo=bar&x=y etc</li></ul></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="methodgetOption"></a><p></p><h3>getOption</h3><div class="indent"><p><code>void getOption( $optionName, string $opionName)</code></p><p class="linenumber">[line 475]</p><p align="center"><strong>Get an option </strong></p><p>This function gets an option from the $this->options array andreturn it's value.</p><h4>Tags:</h4><ul><li><b>see</b> - $this->options</li><li><b>access</b> - public</li></ul><h4>Parameters:</h4><ul><li><span class="type">string</span> <b>$opionName</b> - The nameof the option to retrieve</li><li><span class="type"></span> <b>$optionName</b> -</li></ul></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="methodgetQueryString"></a><p></p><h3>getQueryString</h3><div class="indent"><p><code>string getQueryString( )</code></p><p class="linenumber">[line 292]</p><p align="center"><strong>Returns flat querystring </strong></p><h4>Tags:</h4><ul><li><b>return</b> - Querystring</li><li><b>access</b> - public</li></ul><h4>Parameters:</h4><ul></ul></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="methodgetStandardPort"></a><p></p><h3>getStandardPort</h3><div class="indent"><p><code>integer getStandardPort( string $scheme)</code></p><p class="linenumber">[line 418]</p><p align="center"><strong>Returns the standard port numberfor a protocol </strong></p><h4>Tags:</h4><ul><li><b>return</b> - Port number or NULL if no scheme matches</li><li><b>author</b> - Philippe Jausions <<ahref="mailto:Philippe.Jausions@11abacus.com">Philippe.Jausions@11abacus.com</a>></li></ul><h4>Parameters:</h4><ul><li><span class="type">string</span> <b>$scheme</b> - The protocolto lookup</li></ul></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="methodgetURL"></a><p></p><h3>getURL</h3><div class="indent"><p><code>string getURL( )</code></p><p class="linenumber">[line 218]</p><p align="center"><strong>Returns full url </strong></p><h4>Tags:</h4><ul><li><b>return</b> - Full url</li><li><b>access</b> - public</li></ul><h4>Parameters:</h4><ul></ul></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="methodinitialize"></a><p></p><h3>initialize</h3><div class="indent"><p><code>void initialize( )</code></p><p class="linenumber">[line 132]</p><h4>Parameters:</h4><ul></ul></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="methodremoveQueryString"></a><p></p><h3>removeQueryString</h3><div class="indent"><p><code>void removeQueryString( string $name)</code></p><p class="linenumber">[line 264]</p><p align="center"><strong>Removes a querystring item </strong></p><h4>Tags:</h4><ul><li><b>access</b> - public</li></ul><h4>Parameters:</h4><ul><li><span class="type">string</span> <b>$name</b> - Name of item</li></ul></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="methodresolvePath"></a><p></p><h3>resolvePath</h3><div class="indent"><p><code>string resolvePath( string $path)</code></p><p class="linenumber">[line 381]</p><p align="center"><strong>Resolves //, ../ and ./ from apath and returns the result. Eg: </strong></p><p>/foo/bar/../boo.php => /foo/boo.php /foo/bar/../../boo.php=> /boo.php /foo/bar/.././/boo.php => /foo/boo.php</p><p>This method can also be called statically.</p><h4>Tags:</h4><ul><li><b>return</b> - The result</li></ul><h4>Parameters:</h4><ul><li><span class="type">string</span> <b>$path</b> - URL path toresolve</li></ul></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="methodsetOption"></a><p></p><h3>setOption</h3><div class="indent"><p><code>void setOption( string $optionName, string $value)</code></p><p class="linenumber">[line 454]</p><p align="center"><strong>Set an option </strong></p><p>This function set an option to be used thorough the script.</p><h4>Tags:</h4><ul><li><b>access</b> - public</li></ul><h4>Parameters:</h4><ul><li><span class="type">string</span> <b>$optionName</b> - Theoptionname to set</li><li><span class="type">string</span> <b>$value</b> - The value ofthis option.</li></ul></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="methodsetProtocol"></a><p></p><h3>setProtocol</h3><div class="indent"><p><code>void setProtocol( string $protocol, [integer $port =null])</code></p><p class="linenumber">[line 438]</p><p align="center"><strong>Forces the URL to a particularprotocol </strong></p><h4>Parameters:</h4><ul><li><span class="type">string</span> <b>$protocol</b> - Protocolto force the URL to</li><li><span class="type">integer</span> <b>$port</b> - Optional port(standard port is used by default)</li></ul></div><p class="top">[ <a href="#top">Top</a> ]</p><a name="method__toString"></a><p></p><h3>__toString</h3><div class="indent"><p><code>void __toString( )</code></p><p class="linenumber">[line 484]</p><h4>Parameters:</h4><ul></ul></div><p class="top">[ <a href="#top">Top</a> ]</p><hr><a name="class_consts"></a><h2>Class Constants</h2></div><div id="credit"><hr>Documentation generated on Thu, 02 Apr 2009 10:23:02 +0200 by <ahref="http://www.phpdoc.org">phpDocumentor 1.4.1</a></div></div></body></html>