1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
/**
* This class helps to handle URLs of hyperlinks and change their parameters.
* For example a javascript-page may open an item and the user expects other links
* on the same page to "know" that this item is now open. But because we don't use
* PHP session-variables here, this is difficult to use. This class can help. You
* can overwrite the href-attribute of the link by:
*
* [code]
* link.href = STUDIP.URLHelper.getURL("adresse.php?hello=world#anchor");
* [/code]
* Returns something like:
* "http://uni-adresse.de/studip/adresse.php?hello=world&mandatory=parameter#anchor"
*/
type URLHelperParameters = Record<string, string>;
class URLHelper {
base_url: string;
parameters: URLHelperParameters;
constructor(base_url: string = "", parameters: URLHelperParameters = {}) {
//the base url for all links
this.base_url = base_url;
// bound link parameters
this.parameters = parameters;
}
/**
* returns a readily encoded URL with the mandatory parameters and additionally passed
* parameters.
*
* @param url string: any url-string
* @param param_object map: associative object for extra values
* @param ignore_params boolean: ignore previously bound parameters
* @return: url with all necessary and additional parameters, encoded
*/
getURL(url: string, param_object: URLHelperParameters = {}, ignore_params: boolean = false): string {
let result;
if (url === '' || url.match(/^[?#]/)) {
result = new URL(url, location.href.replace(/\?.*/, ''));
} else {
result = new URL(url, this.base_url);
}
if (!ignore_params) {
for (const key in this.parameters) {
if (result.searchParams.has(key) || this.parameters[key] === null) {
continue;
}
result.searchParams.set(key, this.parameters[key]);
}
}
for (const key in param_object) {
if (param_object[key] !== null) {
result.searchParams.set(key, param_object[key]);
} else {
result.searchParams.delete(key);
}
}
return result.href;
}
}
export function createURLHelper(config: { base_url?: string, parameters?: Record<string, string>}): URLHelper {
return new URLHelper(config?.base_url, config?.parameters);
}
|
