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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Bart Visscher <bartv@thisnet.nl>
* @author Joas Schilling <coding@schilljs.com>
* @author Julius Härtl <jus@bitgrid.net>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Thomas Müller <thomas.mueller@tmit.eu>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
/**
* Public interface of ownCloud for apps to use.
* URL generator interface
*
*/
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP;
/**
* Class to generate URLs
* @since 6.0.0
*/
interface IURLGenerator {
/**
* Returns the URL for a route
* @param string $routeName the name of the route
* @param array $arguments an array with arguments which will be filled into the url
* @return string the url
* @since 6.0.0
*/
public function linkToRoute($routeName, $arguments = array());
/**
* Returns the absolute URL for a route
* @param string $routeName the name of the route
* @param array $arguments an array with arguments which will be filled into the url
* @return string the absolute url
* @since 8.0.0
*/
public function linkToRouteAbsolute($routeName, $arguments = array());
/**
* Returns an URL for an image or file
* @param string $appName the name of the app
* @param string $file the name of the file
* @param array $args array with param=>value, will be appended to the returned url
* The value of $args will be urlencoded
* @return string the url
* @since 6.0.0
*/
public function linkTo($appName, $file, $args = array());
/**
* Returns the link to an image, like linkTo but only with prepending img/
* @param string $appName the name of the app
* @param string $file the name of the file
* @return string the url
* @since 6.0.0
*/
public function imagePath($appName, $file);
/**
* Makes an URL absolute
* @param string $url the url in the ownCloud host
* @return string the absolute version of the url
* @since 6.0.0
*/
public function getAbsoluteURL($url);
/**
* @param string $key
* @return string url to the online documentation
* @since 8.0.0
*/
public function linkToDocs($key);
/**
* @return string base url of the current request
* @since 13.0.0
*/
public function getBaseUrl();
}
|
