Difference between revisions of "Web Module"
Jump to navigation
Jump to search
| Line 13: | Line 13: | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
| − | |{{Func| | + | |{{Func|web:content-type|$path as xs:string|xs:string}}<br/> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
| Line 21: | Line 21: | ||
| | | | ||
* <code><nowiki>web:content-type("sample.mp3")</nowiki></code> returns <code>audio/mpeg</code> | * <code><nowiki>web:content-type("sample.mp3")</nowiki></code> returns <code>audio/mpeg</code> | ||
| + | |} | ||
| + | |||
| + | ==web:create-url== | ||
| + | |||
| + | {| width='100%' | ||
| + | |- | ||
| + | | width='120' | '''Signatures''' | ||
| + | |{{Func|web:create-url|$url as xs:string, $parameters as map(*)|xs:string}}<br/> | ||
| + | |- | ||
| + | | '''Summary''' | ||
| + | |Creates a new URL from the specified <code>$url</code> string and the <code>$parameters</code> specified in a map. The keys and and values of the map entries will be converted to strings, URI-encoded, and appended to the url as query parameters. If a map entry has more than a single item, all of them will be appended as single parameters. | ||
| + | |- | ||
| + | | '''Examples''' | ||
| + | | | ||
| + | * <code><nowiki>web:create-url("http://find.me", map { 'q': 'dog' })</nowiki></code> returns <code>http://find.me?q=dog</code> | ||
| + | * <code><nowiki>web:create-url("search", map { 'year': (2000,2001) })</nowiki></code> returns <code>search?year=2000&year=2001</code> | ||
|} | |} | ||
Revision as of 14:56, 27 March 2015
This XQuery Module provides convenience functions for building web applications with RESTXQ.
Conventions
All functions in this module are assigned to the http://basex.org/modules/web namespace, which is statically bound to the web prefix.
All errors are assigned to the http://basex.org/errors namespace, which is statically bound to the bxerr prefix.
Functions
web:content-type
| Signatures | web:content-type($path as xs:string) as xs:string |
| Summary | Returns the content type of a path by analyzing its file suffix. application/octet-stream is returned if the file suffix is unknown.
|
| Examples |
|
web:create-url
| Signatures | web:create-url($url as xs:string, $parameters as map(*)) as xs:string |
| Summary | Creates a new URL from the specified $url string and the $parameters specified in a map. The keys and and values of the map entries will be converted to strings, URI-encoded, and appended to the url as query parameters. If a map entry has more than a single item, all of them will be appended as single parameters.
|
| Examples |
|
Changelog
The module was introduced with Version 8.1.
