You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
102 lines
3.0 KiB
102 lines
3.0 KiB
<?php |
|
declare(strict_types=1); |
|
/** |
|
* @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/> |
|
* |
|
*/ |
|
|
|
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(string $routeName, array $arguments = array()): string; |
|
|
|
/** |
|
* 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(string $routeName, array $arguments = array()): string; |
|
|
|
/** |
|
* @param string $routeName |
|
* @param array $arguments |
|
* @return string |
|
* @since 15.0.0 |
|
*/ |
|
public function linkToOCSRouteAbsolute(string $routeName, array $arguments = []): string; |
|
|
|
/** |
|
* 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(string $appName, string $file, array $args = array()): string; |
|
|
|
/** |
|
* 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(string $appName, string $file): string; |
|
|
|
|
|
/** |
|
* 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(string $url): string; |
|
|
|
/** |
|
* @param string $key |
|
* @return string url to the online documentation |
|
* @since 8.0.0 |
|
*/ |
|
public function linkToDocs(string $key): string; |
|
|
|
/** |
|
* @return string base url of the current request |
|
* @since 13.0.0 |
|
*/ |
|
public function getBaseUrl(): string; |
|
}
|
|
|