kiss-lang/lime
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added documentation for lime.net.URIParser.

Browse Source 
Every field is described with examples.
This commit is contained in:
pfoof
2021-10-07 21:10:23 +02:00
parent b9c06ff299
commit 1aec979511
1 changed files with 100 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

101
src/lime/net/URIParser.hx
View File

@@ -1,29 +1,128 @@
package lime.net;
/**
Class used for parsing URIs and URLs.
Based on http://blog.stevenlevithan.com/archives/parseuri
**/
#if !lime_debug
@:fileXml('tags="haxe,release"')
@:noDebug
#end
// Based on http://blog.stevenlevithan.com/archives/parseuri
class URIParser
{
public static var URI_REGEX = ~/^(?:([^:\/?#]+):)?(?:\/\/((?:(([^:@]*)(?::([^:@]*))?)?@)?([^:\/?#]*)(?::(\d*))?))?((((?:[^?#\/]*\/)*)([^?#]*))(?:\?([^#]*))?(?:#(.*))?)/;
public static var QUERY_REGEX = ~/(?:^|&)([^&=]*)=?([^&]*)/;
/**
The original URI value from the constructor.
**/
public var source:String;
/**
In `"https://example.com/page/index.html"` this would be `"https"`.
`null` if unspecified.
**/
public var protocol:String;
/**
In `"https://user:password@example.com:443/page/index.html"` this would be `"user:password@example.com:443"`.
`null` if unspecified.
**/
public var authority:String;
/**
In `"https://user:password@example.com/page/index.html"` this would be `"user:password"`.
`null` if unspecified.
**/
public var userInfo:String;
/**
In `"https://john:password@example.com/index.html"` this would be `"john"`.
`null` if unspecified.
**/
public var user:String;
/**
In `"https://john:secret@example.com/index.html"` this would be `"secret"`.
`null` if unspecified.
**/
public var password:String;
/**
Domain/hostname/IP in the address.
In `"https://subdomain.example.com:443/index.html"` this would be `"subdomain.example.com"`
`null` if unspecified.
**/
public var host:String;
/**
Port used in the address as **String**.
In `"https://subdomain.example.com:443/index.html"` this would be `"443"`.
`null` if unspecified.
**/
public var port:String;
/**
Full path after the domain with all the directories and parameters.
In `"https://subdomain.example.com/files/website/index.php?action=upload&token=12345#header"`
this would be `"/files/website/index.php?action=upload&token=12345#header"`.
`null` if unspecified.
**/
public var relative:String;
/**
Full path after the domain with directories, without parameters.
In `"https://subdomain.example.com/files/website/index.php?action=upload&token=12345#header"`
this would be `"/files/website/index.php"`.
`null` if unspecified.
**/
public var path:String;
/**
Directory where the target file lays.
In `"https://subdomain.example.com/files/website/index.php"` this would be `"/files/website/"`.
`null` if unspecified.
**/
public var directory:String;
/**
Name of the file pointed.
In `"https://example.com/files/website/index.php?action=upload"` this would be `"index.php"`.
`null` if unspecified.
**/
public var file:String;
/**
Query string passed.
In `"https://example.com/index.php?action=upload&token=12345#header"`
this would be `"action=upload&token=12345"`.
`null` if unspecified.
**/
public var query:String;
/**
The "#hash" part of the query.
In `"https://example.com/index.php?action=upload&token=12345#header"` this would be `"header"`.
In a more sophisicated example `"https://example.com/index.php?action=upload#header=/abc/1234"`
that would be `"header=/abc/1234"`.
`null` if unspecified.
**/
public var anchor:String;
/**
Value from `query` returned as an array of key pair values.
In `"https://example.com/index.php?action=upload&token=12345#header"` the array would contain
`{k: "action", v: "upload"}, {k: "token", v: "12345"}`. If query is not present it is just an empty
array.
```haxe
var uri = new URIParser("https://example.com/index.php?action=upload&token=12345#header");
for( q in uri.queryArray )
trace( q.k + " = " + q.v); // action = upload
// token = 12345
```
**/
public var queryArray:Array<KVPair>;
public function new(uri:String)