<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Class URI - Class URI</title>
<link href="faldoc.css" rel="stylesheet" type="text/css"/>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
</head>
<body class="faldoc_body">
<div class="navitop">
<div class="tabs">
<ul>
<li><a href="./index.html"><span>Main</span></a></li>
<li><a href="./pages.html"><span>Related pages</span></a></li>
<li><a href="./groups.html"><span>Groups</span></a></li>
<li><a href="./funset.html"><span>Function sets</span></a></li>
<li><a href="./classes.html"><span>Classes</span></a></li>
<li><a href="./objects.html"><span>Objects</span></a></li>
<li><a href="./functions.html"><span>All functions</span></a></li>
<li><a href="./globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<hr/>
<h1 class="faldoc_title">Class URI</h1>
<p class="faldoc_brief">Interface to RFC3986 Universal Resource Indicator. </p>
<p class="faldoc_funcdecl">
<b>class</b> URI( [path], [decode] )
</p>
<p class="faldoc_brief"><a href="#more">more...</a></p>
<h2 class="faldoc_title">Summary</h2>
<table class="faldoc_list">
<tr><td><a href="#fragment">fragment</a></td><td>Fragment string in the uri (following path and query after a '#').</td></tr>
<tr><td><a href="#host">host</a></td><td>Host specificator.</td></tr>
<tr><td><a href="#path">path</a></td><td>Path specificator.</td></tr>
<tr><td><a href="#port">port</a></td><td>Optional port specificator (following the host after a ':').</td></tr>
<tr><td><a href="#query">query</a></td><td>Query string in the URI.</td></tr>
<tr><td><a href="#scheme">scheme</a></td><td>URI scheme.</td></tr>
<tr><td><a href="#uri">uri</a></td><td>Complete URI.</td></tr>
<tr><td><a href="#userInfo">userInfo</a></td><td>User, password or account specification preceding '\@' host.</td></tr>
<tr><td><a href="#decode">decode()</a></td><td>Decode a string to from URL encoding (static). </td></tr>
<tr><td><a href="#encode">encode()</a></td><td>Encode a string to URL encoding (static). </td></tr>
<tr><td><a href="#getFields">getFields()</a></td><td>Returns fields contained in the query element into a dictionary. </td></tr>
<tr><td><a href="#setFields">setFields()</a></td><td>Sets query fields for this uri. </td></tr>
<tr><td><a href="#toString">toString()</a></td><td>Returns a string representing this URI. </td></tr>
</table>
<a name="more"><h2 class="faldoc_title">Detailed description</h2></a>
<p class="faldoc_funcdecl">
<b>class</b> URI( [path], [decode] )
</p>
<table class="faldoc_function">
<tr><td class="faldoc_optparam">path</td><td class="faldoc_optparamdesc">The URI that will be used as initial data. </td></tr><tr><td class="faldoc_optparam">decode</td><td class="faldoc_optparamdesc">True if the path is URI encoded, and must be decoded (default). </td></tr>
</table>
<br/>
<p class="item_brief">Interface to RFC3986 Universal Resource Indicator. </p>
<p class="faldoc_text">This class offers an object oriented interface to access URI elements. </p>
<p class="faldoc_text"> Setting the properties in this class immediately reflects on the related fields; for example setting the value of the <b>uri</b> property causes a complete re-parse of the item; setting a field as the query string will cause the uri to change. </p>
<p class="faldoc_text">Each update is subject to RFC3986 compliance checks, and will raise a ParseError if conformance of the URI object is broken. </p>
<h2 class="faldoc_title">Properties</h2>
<h3 class="faldoc_funcname"><a name="fragment">fragment</a></h3>
<p class="item_brief">Fragment string in the uri (following path and query after a '#').</p>
<h3 class="faldoc_funcname"><a name="host">host</a></h3>
<p class="item_brief">Host specificator.</p>
<h3 class="faldoc_funcname"><a name="path">path</a></h3>
<p class="item_brief">Path specificator.</p>
<h3 class="faldoc_funcname"><a name="port">port</a></h3>
<p class="item_brief">Optional port specificator (following the host after a ':').</p>
<h3 class="faldoc_funcname"><a name="query">query</a></h3>
<p class="item_brief">Query string in the URI.</p>
<h3 class="faldoc_funcname"><a name="scheme">scheme</a></h3>
<p class="item_brief">URI scheme.</p>
<h3 class="faldoc_funcname"><a name="uri">uri</a></h3>
<p class="item_brief">Complete URI.</p>
<h3 class="faldoc_funcname"><a name="userInfo">userInfo</a></h3>
<p class="item_brief">User, password or account specification preceding '\@' host.</p>
<h2 class="faldoc_title">Methods</h2>
<h3 class="faldoc_funcname"><a name="decode">decode()</a></h3>
<p class="item_brief">Decode a string to from URL encoding (static). </p>
<p class="faldoc_funcdecl">URI.decode( enc_string )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">enc_string</td><td class="faldoc_paramdesc">The URI/URL encoded string. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">The decoded string. </td></tr>
<tr><td class="faldoc_raise">Raises:</td><td class="faldoc_raisedesc">
<table class="faldoc_raise">
<tr><td class="faldoc_raiseitem"><a href="./class_ParamError.html">ParamError</a></td><td class="faldoc_raisedesc">if the string is not a valid URI/URL encoded string. </td></tr>
</table>
</td></tr>
</table>
<h3 class="faldoc_funcname"><a name="encode">encode()</a></h3>
<p class="item_brief">Encode a string to URL encoding (static). </p>
<p class="faldoc_funcdecl">URI.encode( string )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">string</td><td class="faldoc_paramdesc">The string to be encoded. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">the URL/URI encoded string. </td></tr>
</table>
<h3 class="faldoc_funcname"><a name="getFields">getFields()</a></h3>
<p class="item_brief">Returns fields contained in the query element into a dictionary. </p>
<p class="faldoc_funcdecl">URI.getFields( )</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">The fields as a dictionary of nil if the query part contains no element. </td></tr>
<tr><td class="faldoc_raise">Raises:</td><td class="faldoc_raisedesc">
<table class="faldoc_raise">
<tr><td class="faldoc_raiseitem"><a href="./class_ParamError.html">ParamError</a></td><td class="faldoc_raisedesc">if the string is not a valid URI/URL encoded string. </td></tr>
</table>
</td></tr>
</table>
<h3 class="faldoc_funcname"><a name="setFields">setFields()</a></h3>
<p class="item_brief">Sets query fields for this uri. </p>
<p class="faldoc_funcdecl">URI.setFields( fields )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">fields</td><td class="faldoc_paramdesc">A dictionary of fields or nil to clear the query. </td></tr>
<tr><td class="faldoc_raise">Raises:</td><td class="faldoc_raisedesc">
<table class="faldoc_raise">
<tr><td class="faldoc_raiseitem"><a href="./class_ParamError.html">ParamError</a></td><td class="faldoc_raisedesc">if the input dictionary contains non-string values. </td></tr>
</table>
</td></tr>
</table>
<h3 class="faldoc_funcname"><a name="toString">toString()</a></h3>
<p class="item_brief">Returns a string representing this URI. </p>
<p class="faldoc_funcdecl">URI.toString( )</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">An URI encoded string containing a valid URI. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">Renders the URI into a valid string representation. </p>
</p>
<hr/>
<div class="navibottom">
<center>
<a href="./index.html">Main</a> - <a href="./pages.html">Related pages</a> - <a href="./groups.html">Groups</a> - <a href="./funset.html">Function sets</a> - <a href="./classes.html">Classes</a> - <a href="./objects.html">Objects</a> - <a href="./functions.html">All functions</a> - <a href="./globals.html">Globals</a>
</center>
</div>
</div>
<div class="faldoc_signature">Made with <a href="http://www.falconpl.org">faldoc 2.2.0</div>
</body>
</html>
