diff options
Diffstat (limited to 'lib/public/IURLGenerator.php')
| -rw-r--r-- | lib/public/IURLGenerator.php | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/lib/public/IURLGenerator.php b/lib/public/IURLGenerator.php new file mode 100644 index 00000000000..a702ca47bfc --- /dev/null +++ b/lib/public/IURLGenerator.php @@ -0,0 +1,93 @@ +<?php +/** + * @author Bart Visscher <bartv@thisnet.nl> + * @author Joas Schilling <nickvergessen@owncloud.com> + * @author Morris Jobke <hey@morrisjobke.de> + * @author Thomas Müller <thomas.mueller@tmit.eu> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @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); +} |